Robot::RobotObjectPy Class Reference

The python export class for RobotObject. More...

#include <RobotObjectPy.h>

Inheritance diagram for Robot::RobotObjectPy:

Public Types
typedef RobotObject *	PointerType
Public Member Functions
PyObject *	_getattr (char *attr)
	GetAttribute implementation This method implements the retriavel of object attributes.
virtual PyObject *	_repr (void)
	_repr method Overide this method to return a string object with some invormation about the object.
int	_setattr (char attr, PyObject value)
	SetAttribute implementation This method implements the seting of object attributes.
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones)
virtual PyParentObject *	GetParents (void)
RobotObject *	getRobotObjectPtr (void) const
	getter for the object handled by this class
virtual PyTypeObject *	GetType (void)
virtual int	PyInit (PyObject args, PyObject k)
	PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).
std::string	representation (void) const
	RobotObjectPy (RobotObject pcObject, PyTypeObject T=&Type)
int	setCustomAttributes (const char attr, PyObject obj)
	setter for special attributes (e.g. dynamic ones)
	~RobotObjectPy ()
Static Public Member Functions
static PyObject *	PyMake (struct _typeobject , PyObject , PyObject *)
Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of RobotObjectPy.
static PyMethodDef	Methods []
	Methods structure of RobotObjectPy.
static PyParentObject	Parents [] = { PARENTSRobotRobotObjectPy }
static PyTypeObject	Type
	Type structure of RobotObjectPy.
callbacks and implementers for the python object methods

PyObject *	getRobot (PyObject *args)
	implementer for the getRobot() method
static PyObject *	staticCallback_getRobot (PyObject self, PyObject args)
	callback for the getRobot() method

Detailed Description

The python export class for RobotObject.

Definition at line 20 of file RobotObjectPy.h.

Member Typedef Documentation

typedef RobotObject* Robot::RobotObjectPy::PointerType

Reimplemented from App::DocumentObjectPy.

Definition at line 36 of file RobotObjectPy.h.

Constructor & Destructor Documentation

RobotObjectPy::RobotObjectPy	(	RobotObject *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Definition at line 176 of file RobotObjectPy.cpp.

RobotObjectPy::~RobotObjectPy ( )

Definition at line 197 of file RobotObjectPy.cpp.

Member Function Documentation

PyObject * RobotObjectPy::_getattr ( char * attr ) [virtual]

GetAttribute implementation This method implements the retriavel of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class. Note: if you reimplement _gettattr() in a inheriting class you need to call the method of the base class! Otherwise even the methods of the object will disapiear!

Reimplemented from App::DocumentObjectPy.

Definition at line 212 of file RobotObjectPy.cpp.

References Base::Console(), getCustomAttributes(), Methods, Base::Exception::ReportException(), and Base::Exception::what().

PyObject * RobotObjectPy::_repr ( void ) [virtual]

_repr method Overide this method to return a string object with some invormation about the object.

 PyObject *MeshFeaturePy::_repr(void)
 {
   std::stringstream a;
   a << "MeshFeature: [ ";
   a << "some realy important info about the object!";
   a << "]" << std::endl;
   return Py_BuildValue("s", a.str().c_str());
 }

Reimplemented from App::DocumentObjectPy.

Definition at line 204 of file RobotObjectPy.cpp.

References representation().

int RobotObjectPy::_setattr	(	char *	attr,
		PyObject *	value
	)			`[virtual]`

SetAttribute implementation This method implements the seting of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class.

Reimplemented from App::DocumentObjectPy.

Definition at line 280 of file RobotObjectPy.cpp.

References Base::Console(), Base::Exception::ReportException(), setCustomAttributes(), and Base::Exception::what().

PyObject * RobotObjectPy::getCustomAttributes ( const char * attr ) const

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

Reimplemented from App::DocumentObjectPy.

Definition at line 28 of file RobotObjectPyImp.cpp.

Referenced by _getattr().

virtual PyParentObject* Robot::RobotObjectPy::GetParents ( void ) [inline, virtual]

Reimplemented from App::DocumentObjectPy.

Definition at line 28 of file RobotObjectPy.h.

PyObject * RobotObjectPy::getRobot ( PyObject * args )

implementer for the getRobot() method

Definition at line 20 of file RobotObjectPyImp.cpp.

RobotObject * RobotObjectPy::getRobotObjectPtr ( void ) const

getter for the object handled by this class

Definition at line 339 of file RobotObjectPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

virtual PyTypeObject* Robot::RobotObjectPy::GetType ( void ) [inline, virtual]

Reimplemented from App::DocumentObjectPy.

Definition at line 27 of file RobotObjectPy.h.

int RobotObjectPy::PyInit	(	PyObject *	,
		PyObject *
	)			`[virtual]`

PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).

Reimplemented from App::DocumentObjectPy.

Definition at line 189 of file RobotObjectPy.cpp.

PyObject * RobotObjectPy::PyMake	(	struct _typeobject *	,
		PyObject *	,
		PyObject *
	)			`[static]`

Reimplemented from App::DocumentObjectPy.

Definition at line 181 of file RobotObjectPy.cpp.

std::string RobotObjectPy::representation ( void ) const

Reimplemented from App::DocumentObjectPy.

Definition at line 13 of file RobotObjectPyImp.cpp.

Referenced by _repr().

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

setter for special attributes (e.g. dynamic ones)

Reimplemented from App::DocumentObjectPy.

Definition at line 33 of file RobotObjectPyImp.cpp.

Referenced by _setattr().

PyObject * RobotObjectPy::staticCallback_getRobot	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the getRobot() method

Definition at line 93 of file RobotObjectPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

Member Data Documentation

PyGetSetDef RobotObjectPy::GetterSetter [static]

Initial value:

 {
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of RobotObjectPy.

Reimplemented from App::DocumentObjectPy.

Definition at line 25 of file RobotObjectPy.h.

PyMethodDef RobotObjectPy::Methods [static]

Initial value:

 {
    {"getRobot",
        (PyCFunction) staticCallback_getRobot,
        METH_VARARGS,
        "\n                                     Returns a copy of the robot. Be aware, the robot behaves the same\n                                     like the robot of the object but is a copy!\n                   "
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of RobotObjectPy.

Reimplemented from App::DocumentObjectPy.

Definition at line 24 of file RobotObjectPy.h.

Referenced by _getattr().

PyParentObject RobotObjectPy::Parents = { PARENTSRobotRobotObjectPy } [static]

Reimplemented from App::DocumentObjectPy.

Definition at line 26 of file RobotObjectPy.h.

PyTypeObject RobotObjectPy::Type [static]

Type structure of RobotObjectPy.

Reimplemented from App::DocumentObjectPy.

Definition at line 23 of file RobotObjectPy.h.

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