Part::LinePy Class Reference

The python export class for GeomLineSegment. More...

#include <LinePy.h>

Inheritance diagram for Part::LinePy:
Part::GeometryCurvePy Part::GeometryPy Base::PyObjectBase

List of all members.

Public Types

typedef GeomLineSegmentPointerType

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

Static Public Member Functions

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

Public Attributes

additional declarations and methods for the wrapper class



bool Infinite

Static Public Attributes

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

callbacks and implementers for the python object attributes



Py::Object getEndPoint (void) const
 getter for the EndPoint attribute
Py::Boolean getInfinite (void) const
 getter for the Infinite attribute
Py::Object getStartPoint (void) const
 getter for the StartPoint attribute
void setEndPoint (Py::Object arg)
 setter for the EndPoint attribute
void setInfinite (Py::Boolean arg)
 setter for the Infinite attribute
void setStartPoint (Py::Object arg)
 setter for the StartPoint attribute
static PyObjectstaticCallback_getEndPoint (PyObject *self, void *closure)
 getter callback for the EndPoint attribute
static PyObjectstaticCallback_getInfinite (PyObject *self, void *closure)
 getter callback for the Infinite attribute
static PyObjectstaticCallback_getStartPoint (PyObject *self, void *closure)
 getter callback for the StartPoint attribute
static int staticCallback_setEndPoint (PyObject *self, PyObject *value, void *closure)
 setter callback for the EndPoint attribute
static int staticCallback_setInfinite (PyObject *self, PyObject *value, void *closure)
 setter callback for the Infinite attribute
static int staticCallback_setStartPoint (PyObject *self, PyObject *value, void *closure)
 setter callback for the StartPoint attribute

callbacks and implementers for the python object methods



PyObjectsetParameterRange (PyObject *args)
 implementer for the setParameterRange() method
static PyObjectstaticCallback_setParameterRange (PyObject *self, PyObject *args)
 callback for the setParameterRange() method

Detailed Description

The python export class for GeomLineSegment.

Definition at line 20 of file LinePy.h.


Member Typedef Documentation

Reimplemented from Part::GeometryCurvePy.

Definition at line 36 of file LinePy.h.


Constructor & Destructor Documentation

