optiVariable

Module Contents

class OptimizationVariable(attributeName)[source]

Contains information about the optimization of a variable

get_attribute_name(self)[source]

Return the attribute to set

get_PhysToMaths(self, deviceIn)[source]

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

Parameters:deviceInInterfaceDevice
Returns:value of the corresponding optimization variable
do_MathsToPhys(self, variableValue, deviceIn)[source]

Apply the value to the device

__str__(self)[source]
class Real_OptimizationVariable(attributeName, val_min, val_max)[source]

Bases: optimeed.optimize.optiVariable.OptimizationVariable

Real (continuous) optimization variable. Most used type

get_min_value(self)[source]
get_max_value(self)[source]
get_PhysToMaths(self, deviceIn)[source]
do_MathsToPhys(self, value, deviceIn)[source]
__str__(self)[source]
class Binary_OptimizationVariable[source]

Bases: optimeed.optimize.optiVariable.OptimizationVariable

Boolean (True/False) optimization variable.

get_PhysToMaths(self, deviceIn)[source]
do_MathsToPhys(self, value, deviceIn)[source]
__str__(self)[source]
class Integer_OptimizationVariable(attributeName, val_min, val_max)[source]

Bases: optimeed.optimize.optiVariable.OptimizationVariable

Integer variable, in [min_value, max_value]

get_min_value(self)[source]
get_max_value(self)[source]
get_PhysToMaths(self, deviceIn)[source]
do_MathsToPhys(self, value, deviceIn)[source]
__str__(self)[source]