The python export class for Measurement. More...

#include <MeasurementPy.h>

Public Types

typedef MeasurementPointerType
 
- Public Types inherited from Base::BaseClassPy
typedef BaseClassPointerType
 
- 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
PyObjectgetCustomAttributes (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...
 
MeasurementgetMeasurementPtr (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
 
PyObjectisDerivedFrom (PyObject *args)
 implementer for the isDerivedFrom() method More...
 
PyObjectgetAllDerivedFrom (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...
 
PyObjectgetCustomAttributes (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...
 
BaseClassgetBaseClassPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBaseDecRef (void)
 decref method wrapper (see python extending manual) More...
 
PyObjectBaseIncRef (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 PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from Base::BaseClassPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_isDerivedFrom (PyObject *self, PyObject *args)
 callback for the isDerivedFrom() method More...
 
static PyObjectstaticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
 callback for the getAllDerivedFrom() method More...
 
static PyObjectstaticCallback_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 PyObjectstaticCallback_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
void setTwinPointer (void *ptr)
 Overrides the pointer to the twin object. More...
 
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObjectaddReference3D (PyObject *args)
 implementer for the addReference3D() method More...
 
PyObjecthas3DReferences (PyObject *args)
 implementer for the has3DReferences() method More...
 
PyObjectclear (PyObject *args)
 implementer for the clear() method More...
 
PyObjectdelta (PyObject *args)
 implementer for the delta() method More...
 
PyObjectlength (PyObject *args)
 implementer for the length() method More...
 
PyObjectangle (PyObject *args)
 implementer for the angle() method More...
 
PyObjectradius (PyObject *args)
 implementer for the radius() method More...
 
PyObjectcom (PyObject *args)
 implementer for the com() method More...
 
static PyObjectstaticCallback_addReference3D (PyObject *self, PyObject *args)
 callback for the addReference3D() method More...
 
static PyObjectstaticCallback_has3DReferences (PyObject *self, PyObject *args)
 callback for the has3DReferences() method More...
 
static PyObjectstaticCallback_clear (PyObject *self, PyObject *args)
 callback for the clear() method More...
 
static PyObjectstaticCallback_delta (PyObject *self, PyObject *args)
 callback for the delta() method More...
 
static PyObjectstaticCallback_length (PyObject *self, PyObject *args)
 callback for the length() method More...
 
static PyObjectstaticCallback_angle (PyObject *self, PyObject *args)
 callback for the angle() method More...
 
static PyObjectstaticCallback_radius (PyObject *self, PyObject *args)
 callback for the radius() method More...
 
static PyObjectstaticCallback_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

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)

◆ 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 PathScripts.post.comparams_post.saveVals::retVals(), and staticCallback_com().

◆ 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()

◆ 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 PathScripts.PathPocketBase.ObjectPocket::areaOpAreaParams(), PathScripts.PathProfile.ObjectProfile::areaOpAreaParams(), PathScripts.PathPocketBase.ObjectPocket::areaOpPathParams(), PathScripts.PathAreaOp.ObjectOp::areaOpSetDefaultValues(), DraftGui.DraftToolBar::changeRadiusValue(), PathScripts.PathHelix.ObjectHelix::circularHoleExecute(), PathScripts.PathDressupHoldingTags.Tag::createSolidsAt(), PathScripts.PathSurface.ObjectSurface::deleteOpVariables(), PathScripts.PathWaterline.ObjectWaterline::deleteOpVariables(), PathScripts.PathOp.ObjectOp::execute(), PathScripts.PathDressupAxisMap.TaskPanel::getFields(), PathScripts.PathHelix.ObjectHelix::helix_cut(), ifc4.ifcsweptdisksolid::innerradiussize(), draftguitools.gui_snapper.Snapper::off(), PathScripts.PathSurfaceSupport.ProcessSelectedFaces::preProcessModel(), draftguitools.gui_snapper.Snapper::showradius(), draftguitools.gui_snapper.Snapper::snapToCrossExtensions(), draftguitools.gui_snapper.Snapper::snapToExtensions(), draftguitools.gui_snapper.Snapper::snapToGrid(), draftguitools.gui_snapper.Snapper::snapToHold(), draftguitools.gui_snapper.Snapper::snapToObject(), draftguitools.gui_snapper.Snapper::snapToPolar(), staticCallback_radius(), DraftGui.DraftToolBar::taskUi(), PathScripts.PathDressupAxisMap.TaskPanel::updateUI(), DraftGui.DraftToolBar::validatePoint(), automotive_design.right_circular_cone::wr1(), automotive_design.conical_surface::wr1(), config_control_design.conical_surface::wr1(), automotive_design.swept_disk_solid::wr2(), and ifc2x3.ifcsweptdisksolid::wr2().

◆ representation()

◆ 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()

◆ staticCallback_angle()

◆ staticCallback_clear()

◆ staticCallback_com()

◆ staticCallback_delta()

◆ staticCallback_has3DReferences()

◆ staticCallback_length()

◆ staticCallback_radius()

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


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/Mod/Measure/App/MeasurementPy.h
  • Sources/FreeCAD/src/Mod/Measure/App/MeasurementPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/Mod/Measure/App/MeasurementPy.cpp