Back to index

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

StdMeshers_LocalLength: interface of "Average length" hypothesis. More...

import "SMESH_BasicHypothesis.idl";

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

List of all members.

Public Member Functions

void SetLength (in double length) raises (SALOME::SALOME_Exception)
 Sets <length> parameter value.
void SetPrecision (in double precision) raises (SALOME::SALOME_Exception)
 Sets <precision> parameter value.
double GetLength ()
 Returns <length> parameter value.
double GetPrecision ()
 Returns <precision> parameter value.
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_LocalLength: interface of "Average length" hypothesis.

Definition at line 41 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 97 of file StdMeshers_LocalLength.cxx.

{
  return _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 <precision> parameter value.

Definition at line 123 of file StdMeshers_LocalLength.cxx.

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

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

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_LocalLength::SetLength ( in double  length) raises (SALOME::SALOME_Exception)

Sets <length> parameter value.

Definition at line 80 of file StdMeshers_LocalLength.cxx.

{
  double oldLength = _length;
  if (length <= 0)
    throw SALOME_Exception(LOCALIZED("length must be positive"));
  _length = length;
  const double precision = 1e-7;
  if (fabs(oldLength - _length) > precision)
    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_LocalLength::SetPrecision ( in double  precision) raises (SALOME::SALOME_Exception)

Sets <precision> parameter value.

Precision parameter is used to allow rounding a number of segments, calculated from the edge length and average length of segment, to the lower integer, if this value outstands from it in bounds of the precision. Otherwise, the number of segments is rounded to the higher integer. Use value 0.5 to provide rounding to the nearest integer, 1.0 for the lower integer, 0.0 for the higher integer. Default value is 1e-07. In old studies, restored from file, this value will be set to zero, what corresponds to the old behaviour.

Definition at line 107 of file StdMeshers_LocalLength.cxx.

{
  double oldPrecision = _precision;
  if (_precision < 0)
    throw SALOME_Exception(LOCALIZED("precision cannot be negative"));
  _precision = thePrecision;
  const double precision = 1e-8;
  if (fabs(oldPrecision - _precision) > precision)
    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: