Part::ToroidPy Class Reference

The python export class for GeomToroid. More...

#include <ToroidPy.h>

Inheritance diagram for Part::ToroidPy:
Part::GeometrySurfacePy Part::GeometryPy Base::PyObjectBase

List of all members.

Public Types

typedef GeomToroidPointerType

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)
GeomToroidgetGeomToroidPtr (void) const
 getter for the object handled by this class
virtual PyParentObjectGetParents (void)
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)
 ToroidPy (GeomToroid *pcObject, PyTypeObject *T=&Type)
 ~ToroidPy ()

Static Public Member Functions

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

Static Public Attributes

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

callbacks and implementers for the python object attributes



Py::Float getArea (void) const
 getter for the Area attribute
Py::Object getAxis (void) const
 getter for the Axis attribute
Py::Object getCenter (void) const
 getter for the Center attribute
Py::Float getMajorRadius (void) const
 getter for the MajorRadius attribute
Py::Float getMinorRadius (void) const
 getter for the MinorRadius attribute
Py::Float getVolume (void) const
 getter for the Volume attribute
void setAxis (Py::Object arg)
 setter for the Axis attribute
void setCenter (Py::Object arg)
 setter for the Center attribute
void setMajorRadius (Py::Float arg)
 setter for the MajorRadius attribute
void setMinorRadius (Py::Float arg)
 setter for the MinorRadius attribute
static PyObjectstaticCallback_getArea (PyObject *self, void *closure)
 getter callback for the Area attribute
static PyObjectstaticCallback_getAxis (PyObject *self, void *closure)
 getter callback for the Axis attribute
static PyObjectstaticCallback_getCenter (PyObject *self, void *closure)
 getter callback for the Center attribute
static PyObjectstaticCallback_getMajorRadius (PyObject *self, void *closure)
 getter callback for the MajorRadius attribute
static PyObjectstaticCallback_getMinorRadius (PyObject *self, void *closure)
 getter callback for the MinorRadius attribute
static PyObjectstaticCallback_getVolume (PyObject *self, void *closure)
 getter callback for the Volume attribute
static int staticCallback_setArea (PyObject *self, PyObject *value, void *closure)
 setter callback for the Area attribute
static int staticCallback_setAxis (PyObject *self, PyObject *value, void *closure)
 setter callback for the Axis attribute
static int staticCallback_setCenter (PyObject *self, PyObject *value, void *closure)
 setter callback for the Center attribute
static int staticCallback_setMajorRadius (PyObject *self, PyObject *value, void *closure)
 setter callback for the MajorRadius attribute
static int staticCallback_setMinorRadius (PyObject *self, PyObject *value, void *closure)
 setter callback for the MinorRadius attribute
static int staticCallback_setVolume (PyObject *self, PyObject *value, void *closure)
 setter callback for the Volume attribute

callbacks and implementers for the python object methods



PyObjectuIso (PyObject *args)
 implementer for the uIso() method
PyObjectvIso (PyObject *args)
 implementer for the vIso() method
static PyObjectstaticCallback_uIso (PyObject *self, PyObject *args)
 callback for the uIso() method
static PyObjectstaticCallback_vIso (PyObject *self, PyObject *args)
 callback for the vIso() method

Detailed Description

The python export class for GeomToroid.

Definition at line 20 of file ToroidPy.h.


Member Typedef Documentation

Reimplemented from Part::GeometrySurfacePy.

Definition at line 36 of file ToroidPy.h.


Constructor & Destructor Documentation

