Version: 9.12.0
_pyObject Class Referenceabstract

Root of all objects. More...

#include <SMESH_2smeshpy.hxx>

Inheritance diagram for _pyObject:

Public Member Functions

 _pyObject (const Handle(_pyCommand)&theCreationCmd, const _pyID &theID=_pyID())
 Creates pyObject. More...
 
const _pyIDGetID ()
 
const Handle (_pyCommand) &GetCreationCmd()
 
int GetNbCalls () const
 
bool IsInStudy () const
 
virtual void SetRemovedFromStudy (const bool isRemoved)
 
void SetCreationCmd (Handle(_pyCommand) cmd)
 
int GetCommandNb ()
 
void AddProcessedCmd (const Handle(_pyCommand) &cmd)
 
std::list< Handle(_pyCommand) > & GetProcessedCmds ()
 
void AddArgCmd (const Handle(_pyCommand) &cmd)
 
virtual void Process (const Handle(_pyCommand) &cmd)
 
virtual void Flush ()=0
 
virtual const char * AccessorMethod () const
 Return method name giving access to an interaface object wrapped by python class. More...
 
virtual bool CanClear ()
 Return true if all my users can be cleared. More...
 
virtual void ClearCommands ()
 Clear myCreationCmd and myProcessedCmds. More...
 
virtual void Free ()
 

Static Public Member Functions

static _pyID FatherID (const _pyID &childID)
 Return ID of a father. More...
 

Protected Member Functions

 Handle (_pyCommand) myCreationCmd
 
void setID (const _pyID &theID)
 Set up myID and myIsPublished. More...
 

Protected Attributes

_pyID myID
 
std::list< Handle(_pyCommand) > myProcessedCmds
 
std::list< Handle(_pyCommand) > myArgCmds
 
bool myIsPublished
 

Detailed Description

Root of all objects.

It counts calls of Process()

Constructor & Destructor Documentation

◆ _pyObject()

_pyObject::_pyObject ( const Handle(_pyCommand)&  theCreationCmd,
const _pyID theID = _pyID() 
)

Creates pyObject.

References setID().

Member Function Documentation

◆ AccessorMethod()

const char * _pyObject::AccessorMethod ( ) const
virtual

Return method name giving access to an interaface object wrapped by python class.

Return values
constchar* - method name

Reimplemented in _pyAlgorithm, _pyMesh, and _pyGen.

◆ AddArgCmd()

void _pyObject::AddArgCmd ( const Handle(_pyCommand) &  cmd)

References myArgCmds.

◆ AddProcessedCmd()

void _pyObject::AddProcessedCmd ( const Handle(_pyCommand) &  cmd)

References myProcessedCmds.

Referenced by Process().

◆ CanClear()

bool _pyObject::CanClear ( )
virtual

Return true if all my users can be cleared.

Reimplemented in _pyGroup, _pySelfEraser, _pyHypothesis, _pyMeshEditor, and _pyMesh.

References Handle(), myArgCmds, and myIsPublished.

Referenced by ClearCommands().

◆ ClearCommands()

void _pyObject::ClearCommands ( )
virtual

Clear myCreationCmd and myProcessedCmds.

Reimplemented in _pyHypothesis, _pyMesh, and _pyGen.

References CanClear(), Handle(), and myProcessedCmds.

Referenced by _pyMesh::ClearCommands(), _pyHypothesis::ClearCommands(), and _pySelfEraser::Flush().

◆ FatherID()

_pyID _pyObject::FatherID ( const _pyID childID)
static

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

◆ Flush()

◆ Free()

virtual void _pyObject::Free ( )
virtual

◆ GetCommandNb()

int _pyObject::GetCommandNb ( )

◆ GetID()

◆ GetNbCalls()

int _pyObject::GetNbCalls ( ) const

References myProcessedCmds.

Referenced by _pySubMesh::Flush(), and _pyFilter::Process().

◆ GetProcessedCmds()

std::list< Handle(_pyCommand) >& _pyObject::GetProcessedCmds ( )

References myProcessedCmds.

Referenced by _pySelfEraser::CanClear().

◆ Handle() [1/2]

const _pyObject::Handle ( _pyCommand  ) &

◆ Handle() [2/2]

◆ IsInStudy()

◆ Process()

virtual void _pyObject::Process ( const Handle(_pyCommand) &  cmd)
virtual

◆ SetCreationCmd()

void _pyObject::SetCreationCmd ( Handle(_pyCommand cmd)

◆ setID()

void _pyObject::setID ( const _pyID theID)
protected

Set up myID and myIsPublished.

References GetID(), myID, and myIsPublished.

Referenced by _pyGroup::_pyGroup(), and _pyObject().

◆ SetRemovedFromStudy()

virtual void _pyObject::SetRemovedFromStudy ( const bool  isRemoved)
virtual

Reimplemented in _pyMesh.

References myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Field Documentation

◆ myArgCmds

std::list< Handle(_pyCommand) > _pyObject::myArgCmds
protected

◆ myID

_pyID _pyObject::myID
protected

Referenced by GetID(), and setID().

◆ myIsPublished

bool _pyObject::myIsPublished
protected

◆ myProcessedCmds

std::list< Handle(_pyCommand) > _pyObject::myProcessedCmds
protected