The representation of a single tool. More...

#include <Tool.h>

Public Types
enum	ToolMaterial { MATUNDEFINED , HIGHSPEEDSTEEL , HIGHCARBONTOOLSTEEL , CASTALLOY , CARBIDE , CERAMICS , DIAMOND , SIALON }

enum	ToolType { UNDEFINED , DRILL , CENTERDRILL , COUNTERSINK , COUNTERBORE , FLYCUTTER , REAMER , TAP , ENDMILL , SLOTCUTTER , BALLENDMILL , CHAMFERMILL , CORNERROUND , ENGRAVER }

Public Member Functions
virtual unsigned int	getMemSize (void) const
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

virtual void	Restore (Base::XMLReader &)
	This method is used to restore properties from an XML document. More...

virtual void	Save (Base::Writer &) const
	This method is used to save properties to an XML document. More...

	Tool ()

	Tool (const char *name, ToolType type=Tool::UNDEFINED, ToolMaterial material=Tool::MATUNDEFINED, double diameter=10.0, double lengthoffset=100, double flatradius=0, double cornerradius=0, double cuttingedgeangle=0, double cuttingedgeheight=0)

	~Tool ()

Public Member Functions inherited from Base::Persistence
void	dumpToStream (std::ostream &stream, int compression)

virtual unsigned int	getMemSize () const =0
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

virtual Base::Type	getTypeId (void) const

virtual void	Restore (XMLReader &)=0
	This method is used to restore properties from an XML document. More...

virtual void	RestoreDocFile (Reader &)
	This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...

void	restoreFromStream (std::istream &stream)

virtual void	Save (Writer &) const =0
	This method is used to save properties to an XML document. More...

virtual void	SaveDocFile (Writer &) const
	This method is used to save large amounts of data to a binary file. More...

Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...

	BaseClass (const BaseClass &)=default

virtual PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...

virtual Type	getTypeId () const

bool	isDerivedFrom (const Type type) const

BaseClass &	operator= (const BaseClass &)=default

virtual void	setPyObject (PyObject *)

virtual	~BaseClass ()
	Destruction. More...

Static Public Member Functions
static ToolMaterial	getToolMaterial (std::string mat)

static ToolType	getToolType (std::string type)

static const char *	MaterialName (ToolMaterial mat)

static const std::vector< std::string >	ToolMaterials (void)

static const std::vector< std::string >	ToolTypes (void)

static const char *	TypeName (ToolType typ)

Static Public Member Functions inherited from Base::Persistence
static void *	create (void)

static std::string	encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...

static Base::Type	getClassTypeId (void)

static void	init (void)

Static Public Member Functions inherited from Base::BaseClass
static void *	create ()

static Type	getClassTypeId ()

static void	init ()

Public Attributes
double	CornerRadius

double	CuttingEdgeAngle

double	CuttingEdgeHeight

double	Diameter

double	FlatRadius

double	LengthOffset

ToolMaterial	Material

std::string	Name

ToolType	Type

Additional Inherited Members
Static Protected Member Functions inherited from Base::BaseClass
static void	initSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Type::instantiationMethod method=nullptr)

Detailed Description

The representation of a single tool.

Member Enumeration Documentation

◆ ToolMaterial

enum Path::Tool::ToolMaterial

Enumerator
MATUNDEFINED
HIGHSPEEDSTEEL
HIGHCARBONTOOLSTEEL
CASTALLOY
CARBIDE
CERAMICS
DIAMOND
SIALON

◆ ToolType

enum Path::Tool::ToolType

Enumerator
UNDEFINED
DRILL
CENTERDRILL
COUNTERSINK
COUNTERBORE
FLYCUTTER
REAMER
TAP
ENDMILL
SLOTCUTTER
BALLENDMILL
CHAMFERMILL
CORNERROUND
ENGRAVER

Constructor & Destructor Documentation

◆ Tool() [1/2]

Tool::Tool ( )

References CornerRadius, CuttingEdgeAngle, CuttingEdgeHeight, Diameter, FlatRadius, LengthOffset, MATUNDEFINED, and UNDEFINED.

Referenced by PathScripts.PathToolEdit.ToolEditor::accept(), and PathScripts.PathToolEdit.ToolEditor::reject().

◆ Tool() [2/2]

Tool::Tool	(	const char *	name,
		ToolType	type = `Tool::UNDEFINED`,
		ToolMaterial	material = `Tool::MATUNDEFINED`,
		double	diameter = `10.0`,
		double	lengthoffset = `100`,
		double	flatradius = `0`,
		double	cornerradius = `0`,
		double	cuttingedgeangle = `0`,
		double	cuttingedgeheight = `0`
	)

Referenced by PathScripts.PathToolEdit.ToolEditor::accept(), and PathScripts.PathToolEdit.ToolEditor::reject().

◆ ~Tool()

Tool::~Tool ( )

Member Function Documentation

◆ getMemSize()

unsigned int Tool::getMemSize ( void ) const

virtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?

Implements Base::Persistence.

◆ getToolMaterial()

Tool::ToolMaterial Tool::getToolMaterial ( std::string mat )

static

