SALOME - SMESH
StdMeshers_ProjectionSource2D Class Reference

#include <StdMeshers_ProjectionSource2D.hxx>

Inheritance diagram for StdMeshers_ProjectionSource2D:
Inheritance graph
Collaboration diagram for StdMeshers_ProjectionSource2D:
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_ProjectionSource2D (int hypId, int studyId, SMESH_Gen *gen)
 
virtual ~StdMeshers_ProjectionSource2D ()
 
void SetSourceFace (const TopoDS_Shape &face) throw ( SMESH_Exception )
 
TopoDS_Shape GetSourceFace () const
 
bool IsCompoundSource () const
 
void SetSourceMesh (SMESH_Mesh *mesh)
 
SMESH_MeshGetSourceMesh () const
 
void SetVertexAssociation (const TopoDS_Shape &sourceVertex1, const TopoDS_Shape &sourceVertex2, const TopoDS_Shape &targetVertex1, const TopoDS_Shape &targetVertex2) throw ( SMESH_Exception )
 
TopoDS_Vertex GetSourceVertex (int i) const throw ( SMESH_Exception )
 
TopoDS_Vertex GetTargetVertex (int i) const throw ( SMESH_Exception )
 
bool HasVertexAssociation () const
 Test if vertex association defined. More...
 
void GetStoreParams (TopoDS_Shape &s1, TopoDS_Shape &s2, TopoDS_Shape &s3, TopoDS_Shape &s4, TopoDS_Shape &s5) const
 Return all parameters. More...
 
void RestoreParams (const TopoDS_Shape &s1, const TopoDS_Shape &s2, const TopoDS_Shape &s3, const TopoDS_Shape &s4, const TopoDS_Shape &s5, SMESH_Mesh *mesh)
 Set all parameters without notifying on modification. More...
 
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 parameters 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

TopoDS_Shape _sourceFace
 
SMESH_Mesh_sourceMesh
 
TopoDS_Vertex _sourceVertex1
 
TopoDS_Vertex _sourceVertex2
 
TopoDS_Vertex _targetVertex1
 
TopoDS_Vertex _targetVertex2
 
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_ProjectionSource2D &hyp)
 
std::istream & operator>> (std::istream &load, StdMeshers_ProjectionSource2D &hyp)
 

Detailed Description

This hypothesis specifies a meshed face to take a mesh pattern from and optionally association of vertices between the source face and a target one (where a hipothesis is assigned to)

Definition at line 47 of file StdMeshers_ProjectionSource2D.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_ProjectionSource2D()

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

◆ ~StdMeshers_ProjectionSource2D()

virtual StdMeshers_ProjectionSource2D::~StdMeshers_ProjectionSource2D ( )
virtual

Member Function Documentation

◆ SetSourceFace()

void StdMeshers_ProjectionSource2D::SetSourceFace ( const TopoDS_Shape &  face)
throw (SMESH_Exception
)

Sets a source <face> to take a mesh pattern from

◆ GetSourceFace()

TopoDS_Shape StdMeshers_ProjectionSource2D::GetSourceFace ( ) const

Returns the source face or a group containing faces

◆ IsCompoundSource()

bool StdMeshers_ProjectionSource2D::IsCompoundSource ( ) const

Returns true the source face is a group of faces

Definition at line 69 of file StdMeshers_ProjectionSource2D.hxx.

◆ SetSourceMesh()

void StdMeshers_ProjectionSource2D::SetSourceMesh ( SMESH_Mesh mesh)

Sets source <mesh> to take a mesh pattern from

◆ GetSourceMesh()

SMESH_Mesh* StdMeshers_ProjectionSource2D::GetSourceMesh ( ) const

Return source mesh

Definition at line 80 of file StdMeshers_ProjectionSource2D.hxx.

◆ SetVertexAssociation()

void StdMeshers_ProjectionSource2D::SetVertexAssociation ( const TopoDS_Shape &  sourceVertex1,
const TopoDS_Shape &  sourceVertex2,
const TopoDS_Shape &  targetVertex1,
const TopoDS_Shape &  targetVertex2 
)
throw (SMESH_Exception
)

Sets vertex association between the source face and the target one. This parameter is optional. Two vertices must belong to one edge of a face

◆ GetSourceVertex()

TopoDS_Vertex StdMeshers_ProjectionSource2D::GetSourceVertex ( int  i) const
throw (SMESH_Exception
)

Returns the -th source vertex associated with the -th target vertex. Result may be nil if association not set. Valid indices are 1 and 2

◆ GetTargetVertex()

TopoDS_Vertex StdMeshers_ProjectionSource2D::GetTargetVertex ( int  i) const
throw (SMESH_Exception
)

Returns the -th target vertex associated with the -th source vertex. Result may be nil if association not set. Valid indices are 1 and 2

◆ HasVertexAssociation()

bool StdMeshers_ProjectionSource2D::HasVertexAssociation ( ) const

Test if vertex association defined.

Return values
bool- test result

Definition at line 111 of file StdMeshers_ProjectionSource2D.hxx.

◆ GetStoreParams()

void StdMeshers_ProjectionSource2D::GetStoreParams ( TopoDS_Shape &  s1,
TopoDS_Shape &  s2,
TopoDS_Shape &  s3,
TopoDS_Shape &  s4,
TopoDS_Shape &  s5 
) const

Return all parameters.

◆ RestoreParams()

void StdMeshers_ProjectionSource2D::RestoreParams ( const TopoDS_Shape &  s1,
const TopoDS_Shape &  s2,
const TopoDS_Shape &  s3,
const TopoDS_Shape &  s4,
const TopoDS_Shape &  s5,
SMESH_Mesh mesh 
)

Set all parameters without notifying on modification.

◆ SaveTo()

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

Implements SMESHDS_Hypothesis.

◆ LoadFrom()

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

Implements SMESHDS_Hypothesis.

◆ SetParametersByMesh()

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

Initialize parameters 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

Implementation does noting

Implements SMESH_Hypothesis.

◆ SetParametersByDefaults()

virtual bool StdMeshers_ProjectionSource2D::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_ProjectionSource2D hyp 
)
friend

◆ operator>>

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

Field Documentation

◆ _sourceFace

TopoDS_Shape StdMeshers_ProjectionSource2D::_sourceFace
protected

Definition at line 157 of file StdMeshers_ProjectionSource2D.hxx.

◆ _sourceMesh

SMESH_Mesh* StdMeshers_ProjectionSource2D::_sourceMesh
protected

Definition at line 158 of file StdMeshers_ProjectionSource2D.hxx.

◆ _sourceVertex1

TopoDS_Vertex StdMeshers_ProjectionSource2D::_sourceVertex1
protected

Definition at line 159 of file StdMeshers_ProjectionSource2D.hxx.

◆ _sourceVertex2

TopoDS_Vertex StdMeshers_ProjectionSource2D::_sourceVertex2
protected

Definition at line 160 of file StdMeshers_ProjectionSource2D.hxx.

◆ _targetVertex1

TopoDS_Vertex StdMeshers_ProjectionSource2D::_targetVertex1
protected

Definition at line 161 of file StdMeshers_ProjectionSource2D.hxx.

◆ _targetVertex2

TopoDS_Vertex StdMeshers_ProjectionSource2D::_targetVertex2
protected

Definition at line 162 of file StdMeshers_ProjectionSource2D.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.