_pyAlgorithm Class Reference

Class representing smesh.Mesh_Algorithm. More...

#include <SMESH_2smeshpy.hxx>

Inheritance diagram for _pyAlgorithm:

Public Member Functions
	_pyAlgorithm (const Handle(_pyCommand)&theCreationCmd)
	_pyAlgorithm constructor More...
virtual bool	Addition2Creation (const Handle(_pyCommand)&theAdditionCmd, const _pyID &theMesh)
	Convert the command adding an algorithm to mesh. More...
virtual const char *	AccessorMethod () const
	Return method name giving access to an interaface object wrapped by python class. More...
virtual bool	IsWrappable (const _pyID &theMesh)
void	SetConvMethodAndType (const _AString &creationMethod, const _AString &type)
void	AddArgMethod (const _AString &method, const int argNb=1)
void	AddAccumulativeMethod (const _AString &method)
const std::list< Handle(_pyCommand)> &	GetArgCommands () const
void	ClearAllCommands ()
	clear creation, arg and unknown commands More...
virtual bool	IsAlgo () const
bool	IsValid () const
bool	IsWrapped () const
const _pyID &	GetGeom () const
void	SetMesh (const _pyID &theMeshId)
const _pyID &	GetMesh () const
const _AString &	GetAlgoType () const
const _AString &	GetAlgoCreationMethod () const
bool	CanBeCreatedBy (const _AString &algoType) const
const _AString &	GetCreationMethod (const _AString &algoType)
virtual bool	IsWrappable (const _pyID &theMesh) const
	Returns true if addition of this hypothesis to a given mesh can be wrapped into hypothesis creation. More...
virtual void	Process (const Handle(_pyCommand)&theCommand)
	Remember hypothesis parameter values. More...
virtual void	Flush ()
	Finish conversion. More...
virtual void	Free ()
virtual void	Assign (const Handle(_pyHypothesis)&theOther, const _pyID &theMesh)
	Assign fields of theOther to me except myIsWrapped. More...
virtual bool	CanClear ()
	Analyze my erasability depending on myReferredObjs. More...
virtual void	ClearCommands ()
	Clear my commands depending on usage by meshes. More...
virtual bool	GetReferredMeshesAndGeom (std::list< Handle(_pyMesh) > &meshes)
	Find arguments that are objects like mesh, group, geometry. More...
void	MeshComputed (const Handle(_pyCommand)&theComputeCommand)
	Save commands setting parameters as they are used for a mesh computation. More...
void	ComputeDiscarded (const Handle(_pyCommand)&theComputeCommand)
	Clear commands setting parameters as a mesh computed using them is cleared. More...
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)

Static Public Member Functions
static	Handle (_pyHypothesis) NewHypothesis(const Handle(_pyCommand)&theCreationCmd)
static _pyID	FatherID (const _pyID &childID)
	Return ID of a father. More...

Protected Types
typedef std::map< _AString, CreationMethod >	TType2CrMethod

Protected Member Functions
void	setCreationArg (const int argNb, const _AString &arg)
	Sets an argNb-th argument of current creation command. More...
void	rememberCmdOfParameter (const Handle(_pyCommand)&cmd)
	Remember theCommand setting a parameter. More...
bool	isCmdUsedForCompute (const Handle(_pyCommand)&cmd, _pyCommand::TAddr avoidComputeAddr=NULL) const
	Return true if a setting parameter command ha been used to compute mesh. More...
	Handle (_pyCommand) myCreationCmd
void	setID (const _pyID &theID)
	Set up myID and myIsPublished. More...

Protected Attributes
bool	myIsAlgo
bool	myIsWrapped
_pyID	myGeom
_pyID	myMesh
TType2CrMethod	myAlgoType2CreationMethod
std::set< _AString >	myAccumulativeMethods
CreationMethod *	myCurCrMethod
std::list< Handle(_pyCommand)>	myArgCommands
std::list< Handle(_pyCommand)>	myUnusedCommands
std::list< Handle(_pyObject) >	myReferredObjs
std::map< _AString, std::list < Handle(_pyCommand)> >	myMeth2Commands
std::map< _pyCommand::TAddr, std::list< Handle(_pyCommand) > >	myComputeAddr2Cmds
std::list< Handle(_pyCommand) >	myComputeCmds
_pyID	myID
std::list< Handle(_pyCommand) >	myProcessedCmds
std::list< Handle(_pyCommand) >	myArgCmds
bool	myIsPublished

Detailed Description

Class representing smesh.Mesh_Algorithm.

Member Typedef Documentation

typedef std::map<_AString, CreationMethod > _pyHypothesis::TType2CrMethod

protectedinherited

Constructor & Destructor Documentation

_pyAlgorithm::_pyAlgorithm