References CARBIDE, CASTALLOY, CERAMICS, DIAMOND, HIGHCARBONTOOLSTEEL, HIGHSPEEDSTEEL, Material, MATUNDEFINED, and SIALON.

Referenced by Restore().

◆ getToolType()

Tool::ToolType Tool::getToolType ( std::string type )

static

References BALLENDMILL, CENTERDRILL, CHAMFERMILL, CORNERROUND, COUNTERBORE, COUNTERSINK, DRILL, ENDMILL, ENGRAVER, FLYCUTTER, REAMER, SLOTCUTTER, TAP, Type, and UNDEFINED.

Referenced by Restore().

◆ MaterialName()

const char * Tool::MaterialName ( Tool::ToolMaterial mat )

static

References CARBIDE, CASTALLOY, CERAMICS, DIAMOND, HIGHCARBONTOOLSTEEL, HIGHSPEEDSTEEL, MATUNDEFINED, and SIALON.

Referenced by Save().

◆ Restore()

void Tool::Restore ( Base::XMLReader & )

virtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

void PropertyVector::Restore(Base::XMLReader &reader)
{
  // read my Element
  reader.readElement("PropertyVector");
  // get the value of my Attribute
  _cVec.x = reader.getAttributeAsFloat("valueX");
  _cVec.y = reader.getAttributeAsFloat("valueY");
  _cVec.z = reader.getAttributeAsFloat("valueZ");
}

Implements Base::Persistence.

References CornerRadius, CuttingEdgeAngle, CuttingEdgeHeight, Diameter, FlatRadius, Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsFloat(), getToolMaterial(), getToolType(), Base::XMLReader::hasAttribute(), LengthOffset, Name, and Base::XMLReader::readElement().

Referenced by Path::PropertyTool::Restore().

◆ Save()

void Tool::Save ( Base::Writer & ) const

virtual

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

void PropertyVector::Save (Writer &writer) const
{
   writer << writer.ind() << "<PropertyVector valueX=\"" <<  _cVec.x <<
                                          "\" valueY=\"" <<  _cVec.y <<
                                          "\" valueZ=\"" <<  _cVec.z <<"\"/>" << endl;
}

The writer.ind() expression writes the indentation, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.

See also: Base::Writer

Implements Base::Persistence.

References CornerRadius, CuttingEdgeAngle, CuttingEdgeHeight, Diameter, Base::Persistence::encodeAttribute(), FlatRadius, Base::Writer::ind(), LengthOffset, MaterialName(), Name, Base::Writer::Stream(), and TypeName().

◆ ToolMaterials()

const std::vector< std::string > Tool::ToolMaterials ( void )

static

◆ ToolTypes()

const std::vector< std::string > Tool::ToolTypes ( void )

static

◆ TypeName()

const char * Tool::TypeName ( Tool::ToolType typ )

static

References BALLENDMILL, CENTERDRILL, CHAMFERMILL, CORNERROUND, COUNTERBORE, COUNTERSINK, DRILL, ENDMILL, ENGRAVER, FLYCUTTER, REAMER, SLOTCUTTER, TAP, and UNDEFINED.

Referenced by Save().

Member Data Documentation

◆ CornerRadius

double Path::Tool::CornerRadius

Referenced by Restore(), Save(), and Tool().

◆ CuttingEdgeAngle

double Path::Tool::CuttingEdgeAngle

Referenced by Restore(), Save(), and Tool().

◆ CuttingEdgeHeight

double Path::Tool::CuttingEdgeHeight

Referenced by Restore(), Save(), and Tool().

◆ Diameter

double Path::Tool::Diameter

Referenced by Restore(), Save(), PathTests.TestPathDeburr.TestPathDeburr::test11(), and Tool().

◆ FlatRadius

double Path::Tool::FlatRadius

Referenced by Restore(), Save(), and Tool().

◆ LengthOffset

double Path::Tool::LengthOffset

Referenced by Restore(), Save(), and Tool().

◆ Material

ToolMaterial Path::Tool::Material

Referenced by getToolMaterial().

◆ Name

std::string Path::Tool::Name

Referenced by Restore(), and Save().

◆ Type

ToolType Path::Tool::Type

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), draftobjects.draft_annotation.DraftAnnotation::add_missing_properties_0v19(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchComponent.Component::execute(), draftobjects.layer.LayerContainer::execute(), getToolType(), ArchSchedule.CommandArchSchedule::IsActive(), draftobjects.layer.Layer::set_properties(), and ArchReference.ArchReference::setProperties().

The documentation for this class was generated from the following files:

FreeCAD/src/Mod/Path/App/Tool.h
FreeCAD/src/Mod/Path/App/Tool.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ToolMaterial

◆ ToolType

Constructor & Destructor Documentation

◆ Tool() [1/2]

◆ Tool() [2/2]

◆ ~Tool()

Member Function Documentation

◆ getMemSize()

◆ getToolMaterial()

◆ getToolType()

◆ MaterialName()

◆ Restore()

◆ Save()

◆ ToolMaterials()

◆ ToolTypes()

◆ TypeName()

Member Data Documentation

◆ CornerRadius

◆ CuttingEdgeAngle

◆ CuttingEdgeHeight

◆ Diameter

◆ FlatRadius

◆ LengthOffset

◆ Material

◆ Name

◆ Type