ToroidPy::ToroidPy ( GeomToroid pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 533 of file ToroidPy.cpp.

Referenced by PyMake().

ToroidPy::~ToroidPy (  ) 

Definition at line 542 of file ToroidPy.cpp.


Member Function Documentation

PyObject * ToroidPy::_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::GeometrySurfacePy.

Definition at line 557 of file ToroidPy.cpp.

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

PyObject * ToroidPy::_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::GeometrySurfacePy.

Definition at line 549 of file ToroidPy.cpp.

References representation().

int ToroidPy::_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::GeometrySurfacePy.

Definition at line 625 of file ToroidPy.cpp.

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

Py::Float ToroidPy::getArea ( void   )  const

getter for the Area attribute

Definition at line 211 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getArea().

Py::Object ToroidPy::getAxis ( void   )  const

getter for the Axis attribute

Definition at line 168 of file ToroidPyImp.cpp.

References Part::GeometryPy::getGeometryPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getAxis().

Py::Object ToroidPy::getCenter ( void   )  const

getter for the Center attribute

Definition at line 144 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getCenter().

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

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 225 of file ToroidPyImp.cpp.

Referenced by _getattr().

GeomToroid * ToroidPy::getGeomToroidPtr ( void   )  const

getter for the object handled by this class

Definition at line 684 of file ToroidPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getArea(), getCenter(), getMajorRadius(), getMinorRadius(), getVolume(), PyInit(), setCenter(), setMajorRadius(), setMinorRadius(), uIso(), and vIso().

Py::Float ToroidPy::getMajorRadius ( void   )  const

getter for the MajorRadius attribute

Definition at line 106 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getMajorRadius().

Py::Float ToroidPy::getMinorRadius ( void   )  const

getter for the MinorRadius attribute

Definition at line 125 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getMinorRadius().

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 28 of file ToroidPy.h.

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 27 of file ToroidPy.h.

Py::Float ToroidPy::getVolume ( void   )  const

getter for the Volume attribute

Definition at line 218 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

Referenced by staticCallback_getVolume().

int ToroidPy::PyInit ( PyObject ,
PyObject  
) [virtual]

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 55 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 48 of file ToroidPyImp.cpp.

References ToroidPy().

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 43 of file ToroidPyImp.cpp.

Referenced by _repr().

void ToroidPy::setAxis ( Py::Object  arg  ) 
void ToroidPy::setCenter ( Py::Object  arg  ) 
int ToroidPy::setCustomAttributes ( const char *  attr,
PyObject obj 
)

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 230 of file ToroidPyImp.cpp.

Referenced by _setattr().

void ToroidPy::setMajorRadius ( Py::Float  arg  ) 

setter for the MajorRadius attribute

Definition at line 113 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

void ToroidPy::setMinorRadius ( Py::Float  arg  ) 

setter for the MinorRadius attribute

Definition at line 132 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

PyObject * ToroidPy::staticCallback_getArea ( PyObject self,
void *  closure 
) [static]

getter callback for the Area attribute

Definition at line 462 of file ToroidPy.cpp.

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

PyObject * ToroidPy::staticCallback_getAxis ( PyObject self,
void *  closure 
) [static]

getter callback for the Axis attribute

Definition at line 418 of file ToroidPy.cpp.

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

PyObject * ToroidPy::staticCallback_getCenter ( PyObject self,
void *  closure 
) [static]

getter callback for the Center attribute

Definition at line 374 of file ToroidPy.cpp.

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

PyObject * ToroidPy::staticCallback_getMajorRadius ( PyObject self,
void *  closure 
) [static]

getter callback for the MajorRadius attribute

Definition at line 286 of file ToroidPy.cpp.

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

PyObject * ToroidPy::staticCallback_getMinorRadius ( PyObject self,
void *  closure 
) [static]

getter callback for the MinorRadius attribute

Definition at line 330 of file ToroidPy.cpp.

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

PyObject * ToroidPy::staticCallback_getVolume ( PyObject self,
void *  closure 
) [static]

getter callback for the Volume attribute

Definition at line 494 of file ToroidPy.cpp.

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

int ToroidPy::staticCallback_setArea ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Area attribute

Definition at line 480 of file ToroidPy.cpp.

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

int ToroidPy::staticCallback_setAxis ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Axis attribute

Definition at line 436 of file ToroidPy.cpp.

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

int ToroidPy::staticCallback_setCenter ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Center attribute

Definition at line 392 of file ToroidPy.cpp.

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

int ToroidPy::staticCallback_setMajorRadius ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the MajorRadius attribute

Definition at line 304 of file ToroidPy.cpp.

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

int ToroidPy::staticCallback_setMinorRadius ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the MinorRadius attribute

Definition at line 348 of file ToroidPy.cpp.

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

int ToroidPy::staticCallback_setVolume ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Volume attribute

Definition at line 512 of file ToroidPy.cpp.

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

PyObject * ToroidPy::staticCallback_uIso ( PyObject self,
PyObject args 
) [static]
PyObject * ToroidPy::staticCallback_vIso ( PyObject self,
PyObject args 
) [static]
PyObject * ToroidPy::uIso ( PyObject args  ) 

implementer for the uIso() method

Definition at line 68 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().

PyObject * ToroidPy::vIso ( PyObject args  ) 

implementer for the vIso() method

Definition at line 87 of file ToroidPyImp.cpp.

References getGeomToroidPtr(), and StartPage::StartPage::handle().


Member Data Documentation

PyGetSetDef ToroidPy::GetterSetter [static]

Attribute structure of ToroidPy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 25 of file ToroidPy.h.

PyMethodDef ToroidPy::Methods [static]
Initial value:
 {
    {"uIso",
        (PyCFunction) staticCallback_uIso,
        METH_VARARGS,
        "Builds the U isoparametric circle of this toroid"
    },
    {"vIso",
        (PyCFunction) staticCallback_vIso,
        METH_VARARGS,
        "Builds the V isoparametric circle of this toroid"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of ToroidPy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 24 of file ToroidPy.h.

Referenced by _getattr().

PyParentObject ToroidPy::Parents = { PARENTSPartToroidPy } [static]

Reimplemented from Part::GeometrySurfacePy.

Definition at line 26 of file ToroidPy.h.

PyTypeObject ToroidPy::Type [static]

Type structure of ToroidPy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 23 of file ToroidPy.h.

Referenced by initPart().


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

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