Decimal Class Reference

The Decimal data type class represents a fixed point number. More...

Inheritance diagram for Decimal:

Collaboration diagram for Decimal:

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

Static Public Attributes
	DISPLAYLIST = None
	The Decimal data type class represents a fixed point number. 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

The Decimal data type class represents a fixed point number.

Member Function Documentation

DisplayToLogical()

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

static

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

a Decimal (fixed point) value, into a logical Decimal value.

Returns the value of the input string val as a fixed point number.

IsValid()

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

static

Tests if the logical value val, which is a Decimal 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.Numeric  val  )

static

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

Returns the string value of val.

XSDToLogical()

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

static

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

Returns "" for error.

Member Data Documentation

DISPLAYLIST

DISPLAYLIST = None

static

The Decimal data type class represents a fixed point number.

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. It is also possible to specify FORMAT = "AUTO" which means no formatting (otherwise the display value will be padded with zeroes up to the specified scale).

SCALE

SCALE = None

static

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

The logical value 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.