Base::BaseClassPy Class Reference

The python export class for BaseClass. More...

#include <BaseClassPy.h>

Public Types
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
	BaseClassPy (BaseClass *pcObject, PyTypeObject *T=&Type)
virtual PyTypeObject *	GetType (void)
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
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::PyObjectBase
static void	PyDestructor (PyObject *P)
	Wrapper for the Python destructor. More...

Static Public Attributes
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
	~BaseClassPy ()
Protected Member Functions inherited from Base::PyObjectBase
virtual	~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
PyObject *	isDerivedFrom (PyObject *args)
	implementer for the isDerivedFrom() method More...
PyObject *	getAllDerivedFrom (PyObject *args)
	implementer for the getAllDerivedFrom() method More...
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...

callbacks and implementers for the python object attributes
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...
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...

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

Detailed Description

The python export class for BaseClass.

Member Typedef Documentation

PointerType

typedef BaseClass* Base::BaseClassPy::PointerType

Constructor & Destructor Documentation

~BaseClassPy()

BaseClassPy::~BaseClassPy ( )

protected

BaseClassPy()

BaseClassPy::BaseClassPy	(	BaseClass *	pcObject,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

getAllDerivedFrom()

PyObject * BaseClassPy::getAllDerivedFrom

(

PyObject *

args

)

implementer for the getAllDerivedFrom() method

References Base::Type::getAllDerivedFrom(), getBaseClassPtr(), and getTypeId().

Referenced by staticCallback_getAllDerivedFrom().

getBaseClassPtr()

BaseClass * BaseClassPy::getBaseClassPtr

(

void

)

const

getter for the object handled by this class

Referenced by getAllDerivedFrom(), getModule(), getTypeId(), and isDerivedFrom().

getCustomAttributes()

PyObject * BaseClassPy::getCustomAttributes

(

const char *

attr

)

const

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

getModule()

Py::String BaseClassPy::getModule

(

void

)

const

getter for the Module attribute

References getBaseClassPtr(), and getTypeId().

Referenced by staticCallback_getModule().

GetType()

virtual PyTypeObject* Base::BaseClassPy::GetType ( void  )

virtual

Reimplemented from Base::PyObjectBase.

Reimplemented in Gui::AxisOriginPy, Gui::LinkViewPy, Gui::ViewProviderLinkPy, TechDraw::DrawTilePy, TechDraw::DrawTileWeldPy, TechDraw::DrawViewDimExtentPy, TechDraw::DrawWeldSymbolPy, Base::PersistencePy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::ExtensionContainerPy, App::GeoFeaturePy, App::PartPy, App::PropertyContainerPy, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::WorkbenchPy, Fem::FemMeshPy, Fem::FemPostPipelinePy, FemGui::ViewProviderFemMeshPy, Measure::MeasurementPy, Mesh::MeshFeaturePy, Mesh::MeshPy, MeshGui::ViewProviderMeshPy, Attacher::AttachEnginePy, Part::BodyBasePy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, PartDesign::BodyPy, PartDesign::FeaturePy, PartDesignGui::ViewProviderPy, Path::AreaPy, Path::CommandPy, Path::FeatureAreaPy, Path::FeaturePathCompoundPy, Path::PathPy, Path::ToolPy, Path::TooltablePy, PathSimulator::PathSimPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, Sketcher::SketchPy, Spreadsheet::PropertyColumnWidthsPy, Spreadsheet::PropertyRowHeightsPy, Spreadsheet::PropertySheetPy, Spreadsheet::SheetPy, TechDraw::DrawGeomHatchPy, TechDraw::DrawHatchPy, TechDraw::DrawLeaderLinePy, TechDraw::DrawPagePy, TechDraw::DrawParametricTemplatePy, TechDraw::DrawProjGroupItemPy, TechDraw::DrawProjGroupPy, TechDraw::DrawRichAnnoPy, TechDraw::DrawSVGTemplatePy, TechDraw::DrawTemplatePy, TechDraw::DrawViewAnnotationPy, TechDraw::DrawViewClipPy, TechDraw::DrawViewCollectionPy, TechDraw::DrawViewDimensionPy, TechDraw::DrawViewPartPy, TechDraw::DrawViewPy, and TechDraw::DrawViewSymbolPy.

getTypeId()

Py::String BaseClassPy::getTypeId

(

void

)

const

getter for the TypeId attribute

References getBaseClassPtr().

Referenced by Gui::WorkbenchPy::activate(), getAllDerivedFrom(), Attacher::AttachEnginePy::getAttacherType(), Attacher::AttachEnginePy::getModeInfo(), getModule(), and staticCallback_getTypeId().

isDerivedFrom()

PyObject * BaseClassPy::isDerivedFrom

(

PyObject *

args

)

implementer for the isDerivedFrom() method

References Base::Type::badType(), Base::Type::fromName(), getBaseClassPtr(), Base::BaseClass::getTypeId(), and Base::Type::isDerivedFrom().

Referenced by App::PropertyContainerPy::getCustomAttributes(), and staticCallback_isDerivedFrom().

PyInit()

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

virtual

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

Reimplemented from Base::PyObjectBase.

Reimplemented in Gui::AxisOriginPy, Gui::LinkViewPy, Gui::ViewProviderLinkPy, TechDraw::DrawTilePy, TechDraw::DrawTileWeldPy, TechDraw::DrawViewDimExtentPy, TechDraw::DrawWeldSymbolPy, Base::PersistencePy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::ExtensionContainerPy, App::GeoFeaturePy, App::PartPy, App::PropertyContainerPy, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::WorkbenchPy, Fem::FemMeshPy, Fem::FemPostPipelinePy, FemGui::ViewProviderFemMeshPy, Measure::MeasurementPy, Mesh::MeshFeaturePy, Mesh::MeshPy, MeshGui::ViewProviderMeshPy, Attacher::AttachEnginePy, Part::BodyBasePy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, PartDesign::BodyPy, PartDesign::FeaturePy, PartDesignGui::ViewProviderPy, Path::AreaPy, Path::CommandPy, Path::FeatureAreaPy, Path::FeaturePathCompoundPy, Path::PathPy, Path::ToolPy, Path::TooltablePy, PathSimulator::PathSimPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, Sketcher::SketchPy, Spreadsheet::PropertyColumnWidthsPy, Spreadsheet::PropertyRowHeightsPy, Spreadsheet::PropertySheetPy, Spreadsheet::SheetPy, TechDraw::DrawGeomHatchPy, TechDraw::DrawHatchPy, TechDraw::DrawLeaderLinePy, TechDraw::DrawPagePy, TechDraw::DrawParametricTemplatePy, TechDraw::DrawProjGroupItemPy, TechDraw::DrawProjGroupPy, TechDraw::DrawRichAnnoPy, TechDraw::DrawSVGTemplatePy, TechDraw::DrawTemplatePy, TechDraw::DrawViewAnnotationPy, TechDraw::DrawViewClipPy, TechDraw::DrawViewCollectionPy, TechDraw::DrawViewDimensionPy, TechDraw::DrawViewPartPy, TechDraw::DrawViewPy, and TechDraw::DrawViewSymbolPy.

PyMake()

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

static

representation()

std::string BaseClassPy::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 BaseClassPy::setCustomAttributes	(	const char *	attr,
		PyObject *	obj
	)

setter for special attributes (e.g.

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

staticCallback_getAllDerivedFrom()

PyObject * BaseClassPy::staticCallback_getAllDerivedFrom ( PyObject *  self, PyObject *  args  )

static

callback for the getAllDerivedFrom() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), getAllDerivedFrom(), and Base::PyObjectBase::isValid().

staticCallback_getModule()

PyObject * BaseClassPy::staticCallback_getModule ( PyObject *  self, void *  closure  )

static

getter callback for the Module attribute

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

staticCallback_getTypeId()

PyObject * BaseClassPy::staticCallback_getTypeId ( PyObject *  self, void *  closure  )

static

getter callback for the TypeId attribute

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

staticCallback_isDerivedFrom()

PyObject * BaseClassPy::staticCallback_isDerivedFrom ( PyObject *  self, PyObject *  args  )

static

callback for the isDerivedFrom() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), isDerivedFrom(), and Base::PyObjectBase::isValid().