(

const Handle(_pyCommand)&

theCreationCmd

)

_pyAlgorithm constructor

Parameters

theCreationCmd

- The command like "algo = smeshgen.CreateHypothesis(type,lib)"

References _pyHypothesis::myIsAlgo.

Member Function Documentation

virtual const char* _pyAlgorithm::AccessorMethod ( ) const

virtual

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

Return values

const

char* - method name

Reimplemented from _pyObject.

void _pyHypothesis::AddAccumulativeMethod ( const _AString &  method )

inherited

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

inherited

References _pyObject::myArgCmds.

void _pyHypothesis::AddArgMethod ( const _AString &  method, const int  argNb = 1  )

inherited

bool _pyAlgorithm::Addition2Creation ( const Handle(_pyCommand)&  theCmd, const _pyID &  theMeshID  )

virtual

Convert the command adding an algorithm to mesh.

Parameters

theCmd	- The command like mesh.AddHypothesis( geom, algo )
theMesh	- The mesh needing this algo

Return values

bool	- false if the command can't be converted

Reimplemented from _pyHypothesis.

References _pyHypothesis::Addition2Creation(), _pyObject::GetID(), and _pyGen::SetAccessorMethod().

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

inherited

References _pyObject::myProcessedCmds.

Referenced by _pyObject::Process().

void _pyHypothesis::Assign ( const Handle(_pyHypothesis)&  theOther, const _pyID &  theMesh  )

virtualinherited

Assign fields of theOther to me except myIsWrapped.

References _pyHypothesis::GetAlgoType(), _pyHypothesis::GetCreationMethod(), _pyHypothesis::myAccumulativeMethods, _pyHypothesis::myAlgoType2CreationMethod, _pyHypothesis::myGeom, _pyHypothesis::myIsAlgo, _pyHypothesis::myIsWrapped, and _pyHypothesis::myMesh.

bool _pyHypothesis::CanBeCreatedBy ( const _AString &  algoType ) const

inherited

bool _pyHypothesis::CanClear ( )

virtualinherited

Analyze my erasability depending on myReferredObjs.

Reimplemented from _pyObject.

References _pyObject::IsInStudy(), and _pyHypothesis::myReferredObjs.

void _pyHypothesis::ClearAllCommands ( )

inherited

clear creation, arg and unknown commands

References _pyHypothesis::myArgCommands, and _pyHypothesis::myUnusedCommands.

void _pyHypothesis::ClearCommands ( )

virtualinherited

Clear my commands depending on usage by meshes.

Reimplemented from _pyObject.

References _pyObject::ClearCommands().

void _pyHypothesis::ComputeDiscarded ( const Handle(_pyCommand)&  theComputeCommand )

inherited

Clear commands setting parameters as a mesh computed using them is cleared.

References _pyCommand::GetAddress(), _pyHypothesis::isCmdUsedForCompute(), _pyHypothesis::myComputeAddr2Cmds, and _pyHypothesis::myMeth2Commands.

_pyID _pyObject::FatherID ( const _pyID &  childID )

staticinherited

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

void _pyHypothesis::Flush ( )

virtualinherited

Finish conversion.

Implements _pyObject.

Reimplemented in _pyNumberOfSegmentsHyp, _pyLayerDistributionHypo, and _pyComplexParamHypo.

References _pyGen::AddAlgoAccessorMethod(), _pyGen::AddMeshAccessorMethod(), _pyHypothesis::IsAlgo(), _pyHypothesis::myArgCommands, and _pyHypothesis::myUnusedCommands.

virtual void _pyHypothesis::Free ( )

virtualinherited

Reimplemented from _pyObject.

Reimplemented in _pyLayerDistributionHypo.

const _AString& _pyHypothesis::GetAlgoCreationMethod ( ) const

inherited

Referenced by _pyHypothesis::Addition2Creation().

const _AString& _pyHypothesis::GetAlgoType ( ) const

inherited

Referenced by _pyHypothesis::Addition2Creation(), _pyLayerDistributionHypo::Addition2Creation(), _pyHypothesis::Assign(), and _pyComplexParamHypo::Process().

const std::list<Handle(_pyCommand)>& _pyHypothesis::GetArgCommands ( ) const

inherited

int _pyObject::GetCommandNb ( )

inherited

const _AString& _pyHypothesis::GetCreationMethod ( const _AString &  algoType )

inherited

Referenced by _pyHypothesis::Addition2Creation(), and _pyHypothesis::Assign().

const _pyID& _pyHypothesis::GetGeom ( ) const

inherited

const _pyID& _pyObject::GetID ( )

inherited

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

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

const _pyID& _pyHypothesis::GetMesh ( ) const

inherited

int _pyObject::GetNbCalls ( ) const

