#include <StdMeshers_MaxLength.hxx>

Inheritance diagram for StdMeshers_MaxLength:

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_MaxLength (int hypId, int studyId, SMESH_Gen *gen)
virtual	~StdMeshers_MaxLength ()
void	SetLength (double length) throw (SALOME_Exception)
double	GetLength () const
bool	HavePreestimatedLength () const
double	GetPreestimatedLength () const
void	SetPreestimatedLength (double length)
	Store preestemated length.
void	SetUsePreestimatedLength (bool toUse)
	Sets boolean parameter enabling/desabling usage of length computed basing on size of bounding box of shape to mesh.
bool	GetUsePreestimatedLength () const
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 segment length by the mesh built on the geometry.
virtual bool	SetParametersByDefaults (const TDefaults &dflts, const SMESH_Mesh *theMesh=0)
	Initialize my parameter values by default parameters.
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.
SMESH_Mesh *	GetMeshByPersistentID (int id)
	Find a mesh with given persistent ID.
const char *	GetName () const
int	GetID () const
int	GetType () const
virtual bool	operator== (const SMESHDS_Hypothesis &other) const
	Equality.
bool	operator!= (const SMESHDS_Hypothesis &other) const
Static Public Member Functions
static bool	IsStatusFatal (Hypothesis_Status theStatus)
Protected Attributes
double	_length
double	_preestimated
bool	_preestimation
SMESH_Gen *	_gen
int	_studyId
int	_shapeType
int	_param_algo_dim
std::string	_name
int	_hypId
int	_type

Detailed Description

Definition at line 32 of file StdMeshers_MaxLength.hxx.

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

Definition at line 50 of file SMESH_Hypothesis.hxx.

  {
    HYP_OK = 0,
    HYP_MISSING,      // algo misses a hypothesis
    HYP_CONCURENT,    // several applicable hypotheses
    HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
    HYP_HIDDEN_ALGO,  // an algo is hidden by an upper dim algo generating all-dim elements
    HYP_HIDING_ALGO,  // an algo hides lower dim algos by generating all-dim elements
    HYP_UNKNOWN_FATAL,//  --- all statuses below should be considered as fatal
                      //      for Add/RemoveHypothesis operations
    HYP_INCOMPATIBLE, // hypothesis does not fit algo
    HYP_NOTCONFORM,   // not conform mesh is produced appling a hypothesis
    HYP_ALREADY_EXIST,// such hypothesis already exist
    HYP_BAD_DIM,      // bad dimension
    HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its subshape, nor a group
    HYP_BAD_GEOMETRY, // shape geometry mismatches algorithm's expectation
    HYP_NEED_SHAPE    // algorithm can work on shape only
  };

enum SMESHDS_Hypothesis::hypothesis_type [inherited]

Enumerator:

PARAM_ALGO
ALGO_0D
ALGO_1D
ALGO_2D
ALGO_3D

Definition at line 53 of file SMESHDS_Hypothesis.hxx.

{PARAM_ALGO, ALGO_0D, ALGO_1D, ALGO_2D, ALGO_3D};

Constructor & Destructor Documentation

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

Definition at line 50 of file StdMeshers_MaxLength.cxx.

References _length, SMESHDS_Hypothesis._name, SMESH_Hypothesis._param_algo_dim, _preestimated, and _preestimation.

  :SMESH_Hypothesis(hypId, studyId, gen)
{
  _length = 1.;
  _preestimated = 0.;
  _preestimation = false;
  _name = "MaxLength";
  _param_algo_dim = 1; // is used by SMESH_Regular_1D
}

StdMeshers_MaxLength::~StdMeshers_MaxLength ( ) [virtual]

Definition at line 66 of file StdMeshers_MaxLength.cxx.

{
}

Member Function Documentation

void SMESH_Hypothesis.ClearParameters ( ) [inherited]

int SMESH_Hypothesis::GetDim ( ) const [virtual, inherited]

Definition at line 74 of file SMESH_Hypothesis.cxx.

{
  int dim = 0;
  switch (_type)
    {
    case ALGO_1D: dim = 1; break;
    case ALGO_2D: dim = 2; break;
    case ALGO_3D: dim = 3; break;
    case PARAM_ALGO:
      dim = ( _param_algo_dim < 0 ) ? -_param_algo_dim : _param_algo_dim; break;
    }
  return dim;
}

int SMESHDS_Hypothesis::GetID ( ) const [inherited]

Definition at line 73 of file SMESHDS_Hypothesis.cxx.

Referenced by SMESHDS_Document.AddHypothesis(), and SMESH_Mesh_i.GetHypothesisList().

{
  return _hypId;
}

char* SMESH_Hypothesis.GetLastParameters ( ) const [inherited]

double StdMeshers_MaxLength.GetLength ( ) const

virtual const char* SMESH_Hypothesis.GetLibName ( ) const [virtual, inherited]

SMESH_Mesh * SMESH_Hypothesis::GetMeshByPersistentID ( int id ) [inherited]

Find a mesh with given persistent ID.

Definition at line 160 of file SMESH_Hypothesis.cxx.

References studyContextStruct.mapMesh, and PAL_MESH_041_mesh.mesh.

{
  StudyContextStruct* myStudyContext = _gen->GetStudyContext(_studyId);
  map<int, SMESH_Mesh*>::iterator itm = itm = myStudyContext->mapMesh.begin();
  for ( ; itm != myStudyContext->mapMesh.end(); itm++)
  {
    SMESH_Mesh* mesh = (*itm).second;
    if ( mesh->GetMeshDS()->GetPersistentId() == id )
      return mesh;
  }
  return 0;
}

