Output¶
- class persalys.Output(*args)¶
Create an output variable.
Represents an output variable.
- Parameters:
- namestr
Name
- descriptionstr
Description text (optional)
Methods
Accessor to the object's name.
Description accessor.
getName()Accessor to the object's name.
Python script accessor.
getUnit()Unit accessor.
getValue()Default value accessor.
Whether the variable has been evaluated.
hasName()Test if the object is named.
Whether the variable is selected.
setDescription(description)Description accessor.
setHasBeenComputed(hasBeenComputed)Whether the variable has been evaluated.
setIsSelected(isSelected)Whether the variable is selected.
setName(name)Accessor to the object's name.
setUnit(unit)Unit accessor.
setValue(value)Default value accessor.
Examples
>>> import persalys >>> G = persalys.Output('G', 'deviation')
- __init__(*args)¶
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getDescription()¶
Description accessor.
- Returns:
- description
openturns.Description Text describing the variable
- description
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getPythonScript()¶
Python script accessor.
- Returns:
- scriptstr
Python script to replay the analysis
- getUnit()¶
Unit accessor.
- Returns:
- unitstr
Physical quantity unit, if applicable
- getValue()¶
Default value accessor.
- Returns:
- valuefloat
Default value
- hasBeenComputed()¶
Whether the variable has been evaluated.
- Returns:
- computedbool
Whether the variable has been evaluated
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- isSelected()¶
Whether the variable is selected.
- Returns:
- isSelectedbool
Whether the variable is selected
- setDescription(description)¶
Description accessor.
- Parameters:
- descriptionstr
Text describing the variable
- setHasBeenComputed(hasBeenComputed)¶
Whether the variable has been evaluated.
- Parameters:
- computedbool
Whether the variable has been evaluated
- setIsSelected(isSelected)¶
Whether the variable is selected.
- Parameters:
- isSelectedbool
Whether the variable is selected
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- setUnit(unit)¶
Unit accessor.
- Parameters:
- unitstr
Physical quantity unit, if applicable
- setValue(value)¶
Default value accessor.
- Parameters:
- valuefloat
Default value