Back to index

salome-smesh  6.5.0
Public Member Functions
StdMeshers::StdMeshers_MaxLength Interface Reference

StdMeshers_MaxLength: interface of "Max length" hypothesis. More...

import "SMESH_BasicHypothesis.idl";

Inheritance diagram for StdMeshers::StdMeshers_MaxLength:
Inheritance graph
[legend]
Collaboration diagram for StdMeshers::StdMeshers_MaxLength:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void SetLength (in double length) raises (SALOME::SALOME_Exception)
 Sets <length> parameter value.
double GetLength ()
 Returns <length> parameter value.
boolean HavePreestimatedLength ()
 Returns true if preestemated length is defined.
double GetPreestimatedLength ()
 Returns preestemated length.
void SetPreestimatedLength (in double length)
 Sets preestemated length.
void SetUsePreestimatedLength (in boolean toUse)
 Sets boolean parameter enabling/desabling usage of length computed basing on size of bounding box of shape to mesh.
boolean GetUsePreestimatedLength ()
 Returns value of boolean parameter enabling/desabling usage of length computed basing on size of bounding box of shape to mesh.
string GetName ()
 Get the Hypothesis typeName.
string GetLibName ()
 Get the Hypothesis plugin library Name.
long GetId ()
 Get the internal Id.
void SetVarParameter (in string parameter, in string method)
 Set the variable parameter.
string GetVarParameter (in string methodName)
 Return the variable parameter used for Hypothesis creation by name of method setting this parameter.
void SetParameters (in string theParameters)
 Set list of parameters.
string GetParameters ()
 Return list of notebook variables used for Hypothesis creation separated by ":" symbol.
ListOfParameters GetLastParameters ()
 Return list of last notebook variables used for Hypothesis creation.
void SetLastParameters (in string theParameters)
 Set list of parameters.
void ClearParameters ()
 Clear parameters list.
boolean IsDimSupported (in Dimension type)
 Verify whether hypothesis supports given entity type.

Detailed Description

StdMeshers_MaxLength: interface of "Max length" hypothesis.

Definition at line 78 of file SMESH_BasicHypothesis.idl.


Member Function Documentation

void SMESH_Hypothesis::ClearParameters ( ) [inherited]

Clear parameters list.

Definition at line 196 of file SMESH_Hypothesis.cxx.

{
  _parameters = string();
}
long SMESH::SMESH_Hypothesis::GetId ( ) [inherited]

Get the internal Id.

char * SMESH_Hypothesis::GetLastParameters ( ) [inherited]

Return list of last notebook variables used for Hypothesis creation.

Definition at line 216 of file SMESH_Hypothesis.cxx.

{
  return (char*)_lastParameters.c_str();
}

Returns <length> parameter value.

Definition at line 92 of file StdMeshers_MaxLength.cxx.

{
  return ( _preestimation && _preestimated > 0. ) ? _preestimated : _length;
}
const char * SMESH_Hypothesis::GetLibName ( ) [inherited]

Get the Hypothesis plugin library Name.

Definition at line 141 of file SMESH_Hypothesis.cxx.

{
  return _libName.c_str();
}
string SMESH::SMESH_Hypothesis::GetName ( ) [inherited]

Get the Hypothesis typeName.

Here is the caller graph for this function:

char * SMESH_Hypothesis::GetParameters ( ) [inherited]

Return list of notebook variables used for Hypothesis creation separated by ":" symbol.

Definition at line 206 of file SMESH_Hypothesis.cxx.

{
  return (char*)_parameters.c_str();
}

Returns preestemated length.

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

Definition at line 133 of file StdMeshers_MaxLength.cxx.

{
  return _preestimation;
}
string SMESH::SMESH_Hypothesis::GetVarParameter ( in string  methodName) [inherited]

Return the variable parameter used for Hypothesis creation by name of method setting this parameter.

Returns true if preestemated length is defined.

boolean SMESH::SMESH_Hypothesis::IsDimSupported ( in Dimension  type) [inherited]

Verify whether hypothesis supports given entity type.

void SMESH_Hypothesis::SetLastParameters ( in string  theParameters) [inherited]

Set list of parameters.

Parameters:
theParametersis a string containing the last notebook variables separated by ":" symbol, used for Hypothesis creation

Definition at line 226 of file SMESH_Hypothesis.cxx.

{
  _lastParameters = string(theParameters);
}
void StdMeshers_MaxLength::SetLength ( in double  length) raises (SALOME::SALOME_Exception)

Sets <length> parameter value.

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::SetParameters ( in string  theParameters) [inherited]

Set list of parameters.

Parameters:
theParametersis a string containing the notebook variables separated by ":" symbol, used for Hypothesis creation

Definition at line 180 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);
}

Here is the call graph for this function:

void StdMeshers_MaxLength::SetPreestimatedLength ( in double  length)

Sets preestemated length.

Store preestemated length.

Definition at line 120 of file StdMeshers_MaxLength.cxx.

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

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();
  }
}
void SMESH::SMESH_Hypothesis::SetVarParameter ( in string  parameter,
in string  method 
) [inherited]

Set the variable parameter.

Parameters:
parameteris a string containing the notebook variable used for Hypothesis creation
methodis a name of Hypothesis method setting this parameter

This method must be called before calling method()


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