App::GroupExtensionPy Class Reference

The python export class for GroupExtension. More...

#include <GroupExtensionPy.h>

Public Types
typedef GroupExtension *	PointerType
Public Types inherited from App::DocumentObjectExtensionPy
typedef DocumentObjectExtension *	PointerType
Public Types inherited from App::ExtensionPy
typedef Extension *	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)
	GroupExtensionPy (GroupExtension *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...
GroupExtension *	getGroupExtensionPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from App::DocumentObjectExtensionPy
	DocumentObjectExtensionPy (DocumentObjectExtension *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
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...
DocumentObjectExtension *	getDocumentObjectExtensionPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from App::ExtensionPy
	ExtensionPy (Extension *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
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...
Extension *	getExtensionPtr (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 App::DocumentObjectExtensionPy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
Static Public Member Functions inherited from App::ExtensionPy
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 GroupExtensionPy. More...
static PyMethodDef	Methods []
	Methods structure of GroupExtensionPy. More...
static PyTypeObject	Type
	Type structure of GroupExtensionPy. More...
Static Public Attributes inherited from App::DocumentObjectExtensionPy
static PyGetSetDef	GetterSetter []
	Attribute structure of DocumentObjectExtensionPy. More...
static PyMethodDef	Methods []
	Methods structure of DocumentObjectExtensionPy. More...
static PyTypeObject	Type
	Type structure of DocumentObjectExtensionPy. More...
Static Public Attributes inherited from App::ExtensionPy
static PyGetSetDef	GetterSetter []
	Attribute structure of ExtensionPy. More...
static PyMethodDef	Methods []
	Methods structure of ExtensionPy. More...
static PyTypeObject	Type
	Type structure of ExtensionPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

Protected Member Functions
	~GroupExtensionPy ()
Protected Member Functions inherited from App::DocumentObjectExtensionPy
	~DocumentObjectExtensionPy ()
Protected Member Functions inherited from App::ExtensionPy
	~ExtensionPy ()
Protected Member Functions inherited from Base::PyObjectBase
virtual	~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
PyObject *	newObject (PyObject *args)
	implementer for the newObject() method More...
PyObject *	addObject (PyObject *args)
	implementer for the addObject() method More...
PyObject *	addObjects (PyObject *args)
	implementer for the addObjects() method More...
PyObject *	setObjects (PyObject *args)
	implementer for the setObjects() method More...
PyObject *	removeObject (PyObject *args)
	implementer for the removeObject() method More...
PyObject *	removeObjects (PyObject *args)
	implementer for the removeObjects() method More...
PyObject *	removeObjectsFromDocument (PyObject *args)
	implementer for the removeObjectsFromDocument() method More...
PyObject *	getObject (PyObject *args)
	implementer for the getObject() method More...
PyObject *	hasObject (PyObject *args)
	implementer for the hasObject() method More...
static PyObject *	staticCallback_newObject (PyObject *self, PyObject *args)
	callback for the newObject() method More...
static PyObject *	staticCallback_addObject (PyObject *self, PyObject *args)
	callback for the addObject() method More...
static PyObject *	staticCallback_addObjects (PyObject *self, PyObject *args)
	callback for the addObjects() method More...
static PyObject *	staticCallback_setObjects (PyObject *self, PyObject *args)
	callback for the setObjects() method More...
static PyObject *	staticCallback_removeObject (PyObject *self, PyObject *args)
	callback for the removeObject() method More...
static PyObject *	staticCallback_removeObjects (PyObject *self, PyObject *args)
	callback for the removeObjects() method More...
static PyObject *	staticCallback_removeObjectsFromDocument (PyObject *self, PyObject *args)
	callback for the removeObjectsFromDocument() method More...
static PyObject *	staticCallback_getObject (PyObject *self, PyObject *args)
	callback for the getObject() method More...
static PyObject *	staticCallback_hasObject (PyObject *self, PyObject *args)
	callback for the hasObject() method More...

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

Detailed Description

The python export class for GroupExtension.

Member Typedef Documentation

PointerType

typedef GroupExtension* App::GroupExtensionPy::PointerType

Constructor & Destructor Documentation

~GroupExtensionPy()

GroupExtensionPy::~GroupExtensionPy ( )

protected

GroupExtensionPy()

GroupExtensionPy::GroupExtensionPy	(	GroupExtension *	pcObject,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

addObject()

PyObject * GroupExtensionPy::addObject

(

PyObject *

args

)

implementer for the addObject() method

References App::GroupExtension::addObject(), Base::BaseExceptionFreeCADError, App::DocumentObject::getDocument(), App::DocumentObjectPy::getDocumentObjectPtr(), App::ExtensionContainer::getExtensionByType(), getGroupExtensionPtr(), App::DocumentObject::getNameInDocument(), App::ExtensionContainer::hasExtension(), App::GroupExtension::hasObject(), and App::DocumentObjectPy::Type.

Referenced by ArchPanel.NestTaskPanel::getContainer(), ArchPanel.NestTaskPanel::getShapes(), and staticCallback_addObject().

addObjects()

PyObject * GroupExtensionPy::addObjects

(

PyObject *

args

)

implementer for the addObjects() method

References App::GroupExtension::addObjects(), App::DocumentObjectPy::getDocumentObjectPtr(), getGroupExtensionPtr(), and App::DocumentObjectPy::Type.

Referenced by staticCallback_addObjects().

getCustomAttributes()

PyObject * GroupExtensionPy::getCustomAttributes

(

const char *

attr

)

const

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

getGroupExtensionPtr()

GroupExtension * GroupExtensionPy::getGroupExtensionPtr

(

void

)

const

getter for the object handled by this class

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

getObject()

PyObject * GroupExtensionPy::getObject

(

PyObject *

args

)

implementer for the getObject() method

References getGroupExtensionPtr(), App::GroupExtension::getObject(), and App::DocumentObject::getPyObject().

Referenced by staticCallback_getObject().

GetType()

virtual PyTypeObject* App::GroupExtensionPy::GetType ( void  )

virtual

Reimplemented from App::DocumentObjectExtensionPy.

Reimplemented in App::GeoFeatureGroupExtensionPy, and App::OriginGroupExtensionPy.

hasObject()

PyObject * GroupExtensionPy::hasObject

(

PyObject *

args

)

implementer for the hasObject() method

References Base::BaseExceptionFreeCADError, App::DocumentObject::getDocument(), App::DocumentObjectPy::getDocumentObjectPtr(), getGroupExtensionPtr(), App::DocumentObject::getNameInDocument(), App::GroupExtension::hasObject(), and App::DocumentObjectPy::Type.

Referenced by staticCallback_hasObject().

newObject()

PyObject * GroupExtensionPy::newObject

(

PyObject *

args

)

implementer for the newObject() method

References App::GroupExtension::addObject(), Base::BaseExceptionFreeCADError, getGroupExtensionPtr(), and App::DocumentObject::getPyObject().

Referenced by staticCallback_newObject().

PyInit()

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

virtual

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

Reimplemented from App::DocumentObjectExtensionPy.

Reimplemented in App::GeoFeatureGroupExtensionPy, and App::OriginGroupExtensionPy.

PyMake()

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

static

removeObject()

PyObject * GroupExtensionPy::removeObject

(

PyObject *

args

)

implementer for the removeObject() method

References Base::BaseExceptionFreeCADError, App::DocumentObject::getDocument(), App::DocumentObjectPy::getDocumentObjectPtr(), getGroupExtensionPtr(), App::DocumentObject::getNameInDocument(), App::GroupExtension::removeObject(), and App::DocumentObjectPy::Type.

Referenced by staticCallback_removeObject().

removeObjects()

PyObject * GroupExtensionPy::removeObjects

(

PyObject *

args

)

implementer for the removeObjects() method

References App::DocumentObjectPy::getDocumentObjectPtr(), getGroupExtensionPtr(), App::GroupExtension::removeObjects(), and App::DocumentObjectPy::Type.

Referenced by staticCallback_removeObjects().

removeObjectsFromDocument()

PyObject * GroupExtensionPy::removeObjectsFromDocument

(

PyObject *

args

)

implementer for the removeObjectsFromDocument() method

References getGroupExtensionPtr(), and App::GroupExtension::removeObjectsFromDocument().

Referenced by staticCallback_removeObjectsFromDocument().

representation()

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

setter for special attributes (e.g.

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

setObjects()

PyObject * GroupExtensionPy::setObjects

(

PyObject *

args

)

implementer for the setObjects() method

References App::DocumentObjectPy::getDocumentObjectPtr(), getGroupExtensionPtr(), App::GroupExtension::setObjects(), and App::DocumentObjectPy::Type.

Referenced by staticCallback_setObjects().

staticCallback_addObject()

PyObject * GroupExtensionPy::staticCallback_addObject ( PyObject *  self, PyObject *  args  )

static

callback for the addObject() method

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

staticCallback_addObjects()

PyObject * GroupExtensionPy::staticCallback_addObjects ( PyObject *  self, PyObject *  args  )

static

callback for the addObjects() method

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

staticCallback_getObject()

PyObject * GroupExtensionPy::staticCallback_getObject ( PyObject *  self, PyObject *  args  )

static

callback for the getObject() method

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

staticCallback_hasObject()

PyObject * GroupExtensionPy::staticCallback_hasObject ( PyObject *  self, PyObject *  args  )

static

callback for the hasObject() method

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

staticCallback_newObject()

PyObject * GroupExtensionPy::staticCallback_newObject ( PyObject *  self, PyObject *  args  )

static

callback for the newObject() method

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

staticCallback_removeObject()

PyObject * GroupExtensionPy::staticCallback_removeObject ( PyObject *  self, PyObject *  args  )

static

callback for the removeObject() method

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

staticCallback_removeObjects()

PyObject * GroupExtensionPy::staticCallback_removeObjects ( PyObject *  self, PyObject *  args  )

static

callback for the removeObjects() method

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

staticCallback_removeObjectsFromDocument()

PyObject * GroupExtensionPy::staticCallback_removeObjectsFromDocument ( PyObject *  self, PyObject *  args  )

static

callback for the removeObjectsFromDocument() method

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

staticCallback_setObjects()

PyObject * GroupExtensionPy::staticCallback_setObjects ( PyObject *  self, PyObject *  args  )

static

callback for the setObjects() method

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

Member Data Documentation

GetterSetter

PyGetSetDef GroupExtensionPy::GetterSetter

static

Initial value:

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

Attribute structure of GroupExtensionPy.

Methods

PyMethodDef GroupExtensionPy::Methods

static

Methods structure of GroupExtensionPy.

Type

PyTypeObject GroupExtensionPy::Type

static

Type structure of GroupExtensionPy.

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/App/GroupExtensionPy.h
• src/App/GroupExtensionPyImp.cpp
• build/webdoc/src/App/GroupExtensionPy.cpp