staticCallback_setModule()

int BaseClassPy::staticCallback_setModule ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Module attribute

References Base::PyObjectBase::isValid().

staticCallback_setTypeId()

int BaseClassPy::staticCallback_setTypeId ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the TypeId attribute

References Base::PyObjectBase::isValid().

Member Data Documentation

GetterSetter

PyGetSetDef BaseClassPy::GetterSetter

static

Initial value:

= {
    {"TypeId",
        (getter) staticCallback_getTypeId,
        (setter) staticCallback_setTypeId, 
        "Is the type of the FreeCAD object with module domain",
        NULL
    },
    {"Module",
        (getter) staticCallback_getModule,
        (setter) staticCallback_setModule, 
        "Module in which this class is defined",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of BaseClassPy.

Methods

PyMethodDef BaseClassPy::Methods

static

Initial value:

= {
    {"isDerivedFrom",
        reinterpret_cast<PyCFunction>( staticCallback_isDerivedFrom ),
        METH_VARARGS,
        "Returns true if given type is a father"
    },
    {"getAllDerivedFrom",
        reinterpret_cast<PyCFunction>( staticCallback_getAllDerivedFrom ),
        METH_VARARGS,
        "Returns all descendants"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of BaseClassPy.

Type

PyTypeObject BaseClassPy::Type

static

Type structure of BaseClassPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), ArchReference.ArchReference::setProperties(), and DraftLayer.Layer::setProperties().

---

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

• build/webdoc/src/Base/BaseClassPy.h
• src/Base/BaseClassPyImp.cpp
• build/webdoc/src/Base/BaseClassPy.cpp