SALOME - SMESH
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
StdMeshers_Propagation Class Reference

Propagation hypothesis. More...

#include <StdMeshers_Propagation.hxx>

Inheritance diagram for StdMeshers_Propagation:
Inheritance graph
Collaboration diagram for StdMeshers_Propagation:
Collaboration graph

Public Types

enum  Hypothesis_Status {
  HYP_OK = 0, HYP_MISSING, HYP_CONCURENT, HYP_BAD_PARAMETER,
  HYP_HIDDEN_ALGO, HYP_HIDING_ALGO, HYP_UNKNOWN_FATAL, HYP_INCOMPATIBLE,
  HYP_NOTCONFORM, HYP_ALREADY_EXIST, HYP_BAD_DIM, HYP_BAD_SUBSHAPE,
  HYP_BAD_GEOMETRY, HYP_NEED_SHAPE
}
enum  hypothesis_type {
  PARAM_ALGO, ALGO_0D, ALGO_1D, ALGO_2D,
  ALGO_3D
}

Public Member Functions

 StdMeshers_Propagation (int hypId, int studyId, SMESH_Gen *gen)
virtual ~StdMeshers_Propagation ()
virtual std::ostream & SaveTo (std::ostream &save)
virtual std::istream & LoadFrom (std::istream &load)
virtual bool SetParametersByMesh (const SMESH_Mesh *theMesh, const TopoDS_Shape &theShape)
 Initialize my parameter values by the mesh built on the geometry.
virtual bool SetParametersByDefaults (const TDefaults &dflts, const SMESH_Mesh *theMesh=0)
 Initialize my parameter values by default parameters.
virtual int GetDim () const
int GetStudyId () const
virtual void NotifySubMeshesHypothesisModification ()
virtual int GetShapeType () const
virtual const char * GetLibName () const
void SetLibName (const char *theLibName)
void SetParameters (const char *theParameters)
char * GetParameters () const
void SetLastParameters (const char *theParameters)
char * GetLastParameters () const
void ClearParameters ()
virtual bool IsAuxiliary () const
 Return true if me is an auxiliary hypothesis.
const char * GetName () const
int GetID () const
int GetType () const

Static Public Member Functions

static std::string GetName ()
static void SetPropagationMgr (SMESH_subMesh *subMesh)
 Set EventListener managing propagation of hypotheses.
static TopoDS_Edge GetPropagationSource (SMESH_Mesh &theMesh, const TopoDS_Shape &theEdge)
 Return an edge from which hypotheses are propagated.
static bool IsStatusFatal (Hypothesis_Status theStatus)

Protected Attributes

SMESH_Gen_gen
int _studyId
int _shapeType
int _param_algo_dim
std::string _name
int _hypId
int _type

Friends

std::ostream & operator<< (std::ostream &save, StdMeshers_Propagation &hyp)
std::istream & operator>> (std::istream &load, StdMeshers_Propagation &hyp)

Detailed Description

Propagation hypothesis.

Definition at line 44 of file StdMeshers_Propagation.hxx.

Member Enumeration Documentation

Enumerator:
HYP_OK 
HYP_MISSING 
HYP_CONCURENT 
HYP_BAD_PARAMETER 
HYP_HIDDEN_ALGO 
HYP_HIDING_ALGO 
HYP_UNKNOWN_FATAL 
HYP_INCOMPATIBLE 
HYP_NOTCONFORM 
HYP_ALREADY_EXIST 
HYP_BAD_DIM 
HYP_BAD_SUBSHAPE 
HYP_BAD_GEOMETRY 
HYP_NEED_SHAPE 

Definition at line 50 of file SMESH_Hypothesis.hxx.

Enumerator:
PARAM_ALGO 
ALGO_0D 
ALGO_1D 
ALGO_2D 
ALGO_3D 

Definition at line 49 of file SMESHDS_Hypothesis.hxx.

Constructor & Destructor Documentation

StdMeshers_Propagation::StdMeshers_Propagation ( int  hypId,
int  studyId,
SMESH_Gen gen 
)
virtual StdMeshers_Propagation::~StdMeshers_Propagation ( )
virtual

Member Function Documentation

virtual std::ostream& StdMeshers_Propagation::SaveTo ( std::ostream &  save)
virtual

Implements SMESHDS_Hypothesis.

virtual std::istream& StdMeshers_Propagation::LoadFrom ( std::istream &  load)
virtual

Implements SMESHDS_Hypothesis.

