SALOME - SMESH
StdMeshers_StartEndLength Class Reference

#include <StdMeshers_StartEndLength.hxx>

Inheritance diagram for StdMeshers_StartEndLength:
Inheritance graph
Collaboration diagram for StdMeshers_StartEndLength:
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_StartEndLength (int hypId, int studyId, SMESH_Gen *gen)
 
virtual ~ StdMeshers_StartEndLength ()
 
void SetLength (double length, bool isStartLength) throw ( SMESH_Exception )
 
double GetLength (bool isStartLength) const
 
void SetReversedEdges (std::vector< int > &ids)
 
const std::vector< int > & GetReversedEdges () const
 
void SetObjectEntry (const char *entry)
 
const char * GetObjectEntry ()
 
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 start and end length by the mesh built on the geometry. More...
 
virtual bool SetParametersByDefaults (const TDefaults &dflts, const SMESH_Mesh *theMesh=0)
 Initialize my parameter values by default parameters. More...
 
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. More...
 
const char * GetName () const
 
int GetID () const
 
int GetType () const
 

Static Public Member Functions

static bool IsStatusFatal (Hypothesis_Status theStatus)
 

Protected Attributes

double _begLength
 
double _endLength
 
std::vector< int_edgeIDs
 
std::string _objEntry
 
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_StartEndLength &hyp)
 
std::istream & operator>> (std::istream &load, StdMeshers_StartEndLength &hyp)
 

Detailed Description

Definition at line 36 of file StdMeshers_StartEndLength.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

◆ StdMeshers_StartEndLength()

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

◆ ~ StdMeshers_StartEndLength()

virtual StdMeshers_StartEndLength::~ StdMeshers_StartEndLength ( )
virtual

Member Function Documentation

◆ SetLength()

void StdMeshers_StartEndLength::SetLength ( double  length,
bool  isStartLength 
)
throw (SMESH_Exception
)

◆ GetLength()

double StdMeshers_StartEndLength::GetLength ( bool  isStartLength) const

◆ SetReversedEdges()

void StdMeshers_StartEndLength::SetReversedEdges ( std::vector< int > &  ids)

◆ GetReversedEdges()

const std::vector<int>& StdMeshers_StartEndLength::GetReversedEdges ( ) const

Definition at line 48 of file StdMeshers_StartEndLength.hxx.

◆ SetObjectEntry()

void StdMeshers_StartEndLength::SetObjectEntry ( const char *  entry)

Definition at line 50 of file StdMeshers_StartEndLength.hxx.

◆ GetObjectEntry()

const char* StdMeshers_StartEndLength::GetObjectEntry ( )

Definition at line 52 of file StdMeshers_StartEndLength.hxx.

◆ SaveTo()

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

Implements SMESHDS_Hypothesis.

◆ LoadFrom()

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

Implements SMESHDS_Hypothesis.

◆ SetParametersByMesh()

virtual bool StdMeshers_StartEndLength::SetParametersByMesh ( const SMESH_Mesh theMesh,
const TopoDS_Shape &  theShape 
)
virtual

Initialize start and end length 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

Implements SMESH_Hypothesis.

◆ SetParametersByDefaults()

virtual bool StdMeshers_StartEndLength::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.

◆ IsStatusFatal()

static bool SMESH_Hypothesis::IsStatusFatal ( Hypothesis_Status  theStatus)
staticinherited

Definition at line 68 of file SMESH_Hypothesis.hxx.

◆ GetDim()

virtual int SMESH_Hypothesis::GetDim ( ) const
virtualinherited

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

Here is the caller graph for this function:

◆ GetStudyId()

int SMESH_Hypothesis::GetStudyId ( ) const
inherited

◆ NotifySubMeshesHypothesisModification()

virtual void SMESH_Hypothesis::NotifySubMeshesHypothesisModification ( )
virtualinherited

◆ GetShapeType()

virtual int SMESH_Hypothesis::GetShapeType ( ) const
virtualinherited

◆ GetLibName()

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

◆ SetLibName()

void SMESH_Hypothesis::SetLibName ( const char *  theLibName)
inherited

◆ SetParameters()

void SMESH_Hypothesis::SetParameters ( const char *  theParameters)
inherited

◆ GetParameters()

char* SMESH_Hypothesis::GetParameters ( ) const
inherited

◆ SetLastParameters()

void SMESH_Hypothesis::SetLastParameters ( const char *  theParameters)
inherited

◆ GetLastParameters()

char* SMESH_Hypothesis::GetLastParameters ( ) const
inherited

◆ ClearParameters()

void SMESH_Hypothesis::ClearParameters ( )
inherited

◆ IsAuxiliary()

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:

◆ GetName()

const char* SMESHDS_Hypothesis::GetName ( ) const
inherited

◆ GetID()

int SMESHDS_Hypothesis::GetID ( ) const
inherited

◆ GetType()

int SMESHDS_Hypothesis::GetType ( ) const
inherited

Referenced by SMESH_Hypothesis::IsAuxiliary().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  save,
StdMeshers_StartEndLength hyp 
)
friend

◆ operator>>

std::istream& operator>> ( std::istream &  load,
StdMeshers_StartEndLength hyp 
)
friend

Field Documentation

◆ _begLength

double StdMeshers_StartEndLength::_begLength
protected

Definition at line 75 of file StdMeshers_StartEndLength.hxx.

◆ _endLength

double StdMeshers_StartEndLength::_endLength
protected

Definition at line 75 of file StdMeshers_StartEndLength.hxx.

◆ _edgeIDs

std::vector<int> StdMeshers_StartEndLength::_edgeIDs
protected

Definition at line 76 of file StdMeshers_StartEndLength.hxx.

◆ _objEntry

std::string StdMeshers_StartEndLength::_objEntry
protected

Definition at line 77 of file StdMeshers_StartEndLength.hxx.

◆ _gen

SMESH_Gen* SMESH_Hypothesis::_gen
protectedinherited

Definition at line 118 of file SMESH_Hypothesis.hxx.

◆ _studyId

int SMESH_Hypothesis::_studyId
protectedinherited

Definition at line 119 of file SMESH_Hypothesis.hxx.

◆ _shapeType

int SMESH_Hypothesis::_shapeType
protectedinherited

Definition at line 120 of file SMESH_Hypothesis.hxx.

◆ _param_algo_dim

int SMESH_Hypothesis::_param_algo_dim
protectedinherited

Definition at line 121 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.