Version: 9.12.0
_pyFilter Class Reference

A filter sets a human readable name to self. More...

#include <SMESH_2smeshpy.hxx>

Inheritance diagram for _pyFilter:

Public Member Functions

 _pyFilter (const Handle(_pyCommand)&theCreationCmd, const _pyID &newID="")
 Constructor of _pyFilter. More...
 
virtual void Process (const Handle(_pyCommand)&theCommand)
 To convert creation of a filter by criteria and to replace an old name by a new one. More...
 
virtual void Flush ()
 Set new filter name to the creation command and to myArgCmds. More...
 
const _pyIDGetNewID () const
 
const Handle (_pyCommand) &GetCreationCmd()
 
const _pyIDGetID ()
 
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 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
 

Private Attributes

_pyID myNewID
 
_pyID myMesh
 

Detailed Description

A filter sets a human readable name to self.

Constructor & Destructor Documentation

◆ _pyFilter()

_pyFilter::_pyFilter ( const Handle(_pyCommand)&  theCreationCmd,
const _pyID newID = "" 
)

Constructor of _pyFilter.

References _pyObject::GetID().

Member Function Documentation

◆ AccessorMethod()

const char * _pyObject::AccessorMethod ( ) const
virtualinherited

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)
inherited

References _pyObject::myArgCmds.

◆ AddProcessedCmd()

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

◆ CanClear()

bool _pyObject::CanClear ( )
virtualinherited

Return true if all my users can be cleared.

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

References _pyObject::Handle(), _pyObject::myArgCmds, and _pyObject::myIsPublished.

Referenced by _pyObject::ClearCommands().

◆ ClearCommands()

void _pyObject::ClearCommands ( )
virtualinherited

Clear myCreationCmd and myProcessedCmds.

Reimplemented in _pyHypothesis, _pyMesh, and _pyGen.

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

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

◆ FatherID()

_pyID _pyObject::FatherID ( const _pyID childID)
staticinherited

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

◆ Flush()

void _pyFilter::Flush ( )
virtual

Set new filter name to the creation command and to myArgCmds.

Implements _pyObject.

References _pyObject::GetID(), _pyObject::Handle(), _pyObject::myArgCmds, and myNewID.

◆ Free()

virtual void _pyObject::Free ( )
virtualinherited

◆ GetCommandNb()

int _pyObject::GetCommandNb ( )
inherited

◆ GetID()

◆ GetNbCalls()

int _pyObject::GetNbCalls ( ) const
inherited

References _pyObject::myProcessedCmds.

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

◆ GetNewID()

const _pyID& _pyFilter::GetNewID ( ) const

References myNewID.

◆ GetProcessedCmds()

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

◆ Handle() [1/2]

const _pyObject::Handle ( _pyCommand  ) &
inherited

◆ Handle() [2/2]

◆ IsInStudy()

◆ Process() [1/2]

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

◆ Process() [2/2]

◆ SetCreationCmd()

void _pyObject::SetCreationCmd ( Handle(_pyCommand cmd)
inherited

◆ setID()

void _pyObject::setID ( const _pyID theID)
protectedinherited

Set up myID and myIsPublished.

References _pyObject::GetID(), _pyObject::myID, and _pyObject::myIsPublished.

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

◆ SetRemovedFromStudy()

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

Reimplemented in _pyMesh.

References _pyObject::myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Field Documentation

◆ myArgCmds

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

◆ myID

_pyID _pyObject::myID
protectedinherited

◆ myIsPublished

◆ myMesh

_pyID _pyFilter::myMesh
private

Referenced by Process().

◆ myNewID

_pyID _pyFilter::myNewID
private

Referenced by Flush(), GetNewID(), and Process().

◆ myProcessedCmds

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