Package npsgd :: Module model_parameters :: Class FloatParameter
[hide private]
[frames] | no frames]

Class FloatParameter

source code

    object --+    
             |    
ModelParameter --+
                 |
                FloatParameter
Known Subclasses:

Parameter type for selecting a single float value.

Instance Methods [hide private]
 
__init__(self, name, description='', rangeStart=None, rangeEnd=None, step=None, units='', default=None, hidden=False, helpText='')
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
setValue(self, inVal) source code
 
asMatlabCode(self)
Converts an instance of this parameter (with value) into matlab code.
source code
 
asTextRow(self) source code
 
asLatexRow(self) source code
 
valueString(self) source code
 
hiddenHTML(self)
Returns this parameter as hidden HTML.
source code
 
asHTML(self)
Returns this parameter as HTML.
source code

Inherited from ModelParameter: asDict, fromDict, helpHTML, nonExistValue, withValue

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, description='', rangeStart=None, rangeEnd=None, step=None, units='', default=None, hidden=False, helpText='')
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

asMatlabCode(self)

source code 

Converts an instance of this parameter (with value) into matlab code.

This is used to inject copies of the parameters __directly__ into the Matlab namespace.

Overrides: ModelParameter.asMatlabCode
(inherited documentation)

hiddenHTML(self)

source code 

Returns this parameter as hidden HTML.

Overrides: ModelParameter.hiddenHTML
(inherited documentation)

asHTML(self)

source code 

Returns this parameter as HTML.

Overrides: ModelParameter.asHTML
(inherited documentation)