const char * SMESHDS_Hypothesis::GetName ( ) const [inherited]

Definition at line 62 of file SMESHDS_Hypothesis.cxx.

Referenced by SMESH_DimHyp.checkAlgo(), StdMeshers_Quadrangle_2D.CheckHypothesis(), and StdMeshers_Projection_3D.CheckHypothesis().

{
  return _name.c_str();
}

char* SMESH_Hypothesis.GetParameters ( ) const [inherited]

double StdMeshers_MaxLength.GetPreestimatedLength ( ) const

Definition at line 42 of file StdMeshers_MaxLength.hxx.

{ return _preestimated; }

int SMESH_Hypothesis::GetShapeType ( ) const [virtual, inherited]

Definition at line 94 of file SMESH_Hypothesis.cxx.

{
  return _shapeType;
}

int SMESH_Hypothesis.GetStudyId ( ) const [inherited]

int SMESHDS_Hypothesis::GetType ( ) const [inherited]

Definition at line 84 of file SMESHDS_Hypothesis.cxx.

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

{
  return _type;
}

bool StdMeshers_MaxLength.GetUsePreestimatedLength ( ) const

bool StdMeshers_MaxLength.HavePreestimatedLength ( ) const

Definition at line 41 of file StdMeshers_MaxLength.hxx.

{ return _preestimated > 0.; }

virtual bool SMESH_Hypothesis.IsAuxiliary ( ) const [virtual, inherited]

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

  { return GetType() == PARAM_ALGO && _param_algo_dim < 0; }

static bool SMESH_Hypothesis.IsStatusFatal ( Hypothesis_Status theStatus ) [static, inherited]

Definition at line 68 of file SMESH_Hypothesis.hxx.

References SMESH.HYP_UNKNOWN_FATAL.

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

  { return theStatus >= HYP_UNKNOWN_FATAL; }

virtual std::istream& StdMeshers_MaxLength.LoadFrom ( std::istream & load ) [virtual]

Implements SMESHDS_Hypothesis.

virtual void SMESH_Hypothesis.NotifySubMeshesHypothesisModification ( ) [virtual, inherited]

Referenced by StdMeshers_NumberOfSegments.SetReversedEdges(), StdMeshers_FixedPoints1D.SetReversedEdges(), StdMeshers_Arithmetic1D.SetReversedEdges(), and StdMeshers_ProjectionSource2D.SetSourceMesh().

bool SMESHDS_Hypothesis.operator!= ( const SMESHDS_Hypothesis & other ) const [inherited]

Definition at line 51 of file SMESHDS_Hypothesis.hxx.

{ return !(*this==other); }

bool SMESHDS_Hypothesis::operator== ( const SMESHDS_Hypothesis & other ) const [virtual, inherited]

Equality.

Definition at line 95 of file SMESHDS_Hypothesis.cxx.

References SMESHDS_Hypothesis._name.

{
  if ( this == &other )
    return true;
  if ( _name != other._name )
    return false;
  ostringstream mySave, otherSave;
  ((SMESHDS_Hypothesis*)this  )->SaveTo(mySave);
  ((SMESHDS_Hypothesis*)&other)->SaveTo(otherSave);
  return mySave.str() == otherSave.str();
}

virtual std::ostream& StdMeshers_MaxLength.SaveTo ( std::ostream & save ) [virtual]

Implements SMESHDS_Hypothesis.

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

Definition at line 224 of file SMESH_Hypothesis.cxx.

{
  _lastParameters = string(theParameters);
}

void StdMeshers_MaxLength::SetLength ( double length ) throw (SALOME_Exception)

Definition at line 76 of file StdMeshers_MaxLength.cxx.

{
  if (length <= 0)
    throw SALOME_Exception(LOCALIZED("length must be positive"));
  if ( _length != length ) {
    _length = length;
    NotifySubMeshesHypothesisModification();
  }
}

void SMESH_Hypothesis.SetLibName ( const char * theLibName ) [inherited]

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

Definition at line 178 of file SMESH_Hypothesis.cxx.

{
  string aNewParameters(theParameters);
  if(aNewParameters.size()==0 && _parameters.size()==0)
    aNewParameters = " ";
  if(_parameters.size()>0)
    _parameters +="|";
  _parameters +=aNewParameters;
  SetLastParameters(theParameters);
}

virtual bool StdMeshers_MaxLength.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.

virtual bool StdMeshers_MaxLength.SetParametersByMesh	(	const SMESH_Mesh *	theMesh,
		const TopoDS_Shape &	theShape
	)		`[virtual]`

Initialize segment 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.

void StdMeshers_MaxLength::SetPreestimatedLength ( double length )

Store preestemated length.

Definition at line 120 of file StdMeshers_MaxLength.cxx.

{
  if ( length > 0 )
    _preestimated = length;
}

void StdMeshers_MaxLength::SetUsePreestimatedLength ( bool toUse )

Sets boolean parameter enabling/desabling usage of length computed basing on size of bounding box of shape to mesh.

Definition at line 104 of file StdMeshers_MaxLength.cxx.

{
  if ( toUse != _preestimation )
  {
    _preestimation = toUse;
    // this parameter is just to help the user
    //NotifySubMeshesHypothesisModification();
  }
}