_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 _pyID &	GetNewID () const
const	Handle (_pyCommand)&GetCreationCmd()
const _pyID &	GetID ()
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 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	(	const Handle(_pyCommand)&	theCreationCmd,
		const _pyID &	newID = ""
	)

Constructor of _pyFilter.

References _pyObject::GetID(), and _pyGen::KeepAgrCmds().

Member Function Documentation

const char * _pyObject::AccessorMethod ( ) const

virtualinherited

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

Return values

const

char* - method name

Reimplemented in _pyAlgorithm, _pyMesh, and _pyGen.

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

inherited

References _pyObject::myArgCmds.

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

inherited

References _pyObject::myProcessedCmds.

Referenced by _pyObject::Process().

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(), and _pySelfEraser::IsAliveCmd().

void _pyObject::ClearCommands ( )

virtualinherited

Clear myCreationCmd and myProcessedCmds.

Reimplemented in _pyHypothesis, _pyMesh, and _pyGen.

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

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

_pyID _pyObject::FatherID ( const _pyID &  childID )

staticinherited

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

void _pyFilter::Flush ( )

virtual

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

Implements _pyObject.

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

virtual void _pyObject::Free ( )

virtualinherited

Reimplemented in _pyGroup, _pySubMesh, _pyLayerDistributionHypo, _pyHypothesis, _pyMesh, and _pyGen.

int _pyObject::GetCommandNb ( )

inherited

const _pyID& _pyObject::GetID ( )

inherited

References _pyCommand::GetResultValue(), and _pyObject::myID.

Referenced by _pyFilter(), _pyMesh::_pyMesh(), _pySelfEraser::_pySelfEraser(), _pySubMesh::_pySubMesh(), _pyMesh::addFatherMesh(), _pyHypothesis::Addition2Creation(), _pyAlgorithm::Addition2Creation(), _pyLayerDistributionHypo::Addition2Creation(), _pyGen::AddObject(), _pySelfEraser::CanClear(), _pyGroup::CanClear(), _pyGen::CheckObjectIsReCreated(), _pyMesh::Flush(), Flush(), Process(), and _pyObject::setID().

int _pyObject::GetNbCalls ( ) const

inherited

References _pyObject::myProcessedCmds.

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

const _pyID& _pyFilter::GetNewID

(

)

const

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

inherited

References _pyObject::myProcessedCmds.

Referenced by _pySelfEraser::CanClear().

_pyObject::Handle ( _pyCommand  )

protectedinherited

Referenced by _pyMeshEditor::_pyMeshEditor(), _pyObject::CanClear(), _pyMeshEditor::CanClear(), and _pySelfEraser::IsAliveCmd().

const _pyObject::Handle ( _pyCommand  )

inherited

bool _pyObject::IsInStudy ( ) const

inherited

References _pyObject::myIsPublished.

Referenced by _pyMesh::CanClear(), _pyHypothesis::CanClear(), _pyGroup::CanClear(), _pyMesh::ClearCommands(), _pyHypothesis::GetReferredMeshesAndGeom(), and _pyHypothesis::IsWrappable().

void _pyFilter::Process ( const Handle(_pyCommand)&  theCommand )

virtual

To convert creation of a filter by criteria and to replace an old name by a new one.

Reimplemented from _pyObject.

References _pyCommand::AddDependantCmd(), _pyGen::AddMeshAccessorMethod(), _pyCommand::Clear(), SMESH_2smeshpy::GenName(), _pyCommand::GetArg(), _pyObject::GetID(), _pyCommand::GetMethod(), _pyObject::GetNbCalls(), _pyCommand::GetObject(), _pyCommand::GetString(), myMesh, myNewID, _pyObject::Process(), _pyCommand::SetMethod(), _pyCommand::SetObject(), and _pyCommand::SetResultValue().

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

inherited

Referenced by _pyHypothesis::Addition2Creation().

void _pyObject::setID ( const _pyID &  theID )

protectedinherited

Set up myID and myIsPublished.

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

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

virtual void _pyObject::SetRemovedFromStudy ( const bool  isRemoved )

virtualinherited

Reimplemented in _pyMesh.

References _pyObject::myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Field Documentation

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

protectedinherited

Referenced by _pyObject::AddArgCmd(), _pyObject::CanClear(), _pySelfEraser::CanClear(), _pySubMesh::Flush(), and Flush().

_pyID _pyObject::myID

protectedinherited

Referenced by _pyObject::GetID(), and _pyObject::setID().

bool _pyObject::myIsPublished

protectedinherited

Referenced by _pySelfEraser::_pySelfEraser(), _pyObject::CanClear(), _pySelfEraser::Flush(), _pyObject::IsInStudy(), _pyObject::setID(), and _pyObject::SetRemovedFromStudy().

_pyID _pyFilter::myMesh

private

Referenced by Process().

_pyID _pyFilter::myNewID

private

Referenced by Flush(), and Process().

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

protectedinherited

Referenced by _pyObject::AddProcessedCmd(), _pyObject::ClearCommands(), _pyObject::GetNbCalls(), and _pyObject::GetProcessedCmds().