StdMeshers_ProjectionSource2D Class Reference

#include <StdMeshers_ProjectionSource2D.hxx>

Public Member Functions

TopoDS_Shape GetSourceFace () const
 
SMESH_MeshGetSourceMesh () const
 
TopoDS_Vertex GetSourceVertex (int i) const
 
void GetStoreParams (TopoDS_Shape &s1, TopoDS_Shape &s2, TopoDS_Shape &s3, TopoDS_Shape &s4, TopoDS_Shape &s5) const
 Return all parameters. More...
 
TopoDS_Vertex GetTargetVertex (int i) const
 
bool HasVertexAssociation () const
 Test if vertex association defined. More...
 
bool IsCompoundSource () const
 
virtual std::istream & LoadFrom (std::istream &load)
 
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 bool SetParametersByDefaults (const TDefaults &dflts, const SMESH_Mesh *theMesh=0)
 Initialize my parameter values by default parameters. More...
 
virtual bool SetParametersByMesh (const SMESH_Mesh *theMesh, const TopoDS_Shape &theShape)
 Initialize parameters by the mesh built on the geometry. More...
 
void SetSourceFace (const TopoDS_Shape &face)
 
void SetSourceMesh (SMESH_Mesh *mesh)
 
void SetVertexAssociation (const TopoDS_Shape &sourceVertex1, const TopoDS_Shape &sourceVertex2, const TopoDS_Shape &targetVertex1, const TopoDS_Shape &targetVertex2)
 
 StdMeshers_ProjectionSource2D (int hypId, int studyId, SMESH_Gen *gen)
 
virtual ~StdMeshers_ProjectionSource2D ()
 
- Public Member Functions inherited from SMESH_Hypothesis
void ClearParameters ()
 
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. True result is reasonable for example if EventListeners depend on parameters of hypothesis. More...
 
virtual int GetDim () const
 
SMESH_GenGetGen () const
 
char * GetLastParameters () const
 
virtual const char * GetLibName () const
 
SMESH_MeshGetMeshByPersistentID (int id)
 Find a mesh with given persistent ID. More...
 
char * GetParameters () const
 
virtual int GetShapeType () const
 
int GetStudyId () const
 
virtual bool IsAuxiliary () const
 Return true if me is an auxiliary hypothesis. More...
 
virtual void NotifySubMeshesHypothesisModification ()
 
void SetLastParameters (const char *theParameters)
 
void SetLibName (const char *theLibName)
 
void SetParameters (const char *theParameters)
 
virtual bool SetParametersByDefaults (const TDefaults &dflts, const SMESH_Mesh *theMesh=0)=0
 Initialize my parameter values by default parameters. More...
 
virtual bool SetParametersByMesh (const SMESH_Mesh *theMesh, const TopoDS_Shape &theShape)=0
 Initialize my parameter values by the mesh built on the geometry. More...
 
 SMESH_Hypothesis (int hypId, int studyId, SMESH_Gen *gen)
 
virtual ~SMESH_Hypothesis ()
 
- Public Member Functions inherited from SMESHDS_Hypothesis
int GetID () const
 
const char * GetName () const
 
int GetType () const
 
bool IsSameName (const SMESHDS_Hypothesis &other) const
 Compare types of hypotheses. More...
 
virtual std::istream & LoadFrom (std::istream &load)=0
 
bool operator!= (const SMESHDS_Hypothesis &other) const
 
virtual bool operator== (const SMESHDS_Hypothesis &other) const
 
virtual std::ostream & SaveTo (std::ostream &save)=0
 
 SMESHDS_Hypothesis (int hypId)
 
virtual ~SMESHDS_Hypothesis ()
 

Friends

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

Additional Inherited Members

- Public Types inherited from SMESH_Hypothesis
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
}
 
- Public Types inherited from SMESHDS_Hypothesis
enum  hypothesis_type {
  PARAM_ALGO , ALGO_0D , ALGO_1D , ALGO_2D ,
  ALGO_3D
}
 
- Static Public Member Functions inherited from SMESH_Hypothesis
static bool IsStatusFatal (Hypothesis_Status theStatus)
 

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)

Constructor & Destructor Documentation

◆ StdMeshers_ProjectionSource2D()

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

◆ ~StdMeshers_ProjectionSource2D()

StdMeshers_ProjectionSource2D::~StdMeshers_ProjectionSource2D ( )
virtual

Member Function Documentation

◆ GetSourceFace()

TopoDS_Shape StdMeshers_ProjectionSource2D::GetSourceFace ( ) const

Returns the source face or a group containing faces

Returns the source face

Referenced by StdMeshers_ProjectionUtils::MakeComputed().

◆ GetSourceMesh()

SMESH_Mesh * StdMeshers_ProjectionSource2D::GetSourceMesh ( ) const

Return source mesh

Referenced by StdMeshers_ProjectionUtils::MakeComputed().

◆ GetSourceVertex()

TopoDS_Vertex StdMeshers_ProjectionSource2D::GetSourceVertex ( int  i) const

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

Returns the vertex associated with the target vertex. Result may be nil if association not set

Referenced by StdMeshers_ProjectionUtils::InitVertexAssociation().

◆ GetStoreParams()

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

Return all parameters.

◆ GetTargetVertex()

TopoDS_Vertex StdMeshers_ProjectionSource2D::GetTargetVertex ( int  i) const

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

Returns the -th target vertex associated with the -th source vertex. Result may be nil if association not set.

Referenced by StdMeshers_ProjectionUtils::InitVertexAssociation().

◆ HasVertexAssociation()

bool StdMeshers_ProjectionSource2D::HasVertexAssociation ( ) const

Test if vertex association defined.

Return values
bool- test result

Referenced by StdMeshers_ProjectionUtils::InitVertexAssociation().

◆ IsCompoundSource()

bool StdMeshers_ProjectionSource2D::IsCompoundSource ( ) const

Returns true the source face is a group of faces

◆ LoadFrom()

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

Implements SMESHDS_Hypothesis.

◆ 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()

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

◆ SetParametersByDefaults()

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.

◆ SetParametersByMesh()

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

Initialize parameters by the mesh built on the geometry.

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

Implementation does noting

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

Implements SMESH_Hypothesis.

◆ SetSourceFace()

void StdMeshers_ProjectionSource2D::SetSourceFace ( const TopoDS_Shape &  Face)

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

References SMESH_Hypothesis::NotifySubMeshesHypothesisModification().

◆ SetSourceMesh()

void StdMeshers_ProjectionSource2D::SetSourceMesh ( SMESH_Mesh mesh)

Sets source <mesh> to take a mesh pattern from

References SMESH_Hypothesis::NotifySubMeshesHypothesisModification().

◆ SetVertexAssociation()

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

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

References SMESH_MesherHelper::Count(), and SMESH_Hypothesis::NotifySubMeshesHypothesisModification().

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

The documentation for this class was generated from the following files: