Part::CylinderPy Class Reference

The python export class for GeomCylinder. More...

#include <CylinderPy.h>

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

List of all members.

Public Types

typedef GeomCylinderPointerType

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.
 CylinderPy (GeomCylinder *pcObject, PyTypeObject *T=&Type)
PyObjectgetCustomAttributes (const char *attr) const
 getter method for special attributes (e.g. dynamic ones)
GeomCylindergetGeomCylinderPtr (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)
 ~CylinderPy ()

Static Public Member Functions

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

Static Public Attributes

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

callbacks and implementers for the python object attributes



Py::Object getAxis (void) const
 getter for the Axis attribute
Py::Object getCenter (void) const
 getter for the Center attribute
Py::Float getRadius (void) const
 getter for the Radius attribute
void setAxis (Py::Object arg)
 setter for the Axis attribute
void setCenter (Py::Object arg)
 setter for the Center attribute
void setRadius (Py::Float arg)
 setter for the Radius 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_getRadius (PyObject *self, void *closure)
 getter callback for the Radius 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_setRadius (PyObject *self, PyObject *value, void *closure)
 setter callback for the Radius 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 GeomCylinder.

Definition at line 20 of file CylinderPy.h.


Member Typedef Documentation

Reimplemented from Part::GeometrySurfacePy.

Definition at line 36 of file CylinderPy.h.


Constructor & Destructor Documentation

CylinderPy::CylinderPy ( GeomCylinder pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 423 of file CylinderPy.cpp.

Referenced by PyMake().

CylinderPy::~CylinderPy (  ) 

Definition at line 432 of file CylinderPy.cpp.


Member Function Documentation

PyObject * CylinderPy::_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 447 of file CylinderPy.cpp.

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

PyObject * CylinderPy::_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 439 of file CylinderPy.cpp.

References representation().

int CylinderPy::_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 515 of file CylinderPy.cpp.

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

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

getter for the Axis attribute

Definition at line 260 of file CylinderPyImp.cpp.

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

Referenced by staticCallback_getAxis().

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

getter for the Center attribute

Definition at line 230 of file CylinderPyImp.cpp.

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

Referenced by staticCallback_getCenter().

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

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 303 of file CylinderPyImp.cpp.

Referenced by _getattr().

GeomCylinder * CylinderPy::getGeomCylinderPtr ( void   )  const

getter for the object handled by this class

Definition at line 574 of file CylinderPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getCenter(), getRadius(), PyInit(), setCenter(), setRadius(), uIso(), and vIso().

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 28 of file CylinderPy.h.

Py::Float CylinderPy::getRadius ( void   )  const

getter for the Radius attribute

Definition at line 216 of file CylinderPyImp.cpp.

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

Referenced by staticCallback_getRadius().

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 27 of file CylinderPy.h.

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 56 of file CylinderPyImp.cpp.

References CylinderPy().

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 51 of file CylinderPyImp.cpp.

Referenced by _repr().

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

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

Reimplemented from Part::GeometrySurfacePy.

Definition at line 308 of file CylinderPyImp.cpp.

Referenced by _setattr().

void CylinderPy::setRadius ( Py::Float  arg  ) 

setter for the Radius attribute

Definition at line 223 of file CylinderPyImp.cpp.

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

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

getter callback for the Axis attribute

Definition at line 372 of file CylinderPy.cpp.

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

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

getter callback for the Center attribute

Definition at line 328 of file CylinderPy.cpp.

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

PyObject * CylinderPy::staticCallback_getRadius ( PyObject self,
void *  closure 
) [static]

getter callback for the Radius attribute

Definition at line 284 of file CylinderPy.cpp.

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

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

setter callback for the Axis attribute

Definition at line 390 of file CylinderPy.cpp.

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

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

setter callback for the Center attribute

Definition at line 346 of file CylinderPy.cpp.

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

int CylinderPy::staticCallback_setRadius ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Radius attribute

Definition at line 302 of file CylinderPy.cpp.

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

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

implementer for the uIso() method

Definition at line 159 of file CylinderPyImp.cpp.

References getGeomCylinderPtr(), Part::GeomLineSegment::handle(), and StartPage::StartPage::handle().

PyObject * CylinderPy::vIso ( PyObject args  ) 

implementer for the vIso() method

Definition at line 189 of file CylinderPyImp.cpp.

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


Member Data Documentation

PyGetSetDef CylinderPy::GetterSetter [static]
Initial value:
 {
    {"Radius",
        (getter) staticCallback_getRadius,
        (setter) staticCallback_setRadius, 
        "The radius of the cylinder.",
        NULL
    },
    {"Center",
        (getter) staticCallback_getCenter,
        (setter) staticCallback_setCenter, 
        "Center of the cylinder.",
        NULL
    },
    {"Axis",
        (getter) staticCallback_getAxis,
        (setter) staticCallback_setAxis, 
        "The axis direction of the cylinder",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of CylinderPy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 25 of file CylinderPy.h.

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

Methods structure of CylinderPy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 24 of file CylinderPy.h.

Referenced by _getattr().

PyParentObject CylinderPy::Parents = { PARENTSPartCylinderPy } [static]

Reimplemented from Part::GeometrySurfacePy.

Definition at line 26 of file CylinderPy.h.

PyTypeObject CylinderPy::Type [static]

Type structure of CylinderPy.

Reimplemented from Part::GeometrySurfacePy.

Definition at line 23 of file CylinderPy.h.

Referenced by initPart(), and PyInit().


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

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