PathSimulator::PathSimPy Class Reference

The python export class for PathSim. More...

#include <PathSimPy.h>

Public Types
typedef PathSim *	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)
	PathSimPy (PathSim *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::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::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 PathSimPy. More...
static PyMethodDef	Methods []
	Methods structure of PathSimPy. More...
static PyTypeObject	Type
	Type structure of PathSimPy. 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
	~PathSimPy ()
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 *	BeginSimulation (PyObject *args, PyObject *kwd)
	implementer for the BeginSimulation() method More...
PyObject *	SetCurrentTool (PyObject *args)
	implementer for the SetCurrentTool() method More...
PyObject *	GetResultMesh (PyObject *args)
	implementer for the GetResultMesh() method More...
PyObject *	ApplyCommand (PyObject *args, PyObject *kwd)
	implementer for the ApplyCommand() method More...
static PyObject *	staticCallback_BeginSimulation (PyObject *self, PyObject *args, PyObject *kwd)
	callback for the BeginSimulation() method More...
static PyObject *	staticCallback_SetCurrentTool (PyObject *self, PyObject *args)
	callback for the SetCurrentTool() method More...
static PyObject *	staticCallback_GetResultMesh (PyObject *self, PyObject *args)
	callback for the GetResultMesh() method More...
static PyObject *	staticCallback_ApplyCommand (PyObject *self, PyObject *args, PyObject *kwd)
	callback for the ApplyCommand() method More...

callbacks and implementers for the python object attributes
Py::Object	getTool (void) const
	getter for the Tool 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...
PathSim *	getPathSimPtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getTool (PyObject *self, void *closure)
	getter callback for the Tool attribute More...
static int	staticCallback_setTool (PyObject *self, PyObject *value, void *closure)
	setter callback for the Tool attribute More...

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

Detailed Description

The python export class for PathSim.

Member Typedef Documentation

PointerType

typedef PathSim* PathSimulator::PathSimPy::PointerType

Constructor & Destructor Documentation

~PathSimPy()

PathSimPy::~PathSimPy ( )

protected

PathSimPy()

PathSimPy::PathSimPy	(	PathSim *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by PyMake().

Member Function Documentation

ApplyCommand()

PyObject * PathSimPy::ApplyCommand	(	PyObject *	args,
		PyObject *	kwd
	)

implementer for the ApplyCommand() method

References PathSimulator::PathSim::ApplyCommand(), getPathSimPtr(), Base::PlacementPy::Type, and Path::CommandPy::Type.

Referenced by staticCallback_ApplyCommand().

BeginSimulation()

PyObject * PathSimPy::BeginSimulation	(	PyObject *	args,
		PyObject *	kwd
	)

implementer for the BeginSimulation() method

References PathSimulator::PathSim::BeginSimulation(), getPathSimPtr(), and Part::TopoShapePy::Type.

Referenced by staticCallback_BeginSimulation().

getCustomAttributes()

PyObject * PathSimPy::getCustomAttributes

(

const char *

attr

)

const

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

getPathSimPtr()

PathSim * PathSimPy::getPathSimPtr

(

void

)

const

getter for the object handled by this class

Referenced by ApplyCommand(), BeginSimulation(), and GetResultMesh().

GetResultMesh()

PyObject * PathSimPy::GetResultMesh

(

PyObject *

args

)

implementer for the GetResultMesh() method

References getPathSimPtr(), PathSimulator::PathSim::m_stock, and cStock::Tessellate().

Referenced by staticCallback_GetResultMesh().

getTool()

Py::Object PathSimPy::getTool

(

void

)

const

getter for the Tool attribute

Referenced by staticCallback_getTool().

GetType()

virtual PyTypeObject* PathSimulator::PathSimPy::GetType ( void  )

virtual

Reimplemented from Base::BaseClassPy.

PyInit()

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

virtual

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

Reimplemented from Base::BaseClassPy.

PyMake()

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

static

References PathSimPy().

representation()

std::string PathSimPy::representation

(

void

)

const

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().

SetCurrentTool()

PyObject* PathSimulator::PathSimPy::SetCurrentTool

(

PyObject *

args

)

implementer for the SetCurrentTool() method

Referenced by staticCallback_SetCurrentTool().

setCustomAttributes()

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

setter for special attributes (e.g.

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

staticCallback_ApplyCommand()

PyObject * PathSimPy::staticCallback_ApplyCommand ( PyObject *  self, PyObject *  args, PyObject *  kwd  )

static

callback for the ApplyCommand() method

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

staticCallback_BeginSimulation()

PyObject * PathSimPy::staticCallback_BeginSimulation ( PyObject *  self, PyObject *  args, PyObject *  kwd  )

static

callback for the BeginSimulation() method

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

staticCallback_GetResultMesh()

PyObject * PathSimPy::staticCallback_GetResultMesh ( PyObject *  self, PyObject *  args  )

static

callback for the GetResultMesh() method

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

staticCallback_getTool()

PyObject * PathSimPy::staticCallback_getTool ( PyObject *  self, void *  closure  )

static

getter callback for the Tool attribute

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

staticCallback_SetCurrentTool()

PyObject * PathSimPy::staticCallback_SetCurrentTool ( PyObject *  self, PyObject *  args  )

static

callback for the SetCurrentTool() method

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

staticCallback_setTool()

int PathSimPy::staticCallback_setTool ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Tool attribute

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

Member Data Documentation

GetterSetter

PyGetSetDef PathSimPy::GetterSetter

static

Initial value:

= {
    {"Tool",
        (getter) staticCallback_getTool,
        (setter) staticCallback_setTool, 
        "Return current simulation tool.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of PathSimPy.

Methods

PyMethodDef PathSimPy::Methods

static

Initial value:

= {
    {"BeginSimulation",
        reinterpret_cast<PyCFunction>(reinterpret_cast<void (*) (void)>( staticCallback_BeginSimulation )),
        METH_VARARGS|METH_KEYWORDS,
        "BeginSimulation(stock, resolution):\n\nStart a simulation process on a box shape stock with given resolution\n"
    },
    {"SetCurrentTool",
        reinterpret_cast<PyCFunction>( staticCallback_SetCurrentTool ),
        METH_VARARGS,
        "\n          SetCurrentTool(tool):\n\n          Set the current Path Tool for the subsequent simulator operations.\n\n        "
    },
    {"GetResultMesh",
        reinterpret_cast<PyCFunction>( staticCallback_GetResultMesh ),
        METH_VARARGS,
        "\n          GetResultMesh():\n\n          Return the current mesh result of the simulation.\n\n        "
    },
    {"ApplyCommand",
        reinterpret_cast<PyCFunction>(reinterpret_cast<void (*) (void)>( staticCallback_ApplyCommand )),
        METH_VARARGS|METH_KEYWORDS,
        "\n          ApplyCommand(placement, command):\n\n          Apply a single path command on the stock starting from placement.\n\n        "
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of PathSimPy.

Type

PyTypeObject PathSimPy::Type

static

Type structure of PathSimPy.

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

---

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

• build/webdoc/src/Mod/Path/PathSimulator/App/PathSimPy.h
• src/Mod/Path/PathSimulator/App/PathSimPyImp.cpp
• build/webdoc/src/Mod/Path/PathSimulator/App/PathSimPy.cpp