static std::string StdMeshers_Propagation::GetName ( )
static
static void StdMeshers_Propagation::SetPropagationMgr ( SMESH_subMesh subMesh)
static

Set EventListener managing propagation of hypotheses.

Parameters
subMesh- edge submesh to set event listener on

1D algo is expected to call this method from it's SetEventListener()

static TopoDS_Edge StdMeshers_Propagation::GetPropagationSource ( SMESH_Mesh theMesh,
const TopoDS_Shape theEdge 
)
static

Return an edge from which hypotheses are propagated.

Parameters
theMesh- mesh
theEdge- edge to which hypotheses are propagated
Return values
TopoDS_Edge- source edge, also passing orientation
virtual bool StdMeshers_Propagation::SetParametersByMesh ( const SMESH_Mesh theMesh,
const TopoDS_Shape theShape 
)
virtual

Initialize my parameter values by the mesh built on the geometry.

Parameters
theMesh- the built mesh
theShape- the geometry of interest
Return values
bool- true if parameter values have been successfully defined

Just return false as this hypothesis does not have parameters values

Implements SMESH_Hypothesis.

virtual bool StdMeshers_Propagation::SetParametersByDefaults ( const TDefaults dflts,
const SMESH_Mesh theMesh = 0 
)
virtual

Initialize my parameter values by default parameters.

Return values
bool- true if parameter values have been successfully defined

Implements SMESH_Hypothesis.

static bool SMESH_Hypothesis::IsStatusFatal ( Hypothesis_Status  theStatus)
staticinherited

Definition at line 68 of file SMESH_Hypothesis.hxx.

virtual int SMESH_Hypothesis::GetDim ( ) const
virtualinherited

Referenced by SMESH_Gen::TAlgoStateError::Set().

Here is the caller graph for this function:

int SMESH_Hypothesis::GetStudyId ( ) const
inherited
virtual void SMESH_Hypothesis::NotifySubMeshesHypothesisModification ( )
virtualinherited
virtual int SMESH_Hypothesis::GetShapeType ( ) const
virtualinherited
virtual const char* SMESH_Hypothesis::GetLibName ( ) const
virtualinherited
void SMESH_Hypothesis::SetLibName ( const char *  theLibName)
inherited
void SMESH_Hypothesis::SetParameters ( const char *  theParameters)
inherited
char* SMESH_Hypothesis::GetParameters ( ) const
inherited
void SMESH_Hypothesis::SetLastParameters ( const char *  theParameters)
inherited
char* SMESH_Hypothesis::GetLastParameters ( ) const
inherited
void SMESH_Hypothesis::ClearParameters ( )
inherited
virtual bool SMESH_Hypothesis::IsAuxiliary ( ) const
virtualinherited

Return true if me is an auxiliary hypothesis.

Return values
bool- auxiliary or not

An auxiliary hypothesis is optional, i.e. an algorithm can work without it and another hypothesis of the same dimention can be assigned to the shape

Definition at line 114 of file SMESH_Hypothesis.hxx.

References SMESHDS_Hypothesis::GetType().

Here is the call graph for this function:

const char* SMESHDS_Hypothesis::GetName ( ) const
inherited
int SMESHDS_Hypothesis::GetID ( ) const
inherited
int SMESHDS_Hypothesis::GetType ( ) const
inherited

Referenced by SMESH_Hypothesis::IsAuxiliary().

Here is the caller graph for this function:

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  save,
StdMeshers_Propagation hyp 
)
friend
std::istream& operator>> ( std::istream &  load,
StdMeshers_Propagation hyp 
)
friend

Field Documentation

SMESH_Gen* SMESH_Hypothesis::_gen
protectedinherited

Definition at line 118 of file SMESH_Hypothesis.hxx.

int SMESH_Hypothesis::_studyId
protectedinherited

Definition at line 119 of file SMESH_Hypothesis.hxx.

int SMESH_Hypothesis::_shapeType
protectedinherited

Definition at line 120 of file SMESH_Hypothesis.hxx.

int SMESH_Hypothesis::_param_algo_dim
protectedinherited

Definition at line 121 of file SMESH_Hypothesis.hxx.

std::string SMESHDS_Hypothesis::_name
protectedinherited

Definition at line 52 of file SMESHDS_Hypothesis.hxx.

int SMESHDS_Hypothesis::_hypId
protectedinherited

Definition at line 53 of file SMESHDS_Hypothesis.hxx.

int SMESHDS_Hypothesis::_type
protectedinherited

Definition at line 54 of file SMESHDS_Hypothesis.hxx.