LinePy::LinePy ( GeomLineSegment pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 335 of file LinePy.cpp.

Referenced by PyMake().

LinePy::~LinePy (  ) 

Definition at line 344 of file LinePy.cpp.


Member Function Documentation

PyObject * LinePy::_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::GeometryCurvePy.

Definition at line 359 of file LinePy.cpp.

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

PyObject * LinePy::_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::GeometryCurvePy.

Definition at line 351 of file LinePy.cpp.

References representation().

int LinePy::_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::GeometryCurvePy.

Definition at line 427 of file LinePy.cpp.

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

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

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

Reimplemented from Part::GeometryCurvePy.

Definition at line 293 of file LinePyImp.cpp.

Referenced by _getattr().

Py::Object LinePy::getEndPoint ( void   )  const

getter for the EndPoint attribute

Definition at line 226 of file LinePyImp.cpp.

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

Referenced by staticCallback_getEndPoint().

GeomLineSegment * LinePy::getGeomLineSegmentPtr ( void   )  const

getter for the object handled by this class

Definition at line 486 of file LinePy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getEndPoint(), getStartPoint(), PyInit(), representation(), setEndPoint(), setParameterRange(), and setStartPoint().

Py::Boolean LinePy::getInfinite ( void   )  const

getter for the Infinite attribute

Definition at line 282 of file LinePyImp.cpp.

References Infinite.

Referenced by staticCallback_getInfinite().

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

Reimplemented from Part::GeometryCurvePy.

Definition at line 28 of file LinePy.h.

Py::Object LinePy::getStartPoint ( void   )  const

getter for the StartPoint attribute

Definition at line 170 of file LinePyImp.cpp.

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

Referenced by staticCallback_getStartPoint().

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

Reimplemented from Part::GeometryCurvePy.

Definition at line 27 of file LinePy.h.

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

Reimplemented from Part::GeometryCurvePy.

Definition at line 63 of file LinePyImp.cpp.

References LinePy().

std::string LinePy::representation ( void   )  const
int LinePy::setCustomAttributes ( const char *  attr,
PyObject obj 
)

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

Reimplemented from Part::GeometryCurvePy.

Definition at line 298 of file LinePyImp.cpp.

Referenced by _setattr().

void LinePy::setEndPoint ( Py::Object  arg  ) 
void LinePy::setInfinite ( Py::Boolean  arg  ) 

setter for the Infinite attribute

Definition at line 287 of file LinePyImp.cpp.

References Infinite.

PyObject * LinePy::setParameterRange ( PyObject args  ) 

implementer for the setParameterRange() method

Definition at line 150 of file LinePyImp.cpp.

References getGeomLineSegmentPtr(), StartPage::StartPage::handle(), and Py_Return.

void LinePy::setStartPoint ( Py::Object  arg  ) 
PyObject * LinePy::staticCallback_getEndPoint ( PyObject self,
void *  closure 
) [static]

getter callback for the EndPoint attribute

Definition at line 240 of file LinePy.cpp.

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

PyObject * LinePy::staticCallback_getInfinite ( PyObject self,
void *  closure 
) [static]

getter callback for the Infinite attribute

Definition at line 284 of file LinePy.cpp.

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

PyObject * LinePy::staticCallback_getStartPoint ( PyObject self,
void *  closure 
) [static]

getter callback for the StartPoint attribute

Definition at line 196 of file LinePy.cpp.

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

int LinePy::staticCallback_setEndPoint ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the EndPoint attribute

Definition at line 258 of file LinePy.cpp.

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

int LinePy::staticCallback_setInfinite ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the Infinite attribute

Definition at line 302 of file LinePy.cpp.

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

PyObject * LinePy::staticCallback_setParameterRange ( PyObject self,
PyObject args 
) [static]
int LinePy::staticCallback_setStartPoint ( PyObject self,
PyObject value,
void *  closure 
) [static]

setter callback for the StartPoint attribute

Definition at line 214 of file LinePy.cpp.

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


Member Data Documentation

PyGetSetDef LinePy::GetterSetter [static]
Initial value:
 {
    {"StartPoint",
        (getter) staticCallback_getStartPoint,
        (setter) staticCallback_setStartPoint, 
        "Returns the start point of this line.",
        NULL
    },
    {"EndPoint",
        (getter) staticCallback_getEndPoint,
        (setter) staticCallback_setEndPoint, 
        "Returns the end point point of this line.",
        NULL
    },
    {"Infinite",
        (getter) staticCallback_getInfinite,
        (setter) staticCallback_setInfinite, 
        "Defines the line as infinite. The StartPoint and EndPoint will be ignored as boundaries.",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of LinePy.

Reimplemented from Part::GeometryCurvePy.

Definition at line 25 of file LinePy.h.

Definition at line 92 of file LinePy.h.

Referenced by getInfinite(), PyInit(), and setInfinite().

PyMethodDef LinePy::Methods [static]
Initial value:
 {
    {"setParameterRange",
        (PyCFunction) staticCallback_setParameterRange,
        METH_VARARGS,
        "Set the parameter range of the underlying line geometry"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of LinePy.

Reimplemented from Part::GeometryCurvePy.

Definition at line 24 of file LinePy.h.

Referenced by _getattr().

PyParentObject LinePy::Parents = { PARENTSPartLinePy } [static]

Reimplemented from Part::GeometryCurvePy.

Definition at line 26 of file LinePy.h.

PyTypeObject LinePy::Type [static]

Type structure of LinePy.

Reimplemented from Part::GeometryCurvePy.

Definition at line 23 of file LinePy.h.

Referenced by initPart(), and PyInit().


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

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