Variable¶
-
class
persalys.Variable(*args)¶ Create a variable base class.
Represents a variable.
- Parameters
- namestr
Name
- descriptionstr
Description text (optional)
Examples
>>> import persalys >>> G = persalys.Variable('G', 'deviation')
Methods
getClassName(self)Accessor to the object’s name.
getDescription(self)Description accessor.
getId(self)Accessor to the object’s id.
getName(self)Accessor to the object’s name.
getPythonScript(self)Python script accessor.
getShadowedId(self)Accessor to the object’s shadowed id.
getValue(self)Default value accessor.
getVisibility(self)Accessor to the object’s visibility state.
hasName(self)Test if the object is named.
hasVisibleName(self)Test if the object has a distinguishable name.
setDescription(self, description)Description accessor.
setName(self, name)Accessor to the object’s name.
setShadowedId(self, id)Accessor to the object’s shadowed id.
setValue(self, value)Default value accessor.
setVisibility(self, visible)Accessor to the object’s visibility state.
-
__init__(self, *args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getDescription(self)¶ Description accessor.
- Returns
- description
openturns.Description Text describing the variable
- description
-
getId(self)¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getName(self)¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getPythonScript(self)¶ Python script accessor.
- Returns
- scriptstr
Python script to replay the analysis
-
getShadowedId(self)¶ Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
-
getValue(self)¶ Default value accessor.
- Returns
- valuefloat
Default value
-
getVisibility(self)¶ Accessor to the object’s visibility state.
- Returns
- visiblebool
Visibility flag.
-
hasName(self)¶ Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
-
hasVisibleName(self)¶ Test if the object has a distinguishable name.
- Returns
- hasVisibleNamebool
True if the name is not empty and not the default one.
-
setDescription(self, description)¶ Description accessor.
- Parameters
- descriptionstr
Text describing the variable
-
setName(self, name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
-
setShadowedId(self, id)¶ Accessor to the object’s shadowed id.
- Parameters
- idint
Internal unique identifier.
-
setValue(self, value)¶ Default value accessor.
- Parameters
- valuefloat
Default value
-
setVisibility(self, visible)¶ Accessor to the object’s visibility state.
- Parameters
- visiblebool
Visibility flag.
