Base::PyObjectBase Class Reference

The PyObjectBase class, exports the class as a python type PyObjectBase is the base class for all C++ classes which need to get exported into the python namespace. More...

#include <PyObjectBase.h>

Inheritance diagram for Base::PyObjectBase:

List of all members.

Public Types
typedef void *	PointerType
Public Member Functions
virtual 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.
virtual int	_setattr (char attr, PyObject value)
	SetAttribute implementation This method implements the seting of object attributes.
PyObjectBase *	DecRef (void)
	decref method wrapper (see python extending manual)
virtual PyParentObject *	GetParents (void)
virtual PyTypeObject *	GetType (void)
PyObjectBase *	IncRef (void)
	incref method wrapper (see python extending manual)
bool	isConst ()
bool	isValid ()
virtual int	PyInit (PyObject , PyObject )
	PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).
	PyObjectBase (void , PyTypeObject T)
	Constructor Sets the Type of the object (for inherintance) and decrease the the reference count of the PyObject.
void	setAttributeOf (const char attr, const PyObjectBase par)
void	setConst ()
void	setInvalid ()
void	startNotify ()
Static Public Member Functions
static PyObject *	__getattr (PyObject PyObj, char attr)
	static wrapper for pythons _getattr()
static int	__PyInit (PyObject self, PyObject args, PyObject *kwd)
	python wrapper for the _repr() function
static PyObject *	__repr (PyObject *PyObj)
	python wrapper for the _repr() function
static int	__setattr (PyObject PyObj, char attr, PyObject *value)
	static wrapper for pythons _setattr(). // This should be the entry in Type.
static void	PyDestructor (PyObject *P)
	Wrapper for the Python destructor.
Static Public Attributes
static PyMethodDef	Methods []
static PyParentObject	Parents [] = {&PyObjectBase::Type, NULL}
static PyTypeObject	Type
	Py_Header struct from python.h.
Protected Member Functions
virtual	~PyObjectBase ()
	destructor
Protected Attributes
void *	_pcTwinPointer
	pointer to the handled class
char *	attribute
PyObjectBase *	parent
std::bitset< 32 >	StatusBits

Detailed Description

The PyObjectBase class, exports the class as a python type PyObjectBase is the base class for all C++ classes which need to get exported into the python namespace.

This class is very important because nearly all important classes in FreeCAD are visible in python for macro recording and automation purpose. The class App::Document is a good expample for an exported class. There are some conveniance macros to make it easier to inherit from this class and defining new methods exported to python. PYFUNCDEF_D defines a new exported method. PYFUNCIMP_D defines the implementation of the new exported method. In the implementation you can use Py_Return, Py_Error, Py_Try and Py_Assert. PYMETHODEDEF makes the entry in the python method tabel.

See also:: Document; PYFUNCDEF_D; PYFUNCIMP_D; PYMETHODEDEF; Py_Return; Py_Error; Py_Try; Py_Assert

Definition at line 186 of file PyObjectBase.h.

Member Typedef Documentation

typedef void* Base::PyObjectBase::PointerType

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 295 of file PyObjectBase.h.

Constructor & Destructor Documentation

PyObjectBase::~PyObjectBase ( ) [protected, virtual]

destructor

Definition at line 49 of file PyObjectBase.cpp.

References attribute, Base::Console(), DecRef(), boost::numeric::bindings::umfpack::free(), Base::ConsoleSingleton::Log(), and parent.

PyObjectBase::PyObjectBase	(	void *	p,
		PyTypeObject *	T
	)

Constructor Sets the Type of the object (for inherintance) and decrease the the reference count of the PyObject.

Definition at line 37 of file PyObjectBase.cpp.

References Base::Console(), Base::ConsoleSingleton::Log(), and StatusBits.

Member Function Documentation

PyObject * PyObjectBase::__getattr	(	PyObject *	PyObj,
		char *	attr
	)			`[static]`

static wrapper for pythons _getattr()

Definition at line 138 of file PyObjectBase.cpp.

