_pyGroup Class Reference

To convert creation of a group by filter. More...

#include <SMESH_2smeshpy.hxx>

Inheritance diagram for _pyGroup:

Public Member Functions
	_pyGroup (const Handle(_pyCommand)&theCreationCmd, const _pyID &id=_pyID())
	Creates _pyGroup. More...
virtual void	Process (const Handle(_pyCommand)&theCommand)
	To convert creation of a group by filter. More...
virtual void	Flush ()
	Prevent clearing "DoubleNode...() command if a group created by it is removed. More...
virtual void	Free ()
virtual bool	CanClear ()
	Check if "[ group1, group2 ] = mesh.GetGroups()" creation command can be cleared. More...
void	RemovedWithContents ()
	set myCanClearCreationCmd = true if the main action of the creation command is discarded More...
virtual	Handle (_pyMesh) GetMesh()
const	Handle (_pyCommand) &GetCreationCmd()
virtual void	Process (const Handle(_pyCommand) &cmd)
void	SetCreator (const Handle(_pyObject)&theCreator)
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 void	ClearCommands ()
	Clear myCreationCmd and myProcessedCmds. More...

Static Public Member Functions
static bool	CanBeArgOfMethod (const _AString &theMethodName)
	Return true if a sub-mesh can be used as argument of the given method. More...
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 Member Functions
	Handle (_pyFilter) myFilter

Private Attributes
bool	myCanClearCreationCmd

Detailed Description

To convert creation of a group by filter.

Constructor & Destructor Documentation

_pyGroup()

_pyGroup::_pyGroup	(	const Handle(_pyCommand)&	theCreationCmd,
		const _pyID &	id = _pyID()
	)

Creates _pyGroup.

References SMESH::DownCast(), _pyCommand::GetArg(), _pyCommand::GetMethod(), _pyCommand::GetNbResultValues(), Handle(), myCanClearCreationCmd, _pyCommand::RemoveArgs(), _pyCommand::SetArg(), _pyObject::setID(), and _pyCommand::SetMethod().

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

const

char* - 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

References _pyObject::myProcessedCmds.

Referenced by _pyObject::Process().

CanBeArgOfMethod()

bool _pySubMesh::CanBeArgOfMethod ( const _AString &  theMethodName )

staticinherited

Return true if a sub-mesh can be used as argument of the given method.

CanClear()

bool _pyGroup::CanClear ( )

virtual

Check if "[ group1, group2 ] = mesh.GetGroups()" creation command can be cleared.

Reimplemented from _pyObject.

References SMESH::DownCast(), _pyObject::GetID(), Handle(), _pyObject::IsInStudy(), and myCanClearCreationCmd.

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 _pyGroup::Flush ( )

virtual

Prevent clearing "DoubleNode...() command if a group created by it is removed.

Reimplemented from _pySubMesh.

References myCanClearCreationCmd.

Free()

virtual void _pyGroup::Free ( )

virtual

Reimplemented from _pySubMesh.

GetCommandNb()

int _pyObject::GetCommandNb ( )

inherited

GetID()

const _pyID& _pyObject::GetID ( )

inherited

References _pyObject::myID.

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

GetNbCalls()

int _pyObject::GetNbCalls ( ) const

inherited

References _pyObject::myProcessedCmds.

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

GetProcessedCmds()

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

inherited

References _pyObject::myProcessedCmds.

Referenced by _pySelfEraser::CanClear().

Handle() [1/4]

const _pyObject::Handle ( _pyCommand  ) &

inherited

Handle() [2/4]

_pyObject::Handle ( _pyCommand  )

protectedinherited

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

Handle() [3/4]

_pyGroup::Handle ( _pyFilter  )

private

Referenced by _pyGroup(), CanClear(), and Process().

Handle() [4/4]

virtual _pySubMesh::Handle ( _pyMesh  )

virtualinherited

IsInStudy()

bool _pyObject::IsInStudy ( ) const

inherited

References _pyObject::myIsPublished.

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

Process() [1/2]

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

virtualinherited

References _pyObject::AddProcessedCmd().

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

Process() [2/2]

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

virtual

To convert creation of a group by filter.

Reimplemented from _pySubMesh.

References _pyCommand::Clear(), SMESH::DownCast(), _pyCommand::GetArg(), _pyCommand::GetMethod(), _pyCommand::GetResultValue(), Handle(), and _pyCommand::SetArg().

RemovedWithContents()

void _pyGroup::RemovedWithContents

(

)

set myCanClearCreationCmd = true if the main action of the creation command is discarded

SetCreationCmd()

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

inherited

Referenced by _pyHypothesis::Addition2Creation().

SetCreator()

void _pySubMesh::SetCreator ( const Handle(_pyObject)&  theCreator )

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(), 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

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

myCanClearCreationCmd

bool _pyGroup::myCanClearCreationCmd

private

Referenced by _pyGroup(), CanClear(), and Flush().

myID

_pyID _pyObject::myID

protectedinherited

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

myIsPublished

bool _pyObject::myIsPublished

protectedinherited

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

myProcessedCmds

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

protectedinherited

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