inherited

References _pyObject::myProcessedCmds.

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

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

inherited

References _pyObject::myProcessedCmds.

Referenced by _pySelfEraser::CanClear().

bool _pyHypothesis::GetReferredMeshesAndGeom ( std::list< Handle(_pyMesh) > &  meshes )

virtualinherited

Find arguments that are objects like mesh, group, geometry.

Parameters

meshes

- referred meshes (directly or indirrectly)

Return values

bool	- false if a referred geometry is not in the study

References _pyCommand::GetStudyEntries(), _pyHypothesis::Handle(), _pyHypothesis::IsAlgo(), _pyGen::IsGeomObject(), _pyObject::IsInStudy(), _pyGen::IsNotPublished(), _pyHypothesis::myAlgoType2CreationMethod, _pyHypothesis::CreationMethod::myArgs, _pyHypothesis::myReferredObjs, and _pyHypothesis::myUnusedCommands.

_pyObject::Handle ( _pyCommand  )

protectedinherited

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

static _pyHypothesis::Handle ( _pyHypothesis  ) const

staticinherited

Referenced by _pyHypothesis::Addition2Creation(), _pySegmentLengthAroundVertexHyp::Addition2Creation(), _pyHypothesis::GetReferredMeshesAndGeom(), and _pyHypothesis::IsWrappable().

virtual bool _pyHypothesis::IsAlgo ( ) const

virtualinherited

Referenced by _pyHypothesis::Addition2Creation(), _pyHypothesis::Flush(), and _pyHypothesis::GetReferredMeshesAndGeom().

bool _pyHypothesis::isCmdUsedForCompute ( const Handle(_pyCommand)&  cmd, _pyCommand::TAddr  avoidComputeAddr = NULL  ) const

protectedinherited

Return true if a setting parameter command ha been used to compute mesh.

References _pyHypothesis::myComputeAddr2Cmds.

Referenced by _pyHypothesis::ComputeDiscarded(), and _pyHypothesis::rememberCmdOfParameter().

bool _pyObject::IsInStudy ( ) const

inherited

References _pyObject::myIsPublished.

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

bool _pyHypothesis::IsValid ( ) const

inherited

bool _pyHypothesis::IsWrappable ( const _pyID &  theMesh ) const

virtualinherited

Returns true if addition of this hypothesis to a given mesh can be wrapped into hypothesis creation.

References _pyHypothesis::Handle(), _pyObject::IsInStudy(), _pyHypothesis::myIsWrapped, and _pyHypothesis::myMesh.

Referenced by _pyHypothesis::Addition2Creation(), _pyNumberOfSegmentsHyp::Addition2Creation(), and _pySegmentLengthAroundVertexHyp::Addition2Creation().

virtual bool _pyAlgorithm::IsWrappable ( const _pyID &  theMesh )

virtual

bool _pyHypothesis::IsWrapped ( ) const

inherited

Referenced by _pyComplexParamHypo::Flush(), and _pyNumberOfSegmentsHyp::Flush().

void _pyHypothesis::MeshComputed ( const Handle(_pyCommand)&  theComputeCommand )

inherited

Save commands setting parameters as they are used for a mesh computation.

References _pyCommand::GetAddress(), _pyHypothesis::myComputeAddr2Cmds, _pyHypothesis::myComputeCmds, and _pyHypothesis::myMeth2Commands.

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

virtualinherited

Remember hypothesis parameter values.

Parameters

theCommand

- The called hypothesis method

Reimplemented from _pyObject.

Reimplemented in _pyLayerDistributionHypo, and _pyComplexParamHypo.

References _pyCommand::GetArg(), _pyCommand::GetMethod(), _pyGen::IsToKeepAllCommands(), _pyHypothesis::myAlgoType2CreationMethod, _pyHypothesis::myArgCommands, _pyHypothesis::CreationMethod::myArgMethods, _pyHypothesis::CreationMethod::myArgNb, _pyHypothesis::CreationMethod::myArgs, _pyHypothesis::myIsAlgo, _pyHypothesis::myUnusedCommands, and _pyHypothesis::rememberCmdOfParameter().

Referenced by _pyComplexParamHypo::Process().

void _pyHypothesis::rememberCmdOfParameter ( const Handle(_pyCommand)&  cmd )

protectedinherited

Remember theCommand setting a parameter.

References _pyCommand::GetArg(), _pyCommand::GetMethod(), _pyCommand::GetNbArgs(), _pyCommand::GetString(), _pyHypothesis::isCmdUsedForCompute(), _pyCommand::Length(), _pyHypothesis::myAccumulativeMethods, and _pyHypothesis::myMeth2Commands.

Referenced by _pyHypothesis::Process().