References _getattr(), isConst(), isValid(), setAttributeOf(), Type, and Py::value().

static int Base::PyObjectBase::__PyInit	(	PyObject *	self,
		PyObject *	args,
		PyObject *	kwd
	)			`[inline, static]`

python wrapper for the _repr() function

Definition at line 268 of file PyObjectBase.h.

static PyObject* Base::PyObjectBase::__repr ( PyObject * PyObj ) [inline, static]

python wrapper for the _repr() function

Definition at line 251 of file PyObjectBase.h.

int PyObjectBase::__setattr	(	PyObject *	PyObj,
		char *	attr,
		PyObject *	value
	)			`[static]`

static wrapper for pythons _setattr(). // This should be the entry in Type.

Definition at line 157 of file PyObjectBase.cpp.

References _setattr(), isValid(), and startNotify().

Referenced by startNotify().

PyObject * PyObjectBase::_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 in ParameterGrpPy, Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 182 of file PyObjectBase.cpp.

References Base::streq(), and RobotExample::w.

Referenced by __getattr().

PyObject * PyObjectBase::_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 in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 244 of file PyObjectBase.cpp.

References _pcTwinPointer, Base::Console(), and Base::ConsoleSingleton::Log().

int PyObjectBase::_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 in ParameterGrpPy, Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 221 of file PyObjectBase.cpp.

References Base::streq(), and RobotExample::w.

Referenced by __setattr().

PyObjectBase* Base::PyObjectBase::DecRef ( void ) [inline]

decref method wrapper (see python extending manual)

Definition at line 210 of file PyObjectBase.h.

Referenced by Gui::Document::~Document(), ~PyObjectBase(), Gui::PythonWorkbench::~PythonWorkbench(), and Gui::ViewProvider::~ViewProvider().

virtual PyParentObject* Base::PyObjectBase::GetParents ( void ) [inline, virtual]

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 192 of file PyObjectBase.h.

virtual PyTypeObject* Base::PyObjectBase::GetType ( void ) [inline, virtual]

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 192 of file PyObjectBase.h.

PyObjectBase* Base::PyObjectBase::IncRef ( void ) [inline]

incref method wrapper (see python extending manual)

Definition at line 208 of file PyObjectBase.h.

Referenced by Gui::PythonWorkbench::getPyObject(), Gui::ViewProviderDocumentObject::getPyObject(), Gui::ViewProvider::getPyObject(), and Gui::Document::getPyObject().

bool Base::PyObjectBase::isConst ( ) [inline]

Definition at line 288 of file PyObjectBase.h.

bool Base::PyObjectBase::isValid ( void ) [inline]

Definition at line 279 of file PyObjectBase.h.

static void Base::PyObjectBase::PyDestructor ( PyObject * P ) [inline, static]

Wrapper for the Python destructor.

Definition at line 205 of file PyObjectBase.h.

virtual int Base::PyObjectBase::PyInit	(	PyObject *	,
		PyObject *
	)			`[inline, virtual]`

PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 263 of file PyObjectBase.h.

void PyObjectBase::setAttributeOf	(	const char *	attr,
		const PyObjectBase *	par
	)

Definition at line 254 of file PyObjectBase.cpp.

References attribute, boost::numeric::bindings::umfpack::free(), and parent.

Referenced by __getattr().

void Base::PyObjectBase::setConst ( ) [inline]

Definition at line 283 of file PyObjectBase.h.

Referenced by Mesh::FacetPy::getNormal(), Points::PropertyPointKernel::getPyObject(), Mesh::PropertyMeshKernel::getPyObject(), Fem::PropertyFemMesh::getPyObject(), and Mesh::MeshPointPy::getVector().

void Base::PyObjectBase::setInvalid ( ) [inline]

Definition at line 273 of file PyObjectBase.h.

Referenced by Gui::Document::~Document(), App::Document::~Document(), Gui::PythonWorkbench::~PythonWorkbench(), and Gui::ViewProvider::~ViewProvider().

void PyObjectBase::startNotify ( )

Definition at line 281 of file PyObjectBase.cpp.

