Float Class Reference

Inheritance diagram for Float:

Collaboration diagram for Float:

Static Public Member Functions
_.Library.Float	DisplayToLogical (_, _.Library.String val)
	Converts the input value val, which is a string representing a floating point value,. More...
_.Library.Status	IsValid (_, _.Library.RawString val)
	Tests if the logical value val, which is a floating point value, is valid. More...
_.Library.String	LogicalToDisplay (_, _.Library.Float val)
	Converts the value of val, which is in logical floating point format, into a display string. More...
_.Library.String	LogicalToJSON (_, _.Library.Float val)
	Converts the Objectscript value to the JSON number value.
_.Library.Float	Normalize (_, _.Library.RawString val)
	Converts val to a normalized value.
_.Library.Float	XSDToLogical (_, _.Library.String val)
	Converts the SOAP encoded input decimal value into a logical value. More...

Static Public Attributes
	DISPLAYLIST = None
	Used for enumerated (multiple-choice) attributes. More...
	FORMAT = None
	The format specification for the data type's display value. More...
	MAXVAL = None
	The maximum allowed logical value for the data type.
	MINVAL = None
	The minimum allowed logical value for the data type.
	SCALE = None
	The scale value (number of digits following the decimal point) for this data type. More...
	VALUELIST = None
	Used for enumerated (multiple-choice) attributes. More...
	XSDTYPE = None
	Declares the XSD type used when projecting XML Schemas.
Static Public Attributes inherited from DataType
	INDEXNULLMARKER = None
	Override this parameter value to specify what value should be used as a null marker when a property of the type is used in a subscript of an index map. More...

Detailed Description

This class is DEPRECATED. Applications should use either the <class>Double</class> datatype for cases where values should be in the IEEE float ($Double) format, or <class>Decimal</class> for cases where values should be in Decimal ($Decimal) format.

The Float data type class represents a floating point number.

The logical value of the Float data type is a floating point value.

Member Function Documentation

DisplayToLogical()

_.Library.Float DisplayToLogical (   _, _.Library.String  val  )

static

Converts the input value val, which is a string representing a floating point value,.

into a logical floating point value.

Returns the logical floating point value of the input string val.

IsValid()

_.Library.Status IsValid (   _, _.Library.RawString  val  )

static

Tests if the logical value val, which is a floating point value, is valid.

The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MAXVAL and MINVAL.

Reimplemented from DataType.

LogicalToDisplay()

_.Library.String LogicalToDisplay (   _, _.Library.Float  val  )

static

Converts the value of val, which is in logical floating point format, into a display string.

The formatting is based on the value of the FORMAT parameter.

Returns the formatted value of val.

XSDToLogical()

_.Library.Float XSDToLogical (   _, _.Library.String  val  )

static

Converts the SOAP encoded input decimal value into a logical value.

Returns "" for error.

Member Data Documentation

DISPLAYLIST

DISPLAYLIST = None

static

Used for enumerated (multiple-choice) attributes.

Used in conjunction with the VALUELIST parameter for enumerated (multiple-choice) attributes. DISPLAYLIST, if not null, represents the display values for the attribute corresponding with the logical values listed in VALUELIST.

The display values are returned by the LogicalToDisplay method.

FORMAT

FORMAT = None

static

The format specification for the data type's display value.

The value of FORMAT corresponds to the formatting option of the $FNUMBER function, which is used to perform the formatting.

SCALE

SCALE = None

static

The scale value (number of digits following the decimal point) for this data type.

This parameter only affects the display value which will be rounded to the specified number of decimal places.

VALUELIST

VALUELIST = None

static

Used for enumerated (multiple-choice) attributes.

VALUELIST is either a null string ("") or a delimiter separated list (where the delimiter is the first character) of logical values. If a non-null value is present, then the attribute is restricted to values in the list, and the validation code simply checks to see if the value is in the list.