SALOME - SMESH
SMESH_Hypothesis Class Referenceabstract

#include <SMESH_Hypothesis.hxx>

Inheritance diagram for SMESH_Hypothesis:
Inheritance graph
Collaboration diagram for SMESH_Hypothesis:
Collaboration graph

Data Structures

struct  TDefaults
 

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

 SMESH_Hypothesis (int hypId, int studyId, SMESH_Gen *gen)
 
virtual ~SMESH_Hypothesis ()
 
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 SetParametersByMesh (const SMESH_Mesh *theMesh, const TopoDS_Shape &theShape)=0
 Initialize my parameter values by the mesh built on the geometry. More...
 
virtual bool SetParametersByDefaults (const TDefaults &dflts, const SMESH_Mesh *theMesh=0)=0
 Initialize my parameter values by default parameters. More...
 
virtual bool IsAuxiliary () const
 Return true if me is an auxiliary hypothesis. More...
 
const char * GetName () const
 
int GetID () const
 
int GetType () const
 
virtual std::ostream & SaveTo (std::ostream &save)=0
 
virtual std::istream & LoadFrom (std::istream &load)=0
 

Static Public Member Functions

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
 

Private Attributes

std::string _libName
 
std::string _parameters
 
std::string _lastParameters
 

Detailed Description

Definition at line 47 of file SMESH_Hypothesis.hxx.

Member Enumeration Documentation

◆ Hypothesis_Status

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.

◆ hypothesis_type

Enumerator
PARAM_ALGO 
ALGO_0D 
ALGO_1D 
ALGO_2D 
ALGO_3D 

Definition at line 49 of file SMESHDS_Hypothesis.hxx.

Constructor & Destructor Documentation

◆ SMESH_Hypothesis()

SMESH_Hypothesis::SMESH_Hypothesis ( int  hypId,
int  studyId,
SMESH_Gen gen 
)

◆ ~SMESH_Hypothesis()

virtual SMESH_Hypothesis::~SMESH_Hypothesis ( )
virtual

Member Function Documentation

◆ IsStatusFatal()

static bool SMESH_Hypothesis::IsStatusFatal ( Hypothesis_Status  theStatus)
static

Definition at line 68 of file SMESH_Hypothesis.hxx.

◆ GetDim()

virtual int SMESH_Hypothesis::GetDim ( ) const
virtual

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

Here is the caller graph for this function:

◆ GetStudyId()

int SMESH_Hypothesis::GetStudyId ( ) const

◆ NotifySubMeshesHypothesisModification()

virtual void SMESH_Hypothesis::NotifySubMeshesHypothesisModification ( )
virtual

◆ GetShapeType()

virtual int SMESH_Hypothesis::GetShapeType ( ) const
virtual

◆ GetLibName()

virtual const char* SMESH_Hypothesis::GetLibName ( ) const
virtual

◆ SetLibName()

void SMESH_Hypothesis::SetLibName ( const char *  theLibName)

◆ SetParameters()

void SMESH_Hypothesis::SetParameters ( const char *  theParameters)

◆ GetParameters()

char* SMESH_Hypothesis::GetParameters ( ) const

◆ SetLastParameters()

void SMESH_Hypothesis::SetLastParameters ( const char *  theParameters)

◆ GetLastParameters()

char* SMESH_Hypothesis::GetLastParameters ( ) const

◆ ClearParameters()

void SMESH_Hypothesis::ClearParameters ( )

◆ SetParametersByMesh()

virtual bool SMESH_Hypothesis::SetParametersByMesh ( const SMESH_Mesh theMesh,
const TopoDS_Shape &  theShape 
)
pure 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

