The representation of a cnc command in a path. More...
#include <Command.h>
Public Member Functions | |
Command () | |
Command (const char *name, const std::map< std::string, double > ¶meters) | |
Base::Vector3d | getCenter (void) const |
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... | |
double | getParam (const std::string &name, double fallback=0.0) const |
Base::Placement | getPlacement (const Base::Vector3d pos=Base::Vector3d()) const |
double | getValue (const std::string &name) const |
bool | has (const std::string &) const |
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... | |
void | scaleBy (double factor) |
void | setCenter (const Base::Vector3d &, bool clockwise=true) |
void | setFromGCode (const std::string &) |
void | setFromPlacement (const Base::Placement &) |
std::string | toGCode (int precision=6, bool padzero=true) const |
Command | transform (const Base::Placement &) |
~Command () | |
![]() | |
void | dumpToStream (std::ostream &stream, int compression) |
virtual Base::Type | getTypeId (void) const |
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 | SaveDocFile (Writer &) const |
This method is used to save large amounts of data to a binary file. More... | |
![]() | |
BaseClass () | |
Construction. More... | |
virtual PyObject * | getPyObject (void) |
This method returns the Python wrapper for a C++ object. More... | |
bool | isDerivedFrom (const Type type) const |
virtual void | setPyObject (PyObject *) |
virtual | ~BaseClass () |
Destruction. More... | |
Public Attributes | |
std::string | Name |
std::map< std::string, double > | Parameters |
Additional Inherited Members | |
![]() | |
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 void * | create (void) |
static Type | getClassTypeId (void) |
static void | init (void) |
![]() | |
static void | initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr) |
Detailed Description
The representation of a cnc command in a path.
Constructor & Destructor Documentation
◆ Command() [1/2]
Command::Command | ( | ) |
◆ Command() [2/2]
Command::Command | ( | const char * | name, |
const std::map< std::string, double > & | parameters | ||
) |
◆ ~Command()
Command::~Command | ( | ) |
Member Function Documentation
◆ getCenter()
Vector3d Command::getCenter | ( | void | ) | const |
References draftutils.utils::getParam, and draftgeoutils.general::vec().
Referenced by PathSimulator::PathSim::ApplyCommand(), and Path::PathSegmentWalker::walk().
◆ getMemSize()
|
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.
◆ getParam()
double Path::Command::getParam | ( | const std::string & | name, |
double | fallback = 0.0 |
||
) | const |
◆ getPlacement()
Placement Command::getPlacement | ( | const Base::Vector3d | pos = Base::Vector3d() | ) | const |
References draftutils.utils::getParam, Base::Rotation::setYawPitchRoll(), and draftgeoutils.general::vec().
Referenced by Point3D::UpdateCmd(), and Path::PathSegmentWalker::walk().
◆ getValue()
double Command::getValue | ( | const std::string & | name | ) | const |
References draftutils.utils::getParam.
Referenced by Path::PathSegmentWalker::walk().
◆ has()
bool Command::has | ( | const std::string & | attr | ) | const |
◆ Restore()
|
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:
Implements Base::Persistence.
References Base::XMLReader::getAttribute(), and Base::XMLReader::readElement().
◆ Save()
|
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:
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 Base::Writer::ind(), and Base::Writer::Stream().
◆ scaleBy()
void Command::scaleBy | ( | double | factor | ) |
◆ setCenter()
void Command::setCenter | ( | const Base::Vector3d & | pos, |
bool | clockwise = true |
||
) |
Referenced by draftguitools.gui_trackers.arcTracker::setBy3Points().
◆ setFromGCode()
void Command::setFromGCode | ( | const std::string & | str | ) |
Referenced by Path::CommandPy::PyInit(), and Path::CommandPy::setFromGCode().
◆ setFromPlacement()
void Command::setFromPlacement | ( | const Base::Placement & | plac | ) |
◆ toGCode()
std::string Command::toGCode | ( | int | precision = 6 , |
bool | padzero = true |
||
) | const |
References draftgeoutils.general::precision(), and draftfunctions.scale::scale().
Referenced by PathGui::ViewProviderPath::getElement().
◆ transform()
Command Command::transform | ( | const Base::Placement & | other | ) |
References Base::Placement::getPosition(), Base::Placement::getRotation(), Base::Rotation::getYawPitchRoll(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.
Referenced by importSVG.svgHandler::applyTrans(), importSVG.svgHandler::characters(), importSVG.svgHandler::endElement(), ArchSite.Compass::locate(), ArchSite.Compass::rotate(), ArchSite.Compass::scale(), and Path::CommandPy::transform().
Member Data Documentation
◆ Name
std::string Path::Command::Name |
◆ Parameters
std::map<std::string,double> Path::Command::Parameters |
The documentation for this class was generated from the following files:
- Sources/FreeCAD/src/Mod/Path/App/Command.h
- Sources/FreeCAD/src/Mod/Path/App/Command.cpp