Measure::MeasurementPy Class Reference

The python export class for Measurement. More...

#include <MeasurementPy.h>

Public Types
typedef Measurement * PointerType
Public Types inherited from Base::BaseClassPy
typedef BaseClass * PointerType
Public Types inherited from Base::PyObjectBase
typedef void * PointerType
enum  Status { Valid = 0, Immutable = 1, Notify = 2, NoTrack = 3 }

Public Member Functions
virtual PyTypeObject * GetType (void)
MeasurementPy (Measurement *pcObject, PyTypeObject *T=&Type)
virtual int PyInit (PyObject *args, PyObject *k)
	PyInit method Override this method to initialize a newly created instance of the class (Constructor) More...
std::string representation (void) const
callbacks and implementers for the python object attributes
PyObject * getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones) More...
int setCustomAttributes (const char *attr, PyObject *obj)
	setter for special attributes (e.g. More...
Measurement * getMeasurementPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Base::BaseClassPy
BaseClassPy (BaseClass *pcObject, PyTypeObject *T=&Type)
std::string representation (void) const
PyObject * isDerivedFrom (PyObject *args)
	implementer for the isDerivedFrom() method More...
PyObject * getAllDerivedFrom (PyObject *args)
	implementer for the getAllDerivedFrom() method More...
Py::String getTypeId (void) const
	getter for the TypeId attribute More...
Py::String getModule (void) const
	getter for the Module attribute More...
PyObject * getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones) More...
int setCustomAttributes (const char *attr, PyObject *obj)
	setter for special attributes (e.g. More...
BaseClass * getBaseClassPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from Base::PyObjectBase
PyObjectBase * DecRef (void)
	decref method wrapper (see python extending manual) More...
PyObjectBase * IncRef (void)
	incref method wrapper (see python extending manual) More...
bool isConst ()
bool isNotTracking () const
bool isValid ()
PyObjectBase (void *, PyTypeObject *T)
	Constructor Sets the Type of the object (for inheritance) and decrease the the reference count of the PyObject. More...
void setConst ()
void setInvalid ()
void setNotTracking (bool on=true)
void setShouldNotify (bool on)
bool shouldNotify () const
void startNotify ()

Static Public Member Functions
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
Static Public Member Functions inherited from Base::BaseClassPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject * staticCallback_isDerivedFrom (PyObject *self, PyObject *args)
	callback for the isDerivedFrom() method More...
static PyObject * staticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
	callback for the getAllDerivedFrom() method More...
static PyObject * staticCallback_getTypeId (PyObject *self, void *closure)
	getter callback for the TypeId attribute More...
static int staticCallback_setTypeId (PyObject *self, PyObject *value, void *closure)
	setter callback for the TypeId attribute More...
static PyObject * staticCallback_getModule (PyObject *self, void *closure)
	getter callback for the Module attribute More...
static int staticCallback_setModule (PyObject *self, PyObject *value, void *closure)
	setter callback for the Module attribute More...
Static Public Member Functions inherited from Base::PyObjectBase
static void PyDestructor (PyObject *P)
	Wrapper for the Python destructor. More...

Static Public Attributes
static PyGetSetDef GetterSetter []
	Attribute structure of MeasurementPy. More...
static PyMethodDef Methods []
	Methods structure of MeasurementPy. More...
static PyTypeObject Type
	Type structure of MeasurementPy. More...
Static Public Attributes inherited from Base::BaseClassPy
static PyGetSetDef GetterSetter []
	Attribute structure of BaseClassPy. More...
static PyMethodDef Methods []
	Methods structure of BaseClassPy. More...
static PyTypeObject Type
	Type structure of BaseClassPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
static PyTypeObject Type
	Py_Header struct from python.h. More...

Protected Member Functions
~MeasurementPy ()
Protected Member Functions inherited from Base::BaseClassPy
~BaseClassPy ()
Protected Member Functions inherited from Base::PyObjectBase
virtual ~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
PyObject * addReference3D (PyObject *args)
	implementer for the addReference3D() method More...
PyObject * has3DReferences (PyObject *args)
	implementer for the has3DReferences() method More...
PyObject * clear (PyObject *args)
	implementer for the clear() method More...
PyObject * delta (PyObject *args)
	implementer for the delta() method More...
PyObject * length (PyObject *args)
	implementer for the length() method More...
PyObject * angle (PyObject *args)
	implementer for the angle() method More...
PyObject * radius (PyObject *args)
	implementer for the radius() method More...
PyObject * com (PyObject *args)
	implementer for the com() method More...
static PyObject * staticCallback_addReference3D (PyObject *self, PyObject *args)
	callback for the addReference3D() method More...
static PyObject * staticCallback_has3DReferences (PyObject *self, PyObject *args)
	callback for the has3DReferences() method More...
static PyObject * staticCallback_clear (PyObject *self, PyObject *args)
	callback for the clear() method More...
static PyObject * staticCallback_delta (PyObject *self, PyObject *args)
	callback for the delta() method More...
static PyObject * staticCallback_length (PyObject *self, PyObject *args)
	callback for the length() method More...
static PyObject * staticCallback_angle (PyObject *self, PyObject *args)
	callback for the angle() method More...
static PyObject * staticCallback_radius (PyObject *self, PyObject *args)
	callback for the radius() method More...
static PyObject * staticCallback_com (PyObject *self, PyObject *args)
	callback for the com() method More...

Additional Inherited Members
Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits

Detailed Description

The python export class for Measurement.

Member Typedef Documentation

PointerType

typedef Measurement* Measure::MeasurementPy::PointerType

Constructor & Destructor Documentation

~MeasurementPy()

MeasurementPy::~MeasurementPy ( )

protected

MeasurementPy()

MeasurementPy::MeasurementPy	(	Measurement *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by PyMake().

Member Function Documentation

addReference3D()

PyObject * MeasurementPy::addReference3D

(

PyObject *

args

)

implementer for the addReference3D() method

References App::Application::getActiveDocument(), App::GetApplication(), getMeasurementPtr(), and App::Document::getObject().

Referenced by staticCallback_addReference3D().

angle()

PyObject * MeasurementPy::angle

(

PyObject *

args

)

implementer for the angle() method

References Measure::Measurement::angle(), and getMeasurementPtr().

Referenced by staticCallback_angle().

clear()

PyObject * MeasurementPy::clear

(

PyObject *

args

)

implementer for the clear() method

References Measure::Measurement::clear(), and getMeasurementPtr().

Referenced by staticCallback_clear().

com()

PyObject * MeasurementPy::com

(

PyObject *

args

)

implementer for the com() method

References getMeasurementPtr().

Referenced by staticCallback_com().

delta()

PyObject * MeasurementPy::delta

(

PyObject *

args

)

implementer for the delta() method

References getMeasurementPtr().

Referenced by staticCallback_delta().

getCustomAttributes()

PyObject * MeasurementPy::getCustomAttributes

(

const char *

attr

)

const

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

getMeasurementPtr()

Measurement * MeasurementPy::getMeasurementPtr

(

void

)

const

getter for the object handled by this class

Referenced by addReference3D(), angle(), clear(), com(), delta(), has3DReferences(), length(), and radius().

GetType()

virtual PyTypeObject* Measure::MeasurementPy::GetType ( void  )

virtual

Reimplemented from Base::BaseClassPy.

has3DReferences()

PyObject * MeasurementPy::has3DReferences

(

PyObject *

args

)

implementer for the has3DReferences() method

References getMeasurementPtr().

Referenced by staticCallback_has3DReferences().

length()

PyObject * MeasurementPy::length

(

PyObject *

args

)

implementer for the length() method

References getMeasurementPtr(), and Measure::Measurement::length().

Referenced by staticCallback_length().

PyInit()

int MeasurementPy::PyInit ( PyObject *  , PyObject *    )

virtual

PyInit method Override this method to initialize a newly created instance of the class (Constructor)

Reimplemented from Base::BaseClassPy.

PyMake()

PyObject * MeasurementPy::PyMake ( struct _typeobject *  , PyObject *  , PyObject *    )

static

References MeasurementPy().

radius()

PyObject * MeasurementPy::radius

(

PyObject *

args

)

implementer for the radius() method

References getMeasurementPtr(), and Measure::Measurement::radius().

Referenced by staticCallback_radius().

representation()

std::string MeasurementPy::representation

(

void

)

const

Referenced by config_control_design.pcurve::wr1(), config_control_design.degenerate_pcurve::wr1(), automotive_design.motion_link_relationship::wr1(), automotive_design.pcurve::wr1(), automotive_design.degenerate_pcurve::wr1(), config_control_design.pcurve::wr2(), config_control_design.degenerate_pcurve::wr2(), automotive_design.pcurve::wr2(), and automotive_design.degenerate_pcurve::wr2().

setCustomAttributes()

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

setter for special attributes (e.g.

dynamic ones) Output: Success=1, Failure=-1, Ignore=0

staticCallback_addReference3D()

PyObject * MeasurementPy::staticCallback_addReference3D ( PyObject *  self, PyObject *  args  )

static

callback for the addReference3D() method

References addReference3D(), Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_angle()

PyObject * MeasurementPy::staticCallback_angle ( PyObject *  self, PyObject *  args  )

static

callback for the angle() method

References angle(), Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_clear()

PyObject * MeasurementPy::staticCallback_clear ( PyObject *  self, PyObject *  args  )

static

callback for the clear() method

References Base::BaseExceptionFreeCADError, clear(), Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_com()

PyObject * MeasurementPy::staticCallback_com ( PyObject *  self, PyObject *  args  )

static

callback for the com() method

References Base::BaseExceptionFreeCADError, com(), Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_delta()

PyObject * MeasurementPy::staticCallback_delta ( PyObject *  self, PyObject *  args  )

static

callback for the delta() method

References Base::BaseExceptionFreeCADError, Base::Console(), delta(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_has3DReferences()

PyObject * MeasurementPy::staticCallback_has3DReferences ( PyObject *  self, PyObject *  args  )

static

callback for the has3DReferences() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), has3DReferences(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_length()

PyObject * MeasurementPy::staticCallback_length ( PyObject *  self, PyObject *  args  )

static

callback for the length() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), length(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_radius()

PyObject * MeasurementPy::staticCallback_radius ( PyObject *  self, PyObject *  args  )

static

callback for the radius() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), radius(), and Base::PyObjectBase::startNotify().

Member Data Documentation

GetterSetter

PyGetSetDef MeasurementPy::GetterSetter

static

Initial value:

= {
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of MeasurementPy.

Methods

PyMethodDef MeasurementPy::Methods

static

Methods structure of MeasurementPy.

Type

PyTypeObject MeasurementPy::Type

static

Type structure of MeasurementPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchSchedule.CommandArchSchedule::IsActive(), and ArchAxis.CommandArchGrid::IsActive().

---

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

• build/webdoc/src/Mod/Measure/App/MeasurementPy.h
• src/Mod/Measure/App/MeasurementPyImp.cpp
• build/webdoc/src/Mod/Measure/App/MeasurementPy.cpp