void _pyHypothesis::SetConvMethodAndType ( const _AString &  creationMethod, const _AString &  type  )

inherited

Referenced by _pyHypothesisReader::_pyHypothesisReader().

void _pyHypothesis::setCreationArg ( const int  argNb, const _AString &  arg  )

protectedinherited

Sets an argNb-th argument of current creation command.

Parameters

argNb

- argument index countered from 1

References _pyHypothesis::CreationMethod::myArgs, and _pyHypothesis::myCurCrMethod.

Referenced by _pyHypothesisReader::_pyHypothesisReader(), and _pyComplexParamHypo::Process().

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

void _pyHypothesis::SetMesh ( const _pyID &  theMeshId )

inherited

virtual void _pyObject::SetRemovedFromStudy ( const bool  isRemoved )

virtualinherited

Reimplemented in _pyMesh.

References _pyObject::myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Field Documentation

std::set< _AString > _pyHypothesis::myAccumulativeMethods

protectedinherited

Referenced by _pyHypothesis::Assign(), and _pyHypothesis::rememberCmdOfParameter().

TType2CrMethod _pyHypothesis::myAlgoType2CreationMethod

protectedinherited

Referenced by _pyNumberOfSegmentsHyp::Addition2Creation(), _pyHypothesis::Assign(), _pyHypothesis::GetReferredMeshesAndGeom(), _pyHypothesis::Process(), and _pyComplexParamHypo::Process().

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

protectedinherited

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

std::list<Handle(_pyCommand)> _pyHypothesis::myArgCommands

protectedinherited

Referenced by _pyHypothesis::Addition2Creation(), _pyLayerDistributionHypo::Addition2Creation(), _pyHypothesis::ClearAllCommands(), _pyHypothesis::Flush(), _pyLayerDistributionHypo::Flush(), _pyNumberOfSegmentsHyp::Flush(), _pyHypothesis::Process(), _pyComplexParamHypo::Process(), and _pyLayerDistributionHypo::Process().

std::map< _pyCommand::TAddr, std::list<Handle(_pyCommand) > > _pyHypothesis::myComputeAddr2Cmds

protectedinherited

Referenced by _pyHypothesis::ComputeDiscarded(), _pyHypothesis::isCmdUsedForCompute(), and _pyHypothesis::MeshComputed().

std::list<Handle(_pyCommand) > _pyHypothesis::myComputeCmds

protectedinherited

Referenced by _pyHypothesis::MeshComputed().

CreationMethod* _pyHypothesis::myCurCrMethod

protectedinherited

Referenced by _pyHypothesis::Addition2Creation(), _pyNumberOfSegmentsHyp::Addition2Creation(), _pyComplexParamHypo::Process(), _pyLayerDistributionHypo::Process(), and _pyHypothesis::setCreationArg().

_pyID _pyHypothesis::myGeom

protectedinherited

Referenced by _pyHypothesis::Addition2Creation(), and _pyHypothesis::Assign().

_pyID _pyObject::myID

protectedinherited

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

bool _pyHypothesis::myIsAlgo

protectedinherited

Referenced by _pyAlgorithm(), _pyHypothesis::_pyHypothesis(), _pyHypothesis::Assign(), and _pyHypothesis::Process().

bool _pyObject::myIsPublished

protectedinherited

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

bool _pyHypothesis::myIsWrapped

protectedinherited

Referenced by _pyHypothesis::_pyHypothesis(), _pyHypothesis::Addition2Creation(), _pyLayerDistributionHypo::Addition2Creation(), _pyHypothesis::Assign(), and _pyHypothesis::IsWrappable().

_pyID _pyHypothesis::myMesh

protectedinherited

Referenced by _pyHypothesis::Assign(), and _pyHypothesis::IsWrappable().

std::map<_AString, std::list<Handle(_pyCommand)> > _pyHypothesis::myMeth2Commands

protectedinherited

Referenced by _pyHypothesis::ComputeDiscarded(), _pyHypothesis::MeshComputed(), and _pyHypothesis::rememberCmdOfParameter().

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

protectedinherited

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

std::list<Handle(_pyObject) > _pyHypothesis::myReferredObjs

protectedinherited

Referenced by _pyHypothesis::CanClear(), and _pyHypothesis::GetReferredMeshesAndGeom().

std::list<Handle(_pyCommand)> _pyHypothesis::myUnusedCommands

protectedinherited

Referenced by _pyHypothesis::Addition2Creation(), _pyNumberOfSegmentsHyp::Addition2Creation(), _pyHypothesis::ClearAllCommands(), _pyHypothesis::Flush(), _pyComplexParamHypo::Flush(), _pyNumberOfSegmentsHyp::Flush(), _pyHypothesis::GetReferredMeshesAndGeom(), and _pyHypothesis::Process().