Robot::WaypointPy Class Reference

The python export class for Waypoint. More...

#include <WaypointPy.h>

Inheritance diagram for Robot::WaypointPy:
Base::PersistencePy Base::BaseClassPy Base::PyObjectBase

List of all members.

Public Types

typedef WaypointPointerType

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.
PyObjectgetCustomAttributes (const char *attr) const
 getter method for special attributes (e.g. dynamic ones)
virtual PyParentObjectGetParents (void)
virtual PyTypeObject * GetType (void)
WaypointgetWaypointPtr (void) const
 getter for the object handled by this class
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
int setCustomAttributes (const char *attr, PyObject *obj)
 setter for special attributes (e.g. dynamic ones)
 WaypointPy (Waypoint *pcObject, PyTypeObject *T=&Type)
 ~WaypointPy ()

Static Public Member Functions

static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)

Static Public Attributes

static PyGetSetDef GetterSetter []
 Attribute structure of WaypointPy.
static PyMethodDef Methods []
 Methods structure of WaypointPy.
static PyParentObject Parents [] = { PARENTSRobotWaypointPy }
static PyTypeObject Type
 Type structure of WaypointPy.

callbacks and implementers for the python object attributes



Py::Int getBase (void) const
 getter for the Base attribute
Py::Boolean getCont (void) const
 getter for the Cont attribute
Py::String getName (void) const
 getter for the Name attribute
Py::Object getPos (void) const
 getter for the Pos attribute
Py::Int getTool (void) const
 getter for the Tool attribute
Py::String getType (void) const
 getter for the Type attribute
Py::Float getVelocity (void) const
 getter for the Velocity attribute
void setBase (Py::Int arg)
 setter for the Base attribute
void setCont (Py::Boolean arg)
 setter for the Cont attribute
void setName (Py::String arg)
 setter for the Name attribute
void setPos (Py::Object arg)
 setter for the Pos attribute
void setTool (Py::Int arg)
 setter for the Tool attribute
void setType (Py::String arg)
 setter for the Type attribute
void setVelocity (Py::Float arg)
 setter for the Velocity attribute
static PyObjectstaticCallback_getBase (PyObject *self, void *closure)
 getter callback for the Base attribute
static PyObjectstaticCallback_getCont (PyObject *self, void *closure)
 getter callback for the Cont attribute
static PyObjectstaticCallback_getName (PyObject *self, void *closure)
 getter callback for the Name attribute
static PyObjectstaticCallback_getPos (PyObject *self, void *closure)
 getter callback for the Pos attribute
static PyObjectstaticCallback_getTool (PyObject *self, void *closure)
 getter callback for the Tool attribute
static PyObjectstaticCallback_getType (PyObject *self, void *closure)
 getter callback for the Type attribute
static PyObjectstaticCallback_getVelocity (PyObject *self, void *closure)
 getter callback for the Velocity attribute
static int staticCallback_setBase (PyObject *self, PyObject *value, void *closure)
 setter callback for the Base attribute
static int staticCallback_setCont (PyObject *self, PyObject *value, void *closure)
 setter callback for the Cont attribute
static int staticCallback_setName (PyObject *self, PyObject *value, void *closure)
 setter callback for the Name attribute
static int staticCallback_setPos (PyObject *self, PyObject *value, void *closure)
 setter callback for the Pos attribute
static int staticCallback_setTool (PyObject *self, PyObject *value, void *closure)
 setter callback for the Tool attribute
static int staticCallback_setType (PyObject *self, PyObject *value, void *closure)
 setter callback for the Type attribute
static int staticCallback_setVelocity (PyObject *self, PyObject *value, void *closure)
 setter callback for the Velocity attribute

Detailed Description

The python export class for Waypoint.

Definition at line 20 of file WaypointPy.h.


Member Typedef Documentation

Reimplemented from Base::PersistencePy.

Definition at line 36 of file WaypointPy.h.


Constructor & Destructor Documentation

