Version: 9.12.0
StdMeshers::StdMeshers_LocalLength Interface Reference

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

import"SMESH_BasicHypothesis.idl";

Inheritance diagram for StdMeshers::StdMeshers_LocalLength:

Public Member Functions

void SetLength (in double length) raises (SALOME::SALOME_Exception)
 Sets <length> parameter value. More...
 
void SetPrecision (in double precision) raises (SALOME::SALOME_Exception)
 Sets <precision> parameter value. More...
 
double GetLength ()
 Returns <length> parameter value. More...
 
double GetPrecision ()
 Returns <precision> parameter value. More...
 
string GetName ()
 Get the Hypothesis typeName. More...
 
string GetLibName ()
 Get the Hypothesis plugin library Name. More...
 
short GetId ()
 Get the internal Id. More...
 
void SetVarParameter (in string parameter, in string method)
 Set the variable parameter. More...
 
string GetVarParameter (in string methodName)
 Return the variable parameter used for Hypothesis creation by name of method setting this parameter. More...
 
void SetHolderHypothesis (in SMESH::SMESH_Hypothesis hyp)
 Store a hypothesis wrapping this not published one. More...
 
boolean IsDimSupported (in Dimension type)
 Verify whether hypothesis supports given entity type. More...
 
boolean HasParameters ()
 Return true if a hypothesis has parameters. More...
 

Detailed Description

StdMeshers_LocalLength: interface of "Average length" hypothesis.

Member Function Documentation

◆ GetId()

short SMESH::SMESH_Hypothesis::GetId ( )
inherited

Get the internal Id.

◆ GetLength()

double StdMeshers::StdMeshers_LocalLength::GetLength ( )

Returns <length> parameter value.

Referenced by StdMeshers_Regular_1D::CheckHypothesis().

◆ GetLibName()

string SMESH::SMESH_Hypothesis::GetLibName ( )
inherited

Get the Hypothesis plugin library Name.

◆ GetName()

string SMESH::SMESH_Hypothesis::GetName ( )
inherited

Get the Hypothesis typeName.

Referenced by StdMeshers_Regular_1D::CheckHypothesis().

◆ GetPrecision()

double StdMeshers::StdMeshers_LocalLength::GetPrecision ( )

Returns <precision> parameter value.

Referenced by StdMeshers_Regular_1D::CheckHypothesis().

◆ GetVarParameter()

string SMESH::SMESH_Hypothesis::GetVarParameter ( in string  methodName)
inherited

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

◆ HasParameters()

boolean SMESH::SMESH_Hypothesis::HasParameters ( )
inherited

Return true if a hypothesis has parameters.

This method is intended for GUI to know if "Edit" menu item should be available

◆ IsDimSupported()

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

Verify whether hypothesis supports given entity type.

◆ SetHolderHypothesis()

void SMESH::SMESH_Hypothesis::SetHolderHypothesis ( in SMESH::SMESH_Hypothesis  hyp)
inherited

Store a hypothesis wrapping this not published one.

This hyp, which has no own parameters but is published, is used to store variables defining parameters of this hypothesis.

◆ SetLength()

void StdMeshers::StdMeshers_LocalLength::SetLength ( in double  length)
raises (SALOME::SALOME_Exception
)

Sets <length> parameter value.

◆ SetPrecision()

void StdMeshers::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.

◆ SetVarParameter()

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