MARINA
Length Class Reference

Static Public Member Functions

ClearWater.Length DisplayToLogical (_, _.Library.String val)
 Converts the input value val, which represents a date, into $H format. More...
 
_.Library.Boolean IsValidDT (_, _.Library.String val)
 Tests if the logical value val, which represents a date in $H format,. More...
 
_.Library.String LogicalToDisplay (_, _.Library.String val)
 Converts the value of val, which is in logical $H format, into a display string. More...
 
_.Library.Date Normalize (_, _.Library.String val)
 Converts val to a normalized value.
 

Static Public Attributes

 COLLATION = None
 The default collation value used for this data type.
 
 DISPLAYLIST = None
 Used in conjunction with the VALUELIST parameter for enumerated. 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.
 
 VALUELIST = None
 Used for enumerated (multiple-choice) attributes. More...
 

Detailed Description

Deltanji status:

ObjectClearWater.Length.CLS/MARINA.0
ComponentCLS.ClearWater.Length
LocationMARINA.test2
Date/Time15-May-20 21:21
Userjohnm

Member Function Documentation

◆ DisplayToLogical()

ClearWater.Length DisplayToLogical (   _,
_.Library.String  val 
)
static

Converts the input value val, which represents a date, into $H format.

Returns the logical ($H) value of the input string val.

◆ IsValidDT()

_.Library.Boolean IsValidDT (   _,
_.Library.String  val 
)
static

Tests if the logical value val, which represents a date in $H format,.

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.

Returns true (1) if the value val is valid, otherwise false (0).

◆ LogicalToDisplay()

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

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

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

Returns the formatted value of val.

Member Data Documentation

◆ DISPLAYLIST

DISPLAYLIST = None
static

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 the FORMAT parameter corresponds to the available parameters of the $ZDATE and $ZDATEH functions, which are used to perform the formatting.

◆ 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.