WaypointPy::WaypointPy ( Waypoint pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 445 of file WaypointPy.cpp.

Referenced by PyMake().

WaypointPy::~WaypointPy (  ) 

Definition at line 454 of file WaypointPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.


Member Function Documentation

PyObject * WaypointPy::_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 Base::PersistencePy.

Definition at line 472 of file WaypointPy.cpp.

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

PyObject * WaypointPy::_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 Base::PersistencePy.

Definition at line 464 of file WaypointPy.cpp.

References representation().

int WaypointPy::_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 Base::PersistencePy.

Definition at line 540 of file WaypointPy.cpp.

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

Py::Int WaypointPy::getBase ( void   )  const

getter for the Base attribute

Definition at line 212 of file WaypointPyImp.cpp.

References getWaypointPtr().

Referenced by staticCallback_getBase().

Py::Boolean WaypointPy::getCont ( void   )  const

getter for the Cont attribute

Definition at line 189 of file WaypointPyImp.cpp.

References getWaypointPtr().

Referenced by staticCallback_getCont().

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

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

Reimplemented from Base::PersistencePy.

Definition at line 225 of file WaypointPyImp.cpp.

Referenced by _getattr().

Py::String WaypointPy::getName ( void   )  const

getter for the Name attribute

Definition at line 134 of file WaypointPyImp.cpp.

References getWaypointPtr().

Referenced by staticCallback_getName().

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

Reimplemented from Base::PersistencePy.

Definition at line 28 of file WaypointPy.h.

Py::Object WaypointPy::getPos ( void   )  const

getter for the Pos attribute

Definition at line 176 of file WaypointPyImp.cpp.

References getWaypointPtr().

Referenced by staticCallback_getPos().

Py::Int WaypointPy::getTool ( void   )  const

getter for the Tool attribute

Definition at line 199 of file WaypointPyImp.cpp.

References getWaypointPtr().

Referenced by staticCallback_getTool().

Py::String WaypointPy::getType ( void   )  const

getter for the Type attribute

Reimplemented from Base::BaseClassPy.

Definition at line 144 of file WaypointPyImp.cpp.

References Robot::Waypoint::CIRC, getWaypointPtr(), Robot::Waypoint::LINE, Robot::Waypoint::PTP, Robot::Waypoint::UNDEF, and Robot::Waypoint::WAIT.

Referenced by staticCallback_getType().

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

Reimplemented from Base::PersistencePy.

Definition at line 27 of file WaypointPy.h.

Py::Float WaypointPy::getVelocity ( void   )  const

getter for the Velocity attribute

Definition at line 123 of file WaypointPyImp.cpp.

References getWaypointPtr(), and Base::Velocity.

Referenced by staticCallback_getVelocity().

Waypoint * WaypointPy::getWaypointPtr ( void   )  const

getter for the object handled by this class

Definition at line 599 of file WaypointPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getBase(), getCont(), getName(), getPos(), getTool(), getType(), getVelocity(), PyInit(), representation(), setBase(), setCont(), setName(), setPos(), setTool(), setType(), and setVelocity().

int WaypointPy::PyInit ( PyObject ,
PyObject  
) [virtual]
PyObject * WaypointPy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
) [static]

Reimplemented from Base::PersistencePy.

Definition at line 55 of file WaypointPyImp.cpp.

References WaypointPy().

std::string WaypointPy::representation ( void   )  const
void WaypointPy::setBase ( Py::Int  arg  ) 

setter for the Base attribute

Definition at line 217 of file WaypointPyImp.cpp.

References Robot::Waypoint::Base, getWaypointPtr(), and Py::int.

void WaypointPy::setCont ( Py::Boolean  arg  ) 

setter for the Cont attribute

Definition at line 194 of file WaypointPyImp.cpp.

References Robot::Waypoint::Cont, and getWaypointPtr().

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

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

Reimplemented from Base::PersistencePy.

Definition at line 230 of file WaypointPyImp.cpp.

Referenced by _setattr().

void WaypointPy::setName ( Py::String  arg  ) 

setter for the Name attribute

Definition at line 139 of file WaypointPyImp.cpp.

References Py::String::as_std_string(), getWaypointPtr(), and Robot::Waypoint::Name.

void WaypointPy::setPos ( Py::Object  arg  ) 

setter for the Pos attribute

Definition at line 181 of file WaypointPyImp.cpp.

