Extensions.DiagCom.GetParameterValueAsFloat

From emotive
Revision as of 10:21, 17 July 2014 by Nb (talk | contribs) (Created page with "Category:DiagCom == Classification == {{ClassificationActivity | GetParameterValueAsFloat | The actual value of the parameter as a Float | Term | DiagCom|OTX Dia...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Classification

Name GetParameterValueAsFloat
Short Description The actual value of the parameter as a Float
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

Pseudo-Code Syntax

GetParameterValueAsFloat(Parameter parameter, Float value);

Description

The GetParameterValueAsFloat term accepts a ParameterTerm and returns the actual value of the parameter as a Float.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Float The actual value of the parameter as a Float.)

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The parameter object.

Examples

Float value = GetParameterValueAsFloat(parameter);

See also

GetParameterValueAsBoolean
GetParameterValueAsString
GetParameterValueAsInteger
GetParameterValueAsByteField
GetParameterValueAsQuantity