pyCAPS
pyCAPS: A Python Extension Module for CAPS
|
Functions to interact with a CAPS value object. More...
Public Member Functions | |
def | setVal (self, data) |
Change the value of the object. More... | |
def | getVal (self) |
Get the current value of object. More... | |
def | setLimits (self, newLimits) |
Set new limits. More... | |
def | getLimits (self) |
Get the current value for the limits. More... | |
def | convertUnits (self, toUnits) |
Return the current value of the object in the desired, specified units. More... | |
Public Attributes | |
capsProblem | |
Reference to the problem object that loaded the value. More... | |
units | |
Units of the variable. | |
limits | |
Acceptable limits for the value. More... | |
value | |
Value of the variable. More... | |
Static Public Attributes | |
name | |
Variable name. | |
Functions to interact with a CAPS value object.
Should be created with capsProblem.createValue (not a standalone class)
def convertUnits | ( | self, | |
toUnits | |||
) |
Return the current value of the object in the desired, specified units.
Note that this neither changes the value or units of the object, only returns a converted value. See value4.py for a representative use case.
def getLimits | ( | self | ) |
Get the current value for the limits.
See value3.py for a representative use case.
def getVal | ( | self | ) |
Get the current value of object.
See value2.py for a representative use case.
def setLimits | ( | self, | |
newLimits | |||
) |
Set new limits.
See value3.py for a representative use case.
newLimits | New values to set for the limits. Should be 2 element list - [min value, max value]. |
def setVal | ( | self, | |
data | |||
) |
Change the value of the object.
See value2.py for a representative use case.
data | Data value(s) for the variable. Note that data will be type casted to match the type used to original create the capsValue object. |
Reference to the problem object that loaded the value.
limits |
Acceptable limits for the value.
Limits may be set directly. See value3.py for a representative use case.
value |
Value of the variable.
Value may be set directly. See value2.py for a representative use case.