References Robot::Waypoint::EndPos, getWaypointPtr(), Py::Object::isType(), PyType_Object::o, and Base::PlacementPy::Type.

void WaypointPy::setTool ( Py::Int  arg  ) 

setter for the Tool attribute

Definition at line 204 of file WaypointPyImp.cpp.

References getWaypointPtr(), Py::int, and Robot::Waypoint::Tool.

void WaypointPy::setType ( Py::String  arg  ) 
void WaypointPy::setVelocity ( Py::Float  arg  ) 

setter for the Velocity attribute

Definition at line 128 of file WaypointPyImp.cpp.

References getWaypointPtr(), and Robot::Waypoint::Velocity.

PyObject * WaypointPy::staticCallback_getBase ( PyObject self,
void *  closure 
) [static]

getter callback for the Base attribute

Definition at line 394 of file WaypointPy.cpp.

References getBase(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * WaypointPy::staticCallback_getCont ( PyObject self,
void *  closure 
) [static]

getter callback for the Cont attribute

Definition at line 262 of file WaypointPy.cpp.

References getCont(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * WaypointPy::staticCallback_getName ( PyObject self,
void *  closure 
) [static]

getter callback for the Name attribute

Definition at line 130 of file WaypointPy.cpp.

References getName(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * WaypointPy::staticCallback_getPos ( PyObject self,
void *  closure 
) [static]

getter callback for the Pos attribute

Definition at line 218 of file WaypointPy.cpp.

References getPos(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * WaypointPy::staticCallback_getTool ( PyObject self,
void *  closure 
) [static]

getter callback for the Tool attribute

Definition at line 350 of file WaypointPy.cpp.

References getTool(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * WaypointPy::staticCallback_getType ( PyObject self,
void *  closure 
) [static]

getter callback for the Type attribute

Reimplemented from Base::BaseClassPy.

Definition at line 174 of file WaypointPy.cpp.

References getType(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * WaypointPy::staticCallback_getVelocity ( PyObject self,
void *  closure 
) [static]

getter callback for the Velocity attribute

Definition at line 306 of file WaypointPy.cpp.

References getVelocity(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

int WaypointPy::staticCallback_setBase ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Base attribute

Definition at line 412 of file WaypointPy.cpp.

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

int WaypointPy::staticCallback_setCont ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Cont attribute

Definition at line 280 of file WaypointPy.cpp.

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

int WaypointPy::staticCallback_setName ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Name attribute

Definition at line 148 of file WaypointPy.cpp.

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

int WaypointPy::staticCallback_setPos ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Pos attribute

Definition at line 236 of file WaypointPy.cpp.

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

int WaypointPy::staticCallback_setTool ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Tool attribute

Definition at line 368 of file WaypointPy.cpp.

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

int WaypointPy::staticCallback_setType ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Type attribute

Reimplemented from Base::BaseClassPy.

Definition at line 192 of file WaypointPy.cpp.

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

int WaypointPy::staticCallback_setVelocity ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Velocity attribute

Definition at line 324 of file WaypointPy.cpp.

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


Member Data Documentation

PyGetSetDef WaypointPy::GetterSetter [static]

Attribute structure of WaypointPy.

Reimplemented from Base::PersistencePy.

Definition at line 25 of file WaypointPy.h.

PyMethodDef WaypointPy::Methods [static]
Initial value:
 {
    {NULL, NULL, 0, NULL}               
}

Methods structure of WaypointPy.

Reimplemented from Base::PersistencePy.

Definition at line 24 of file WaypointPy.h.

Referenced by _getattr().

PyParentObject WaypointPy::Parents = { PARENTSRobotWaypointPy } [static]

Reimplemented from Base::PersistencePy.

Definition at line 26 of file WaypointPy.h.

PyTypeObject WaypointPy::Type [static]

Type structure of WaypointPy.

Reimplemented from Base::PersistencePy.

Definition at line 23 of file WaypointPy.h.

Referenced by initRobot(), Robot::TrajectoryPy::insertWaypoints(), and Robot::TrajectoryPy::PyInit().


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

Generated on Wed Nov 23 19:02:46 2011 for FreeCAD by  doxygen 1.6.1