Path::PathPy Class Reference

The python export class for Toolpath. More...

#include <PathPy.h>

Public Types
typedef Toolpath *	PointerType
Public Types inherited from Base::PersistencePy
typedef Persistence *	PointerType
Public Types inherited from Base::BaseClassPy
typedef BaseClass *	PointerType
Public Types inherited from Base::PyObjectBase
typedef void *	PointerType
enum	Status { Valid = 0, Immutable = 1, Notify = 2, NoTrack = 3 }

Public Member Functions
virtual PyTypeObject *	GetType (void)
	PathPy (Toolpath *pcObject, PyTypeObject *T=&Type)
virtual int	PyInit (PyObject *args, PyObject *k)
	PyInit method Override this method to initialize a newly created instance of the class (Constructor) More...
std::string	representation (void) const
Public Member Functions inherited from Base::PersistencePy
	PersistencePy (Persistence *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
PyObject *	dumpContent (PyObject *args, PyObject *kwd)
	implementer for the dumpContent() method More...
PyObject *	restoreContent (PyObject *args)
	implementer for the restoreContent() method More...
Py::String	getContent (void) const
	getter for the Content attribute More...
Py::Int	getMemSize (void) const
	getter for the MemSize attribute More...
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones) More...
int	setCustomAttributes (const char *attr, PyObject *obj)
	setter for special attributes (e.g. More...
Persistence *	getPersistencePtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Base::BaseClassPy
	BaseClassPy (BaseClass *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
PyObject *	isDerivedFrom (PyObject *args)
	implementer for the isDerivedFrom() method More...
PyObject *	getAllDerivedFrom (PyObject *args)
	implementer for the getAllDerivedFrom() method More...
Py::String	getTypeId (void) const
	getter for the TypeId attribute More...
Py::String	getModule (void) const
	getter for the Module attribute More...
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones) More...
int	setCustomAttributes (const char *attr, PyObject *obj)
	setter for special attributes (e.g. More...
BaseClass *	getBaseClassPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Base::PyObjectBase
PyObjectBase *	DecRef (void)
	decref method wrapper (see python extending manual) More...
PyObjectBase *	IncRef (void)
	incref method wrapper (see python extending manual) More...
bool	isConst ()
bool	isNotTracking () const
bool	isValid ()
	PyObjectBase (void *, PyTypeObject *T)
	Constructor Sets the Type of the object (for inheritance) and decrease the the reference count of the PyObject. More...
void	setConst ()
void	setInvalid ()
void	setNotTracking (bool on=true)
void	setShouldNotify (bool on)
bool	shouldNotify () const
void	startNotify ()

Static Public Member Functions
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
Static Public Member Functions inherited from Base::PersistencePy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	staticCallback_dumpContent (PyObject *self, PyObject *args, PyObject *kwd)
	callback for the dumpContent() method More...
static PyObject *	staticCallback_restoreContent (PyObject *self, PyObject *args)
	callback for the restoreContent() method More...
static PyObject *	staticCallback_getContent (PyObject *self, void *closure)
	getter callback for the Content attribute More...
static int	staticCallback_setContent (PyObject *self, PyObject *value, void *closure)
	setter callback for the Content attribute More...
static PyObject *	staticCallback_getMemSize (PyObject *self, void *closure)
	getter callback for the MemSize attribute More...
static int	staticCallback_setMemSize (PyObject *self, PyObject *value, void *closure)
	setter callback for the MemSize attribute More...
Static Public Member Functions inherited from Base::BaseClassPy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	staticCallback_isDerivedFrom (PyObject *self, PyObject *args)
	callback for the isDerivedFrom() method More...
static PyObject *	staticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
	callback for the getAllDerivedFrom() method More...
static PyObject *	staticCallback_getTypeId (PyObject *self, void *closure)
	getter callback for the TypeId attribute More...
static int	staticCallback_setTypeId (PyObject *self, PyObject *value, void *closure)
	setter callback for the TypeId attribute More...
static PyObject *	staticCallback_getModule (PyObject *self, void *closure)
	getter callback for the Module attribute More...
static int	staticCallback_setModule (PyObject *self, PyObject *value, void *closure)
	setter callback for the Module attribute More...
Static Public Member Functions inherited from Base::PyObjectBase
static void	PyDestructor (PyObject *P)
	Wrapper for the Python destructor. More...

Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of PathPy. More...
static PyMethodDef	Methods []
	Methods structure of PathPy. More...
static PyTypeObject	Type
	Type structure of PathPy. More...
Static Public Attributes inherited from Base::PersistencePy
static PyGetSetDef	GetterSetter []
	Attribute structure of PersistencePy. More...
static PyMethodDef	Methods []
	Methods structure of PersistencePy. More...
static PyTypeObject	Type
	Type structure of PersistencePy. More...
Static Public Attributes inherited from Base::BaseClassPy
static PyGetSetDef	GetterSetter []
	Attribute structure of BaseClassPy. More...
static PyMethodDef	Methods []
	Methods structure of BaseClassPy. More...
static PyTypeObject	Type
	Type structure of BaseClassPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

Protected Member Functions
	~PathPy ()
Protected Member Functions inherited from Base::PersistencePy
	~PersistencePy ()
Protected Member Functions inherited from Base::BaseClassPy
	~BaseClassPy ()
Protected Member Functions inherited from Base::PyObjectBase
virtual	~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
PyObject *	addCommands (PyObject *args)
	implementer for the addCommands() method More...
PyObject *	insertCommand (PyObject *args)
	implementer for the insertCommand() method More...
PyObject *	deleteCommand (PyObject *args)
	implementer for the deleteCommand() method More...
PyObject *	setFromGCode (PyObject *args)
	implementer for the setFromGCode() method More...
PyObject *	toGCode (PyObject *args)
	implementer for the toGCode() method More...
PyObject *	copy (PyObject *args)
	implementer for the copy() method More...
static PyObject *	staticCallback_addCommands (PyObject *self, PyObject *args)
	callback for the addCommands() method More...
static PyObject *	staticCallback_insertCommand (PyObject *self, PyObject *args)
	callback for the insertCommand() method More...
static PyObject *	staticCallback_deleteCommand (PyObject *self, PyObject *args)
	callback for the deleteCommand() method More...
static PyObject *	staticCallback_setFromGCode (PyObject *self, PyObject *args)
	callback for the setFromGCode() method More...
static PyObject *	staticCallback_toGCode (PyObject *self, PyObject *args)
	callback for the toGCode() method More...
static PyObject *	staticCallback_copy (PyObject *self, PyObject *args)
	callback for the copy() method More...

callbacks and implementers for the python object attributes
Py::Float	getLength (void) const
	getter for the Length attribute More...
Py::Long	getSize (void) const
	getter for the Size attribute More...
Py::List	getCommands (void) const
	getter for the Commands attribute More...
void	setCommands (Py::List arg)
	setter for the Commands attribute More...
Py::Object	getCenter (void) const
	getter for the Center attribute More...
void	setCenter (Py::Object arg)
	setter for the Center attribute More...
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones) More...
int	setCustomAttributes (const char *attr, PyObject *obj)
	setter for special attributes (e.g. More...
Toolpath *	getToolpathPtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getLength (PyObject *self, void *closure)
	getter callback for the Length attribute More...
static int	staticCallback_setLength (PyObject *self, PyObject *value, void *closure)
	setter callback for the Length attribute More...
static PyObject *	staticCallback_getSize (PyObject *self, void *closure)
	getter callback for the Size attribute More...
static int	staticCallback_setSize (PyObject *self, PyObject *value, void *closure)
	setter callback for the Size attribute More...
static PyObject *	staticCallback_getCommands (PyObject *self, void *closure)
	getter callback for the Commands attribute More...
static int	staticCallback_setCommands (PyObject *self, PyObject *value, void *closure)
	setter callback for the Commands attribute More...
static PyObject *	staticCallback_getCenter (PyObject *self, void *closure)
	getter callback for the Center attribute More...
static int	staticCallback_setCenter (PyObject *self, PyObject *value, void *closure)
	setter callback for the Center attribute More...

Additional Inherited Members
Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 >	StatusBits

Detailed Description

The python export class for Toolpath.

Member Typedef Documentation

PointerType

typedef Toolpath* Path::PathPy::PointerType

Constructor & Destructor Documentation

~PathPy()

PathPy::~PathPy ( )

protected

PathPy()

PathPy::PathPy	(	Toolpath *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by addCommands(), copy(), deleteCommand(), insertCommand(), and PyMake().

Member Function Documentation

addCommands()

PyObject * PathPy::addCommands

(

PyObject *

args

)

implementer for the addCommands() method

References Path::Toolpath::addCommand(), Base::BaseExceptionFreeCADError, getToolpathPtr(), PathPy(), and Path::CommandPy::Type.

Referenced by staticCallback_addCommands().

copy()

PyObject * PathPy::copy

(

PyObject *

args

)

implementer for the copy() method

References getToolpathPtr(), and PathPy().

Referenced by staticCallback_copy().

deleteCommand()

PyObject * PathPy::deleteCommand

(

PyObject *

args

)

implementer for the deleteCommand() method

References Base::BaseExceptionFreeCADError, Path::Toolpath::deleteCommand(), getToolpathPtr(), and PathPy().

Referenced by staticCallback_deleteCommand().

getCenter()

Py::Object PathPy::getCenter

(

void

)

const

getter for the Center attribute

References getToolpathPtr().

Referenced by staticCallback_getCenter().

getCommands()

Py::List PathPy::getCommands

(

void

)

const

getter for the Commands attribute

References Path::Toolpath::getSize(), and getToolpathPtr().

Referenced by staticCallback_getCommands().

getCustomAttributes()

PyObject * PathPy::getCustomAttributes

(

const char *

attr

)

const

getter method for special attributes (e.g. dynamic ones)

getLength()

Py::Float PathPy::getLength

(

void

)

const

getter for the Length attribute

References getToolpathPtr().

Referenced by staticCallback_getLength().

getSize()

Py::Long PathPy::getSize

(

void

)

const

getter for the Size attribute

References getToolpathPtr().

Referenced by staticCallback_getSize().

getToolpathPtr()

Toolpath * PathPy::getToolpathPtr

(

void

)

const

getter for the object handled by this class

Referenced by addCommands(), copy(), deleteCommand(), getCenter(), getCommands(), getLength(), getSize(), insertCommand(), PyInit(), representation(), setCenter(), setCommands(), setFromGCode(), Path::PropertyPath::setPyObject(), and toGCode().

GetType()

virtual PyTypeObject* Path::PathPy::GetType ( void  )

virtual

Reimplemented from Base::PersistencePy.

insertCommand()

PyObject * PathPy::insertCommand

(

PyObject *

args

)

implementer for the insertCommand() method

References Base::BaseExceptionFreeCADError, getToolpathPtr(), Path::Toolpath::insertCommand(), PathPy(), and Path::CommandPy::Type.

Referenced by staticCallback_insertCommand().

PyInit()

int PathPy::PyInit ( PyObject *  , PyObject *    )

virtual

PyInit method Override this method to initialize a newly created instance of the class (Constructor)

Reimplemented from Base::PersistencePy.

References Path::Toolpath::addCommand(), getToolpathPtr(), Path::Toolpath::setFromGCode(), and Path::CommandPy::Type.

PyMake()

PyObject * PathPy::PyMake ( struct _typeobject *  , PyObject *  , PyObject *    )

static

References PathPy().

representation()

std::string PathPy::representation

(

void

)

const

References Path::Toolpath::getLength(), Path::Toolpath::getSize(), and getToolpathPtr().

Referenced by config_control_design.pcurve::wr1(), config_control_design.degenerate_pcurve::wr1(), automotive_design.motion_link_relationship::wr1(), automotive_design.pcurve::wr1(), automotive_design.degenerate_pcurve::wr1(), config_control_design.pcurve::wr2(), config_control_design.degenerate_pcurve::wr2(), automotive_design.pcurve::wr2(), and automotive_design.degenerate_pcurve::wr2().

setCenter()

void PathPy::setCenter

(

Py::Object

arg

)

setter for the Center attribute

References getToolpathPtr(), and Path::Toolpath::setCenter().

Referenced by staticCallback_setCenter().

setCommands()

void PathPy::setCommands

(

Py::List

arg

)

setter for the Commands attribute

References Path::Toolpath::addCommand(), Path::Toolpath::clear(), getToolpathPtr(), and Path::CommandPy::Type.

Referenced by staticCallback_setCommands().

setCustomAttributes()

int PathPy::setCustomAttributes	(	const char *	attr,
		PyObject *	obj
	)

setter for special attributes (e.g.

dynamic ones) Output: Success=1, Failure=-1, Ignore=0

setFromGCode()

PyObject * PathPy::setFromGCode

(

PyObject *

args

)

implementer for the setFromGCode() method

References getToolpathPtr(), and Path::Toolpath::setFromGCode().

Referenced by staticCallback_setFromGCode().

staticCallback_addCommands()

PyObject * PathPy::staticCallback_addCommands ( PyObject *  self, PyObject *  args  )

static

callback for the addCommands() method

References addCommands(), Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_copy()

PyObject * PathPy::staticCallback_copy ( PyObject *  self, PyObject *  args  )

static

callback for the copy() method

References Base::BaseExceptionFreeCADError, Base::Console(), copy(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_deleteCommand()

PyObject * PathPy::staticCallback_deleteCommand ( PyObject *  self, PyObject *  args  )

static

callback for the deleteCommand() method

References Base::BaseExceptionFreeCADError, Base::Console(), deleteCommand(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_getCenter()

PyObject * PathPy::staticCallback_getCenter ( PyObject *  self, void *  closure  )

static

getter callback for the Center attribute

References Base::BaseExceptionFreeCADError, getCenter(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_getCommands()

PyObject * PathPy::staticCallback_getCommands ( PyObject *  self, void *  closure  )

static

getter callback for the Commands attribute

References Base::BaseExceptionFreeCADError, getCommands(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_getLength()

PyObject * PathPy::staticCallback_getLength ( PyObject *  self, void *  closure  )

static

getter callback for the Length attribute

References Base::BaseExceptionFreeCADError, getLength(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_getSize()

PyObject * PathPy::staticCallback_getSize ( PyObject *  self, void *  closure  )

static

getter callback for the Size attribute

References Base::BaseExceptionFreeCADError, getSize(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_insertCommand()

PyObject * PathPy::staticCallback_insertCommand ( PyObject *  self, PyObject *  args  )

static

callback for the insertCommand() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), insertCommand(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_setCenter()

int PathPy::staticCallback_setCenter ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Center attribute

References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and setCenter().

staticCallback_setCommands()

int PathPy::staticCallback_setCommands ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Commands attribute

References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and setCommands().

staticCallback_setFromGCode()

PyObject * PathPy::staticCallback_setFromGCode ( PyObject *  self, PyObject *  args  )

static

callback for the setFromGCode() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), setFromGCode(), and Base::PyObjectBase::startNotify().

staticCallback_setLength()

int PathPy::staticCallback_setLength ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Length attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_setSize()

int PathPy::staticCallback_setSize ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Size attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

staticCallback_toGCode()

PyObject * PathPy::staticCallback_toGCode ( PyObject *  self, PyObject *  args  )

static

callback for the toGCode() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and toGCode().

toGCode()

PyObject * PathPy::toGCode

(

PyObject *

args

)

implementer for the toGCode() method

References getToolpathPtr(), and Path::Toolpath::toGCode().

Referenced by staticCallback_toGCode().

Member Data Documentation

GetterSetter

PyGetSetDef PathPy::GetterSetter

static

Initial value:

= {
    {"Length",
        (getter) staticCallback_getLength,
        (setter) staticCallback_setLength, 
        "the total length of this path in mm",
        NULL
    },
    {"Size",
        (getter) staticCallback_getSize,
        (setter) staticCallback_setSize, 
        "the number of commands in this path",
        NULL
    },
    {"Commands",
        (getter) staticCallback_getCommands,
        (setter) staticCallback_setCommands, 
        "the list of commands of this path",
        NULL
    },
    {"Center",
        (getter) staticCallback_getCenter,
        (setter) staticCallback_setCenter, 
        "the center position for all rotational parameters",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of PathPy.

Methods

PyMethodDef PathPy::Methods

static

Methods structure of PathPy.

Type

PyTypeObject PathPy::Type

static

Type structure of PathPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), and Path::PropertyPath::setPyObject().

---

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

• build/webdoc/src/Mod/Path/App/PathPy.h
• src/Mod/Path/App/PathPyImp.cpp
• build/webdoc/src/Mod/Path/App/PathPy.cpp