_pyHypothesis Class Reference

Root class for hypothesis. More...

#include <SMESH_2smeshpy.hxx>

Inheritance diagram for _pyHypothesis:

Data Structures
struct	CreationMethod

Public Member Functions
	_pyHypothesis (const Handle(_pyCommand)&theCreationCmd)
	_pyHypothesis constructor More...
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 bool	Addition2Creation (const Handle(_pyCommand)&theAdditionCmd, const _pyID &theMesh)
	Convert the command adding a hypothesis to mesh into a smesh command. 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)
virtual const char *	AccessorMethod () const
	Return method name giving access to an interaface object wrapped by python class. More...

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

Friends
class	_pyHypothesisReader

Detailed Description

Root class for hypothesis.

Member Typedef Documentation

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

protected

Constructor & Destructor Documentation

_pyHypothesis::_pyHypothesis

(

const Handle(_pyCommand)&

theCreationCmd

)

_pyHypothesis constructor

Parameters

theCreationCmd

-

References myIsAlgo, and myIsWrapped.

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 _pyHypothesis::AddAccumulativeMethod

(

const _AString &

method

)

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

inherited

References _pyObject::myArgCmds.

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

bool _pyHypothesis::Addition2Creation ( const Handle(_pyCommand)&  theCmd, const _pyID &  theMesh  )

virtual

Convert the command adding a hypothesis to mesh into a smesh command.

Parameters

theCmd	- The command like mesh.AddHypothesis( geom, hypo )
theAlgo	- The algo that can create this hypo

Return values

bool	- false if the command can't be converted

Reimplemented in _pySegmentLengthAroundVertexHyp, _pyNumberOfSegmentsHyp, _pyLayerDistributionHypo, and _pyAlgorithm.

References GetAlgoCreationMethod(), GetAlgoType(), _pyCommand::GetArg(), GetCreationMethod(), _pyObject::GetID(), _pyCommand::GetMethod(), Handle(), IsAlgo(), IsWrappable(), myArgCommands, _pyHypothesis::CreationMethod::myArgs, myCurCrMethod, myGeom, myIsWrapped, myUnusedCommands, _pyCommand::RemoveArgs(), _pyCommand::SetArg(), _pyObject::SetCreationCmd(), _pyCommand::SetMethod(), _pyCommand::SetObject(), and _pyCommand::SetResultValue().

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

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  )

virtual

Assign fields of theOther to me except myIsWrapped.

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

bool _pyHypothesis::CanBeCreatedBy

(

const _AString &

algoType

)

const

bool _pyHypothesis::CanClear ( )

virtual

Analyze my erasability depending on myReferredObjs.

Reimplemented from _pyObject.

References _pyObject::IsInStudy(), and myReferredObjs.

void _pyHypothesis::ClearAllCommands

(

)

clear creation, arg and unknown commands

References myArgCommands, and myUnusedCommands.

void _pyHypothesis::ClearCommands ( )

virtual

Clear my commands depending on usage by meshes.

Reimplemented from _pyObject.

References _pyObject::ClearCommands().

void _pyHypothesis::ComputeDiscarded

(

const Handle(_pyCommand)&

theComputeCommand

)

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

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

_pyID _pyObject::FatherID ( const _pyID &  childID )

staticinherited

Return ID of a father.

Referenced by _pySegmentLengthAroundVertexHyp::Addition2Creation().

void _pyHypothesis::Flush ( )

virtual

Finish conversion.

Implements _pyObject.

Reimplemented in _pyNumberOfSegmentsHyp, _pyLayerDistributionHypo, and _pyComplexParamHypo.

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

virtual void _pyHypothesis::Free ( )

virtual

Reimplemented from _pyObject.

Reimplemented in _pyLayerDistributionHypo.

const _AString& _pyHypothesis::GetAlgoCreationMethod

(

)

const

Referenced by Addition2Creation().

const _AString& _pyHypothesis::GetAlgoType

(

)

const

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

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

(

)

const

int _pyObject::GetCommandNb ( )

inherited

const _AString& _pyHypothesis::GetCreationMethod

(

const _AString &

algoType

)

Referenced by Addition2Creation(), and Assign().

const _pyID& _pyHypothesis::GetGeom

(

)

const

const _pyID& _pyObject::GetID ( )

inherited

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

Referenced by _pyFilter::_pyFilter(), _pyMesh::_pyMesh(), _pySelfEraser::_pySelfEraser(), _pySubMesh::_pySubMesh(), _pyMesh::addFatherMesh(), Addition2Creation(), _pyAlgorithm::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

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 )

virtual

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

_pyObject::Handle ( _pyCommand  )

protectedinherited

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

static _pyHypothesis::Handle ( _pyHypothesis  ) const

static

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

virtual bool _pyHypothesis::IsAlgo ( ) const

virtual

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

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

protected

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

References myComputeAddr2Cmds.

Referenced by ComputeDiscarded(), and rememberCmdOfParameter().

bool _pyObject::IsInStudy ( ) const

inherited

References _pyObject::myIsPublished.

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

bool _pyHypothesis::IsValid

(

)

const

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

virtual

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

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

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

bool _pyHypothesis::IsWrapped

(

)

const

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

void _pyHypothesis::MeshComputed

(

const Handle(_pyCommand)&

theComputeCommand

)

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

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

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

virtual

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(), myAlgoType2CreationMethod, myArgCommands, _pyHypothesis::CreationMethod::myArgMethods, _pyHypothesis::CreationMethod::myArgNb, _pyHypothesis::CreationMethod::myArgs, myIsAlgo, myUnusedCommands, and rememberCmdOfParameter().

Referenced by _pyComplexParamHypo::Process().

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

protected

Remember theCommand setting a parameter.

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

Referenced by Process().

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

Referenced by _pyHypothesisReader::_pyHypothesisReader().

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

protected

Sets an argNb-th argument of current creation command.

Parameters

argNb

- argument index countered from 1

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

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

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

inherited

Referenced by 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

)

virtual void _pyObject::SetRemovedFromStudy ( const bool  isRemoved )

virtualinherited

Reimplemented in _pyMesh.

References _pyObject::myIsPublished.

Referenced by _pyMesh::SetRemovedFromStudy().

Friends And Related Function Documentation

friend class _pyHypothesisReader

friend

Field Documentation

std::set< _AString > _pyHypothesis::myAccumulativeMethods

protected

Referenced by Assign(), and rememberCmdOfParameter().

TType2CrMethod _pyHypothesis::myAlgoType2CreationMethod

protected

Referenced by _pyNumberOfSegmentsHyp::Addition2Creation(), Assign(), GetReferredMeshesAndGeom(), 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

protected

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

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

protected

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

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

protected

Referenced by MeshComputed().

CreationMethod* _pyHypothesis::myCurCrMethod

protected

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

_pyID _pyHypothesis::myGeom

protected

Referenced by Addition2Creation(), and Assign().

_pyID _pyObject::myID

protectedinherited

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

bool _pyHypothesis::myIsAlgo

protected

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

bool _pyObject::myIsPublished

protectedinherited

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

bool _pyHypothesis::myIsWrapped

protected

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

_pyID _pyHypothesis::myMesh

protected

Referenced by Assign(), and IsWrappable().

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

protected

Referenced by ComputeDiscarded(), MeshComputed(), and 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

protected

Referenced by CanClear(), and GetReferredMeshesAndGeom().

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

protected

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