References __setattr(), attribute, and parent.

Referenced by __setattr().

Member Data Documentation

void* Base::PyObjectBase::_pcTwinPointer [protected]

pointer to the handled class

Definition at line 300 of file PyObjectBase.h.

char* Base::PyObjectBase::attribute [protected]

Definition at line 302 of file PyObjectBase.h.

Referenced by setAttributeOf(), startNotify(), and ~PyObjectBase().

PyMethodDef PyObjectBase::Methods [static]

Initial value:

 {
    {NULL, NULL, 0, NULL}        
}

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 192 of file PyObjectBase.h.

PyObjectBase* Base::PyObjectBase::parent [protected]

Definition at line 301 of file PyObjectBase.h.

Referenced by setAttributeOf(), startNotify(), and ~PyObjectBase().

PyParentObject PyObjectBase::Parents = {&PyObjectBase::Type, NULL} [static]

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 192 of file PyObjectBase.h.

std::bitset<32> Base::PyObjectBase::StatusBits [protected]

Definition at line 298 of file PyObjectBase.h.

Referenced by PyObjectBase().

PyTypeObject PyObjectBase::Type [static]

Py_Header struct from python.h.

To prevent subclasses of PyTypeObject to be subclassed in Python we should remove the Py_TPFLAGS_BASETYPE flag.

Every PyObjectBase object is also a python object. So you can use every Python C-Library function also on a PyObjectBase object

For example, the classes App::VectorPy and App::MatrixPy have removed this flag and its Python proxies App.Vector and App.Matrix cannot be subclassed. In case we want to allow to derive from subclasses of PyTypeObject in Python we must either reimplment tp_new, tp_dealloc, tp_getattr, tp_setattr, tp_repr or set them to 0 and define tp_base as 0.

Reimplemented in Base::BaseClassPy, Base::BoundBoxPy, Base::MatrixPy, Base::PersistencePy, Base::PlacementPy, Base::RotationPy, Base::VectorPy, Data::ComplexGeoDataPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::FeaturePythonPy, App::MaterialPy, App::PropertyContainerPy, Gui::PyResource, Gui::DocumentPy, Gui::PythonWorkbenchPy, Gui::SelectionObjectPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Gui::ViewProviderPythonFeaturePy, Gui::WorkbenchPy, TestGui::UnitTestPy, Fem::FemMeshPy, Mesh::FacetPy, Mesh::FeaturePythonPy, Mesh::MeshFeaturePy, Mesh::MeshPointPy, Mesh::MeshPy, Part::ArcOfCirclePy, Part::ArcPy, Part::BezierCurvePy, Part::BezierSurfacePy, Part::BSplineCurvePy, Part::BSplineSurfacePy, Part::CirclePy, Part::ConePy, Part::CylinderPy, Part::EllipsePy, Part::FeaturePythonPy, Part::GeometryCurvePy, Part::GeometryPy, Part::GeometrySurfacePy, Part::HyperbolaPy, Part::LinePy, Part::OffsetCurvePy, Part::OffsetSurfacePy, Part::ParabolaPy, Part::Part2DObjectPy, Part::PartFeaturePy, Part::PlanePy, Part::RectangularTrimmedSurfacePy, Part::SpherePy, Part::SurfaceOfExtrusionPy, Part::SurfaceOfRevolutionPy, Part::TopoShapeCompoundPy, Part::TopoShapeCompSolidPy, Part::TopoShapeEdgePy, Part::TopoShapeFacePy, Part::TopoShapePy, Part::TopoShapeShellPy, Part::TopoShapeSolidPy, Part::TopoShapeVertexPy, Part::TopoShapeWirePy, Part::ToroidPy, Points::PointsPy, Robot::Robot6AxisPy, Robot::RobotObjectPy, Robot::TrajectoryPy, Robot::WaypointPy, Sketcher::ConstraintPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, and Sketcher::SketchPy.

Definition at line 192 of file PyObjectBase.h.

Referenced by __getattr().

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

Base::PyObjectBase Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation