Version: 9.12.0
_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 &)
 
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 _pyIDGetGeom () const
 
void SetMesh (const _pyID &theMeshId)
 
const _pyIDGetMesh () const
 
const _AStringGetAlgoType () const
 
const _AStringGetAlgoCreationMethod () const
 
bool CanBeCreatedBy (const _AString &algoType) const
 
const _AStringGetCreationMethod (const _AString &algoType)
 
const Handle (_pyCommand) &GetCreationCmd()
 
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 Process (const Handle(_pyCommand) &cmd)
 
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 _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)
 

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, CreationMethodTType2CrMethod
 

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< _AStringmyAccumulativeMethods
 
CreationMethodmyCurCrMethod
 
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

◆ TType2CrMethod

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

Constructor & Destructor Documentation

◆ _pyAlgorithm()

_pyAlgorithm::_pyAlgorithm ( const Handle(_pyCommand)&  theCreationCmd)

_pyAlgorithm constructor

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

References _pyHypothesis::myIsAlgo.

Member Function Documentation

◆ AccessorMethod()

virtual const char* _pyAlgorithm::AccessorMethod ( ) const
virtual

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

Return values
constchar* - method name

Reimplemented from _pyObject.

◆ AddAccumulativeMethod()

void _pyHypothesis::AddAccumulativeMethod ( const _AString method)
inherited

◆ AddArgCmd()

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

References _pyObject::myArgCmds.

◆ AddArgMethod()

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

◆ Addition2Creation()

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(), and _pyObject::GetID().

◆ AddProcessedCmd()

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

◆ Assign()

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

◆ CanBeCreatedBy()

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

◆ CanClear()

bool _pyHypothesis::CanClear ( )
virtualinherited

Analyze my erasability depending on myReferredObjs.

Reimplemented from _pyObject.

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

◆ ClearAllCommands()

void _pyHypothesis::ClearAllCommands ( )
inherited

clear creation, arg and unknown commands

References _pyHypothesis::Handle(), _pyHypothesis::myArgCommands, and _pyHypothesis::myUnusedCommands.

◆ ClearCommands()

void _pyHypothesis::ClearCommands ( )
virtualinherited

Clear my commands depending on usage by meshes.

Reimplemented from _pyObject.

References _pyObject::ClearCommands().

◆ ComputeDiscarded()

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

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

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

◆ FatherID()

_pyID _pyObject::FatherID ( const _pyID childID)
staticinherited

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

◆ Flush()

void _pyHypothesis::Flush ( )
virtualinherited

◆ Free()

virtual void _pyHypothesis::Free ( )
virtualinherited

Reimplemented from _pyObject.

Reimplemented in _pyLayerDistributionHypo.

References _pyHypothesis::myReferredObjs.

◆ GetAlgoCreationMethod()

const _AString& _pyHypothesis::GetAlgoCreationMethod ( ) const
inherited

◆ GetAlgoType()

const _AString& _pyHypothesis::GetAlgoType ( ) const
inherited

◆ GetArgCommands()

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

◆ GetCommandNb()

int _pyObject::GetCommandNb ( )
inherited

◆ GetCreationMethod()

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

◆ GetGeom()

const _pyID& _pyHypothesis::GetGeom ( ) const
inherited

References _pyHypothesis::myGeom.

◆ GetID()

◆ GetMesh()

const _pyID& _pyHypothesis::GetMesh ( ) const
inherited

References _pyHypothesis::myMesh.

◆ GetNbCalls()

int _pyObject::GetNbCalls ( ) const
inherited

◆ GetProcessedCmds()

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

◆ GetReferredMeshesAndGeom()

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(), _pyObject::IsInStudy(), _pyHypothesis::myAlgoType2CreationMethod, _pyHypothesis::CreationMethod::myArgs, _pyHypothesis::myReferredObjs, and _pyHypothesis::myUnusedCommands.

◆ Handle() [1/3]

const _pyObject::Handle ( _pyCommand  ) &
inherited

◆ Handle() [2/3]

◆ Handle() [3/3]

◆ IsAlgo()

virtual bool _pyHypothesis::IsAlgo ( ) const
virtualinherited

◆ isCmdUsedForCompute()

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::Handle(), and _pyHypothesis::myComputeAddr2Cmds.

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

◆ IsInStudy()

◆ IsValid()

bool _pyHypothesis::IsValid ( ) const
inherited

◆ IsWrappable() [1/2]

virtual bool _pyAlgorithm::IsWrappable ( const _pyID )
virtual

◆ IsWrappable() [2/2]

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

◆ IsWrapped()

bool _pyHypothesis::IsWrapped ( ) const
inherited

◆ MeshComputed()

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

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

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

◆ Process() [1/2]

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

◆ Process() [2/2]

◆ rememberCmdOfParameter()

◆ SetConvMethodAndType()

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

◆ setCreationArg()

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 _pyComplexParamHypo::Process().

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

◆ SetMesh()

void _pyHypothesis::SetMesh ( const _pyID theMeshId)
inherited

References _pyHypothesis::myMesh.

◆ SetRemovedFromStudy()

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

Reimplemented in _pyMesh.

References _pyObject::myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Field Documentation

◆ myAccumulativeMethods

std::set< _AString > _pyHypothesis::myAccumulativeMethods
protectedinherited

◆ myAlgoType2CreationMethod

◆ myArgCmds

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

◆ myArgCommands

◆ myComputeAddr2Cmds

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

◆ myComputeCmds

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

◆ myCurCrMethod

◆ myGeom

_pyID _pyHypothesis::myGeom
protectedinherited

◆ myID

_pyID _pyObject::myID
protectedinherited

◆ myIsAlgo

bool _pyHypothesis::myIsAlgo
protectedinherited

◆ myIsPublished

◆ myIsWrapped

◆ myMesh

◆ myMeth2Commands

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

◆ myProcessedCmds

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

◆ myReferredObjs

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

◆ myUnusedCommands