Description

The IVariableCollection interface defines a list of variables.

Properties

length

Gets the number of variables stored in the collection.

length(): int

• returns: int - number of stored variables.

Instance methods

add

Adds a new variable to the collection.

add(variable: IVariable)

• variable: IVariable - variable to be added.

clear

Clears the collection.

clear()

clear_values

Clears all stored variables (assigns None values).

clear_values()

find_by_name

Finds variable in the list by it’s name.

findByName(name: str): IVariable

• name: str - The variable name to be found.
• returns: IVariable - Variable or None if the variable was not found.

find_index_by_name

Finds a variable index in the list by the variable’s name.

find_index_by_name(name: str): int

• name: str - name of the variable to be found.
• returns: int - variable index in the list or -1 if variable was not found.

get

Gets a variable by its index.

get(index: int): IVariable

• index: str - variable index.
• returns: IVariable - retrieved variable.

get_all

Gets all the variables stored in the collection.

get_all(): List[IVariable]

• returns: List[IVariable] - list with stored variables.

locate

Finds a variable in the list or creates a new one if the variable was not found.

locate(name: str): IVariable

• name: str - name of the variable to be found.
• returns: IVariable - found or created variable.

remove

Removes a variable by its index.

remove(index: int)

• index: int - index of the variable to be removed.

remove_by_name

Removes a variable by it’s name.

remove_by_name(name: str)

• name: str - name of the variable to be removed.