Part::TopoShapeVertexPy Class Reference

The python export class for TopoShape. More...

#include <TopoShapeVertexPy.h>

Inheritance diagram for Part::TopoShapeVertexPy:

Public Types
typedef TopoShape *	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)
TopoShape *	getTopoShapePtr (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
int	setCustomAttributes (const char attr, PyObject obj)
	setter for special attributes (e.g. dynamic ones)
	TopoShapeVertexPy (TopoShape pcObject, PyTypeObject T=&Type)
	~TopoShapeVertexPy ()
Static Public Member Functions
static PyObject *	PyMake (struct _typeobject , PyObject , PyObject *)
Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of TopoShapeVertexPy.
static PyMethodDef	Methods []
	Methods structure of TopoShapeVertexPy.
static PyParentObject	Parents [] = { PARENTSPartTopoShapeVertexPy }
static PyTypeObject	Type
	Type structure of TopoShapeVertexPy.
callbacks and implementers for the python object attributes

Py::Object	getPoint (void) const
	getter for the Point attribute
Py::Float	getX (void) const
	getter for the X attribute
Py::Float	getY (void) const
	getter for the Y attribute
Py::Float	getZ (void) const
	getter for the Z attribute
static PyObject *	staticCallback_getPoint (PyObject self, void closure)
	getter callback for the Point attribute
static PyObject *	staticCallback_getX (PyObject self, void closure)
	getter callback for the X attribute
static PyObject *	staticCallback_getY (PyObject self, void closure)
	getter callback for the Y attribute
static PyObject *	staticCallback_getZ (PyObject self, void closure)
	getter callback for the Z attribute
static int	staticCallback_setPoint (PyObject self, PyObject value, void *closure)
	setter callback for the Point attribute
static int	staticCallback_setX (PyObject self, PyObject value, void *closure)
	setter callback for the X attribute
static int	staticCallback_setY (PyObject self, PyObject value, void *closure)
	setter callback for the Y attribute
static int	staticCallback_setZ (PyObject self, PyObject value, void *closure)
	setter callback for the Z attribute
callbacks and implementers for the python object methods

PyObject *	setTolerance (PyObject *args)
	implementer for the setTolerance() method
static PyObject *	staticCallback_setTolerance (PyObject self, PyObject args)
	callback for the setTolerance() method

Detailed Description

The python export class for TopoShape.

Definition at line 20 of file TopoShapeVertexPy.h.

Member Typedef Documentation

typedef TopoShape* Part::TopoShapeVertexPy::PointerType

Reimplemented from Part::TopoShapePy.

Definition at line 36 of file TopoShapeVertexPy.h.

Constructor & Destructor Documentation

TopoShapeVertexPy::TopoShapeVertexPy	(	TopoShape *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Definition at line 328 of file TopoShapeVertexPy.cpp.

Referenced by PyMake().

TopoShapeVertexPy::~TopoShapeVertexPy ( )

Definition at line 337 of file TopoShapeVertexPy.cpp.

Member Function Documentation

PyObject * TopoShapeVertexPy::_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 Part::TopoShapePy.

Definition at line 352 of file TopoShapeVertexPy.cpp.

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

PyObject * TopoShapeVertexPy::_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 Part::TopoShapePy.

Definition at line 344 of file TopoShapeVertexPy.cpp.

References representation().

int TopoShapeVertexPy::_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 Part::TopoShapePy.

Definition at line 420 of file TopoShapeVertexPy.cpp.

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

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

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

Reimplemented from Part::TopoShapePy.

Definition at line 158 of file TopoShapeVertexPyImp.cpp.

Referenced by _getattr().

virtual PyParentObject* Part::TopoShapeVertexPy::GetParents ( void ) [inline, virtual]

Reimplemented from Part::TopoShapePy.

Definition at line 28 of file TopoShapeVertexPy.h.

Py::Object TopoShapeVertexPy::getPoint ( void ) const

getter for the Point attribute

Definition at line 151 of file TopoShapeVertexPyImp.cpp.

References getTopoShapePtr(), and draftTools::p.

Referenced by staticCallback_getPoint().

TopoShape * TopoShapeVertexPy::getTopoShapePtr ( void ) const

getter for the object handled by this class

Reimplemented from Part::TopoShapePy.

Definition at line 479 of file TopoShapeVertexPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getPoint(), getX(), getY(), getZ(), PyInit(), representation(), and setTolerance().

virtual PyTypeObject* Part::TopoShapeVertexPy::GetType ( void ) [inline, virtual]

Reimplemented from Part::TopoShapePy.

Definition at line 27 of file TopoShapeVertexPy.h.

Py::Float TopoShapeVertexPy::getX ( void ) const

getter for the X attribute

Definition at line 133 of file TopoShapeVertexPyImp.cpp.

References getTopoShapePtr().

Referenced by staticCallback_getX().

Py::Float TopoShapeVertexPy::getY ( void ) const

getter for the Y attribute

Definition at line 139 of file TopoShapeVertexPyImp.cpp.

References getTopoShapePtr().

Referenced by staticCallback_getY().

Py::Float TopoShapeVertexPy::getZ ( void ) const

getter for the Z attribute

Definition at line 145 of file TopoShapeVertexPyImp.cpp.

References getTopoShapePtr().

Referenced by staticCallback_getZ().

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

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

Reimplemented from Part::TopoShapePy.

Definition at line 62 of file TopoShapeVertexPyImp.cpp.

References Base::PyObjectBase::_pcTwinPointer, Part::TopoShape::_Shape, Py::SeqBase< T >::getItem(), getTopoShapePtr(), Part::TopoShapePy::Type, Base::VectorPy::Type, Base::Vector3< _Precision >::x, MovieTool::x, Base::Vector3< _Precision >::y, MovieTool::y, and Base::Vector3< _Precision >::z.

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

Reimplemented from Part::TopoShapePy.

Definition at line 55 of file TopoShapeVertexPyImp.cpp.

References TopoShapeVertexPy().

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

Reimplemented from Part::TopoShapePy.

Definition at line 47 of file TopoShapeVertexPyImp.cpp.

References getTopoShapePtr().

Referenced by _repr().

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

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

Reimplemented from Part::TopoShapePy.

Definition at line 163 of file TopoShapeVertexPyImp.cpp.

Referenced by _setattr().

PyObject * TopoShapeVertexPy::setTolerance ( PyObject * args )

implementer for the setTolerance() method

Definition at line 122 of file TopoShapeVertexPyImp.cpp.

References getTopoShapePtr(), and Py_Return.

PyObject * TopoShapeVertexPy::staticCallback_getPoint	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Point attribute

Definition at line 289 of file TopoShapeVertexPy.cpp.

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

PyObject * TopoShapeVertexPy::staticCallback_getX	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the X attribute

Definition at line 193 of file TopoShapeVertexPy.cpp.

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

PyObject * TopoShapeVertexPy::staticCallback_getY	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Y attribute

Definition at line 225 of file TopoShapeVertexPy.cpp.

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

PyObject * TopoShapeVertexPy::staticCallback_getZ	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Z attribute

Definition at line 257 of file TopoShapeVertexPy.cpp.

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

int TopoShapeVertexPy::staticCallback_setPoint	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Point attribute

Definition at line 307 of file TopoShapeVertexPy.cpp.

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

PyObject * TopoShapeVertexPy::staticCallback_setTolerance	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the setTolerance() method

Definition at line 117 of file TopoShapeVertexPy.cpp.

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

int TopoShapeVertexPy::staticCallback_setX	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the X attribute

Definition at line 211 of file TopoShapeVertexPy.cpp.

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

int TopoShapeVertexPy::staticCallback_setY	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Y attribute

Definition at line 243 of file TopoShapeVertexPy.cpp.

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

int TopoShapeVertexPy::staticCallback_setZ	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Z attribute

Definition at line 275 of file TopoShapeVertexPy.cpp.

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

Member Data Documentation

PyGetSetDef TopoShapeVertexPy::GetterSetter [static]

Initial value:

 {
    {"X",
        (getter) staticCallback_getX,
        (setter) staticCallback_setX, 
        "X component of this Vertex.",
        NULL
    },
    {"Y",
        (getter) staticCallback_getY,
        (setter) staticCallback_setY, 
        "Y component of this Vertex.",
        NULL
    },
    {"Z",
        (getter) staticCallback_getZ,
        (setter) staticCallback_setZ, 
        "Z component of this Vertex.",
        NULL
    },
    {"Point",
        (getter) staticCallback_getPoint,
        (setter) staticCallback_setPoint, 
        "Position of this Vertex as a Vector",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of TopoShapeVertexPy.

Reimplemented from Part::TopoShapePy.

Definition at line 25 of file TopoShapeVertexPy.h.

PyMethodDef TopoShapeVertexPy::Methods [static]

Initial value:

 {
    {"setTolerance",
        (PyCFunction) staticCallback_setTolerance,
        METH_VARARGS,
        "Set the tolerance for the vertex."
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of TopoShapeVertexPy.

Reimplemented from Part::TopoShapePy.

Definition at line 24 of file TopoShapeVertexPy.h.

Referenced by _getattr().

PyParentObject TopoShapeVertexPy::Parents = { PARENTSPartTopoShapeVertexPy } [static]

Reimplemented from Part::TopoShapePy.

Definition at line 26 of file TopoShapeVertexPy.h.

PyTypeObject TopoShapeVertexPy::Type [static]

Type structure of TopoShapeVertexPy.

Reimplemented from Part::TopoShapePy.

Definition at line 23 of file TopoShapeVertexPy.h.

Referenced by initPart(), and Part::TopoShapeEdgePy::PyInit().

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

Part::TopoShapeVertexPy Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

callbacks and implementers for the python object attributes

callbacks and implementers for the python object methods

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation