The python export class for PropertyContainer. More...

#include <PropertyContainerPy.h>

Public Types

typedef PropertyContainer * PointerType
 
- Public Types inherited from Base::PersistencePy
typedef Persistence * PointerType
 
- Public Types inherited from Base::BaseClassPy
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

virtual PyTypeObject * GetType (void)
 
 PropertyContainerPy (PropertyContainer *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
 
- Public Member Functions inherited from Base::PersistencePy
 PersistencePy (Persistence *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObject * dumpContent (PyObject *args, PyObject *kwd)
 implementer for the dumpContent() method More...
 
PyObject * restoreContent (PyObject *args)
 implementer for the restoreContent() method More...
 
Py::String getContent (void) const
 getter for the Content attribute More...
 
Py::Int getMemSize (void) const
 getter for the MemSize 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...
 
Persistence * getPersistencePtr (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
 
PyObject * isDerivedFrom (PyObject *args)
 implementer for the isDerivedFrom() method More...
 
PyObject * getAllDerivedFrom (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...
 
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...
 
- 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::PersistencePy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_dumpContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpContent() method More...
 
static PyObject * staticCallback_restoreContent (PyObject *self, PyObject *args)
 callback for the restoreContent() method More...
 
static PyObject * staticCallback_getContent (PyObject *self, void *closure)
 getter callback for the Content attribute More...
 
static int staticCallback_setContent (PyObject *self, PyObject *value, void *closure)
 setter callback for the Content attribute More...
 
static PyObject * staticCallback_getMemSize (PyObject *self, void *closure)
 getter callback for the MemSize attribute More...
 
static int staticCallback_setMemSize (PyObject *self, PyObject *value, void *closure)
 setter callback for the MemSize attribute More...
 
- Static Public Member Functions inherited from Base::BaseClassPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
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...
 
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...
 
- 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 PropertyContainerPy. More...
 
static PyMethodDef Methods []
 Methods structure of PropertyContainerPy. More...
 
static PyTypeObject Type
 Type structure of PropertyContainerPy. More...
 
- Static Public Attributes inherited from Base::PersistencePy
static PyGetSetDef GetterSetter []
 Attribute structure of PersistencePy. More...
 
static PyMethodDef Methods []
 Methods structure of PersistencePy. More...
 
static PyTypeObject Type
 Type structure of PersistencePy. 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

 ~PropertyContainerPy ()
 
- Protected Member Functions inherited from Base::PersistencePy
 ~PersistencePy ()
 
- Protected Member Functions inherited from Base::BaseClassPy
 ~BaseClassPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObject * getPropertyByName (PyObject *args)
 implementer for the getPropertyByName() method More...
 
PyObject * getTypeOfProperty (PyObject *args)
 implementer for the getTypeOfProperty() method More...
 
PyObject * getTypeIdOfProperty (PyObject *args)
 implementer for the getTypeIdOfProperty() method More...
 
PyObject * setEditorMode (PyObject *args)
 implementer for the setEditorMode() method More...
 
PyObject * getEditorMode (PyObject *args)
 implementer for the getEditorMode() method More...
 
PyObject * getGroupOfProperty (PyObject *args)
 implementer for the getGroupOfProperty() method More...
 
PyObject * getDocumentationOfProperty (PyObject *args)
 implementer for the getDocumentationOfProperty() method More...
 
PyObject * dumpPropertyContent (PyObject *args, PyObject *kwd)
 implementer for the dumpPropertyContent() method More...
 
PyObject * restorePropertyContent (PyObject *args)
 implementer for the restorePropertyContent() method More...
 
static PyObject * staticCallback_getPropertyByName (PyObject *self, PyObject *args)
 callback for the getPropertyByName() method More...
 
static PyObject * staticCallback_getTypeOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeOfProperty() method More...
 
static PyObject * staticCallback_getTypeIdOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeIdOfProperty() method More...
 
static PyObject * staticCallback_setEditorMode (PyObject *self, PyObject *args)
 callback for the setEditorMode() method More...
 
static PyObject * staticCallback_getEditorMode (PyObject *self, PyObject *args)
 callback for the getEditorMode() method More...
 
static PyObject * staticCallback_getGroupOfProperty (PyObject *self, PyObject *args)
 callback for the getGroupOfProperty() method More...
 
static PyObject * staticCallback_getDocumentationOfProperty (PyObject *self, PyObject *args)
 callback for the getDocumentationOfProperty() method More...
 
static PyObject * staticCallback_dumpPropertyContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpPropertyContent() method More...
 
static PyObject * staticCallback_restorePropertyContent (PyObject *self, PyObject *args)
 callback for the restorePropertyContent() method More...
 

callbacks and implementers for the python object attributes

Py::List getPropertiesList (void) const
 getter for the PropertiesList 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...
 
PropertyContainer * getPropertyContainerPtr (void) const
 getter for the object handled by this class More...
 
static PyObject * staticCallback_getPropertiesList (PyObject *self, void *closure)
 getter callback for the PropertiesList attribute More...
 
static int staticCallback_setPropertiesList (PyObject *self, PyObject *value, void *closure)
 setter callback for the PropertiesList attribute More...
 

Additional Inherited Members

- Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits
 

Detailed Description

The python export class for PropertyContainer.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~PropertyContainerPy()

PropertyContainerPy::~PropertyContainerPy ( )
protected

◆ PropertyContainerPy()

PropertyContainerPy::PropertyContainerPy ( PropertyContainer *  pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ dumpPropertyContent()

PyObject * PropertyContainerPy::dumpPropertyContent ( PyObject *  args,
PyObject *  kwd 
)

◆ getCustomAttributes()

◆ getDocumentationOfProperty()

◆ getEditorMode()

◆ getGroupOfProperty()

PyObject * PropertyContainerPy::getGroupOfProperty ( PyObject *  args)

◆ getPropertiesList()

Py::List PropertyContainerPy::getPropertiesList ( void  ) const

getter for the PropertiesList attribute

References getPropertyContainerPtr(), and App::PropertyContainer::getPropertyMap().

Referenced by staticCallback_getPropertiesList().

◆ getPropertyByName()

◆ getPropertyContainerPtr()

◆ GetType()

◆ getTypeIdOfProperty()

◆ getTypeOfProperty()

◆ PyInit()

◆ PyMake()

PyObject * PropertyContainerPy::PyMake ( struct _typeobject *  ,
PyObject *  ,
PyObject *   
)
static

◆ representation()

◆ restorePropertyContent()

PyObject * PropertyContainerPy::restorePropertyContent ( PyObject *  args)

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

References App::Property::getFullName(), App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), App::Property::Immutable, Base::BaseClass::setPyObject(), and App::Property::testStatus().

◆ setEditorMode()

◆ staticCallback_dumpPropertyContent()

PyObject * PropertyContainerPy::staticCallback_dumpPropertyContent ( PyObject *  self,
PyObject *  args,
PyObject *  kwd 
)
static

◆ staticCallback_getDocumentationOfProperty()

◆ staticCallback_getEditorMode()

◆ staticCallback_getGroupOfProperty()

◆ staticCallback_getPropertiesList()

PyObject * PropertyContainerPy::staticCallback_getPropertiesList ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getPropertyByName()

◆ staticCallback_getTypeIdOfProperty()

◆ staticCallback_getTypeOfProperty()

◆ staticCallback_restorePropertyContent()

◆ staticCallback_setEditorMode()

◆ staticCallback_setPropertiesList()

int PropertyContainerPy::staticCallback_setPropertiesList ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

setter callback for the PropertiesList attribute

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

Member Data Documentation

◆ GetterSetter

PyGetSetDef PropertyContainerPy::GetterSetter
static
Initial value:
= {
{"PropertiesList",
"A list of all property names",
NULL
},
{NULL, NULL, NULL, NULL, NULL}
}

Attribute structure of PropertyContainerPy.

◆ Methods

PyMethodDef PropertyContainerPy::Methods
static

Methods structure of PropertyContainerPy.

◆ Type


The documentation for this class was generated from the following files:
  • build/webdoc/src/App/PropertyContainerPy.h
  • src/App/PropertyContainerPyImp.cpp
  • build/webdoc/src/App/PropertyContainerPy.cpp
static int staticCallback_setPropertiesList(PyObject *self, PyObject *value, void *closure)
setter callback for the PropertiesList attribute
Definition: PropertyContainerPy.cpp:902
static PyObject * staticCallback_getPropertiesList(PyObject *self, void *closure)
getter callback for the PropertiesList attribute
Definition: PropertyContainerPy.cpp:884