Version: 8.3.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends
StdMeshers_StartEndLength Class Reference

#include <StdMeshers_StartEndLength.hxx>

Inheritance diagram for StdMeshers_StartEndLength:
Inheritance graph
[legend]

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, HYP_INCOMPAT_HYPS
}
 
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 (SALOME_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
 
SMESH_Gen * GetGen () const
 
virtual int GetShapeType () const
 
virtual const char * GetLibName () const
 
virtual void NotifySubMeshesHypothesisModification ()
 
void SetLibName (const char *theLibName)
 
virtual bool DataDependOnParams () const
 The returned value is used by NotifySubMeshesHypothesisModification() to decide to call subMesh->AlgoStateEngine( MODIF_HYP, hyp ) or not if subMesh is ready to be computed (algo+hyp==OK) but not yet computed. More...
 
virtual bool IsAuxiliary () const
 Return true if me is an auxiliary hypothesis. More...
 
SMESH_Mesh * GetMeshByPersistentID (int id)
 Find a mesh with given persistent ID. More...
 
const char * GetName () const
 
int GetID () const
 
int GetType () const
 
bool IsSameName (const SMESHDS_Hypothesis &other) const
 Compare types of hypotheses. More...
 
virtual bool operator== (const SMESHDS_Hypothesis &other) const
 Equality. More...
 
bool operator!= (const SMESHDS_Hypothesis &other) 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
 
hypothesis_type _type
 

Friends

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

Member Enumeration Documentation

enum SMESH_Hypothesis::Hypothesis_Status
inherited
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 
HYP_INCOMPAT_HYPS 
enum SMESHDS_Hypothesis::hypothesis_type
inherited
Enumerator
PARAM_ALGO 
ALGO_0D 
ALGO_1D 
ALGO_2D 
ALGO_3D 

Constructor & Destructor Documentation

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

References _begLength, _endLength, SMESHDS_Hypothesis::_name, and SMESH_Hypothesis::_param_algo_dim.

StdMeshers_StartEndLength::~StdMeshers_StartEndLength ( )
virtual

Member Function Documentation

virtual bool SMESH_Hypothesis::DataDependOnParams ( ) const
virtualinherited

The returned value is used by NotifySubMeshesHypothesisModification() to decide to call subMesh->AlgoStateEngine( MODIF_HYP, hyp ) or not if subMesh is ready to be computed (algo+hyp==OK) but not yet computed.

True result is reasonable for example if EventListeners depend on parameters of hypothesis.

Reimplemented in StdMeshers_ImportSource1D.

int SMESH_Hypothesis::GetDim ( ) const
virtualinherited

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

SMESH_Gen* SMESH_Hypothesis::GetGen ( ) const
inherited

Referenced by StdMeshers_Hexa_3D::Compute().

int SMESHDS_Hypothesis::GetID ( ) const
inherited

Referenced by SMESHDS_Document::AddHypothesis().

double StdMeshers_StartEndLength::GetLength ( bool  isStartLength) const
virtual const char* SMESH_Hypothesis::GetLibName ( ) const
virtualinherited
SMESH_Mesh * SMESH_Hypothesis::GetMeshByPersistentID ( int  id)
inherited

Find a mesh with given persistent ID.

References studyContextStruct::mapMesh.

const char * SMESHDS_Hypothesis::GetName ( ) const
inherited

Referenced by StdMeshers_Projection_3D::CheckHypothesis(), StdMeshers_Projection_2D::CheckHypothesis(), StdMeshers_Projection_1D::CheckHypothesis(), StdMeshers_Import_1D2D::CheckHypothesis(), StdMeshers_Import_1D::CheckHypothesis(), StdMeshers_RadialQuadrangle_1D2D::CheckHypothesis(), StdMeshers_RadialPrism_3D::CheckHypothesis(), StdMeshers_Regular_1D::CheckHypothesis(), StdMeshers_MEFISTO_2D::CheckHypothesis(), and StdMeshers_Quadrangle_2D::CheckHypothesis().

const char* StdMeshers_StartEndLength::GetObjectEntry ( )
const std::vector<int>& StdMeshers_StartEndLength::GetReversedEdges ( ) const
int SMESH_Hypothesis::GetShapeType ( ) const
virtualinherited
int SMESH_Hypothesis::GetStudyId ( ) const
inherited
int SMESHDS_Hypothesis::GetType ( ) const
inherited

Referenced by checkConformIgnoredAlgos(), SMESH_Hypothesis::IsAuxiliary(), and SMESH_Mesh::IsUsedHypothesis().

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 dimension can be assigned to the shape

References SMESHDS_Hypothesis::GetType().

bool SMESHDS_Hypothesis::IsSameName ( const SMESHDS_Hypothesis &  other) const
inherited

Compare types of hypotheses.

References SMESHDS_Hypothesis::_name.

Referenced by StdMeshers_Regular_1D::CheckHypothesis().

static bool SMESH_Hypothesis::IsStatusFatal ( Hypothesis_Status  theStatus)
staticinherited

References SMESH::HYP_UNKNOWN_FATAL.

Referenced by SMESH_Mesh_i::AddHypothesis(), SMESH_Mesh_i::addHypothesis(), SMESH_subMesh::AlgoStateEngine(), SMESH_Mesh_i::RemoveHypothesis(), SMESH_Mesh::RemoveHypothesis(), SMESH_Mesh_i::removeHypothesis(), and SMESH_subMesh::SubMeshesAlgoStateEngine().

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

Implements SMESHDS_Hypothesis.

void SMESH_Hypothesis::NotifySubMeshesHypothesisModification ( )
virtualinherited

References studyContextStruct::mapMesh.

Referenced by StdMeshers_Reversible1D::SetReversedEdges(), and StdMeshers_ProjectionSource2D::SetSourceMesh().

bool SMESHDS_Hypothesis::operator!= ( const SMESHDS_Hypothesis &  other) const
inherited
bool SMESHDS_Hypothesis::operator== ( const SMESHDS_Hypothesis &  other) const
virtualinherited

Equality.

References SMESHDS_Hypothesis::_name.

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

Implements SMESHDS_Hypothesis.

void StdMeshers_StartEndLength::SetLength ( double  length,
bool  isStartLength 
) throw (SALOME_Exception)
void SMESH_Hypothesis::SetLibName ( const char *  theLibName)
inherited
void StdMeshers_StartEndLength::SetObjectEntry ( const char *  entry)
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.

References SMESH_Hypothesis::TDefaults::_elemLength.

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.

References Edge, SMESH_Algo::GetNodeParamOnEdge(), and Handle().

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

Friends And Related Function Documentation

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

Field Documentation

double StdMeshers_StartEndLength::_begLength
protected

Referenced by StdMeshers_StartEndLength().

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

Referenced by StdMeshers_StartEndLength().

SMESH_Gen* SMESH_Hypothesis::_gen
protectedinherited

Referenced by SMESH_Hypothesis::SMESH_Hypothesis().

int SMESHDS_Hypothesis::_hypId
protectedinherited
std::string SMESHDS_Hypothesis::_name
protectedinherited

Referenced by SMESHDS_Hypothesis::IsSameName(), SMESHDS_Hypothesis::operator==(), StdMeshers_Adaptive1D::StdMeshers_Adaptive1D(), StdMeshers_Arithmetic1D::StdMeshers_Arithmetic1D(), StdMeshers_AutomaticLength::StdMeshers_AutomaticLength(), StdMeshers_Cartesian_3D::StdMeshers_Cartesian_3D(), StdMeshers_CartesianParameters3D::StdMeshers_CartesianParameters3D(), StdMeshers_CompositeHexa_3D::StdMeshers_CompositeHexa_3D(), StdMeshers_CompositeSegment_1D::StdMeshers_CompositeSegment_1D(), StdMeshers_Deflection1D::StdMeshers_Deflection1D(), StdMeshers_FixedPoints1D::StdMeshers_FixedPoints1D(), StdMeshers_Geometric1D::StdMeshers_Geometric1D(), StdMeshers_Hexa_3D::StdMeshers_Hexa_3D(), StdMeshers_HexaFromSkin_3D::StdMeshers_HexaFromSkin_3D(), StdMeshers_Import_1D::StdMeshers_Import_1D(), StdMeshers_Import_1D2D::StdMeshers_Import_1D2D(), StdMeshers_ImportSource1D::StdMeshers_ImportSource1D(), StdMeshers_ImportSource2D::StdMeshers_ImportSource2D(), StdMeshers_LayerDistribution::StdMeshers_LayerDistribution(), StdMeshers_LayerDistribution2D::StdMeshers_LayerDistribution2D(), StdMeshers_LengthFromEdges::StdMeshers_LengthFromEdges(), StdMeshers_LocalLength::StdMeshers_LocalLength(), StdMeshers_MaxElementArea::StdMeshers_MaxElementArea(), StdMeshers_MaxElementVolume::StdMeshers_MaxElementVolume(), StdMeshers_MaxLength::StdMeshers_MaxLength(), StdMeshers_MEFISTO_2D::StdMeshers_MEFISTO_2D(), StdMeshers_NotConformAllowed::StdMeshers_NotConformAllowed(), StdMeshers_NumberOfLayers::StdMeshers_NumberOfLayers(), StdMeshers_NumberOfLayers2D::StdMeshers_NumberOfLayers2D(), StdMeshers_NumberOfSegments::StdMeshers_NumberOfSegments(), StdMeshers_PolygonPerFace_2D::StdMeshers_PolygonPerFace_2D(), StdMeshers_Prism_3D::StdMeshers_Prism_3D(), StdMeshers_Projection_1D::StdMeshers_Projection_1D(), StdMeshers_Projection_1D2D::StdMeshers_Projection_1D2D(), StdMeshers_Projection_2D::StdMeshers_Projection_2D(), StdMeshers_Projection_3D::StdMeshers_Projection_3D(), StdMeshers_ProjectionSource1D::StdMeshers_ProjectionSource1D(), StdMeshers_ProjectionSource2D::StdMeshers_ProjectionSource2D(), StdMeshers_ProjectionSource3D::StdMeshers_ProjectionSource3D(), StdMeshers_Propagation::StdMeshers_Propagation(), StdMeshers_PropagOfDistribution::StdMeshers_PropagOfDistribution(), StdMeshers_QuadFromMedialAxis_1D2D::StdMeshers_QuadFromMedialAxis_1D2D(), StdMeshers_Quadrangle_2D::StdMeshers_Quadrangle_2D(), StdMeshers_QuadrangleParams::StdMeshers_QuadrangleParams(), StdMeshers_QuadranglePreference::StdMeshers_QuadranglePreference(), StdMeshers_QuadraticMesh::StdMeshers_QuadraticMesh(), StdMeshers_RadialPrism_3D::StdMeshers_RadialPrism_3D(), StdMeshers_RadialQuadrangle_1D2D::StdMeshers_RadialQuadrangle_1D2D(), StdMeshers_Regular_1D::StdMeshers_Regular_1D(), StdMeshers_StartEndLength(), StdMeshers_ViscousLayers::StdMeshers_ViscousLayers(), and StdMeshers_ViscousLayers2D::StdMeshers_ViscousLayers2D().

std::string StdMeshers_StartEndLength::_objEntry
protected
int SMESH_Hypothesis::_param_algo_dim
protectedinherited

Referenced by SMESH_Hypothesis::SMESH_Hypothesis(), StdMeshers_Adaptive1D::StdMeshers_Adaptive1D(), StdMeshers_Arithmetic1D::StdMeshers_Arithmetic1D(), StdMeshers_AutomaticLength::StdMeshers_AutomaticLength(), StdMeshers_CartesianParameters3D::StdMeshers_CartesianParameters3D(), StdMeshers_Deflection1D::StdMeshers_Deflection1D(), StdMeshers_FixedPoints1D::StdMeshers_FixedPoints1D(), StdMeshers_ImportSource1D::StdMeshers_ImportSource1D(), StdMeshers_ImportSource2D::StdMeshers_ImportSource2D(), StdMeshers_LayerDistribution::StdMeshers_LayerDistribution(), StdMeshers_LayerDistribution2D::StdMeshers_LayerDistribution2D(), StdMeshers_LengthFromEdges::StdMeshers_LengthFromEdges(), StdMeshers_LocalLength::StdMeshers_LocalLength(), StdMeshers_MaxElementArea::StdMeshers_MaxElementArea(), StdMeshers_MaxElementVolume::StdMeshers_MaxElementVolume(), StdMeshers_MaxLength::StdMeshers_MaxLength(), StdMeshers_NotConformAllowed::StdMeshers_NotConformAllowed(), StdMeshers_NumberOfLayers::StdMeshers_NumberOfLayers(), StdMeshers_NumberOfLayers2D::StdMeshers_NumberOfLayers2D(), StdMeshers_NumberOfSegments::StdMeshers_NumberOfSegments(), StdMeshers_ProjectionSource1D::StdMeshers_ProjectionSource1D(), StdMeshers_ProjectionSource2D::StdMeshers_ProjectionSource2D(), StdMeshers_ProjectionSource3D::StdMeshers_ProjectionSource3D(), StdMeshers_Propagation::StdMeshers_Propagation(), StdMeshers_QuadrangleParams::StdMeshers_QuadrangleParams(), StdMeshers_QuadranglePreference::StdMeshers_QuadranglePreference(), StdMeshers_QuadraticMesh::StdMeshers_QuadraticMesh(), StdMeshers_Reversible1D::StdMeshers_Reversible1D(), StdMeshers_StartEndLength(), StdMeshers_ViscousLayers::StdMeshers_ViscousLayers(), and StdMeshers_ViscousLayers2D::StdMeshers_ViscousLayers2D().

int SMESH_Hypothesis::_shapeType
protectedinherited

Referenced by SMESH_0D_Algo::SMESH_0D_Algo(), SMESH_1D_Algo::SMESH_1D_Algo(), SMESH_2D_Algo::SMESH_2D_Algo(), SMESH_3D_Algo::SMESH_3D_Algo(), SMESH_Hypothesis::SMESH_Hypothesis(), StdMeshers_Cartesian_3D::StdMeshers_Cartesian_3D(), StdMeshers_CompositeHexa_3D::StdMeshers_CompositeHexa_3D(), StdMeshers_Hexa_3D::StdMeshers_Hexa_3D(), StdMeshers_Import_1D::StdMeshers_Import_1D(), StdMeshers_Import_1D2D::StdMeshers_Import_1D2D(), StdMeshers_MEFISTO_2D::StdMeshers_MEFISTO_2D(), StdMeshers_Prism_3D::StdMeshers_Prism_3D(), StdMeshers_Projection_1D::StdMeshers_Projection_1D(), StdMeshers_Projection_3D::StdMeshers_Projection_3D(), StdMeshers_QuadFromMedialAxis_1D2D::StdMeshers_QuadFromMedialAxis_1D2D(), StdMeshers_Quadrangle_2D::StdMeshers_Quadrangle_2D(), StdMeshers_RadialPrism_3D::StdMeshers_RadialPrism_3D(), StdMeshers_RadialQuadrangle_1D2D::StdMeshers_RadialQuadrangle_1D2D(), and StdMeshers_Regular_1D::StdMeshers_Regular_1D().

int SMESH_Hypothesis::_studyId
protectedinherited

Referenced by SMESH_Hypothesis::SMESH_Hypothesis().

hypothesis_type SMESHDS_Hypothesis::_type
protectedinherited

Referenced by SMESH_0D_Algo::SMESH_0D_Algo(), SMESH_1D_Algo::SMESH_1D_Algo(), SMESH_2D_Algo::SMESH_2D_Algo(), SMESH_3D_Algo::SMESH_3D_Algo(), and SMESH_Hypothesis::SMESH_Hypothesis().