Package empro :: Module empro :: Class ParameterList

Class ParameterList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    ParameterList

Manages the list of parameters.

Class Hierarchy for ParameterList

Instance Methods

__call__(x, ...)
x(...)

__contains__(x, y)
y in x

__delitem__(x, y)
del x[y]

__getitem__(x, y)
x[y]

__len__(x)
len(x)

__setitem__(x, i, y)
x[i]=y

bool

append(iParameterName, iFormula, iNotes, iUserEditable)
Appends a parameter to the list.

at(...)
No documentation available.

None

clear()
Clear the list.

bool

contains(iParameterName)
Determines if the parameter is in the list.

description(...)
No documentation available.

bool

evaluate(iExpression)
Evalues an expression within the context of the parameter list.

string

formula(iParameterName)
Returns the formula of a parameter.

bool

isEditable(iParameterName)
Determines if a parameter is editable.

isRemovable(...)
No documentation available.

isVisible(...)
No documentation available.

list{string}

names()
Returns the names of the parameters in the list.

bool

remove(iParameterName)
Removes a parameter.

rename(...)
No documentation available.

setDescription(...)
No documentation available.

None

setEditable(iParameterName, iUserEditable)
Sets the editability of a parameter.

None

setFormula(iParameterName, iFormula)
Sets the formula of a parameter.

setRemovable(...)
No documentation available.

setVisible(...)
No documentation available.

size(...)
No documentation available.

Inherited from core.Selectable: clone, isSelected

Inherited from core.Updatable: __enter__, __exit__, hash, isValid, reasonWhyInvalid

Properties
Inherited from `core.Selectable`: `metaData`, `name`, `notes`

Method Details

append(iParameterName, iFormula, iNotes, iUserEditable)

Appends a parameter to the list.

Parameters:

iParameterName (string) - Name of the parameter to add.
iFormula (string) - Formula/value of the parameter to add.
iNotes (string) - Notes to add to the parameter.
iUserEditable (bool) - Determines if user can edit the parameter.

Returns: bool

contains(iParameterName)

Determines if the parameter is in the list.

Parameters:

iParameterName (string) - Name of the parameter.

Returns: bool

evaluate(iExpression)

Evalues an expression within the context of the parameter list.

Parameters:

iExpression (string) - Expression to evaluate.

Returns: bool

formula(iParameterName)

Returns the formula of a parameter.

Parameters:

iParameterName (string) - Name of the parameter to query.

Returns: string

isEditable(iParameterName)

Determines if a parameter is editable.

Parameters:

iParameterName (string) - Name of the parameter to query.

Returns: bool

remove(iParameterName)

Removes a parameter.

Parameters:

iParameterName (string) - Name of the parameter to remove.

Returns: bool

setEditable(iParameterName, iUserEditable)

Sets the editability of a parameter.

Parameters:

iParameterName (string) - Name of the parameter to query.
iUserEditable (bool) - Determines if the parameter is editable after construction.

Returns: None

setFormula(iParameterName, iFormula)

Sets the formula of a parameter.

Parameters:

iParameterName (string) - Name of the parameter to query.
iFormula (string) - Formula of the parameter.

Returns: None