App::DocumentObjectGroupPy Class Reference

The python export class for DocumentObjectGroup. More...

#include <DocumentObjectGroupPy.h>

Inheritance diagram for App::DocumentObjectGroupPy:

Public Types
typedef DocumentObjectGroup *	PointerType
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.
	DocumentObjectGroupPy (DocumentObjectGroup pcObject, PyTypeObject T=&Type)
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones)
DocumentObjectGroup *	getDocumentObjectGroupPtr (void) const
	getter for the object handled by this class
virtual PyParentObject *	GetParents (void)
virtual PyTypeObject *	GetType (void)
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)
	~DocumentObjectGroupPy ()
Static Public Member Functions
static PyObject *	PyMake (struct _typeobject , PyObject , PyObject *)
Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of DocumentObjectGroupPy.
static PyMethodDef	Methods []
	Methods structure of DocumentObjectGroupPy.
static PyParentObject	Parents [] = { PARENTSAppDocumentObjectGroupPy }
static PyTypeObject	Type
	Type structure of DocumentObjectGroupPy.
callbacks and implementers for the python object methods

PyObject *	addObject (PyObject *args)
	implementer for the addObject() method
PyObject *	getObject (PyObject *args)
	implementer for the getObject() method
PyObject *	hasObject (PyObject *args)
	implementer for the hasObject() method
PyObject *	newObject (PyObject *args)
	implementer for the newObject() method
PyObject *	removeObject (PyObject *args)
	implementer for the removeObject() method
PyObject *	removeObjectsFromDocument (PyObject *args)
	implementer for the removeObjectsFromDocument() method
static PyObject *	staticCallback_addObject (PyObject self, PyObject args)
	callback for the addObject() method
static PyObject *	staticCallback_getObject (PyObject self, PyObject args)
	callback for the getObject() method
static PyObject *	staticCallback_hasObject (PyObject self, PyObject args)
	callback for the hasObject() method
static PyObject *	staticCallback_newObject (PyObject self, PyObject args)
	callback for the newObject() method
static PyObject *	staticCallback_removeObject (PyObject self, PyObject args)
	callback for the removeObject() method
static PyObject *	staticCallback_removeObjectsFromDocument (PyObject self, PyObject args)
	callback for the removeObjectsFromDocument() method

Detailed Description

The python export class for DocumentObjectGroup.

Definition at line 20 of file DocumentObjectGroupPy.h.

Member Typedef Documentation

typedef DocumentObjectGroup* App::DocumentObjectGroupPy::PointerType

Reimplemented from App::DocumentObjectPy.

Definition at line 36 of file DocumentObjectGroupPy.h.

Constructor & Destructor Documentation

