Variable

class persalys.Variable(*args)

Create a variable base class.

Represents a variable.

Parameters:

name : str

Name

description : str

Description text (optional)

Examples

>>> import persalys
>>> G = persalys.Variable('G', 'deviation')

Methods

getClassName()	Accessor to the object’s name.
getDescription()	Description accessor.
getId()	Accessor to the object’s id.
getName()	Accessor to the object’s name.
getPythonScript()	Python script accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getValue()	Default value accessor.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setDescription(description)	Description accessor.
setName(name)	Accessor to the object’s name.
setShadowedId(id)	Accessor to the object’s shadowed id.
setValue(value)	Default value accessor.
setVisibility(visible)	Accessor to the object’s visibility state.

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getDescription()

Description accessor.

Returns:

description : openturns.Description

Text describing the variable

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getPythonScript()

Python script accessor.

Returns:

script : str

Python script to replay the analysis

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getValue()

Default value accessor.

Returns:

value : float

Default value

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

setDescription(description)

Description accessor.

Parameters:

description : str

Text describing the variable

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setValue(value)

Default value accessor.

Parameters:

value : float

Default value

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.