Package parasol :: Module parameters :: Class OutputParam
[hide private]
[frames] | no frames]

Class OutputParam

source code


Generic Output Parameter.

Output Parameter has a current value and limit values.


Notes:
Instance Methods [hide private]
 
__init__(self, name='a', description='speed of sound', units='ft/sec', val=1.0, loLimit=-1e+300, hiLimit=1e+300)
Initialize parameter properties
source code
 
inRange(self)
returns True if val is within limits, False otherwise
source code
 
hasLowConstraint(self)
returns True if loLimit is > NEG_INF
source code
 
hasHighConstraint(self)
returns True if hiLimit is < POS_INF
source code
 
isConstrained(self) source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables [hide private]
  name
simple name
  description
long description
  units
physical units; Blank string if no units
  val
current numeric value
  loLimit
lower limit value
  hiLimit
upper limit value
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name='a', description='speed of sound', units='ft/sec', val=1.0, loLimit=-1e+300, hiLimit=1e+300)
(Constructor)

source code 

Initialize parameter properties

Parameters:
  • name - simple name (str)
  • description - long description (str)
  • units - physical units; Blank string if no units (str)
  • val - current numeric value (float)
  • loLimit - lower limit value (float)
  • hiLimit - upper limit value value (float)
Overrides: object.__init__