optiVariable

Module Contents

Classes

class OptimizationVariable(attributeName)

Contains information about the optimization of a variable

get_attribute_name()

Return the attribute to set

add_prefix_attribute_name(thePrefix)

Used for nested object, lower the name by prefix. Example: R_ext becomes (thePrefix).R_ext

get_PhysToMaths(deviceIn)

Convert the initial value of the variable contained in the device to optimization variable value

Parameters:deviceIn – InterfaceDevice Returns:value of the corresponding optimization variable

do_MathsToPhys(variableValue, deviceIn)

Apply the value to the device

__str__()

Return str(self).

class Real_OptimizationVariable(attributeName, val_min, val_max)

Bases: OptimizationVariable

Real (continuous) optimization variable. Most used type

get_min_value()

get_max_value()

get_PhysToMaths(deviceIn)

Convert the initial value of the variable contained in the device to optimization variable value

Parameters:deviceIn – InterfaceDevice Returns:value of the corresponding optimization variable

do_MathsToPhys(value, deviceIn)

Apply the value to the device

__str__()

Return str(self).

class Binary_OptimizationVariable(attributeName)

Bases: OptimizationVariable

Boolean (True/False) optimization variable.

get_PhysToMaths(deviceIn)

Convert the initial value of the variable contained in the device to optimization variable value

Parameters:deviceIn – InterfaceDevice Returns:value of the corresponding optimization variable

do_MathsToPhys(value, deviceIn)

Apply the value to the device

__str__()

Return str(self).

class Integer_OptimizationVariable(attributeName, val_min, val_max)

Bases: OptimizationVariable

Integer variable, in [min_value, max_value]

get_min_value()

get_max_value()

get_PhysToMaths(deviceIn)

Convert the initial value of the variable contained in the device to optimization variable value

Parameters:deviceIn – InterfaceDevice Returns:value of the corresponding optimization variable

do_MathsToPhys(value, deviceIn)

Apply the value to the device

__str__()

Return str(self).