DocumentObjectGroupPy::DocumentObjectGroupPy	(	DocumentObjectGroup *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Definition at line 581 of file DocumentObjectGroupPy.cpp.

DocumentObjectGroupPy::~DocumentObjectGroupPy ( )

Definition at line 602 of file DocumentObjectGroupPy.cpp.

Member Function Documentation

PyObject * DocumentObjectGroupPy::_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 App::DocumentObjectPy.

Definition at line 617 of file DocumentObjectGroupPy.cpp.

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

PyObject * DocumentObjectGroupPy::_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 App::DocumentObjectPy.

Definition at line 609 of file DocumentObjectGroupPy.cpp.

References representation().

int DocumentObjectGroupPy::_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 App::DocumentObjectPy.

Definition at line 685 of file DocumentObjectGroupPy.cpp.

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

PyObject * DocumentObjectGroupPy::addObject ( PyObject * args )

implementer for the addObject() method

Definition at line 57 of file DocumentObjectGroupPyImp.cpp.

References App::DocumentObjectGroup::addObject(), App::PropertyContainer::getClassTypeId(), App::DocumentObject::getDocument(), getDocumentObjectGroupPtr(), App::DocumentObjectPy::getDocumentObjectPtr(), App::DocumentObject::getNameInDocument(), App::PropertyContainer::getTypeId(), App::DocumentObjectGroup::isChildOf(), Base::Type::isDerivedFrom(), Py_Return, and App::DocumentObjectPy::Type.

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

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

Reimplemented from App::DocumentObjectPy.

Definition at line 157 of file DocumentObjectGroupPyImp.cpp.

Referenced by _getattr().

DocumentObjectGroup * DocumentObjectGroupPy::getDocumentObjectGroupPtr ( void ) const

getter for the object handled by this class

Definition at line 744 of file DocumentObjectGroupPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by addObject(), getObject(), hasObject(), newObject(), removeObject(), and removeObjectsFromDocument().

PyObject * DocumentObjectGroupPy::getObject ( PyObject * args )

implementer for the getObject() method

Definition at line 117 of file DocumentObjectGroupPyImp.cpp.

References getDocumentObjectGroupPtr(), App::DocumentObjectGroup::getObject(), App::DocumentObject::getPyObject(), and Py_Return.

virtual PyParentObject* App::DocumentObjectGroupPy::GetParents ( void ) [inline, virtual]

Reimplemented from App::DocumentObjectPy.

Definition at line 28 of file DocumentObjectGroupPy.h.

virtual PyTypeObject* App::DocumentObjectGroupPy::GetType ( void ) [inline, virtual]

Reimplemented from App::DocumentObjectPy.

Definition at line 27 of file DocumentObjectGroupPy.h.

PyObject * DocumentObjectGroupPy::hasObject ( PyObject * args )

implementer for the hasObject() method

Definition at line 131 of file DocumentObjectGroupPyImp.cpp.

References App::DocumentObject::getDocument(), getDocumentObjectGroupPtr(), App::DocumentObjectPy::getDocumentObjectPtr(), App::DocumentObject::getNameInDocument(), and App::DocumentObjectPy::Type.

PyObject * DocumentObjectGroupPy::newObject ( PyObject * args )

implementer for the newObject() method

Definition at line 41 of file DocumentObjectGroupPyImp.cpp.

References App::DocumentObjectGroup::addObject(), getDocumentObjectGroupPtr(), and App::DocumentObject::getPyObject().

int DocumentObjectGroupPy::PyInit	(	PyObject *	,
		PyObject *
	)			`[virtual]`

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

Reimplemented from App::DocumentObjectPy.

Definition at line 594 of file DocumentObjectGroupPy.cpp.

PyObject * DocumentObjectGroupPy::PyMake	(	struct _typeobject *	,
		PyObject *	,
		PyObject *
	)			`[static]`

Reimplemented from App::DocumentObjectPy.

Definition at line 586 of file DocumentObjectGroupPy.cpp.

PyObject * DocumentObjectGroupPy::removeObject ( PyObject * args )

implementer for the removeObject() method

Definition at line 88 of file DocumentObjectGroupPyImp.cpp.

References App::DocumentObject::getDocument(), getDocumentObjectGroupPtr(), App::DocumentObjectPy::getDocumentObjectPtr(), App::DocumentObject::getNameInDocument(), Py_Return, App::DocumentObjectGroup::removeObject(), and App::DocumentObjectPy::Type.

PyObject * DocumentObjectGroupPy::removeObjectsFromDocument ( PyObject * args )

implementer for the removeObjectsFromDocument() method

Definition at line 108 of file DocumentObjectGroupPyImp.cpp.

References getDocumentObjectGroupPtr(), Py_Return, and App::DocumentObjectGroup::removeObjectsFromDocument().

std::string DocumentObjectGroupPy::representation ( void ) const

Reimplemented from App::DocumentObjectPy.

Definition at line 36 of file DocumentObjectGroupPyImp.cpp.

Referenced by _repr().

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

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

Reimplemented from App::DocumentObjectPy.

Definition at line 162 of file DocumentObjectGroupPyImp.cpp.

Referenced by _setattr().

PyObject * DocumentObjectGroupPy::staticCallback_addObject	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the addObject() method

Definition at line 194 of file DocumentObjectGroupPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * DocumentObjectGroupPy::staticCallback_getObject	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the getObject() method

Definition at line 422 of file DocumentObjectGroupPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * DocumentObjectGroupPy::staticCallback_hasObject	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the hasObject() method

Definition at line 498 of file DocumentObjectGroupPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * DocumentObjectGroupPy::staticCallback_newObject	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the newObject() method

Definition at line 118 of file DocumentObjectGroupPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * DocumentObjectGroupPy::staticCallback_removeObject	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the removeObject() method

Definition at line 270 of file DocumentObjectGroupPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * DocumentObjectGroupPy::staticCallback_removeObjectsFromDocument	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the removeObjectsFromDocument() method

Definition at line 346 of file DocumentObjectGroupPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

Member Data Documentation

PyGetSetDef DocumentObjectGroupPy::GetterSetter [static]

Initial value:

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

Attribute structure of DocumentObjectGroupPy.

Reimplemented from App::DocumentObjectPy.

Definition at line 25 of file DocumentObjectGroupPy.h.

PyMethodDef DocumentObjectGroupPy::Methods [static]

Methods structure of DocumentObjectGroupPy.

Reimplemented from App::DocumentObjectPy.

Definition at line 24 of file DocumentObjectGroupPy.h.

Referenced by _getattr().

PyParentObject DocumentObjectGroupPy::Parents = { PARENTSAppDocumentObjectGroupPy } [static]

Reimplemented from App::DocumentObjectPy.

Definition at line 26 of file DocumentObjectGroupPy.h.

PyTypeObject DocumentObjectGroupPy::Type [static]

Type structure of DocumentObjectGroupPy.

Reimplemented from App::DocumentObjectPy.

Definition at line 23 of file DocumentObjectGroupPy.h.

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

App::DocumentObjectGroupPy Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

callbacks and implementers for the python object methods

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation