parasol.parameters.InputParam

Class InputParam

Generic Input Parameter.

Has a current value and a range of possible values (arranged either in linear steps or geometric steps)

Notes:

If stepVal is input, then use it to create range List (rangeL) Otherwise use NSteps to create range List
If linear is False, then use geometric steps from minVal to maxVal
If geometric range is illegal, switch to linear range

Instance Methods

__init__(self, name='a', description='speed of sound', units='ft/sec', val=1.0, minVal=0.0, maxVal=10.0, NSteps=10, stepVal=None, linear=1)
Initialize parameter properties and calculate range list (rangeL) source code

buildLinearRange(self)

source code

buildGeometricRange(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

savedVal
temporary storage location for val

InitialVal
initial val (for possible reset)

minVal
minimum value

maxVal
maximum value

linear
linear/geometric flag for steps from minVal to maxVal

NSteps
number of steps from minVal to maxVal in rangeL

stepVal
undefined if using geometric range

rangeL
list of values from minVal to maxVal (inclusive)

Properties

[hide private]

Inherited from object: __class__

init(self, name=`'a'`, description=`'speed of sound'`, units=`'ft/sec'`, val=1.0, minVal=0.0, maxVal=10.0, NSteps=10, stepVal=None, linear=1)
(Constructor)

source code

Initialize parameter properties and calculate range list (rangeL)

Parameters:

name - simple name (str)
description - long description (str)
units - physical units; Blank string if no units (str)
val - current numeric value (float)
minVal - minimum value (float)
maxVal - maximum value (float)
NSteps - number of steps from minVal to maxVal in rangeL (int)
stepVal - if input, then step size from minVal to maxVal in rangeL (float)
linear - linear/geometric flag for steps from minVal to maxVal (boolean or int)

Overrides: object.__init__

Class InputParam

__init__(self, name='a', description='speed of sound', units='ft/sec', val=1.0, minVal=0.0, maxVal=10.0, NSteps=10, stepVal=None, linear=1) (Constructor)

init(self, name=`'a'`, description=`'speed of sound'`, units=`'ft/sec'`, val=1.0, minVal=0.0, maxVal=10.0, NSteps=10, stepVal=None, linear=1)
(Constructor)