Implemented in SMESH_Algo, StdMeshers_NumberOfSegments, StdMeshers_ProjectionSource2D, StdMeshers_ProjectionSource3D, StdMeshers_ProjectionSource1D, NETGENPlugin_Hypothesis, StdMeshers_AutomaticLength, NETGENPlugin_SimpleHypothesis_2D, StdMeshers_LayerDistribution, StdMeshers_Propagation, StdMeshers_FixedPoints1D, StdMeshers_NumberOfLayers, StdMeshers_Arithmetic1D, StdMeshers_StartEndLength, StdMeshers_QuadrangleParams, NETGENPlugin_SimpleHypothesis_3D, StdMeshers_LengthFromEdges, StdMeshers_QuadraticMesh, StdMeshers_LocalLength, StdMeshers_SegmentLengthAroundVertex, StdMeshers_MaxElementVolume, StdMeshers_QuadranglePreference, StdMeshers_MaxLength, StdMeshers_TrianglePreference, StdMeshers_MaxElementArea, StdMeshers_Deflection1D, and StdMeshers_NotConformAllowed.

Referenced by StdMeshers_AutomaticLength::GetFineness(), StdMeshers_LayerDistribution::GetLayerDistribution(), StdMeshers_StartEndLength::GetObjectEntry(), StdMeshers_MaxLength::GetPreestimatedLength(), StdMeshers_Arithmetic1D::GetReversedEdges(), StdMeshers_FixedPoints1D::GetReversedEdges(), StdMeshers_NumberOfSegments::GetReversedEdges(), StdMeshers_QuadrangleParams::GetTriaVertex(), StdMeshers_ProjectionSource3D::HasVertexAssociation(), StdMeshers_ProjectionSource1D::HasVertexAssociation(), and StdMeshers_ProjectionSource2D::HasVertexAssociation().

Here is the caller graph for this function:

◆ SetParametersByDefaults()

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

◆ IsAuxiliary()

virtual bool SMESH_Hypothesis::IsAuxiliary ( ) const
virtual

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.

◆ GetName()

const char* SMESHDS_Hypothesis::GetName ( ) const
inherited

◆ GetID()

int SMESHDS_Hypothesis::GetID ( ) const
inherited

◆ GetType()

int SMESHDS_Hypothesis::GetType ( ) const
inherited

◆ SaveTo()

virtual std::ostream& SMESHDS_Hypothesis::SaveTo ( std::ostream &  save)
pure virtualinherited

◆ LoadFrom()

virtual std::istream& SMESHDS_Hypothesis::LoadFrom ( std::istream &  load)
pure virtualinherited

Field Documentation

◆ _gen

SMESH_Gen* SMESH_Hypothesis::_gen
protected

Definition at line 118 of file SMESH_Hypothesis.hxx.

◆ _studyId

int SMESH_Hypothesis::_studyId
protected

Definition at line 119 of file SMESH_Hypothesis.hxx.

◆ _shapeType

int SMESH_Hypothesis::_shapeType
protected

Definition at line 120 of file SMESH_Hypothesis.hxx.

◆ _param_algo_dim

int SMESH_Hypothesis::_param_algo_dim
protected

Definition at line 121 of file SMESH_Hypothesis.hxx.

◆ _libName

std::string SMESH_Hypothesis::_libName
private

Definition at line 124 of file SMESH_Hypothesis.hxx.

◆ _parameters

std::string SMESH_Hypothesis::_parameters
private

Definition at line 125 of file SMESH_Hypothesis.hxx.

◆ _lastParameters

std::string SMESH_Hypothesis::_lastParameters
private

Definition at line 126 of file SMESH_Hypothesis.hxx.

◆ _name

std::string SMESHDS_Hypothesis::_name
protectedinherited

Definition at line 52 of file SMESHDS_Hypothesis.hxx.

◆ _hypId

int SMESHDS_Hypothesis::_hypId
protectedinherited

Definition at line 53 of file SMESHDS_Hypothesis.hxx.

◆ _type

int SMESHDS_Hypothesis::_type
protectedinherited

Definition at line 54 of file SMESHDS_Hypothesis.hxx.