The python export class for AttachEngine. More...

#include <AttachEnginePy.h>

Public Types

typedef AttachEngine * 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

 AttachEnginePy (AttachEngine *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::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::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 AttachEnginePy. More...
 
static PyMethodDef Methods []
 Methods structure of AttachEnginePy. More...
 
static PyTypeObject Type
 Type structure of AttachEnginePy. 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

 ~AttachEnginePy ()
 
- 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 * getModeInfo (PyObject *args)
 implementer for the getModeInfo() method More...
 
PyObject * getRefTypeOfShape (PyObject *args)
 implementer for the getRefTypeOfShape() method More...
 
PyObject * isFittingRefType (PyObject *args)
 implementer for the isFittingRefType() method More...
 
PyObject * downgradeRefType (PyObject *args)
 implementer for the downgradeRefType() method More...
 
PyObject * getRefTypeInfo (PyObject *args)
 implementer for the getRefTypeInfo() method More...
 
PyObject * copy (PyObject *args)
 implementer for the copy() method More...
 
PyObject * calculateAttachedPlacement (PyObject *args)
 implementer for the calculateAttachedPlacement() method More...
 
PyObject * suggestModes (PyObject *args)
 implementer for the suggestModes() method More...
 
PyObject * readParametersFromFeature (PyObject *args)
 implementer for the readParametersFromFeature() method More...
 
PyObject * writeParametersToFeature (PyObject *args)
 implementer for the writeParametersToFeature() method More...
 
static PyObject * staticCallback_getModeInfo (PyObject *self, PyObject *args)
 callback for the getModeInfo() method More...
 
static PyObject * staticCallback_getRefTypeOfShape (PyObject *self, PyObject *args)
 callback for the getRefTypeOfShape() method More...
 
static PyObject * staticCallback_isFittingRefType (PyObject *self, PyObject *args)
 callback for the isFittingRefType() method More...
 
static PyObject * staticCallback_downgradeRefType (PyObject *self, PyObject *args)
 callback for the downgradeRefType() method More...
 
static PyObject * staticCallback_getRefTypeInfo (PyObject *self, PyObject *args)
 callback for the getRefTypeInfo() method More...
 
static PyObject * staticCallback_copy (PyObject *self, PyObject *args)
 callback for the copy() method More...
 
static PyObject * staticCallback_calculateAttachedPlacement (PyObject *self, PyObject *args)
 callback for the calculateAttachedPlacement() method More...
 
static PyObject * staticCallback_suggestModes (PyObject *self, PyObject *args)
 callback for the suggestModes() method More...
 
static PyObject * staticCallback_readParametersFromFeature (PyObject *self, PyObject *args)
 callback for the readParametersFromFeature() method More...
 
static PyObject * staticCallback_writeParametersToFeature (PyObject *self, PyObject *args)
 callback for the writeParametersToFeature() method More...
 

callbacks and implementers for the python object attributes

Py::String getAttacherType (void) const
 getter for the AttacherType attribute More...
 
Py::String getMode (void) const
 getter for the Mode attribute More...
 
void setMode (Py::String arg)
 setter for the Mode attribute More...
 
Py::Object getReferences (void) const
 getter for the References attribute More...
 
void setReferences (Py::Object arg)
 setter for the References attribute More...
 
Py::Object getAttachmentOffset (void) const
 getter for the AttachmentOffset attribute More...
 
void setAttachmentOffset (Py::Object arg)
 setter for the AttachmentOffset attribute More...
 
Py::Boolean getReverse (void) const
 getter for the Reverse attribute More...
 
void setReverse (Py::Boolean arg)
 setter for the Reverse attribute More...
 
Py::Float getParameter (void) const
 getter for the Parameter attribute More...
 
void setParameter (Py::Float arg)
 setter for the Parameter attribute More...
 
Py::List getCompleteModeList (void) const
 getter for the CompleteModeList attribute More...
 
Py::List getImplementedModes (void) const
 getter for the ImplementedModes attribute More...
 
Py::List getCompleteRefTypeList (void) const
 getter for the CompleteRefTypeList 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...
 
AttachEngine * getAttachEnginePtr (void) const
 getter for the object handled by this class More...
 
static PyObject * staticCallback_getAttacherType (PyObject *self, void *closure)
 getter callback for the AttacherType attribute More...
 
static int staticCallback_setAttacherType (PyObject *self, PyObject *value, void *closure)
 setter callback for the AttacherType attribute More...
 
static PyObject * staticCallback_getMode (PyObject *self, void *closure)
 getter callback for the Mode attribute More...
 
static int staticCallback_setMode (PyObject *self, PyObject *value, void *closure)
 setter callback for the Mode attribute More...
 
static PyObject * staticCallback_getReferences (PyObject *self, void *closure)
 getter callback for the References attribute More...
 
static int staticCallback_setReferences (PyObject *self, PyObject *value, void *closure)
 setter callback for the References attribute More...
 
static PyObject * staticCallback_getAttachmentOffset (PyObject *self, void *closure)
 getter callback for the AttachmentOffset attribute More...
 
static int staticCallback_setAttachmentOffset (PyObject *self, PyObject *value, void *closure)
 setter callback for the AttachmentOffset attribute More...
 
static PyObject * staticCallback_getReverse (PyObject *self, void *closure)
 getter callback for the Reverse attribute More...
 
static int staticCallback_setReverse (PyObject *self, PyObject *value, void *closure)
 setter callback for the Reverse attribute More...
 
static PyObject * staticCallback_getParameter (PyObject *self, void *closure)
 getter callback for the Parameter attribute More...
 
static int staticCallback_setParameter (PyObject *self, PyObject *value, void *closure)
 setter callback for the Parameter attribute More...
 
static PyObject * staticCallback_getCompleteModeList (PyObject *self, void *closure)
 getter callback for the CompleteModeList attribute More...
 
static int staticCallback_setCompleteModeList (PyObject *self, PyObject *value, void *closure)
 setter callback for the CompleteModeList attribute More...
 
static PyObject * staticCallback_getImplementedModes (PyObject *self, void *closure)
 getter callback for the ImplementedModes attribute More...
 
static int staticCallback_setImplementedModes (PyObject *self, PyObject *value, void *closure)
 setter callback for the ImplementedModes attribute More...
 
static PyObject * staticCallback_getCompleteRefTypeList (PyObject *self, void *closure)
 getter callback for the CompleteRefTypeList attribute More...
 
static int staticCallback_setCompleteRefTypeList (PyObject *self, PyObject *value, void *closure)
 setter callback for the CompleteRefTypeList attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for AttachEngine.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~AttachEnginePy()

AttachEnginePy::~AttachEnginePy ( )
protected

◆ AttachEnginePy()

AttachEnginePy::AttachEnginePy ( AttachEngine *  pcObject,
PyTypeObject *  T = &Type 
)

Referenced by copy(), and PyMake().

Member Function Documentation

◆ calculateAttachedPlacement()

PyObject * AttachEnginePy::calculateAttachedPlacement ( PyObject *  args)

◆ copy()

PyObject * AttachEnginePy::copy ( PyObject *  args)

implementer for the copy() method

References AttachEnginePy(), and getAttachEnginePtr().

Referenced by staticCallback_copy().

◆ downgradeRefType()

◆ getAttachEnginePtr()

◆ getAttacherType()

Py::String AttachEnginePy::getAttacherType ( void  ) const

getter for the AttacherType attribute

References getAttachEnginePtr(), and Base::BaseClassPy::getTypeId().

Referenced by staticCallback_getAttacherType().

◆ getAttachmentOffset()

Py::Object AttachEnginePy::getAttachmentOffset ( void  ) const

getter for the AttachmentOffset attribute

References Attacher::AttachEngine::attachmentOffset, and getAttachEnginePtr().

Referenced by staticCallback_getAttachmentOffset().

◆ getCompleteModeList()

Py::List AttachEnginePy::getCompleteModeList ( void  ) const

◆ getCompleteRefTypeList()

Py::List AttachEnginePy::getCompleteRefTypeList ( void  ) const

◆ getCustomAttributes()

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

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

◆ getImplementedModes()

Py::List AttachEnginePy::getImplementedModes ( void  ) const

◆ getMode()

Py::String AttachEnginePy::getMode ( void  ) const

◆ getModeInfo()

◆ getParameter()

Py::Float AttachEnginePy::getParameter ( void  ) const

getter for the Parameter attribute

References Attacher::AttachEngine::attachParameter, and getAttachEnginePtr().

Referenced by staticCallback_getParameter().

◆ getReferences()

Py::Object AttachEnginePy::getReferences ( void  ) const

◆ getRefTypeInfo()

◆ getRefTypeOfShape()

PyObject * AttachEnginePy::getRefTypeOfShape ( PyObject *  args)

◆ getReverse()

Py::Boolean AttachEnginePy::getReverse ( void  ) const

getter for the Reverse attribute

References getAttachEnginePtr(), and Attacher::AttachEngine::mapReverse.

Referenced by staticCallback_getReverse().

◆ GetType()

virtual PyTypeObject* Attacher::AttachEnginePy::GetType ( void  )
virtual

Reimplemented from Base::BaseClassPy.

◆ isFittingRefType()

PyObject * AttachEnginePy::isFittingRefType ( PyObject *  args)

◆ PyInit()

int AttachEnginePy::PyInit ( PyObject *  ,
PyObject *   
)
virtual

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

Reimplemented from Base::BaseClassPy.

References Base::BaseExceptionFreeCADError, Attacher::AttachEngine::copy(), Base::Type::createInstanceByName(), Base::Type::fromName(), getAttachEnginePtr(), Base::BaseClass::getClassTypeId(), PyType_Object::o, and Type.

◆ PyMake()

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

References AttachEnginePy().

◆ readParametersFromFeature()

◆ representation()

◆ setAttachmentOffset()

void AttachEnginePy::setAttachmentOffset ( Py::Object  arg)

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setMode()

void AttachEnginePy::setMode ( Py::String  arg)

◆ setParameter()

void AttachEnginePy::setParameter ( Py::Float  arg)

setter for the Parameter attribute

References Attacher::AttachEngine::attachParameter, and getAttachEnginePtr().

Referenced by staticCallback_setParameter().

◆ setReferences()

void AttachEnginePy::setReferences ( Py::Object  arg)

◆ setReverse()

void AttachEnginePy::setReverse ( Py::Boolean  arg)

setter for the Reverse attribute

References getAttachEnginePtr(), and Attacher::AttachEngine::mapReverse.

Referenced by staticCallback_setReverse().

◆ staticCallback_calculateAttachedPlacement()

PyObject * AttachEnginePy::staticCallback_calculateAttachedPlacement ( PyObject *  self,
PyObject *  args 
)
static

◆ staticCallback_copy()

PyObject * AttachEnginePy::staticCallback_copy ( PyObject *  self,
PyObject *  args 
)
static

◆ staticCallback_downgradeRefType()

◆ staticCallback_getAttacherType()

PyObject * AttachEnginePy::staticCallback_getAttacherType ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getAttachmentOffset()

PyObject * AttachEnginePy::staticCallback_getAttachmentOffset ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getCompleteModeList()

PyObject * AttachEnginePy::staticCallback_getCompleteModeList ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getCompleteRefTypeList()

PyObject * AttachEnginePy::staticCallback_getCompleteRefTypeList ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getImplementedModes()

PyObject * AttachEnginePy::staticCallback_getImplementedModes ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getMode()

PyObject * AttachEnginePy::staticCallback_getMode ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getModeInfo()

◆ staticCallback_getParameter()

PyObject * AttachEnginePy::staticCallback_getParameter ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getReferences()

PyObject * AttachEnginePy::staticCallback_getReferences ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_getRefTypeInfo()

◆ staticCallback_getRefTypeOfShape()

◆ staticCallback_getReverse()

PyObject * AttachEnginePy::staticCallback_getReverse ( PyObject *  self,
void *  closure 
)
static

◆ staticCallback_isFittingRefType()

◆ staticCallback_readParametersFromFeature()

◆ staticCallback_setAttacherType()

int AttachEnginePy::staticCallback_setAttacherType ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

setter callback for the AttacherType attribute

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

◆ staticCallback_setAttachmentOffset()

int AttachEnginePy::staticCallback_setAttachmentOffset ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

◆ staticCallback_setCompleteModeList()

int AttachEnginePy::staticCallback_setCompleteModeList ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

setter callback for the CompleteModeList attribute

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

◆ staticCallback_setCompleteRefTypeList()

int AttachEnginePy::staticCallback_setCompleteRefTypeList ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

setter callback for the CompleteRefTypeList attribute

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

◆ staticCallback_setImplementedModes()

int AttachEnginePy::staticCallback_setImplementedModes ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

setter callback for the ImplementedModes attribute

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

◆ staticCallback_setMode()

int AttachEnginePy::staticCallback_setMode ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

◆ staticCallback_setParameter()

int AttachEnginePy::staticCallback_setParameter ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

◆ staticCallback_setReferences()

int AttachEnginePy::staticCallback_setReferences ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

◆ staticCallback_setReverse()

int AttachEnginePy::staticCallback_setReverse ( PyObject *  self,
PyObject *  value,
void *  closure 
)
static

◆ staticCallback_suggestModes()

◆ staticCallback_writeParametersToFeature()

◆ suggestModes()

◆ writeParametersToFeature()

Member Data Documentation

◆ GetterSetter

PyGetSetDef AttachEnginePy::GetterSetter
static

Attribute structure of AttachEnginePy.

◆ Methods

PyMethodDef AttachEnginePy::Methods
static

Methods structure of AttachEnginePy.

◆ Type


The documentation for this class was generated from the following files:
  • build/webdoc/src/Mod/Part/App/AttachEnginePy.h
  • src/Mod/Part/App/AttachEnginePyImp.cpp
  • build/webdoc/src/Mod/Part/App/AttachEnginePy.cpp