OSFI-Java  3.9.3
OpenSF Integration Library
esa.opensf.osfi.Parameter.ParamType Enum Reference

Public Member Functions

final boolean isStringBased ()
 

Public Attributes

 BOOLEAN
 
 FILE
 
 FLOAT
 
 FOLDER
 
 INTEGER
 
 STRING
 
 TIME
 

Detailed Description

Represents the element type of a Parameter object.

Member Function Documentation

◆ isStringBased()

final boolean esa.opensf.osfi.Parameter.ParamType.isStringBased ( )
Returns
true if this type follows "string" rules, that is, it may have blanks embedded and thus any non-scalars must be quoted.

Member Data Documentation

◆ BOOLEAN

esa.opensf.osfi.Parameter.ParamType.BOOLEAN

Truth value. Per the E2E-ICD, only

TRUE

or

FALSE

are accepted, capitalized.

◆ FILE

esa.opensf.osfi.Parameter.ParamType.FILE

Path to a file. If relative, it is resolved against the configured base directory.

◆ FLOAT

esa.opensf.osfi.Parameter.ParamType.FLOAT

Floating point number, in decimal representation with the range of IEEE754 binary64. The E2E-ICD defines the limits using the Java type

double

.

◆ FOLDER

esa.opensf.osfi.Parameter.ParamType.FOLDER

Path to a folder, with the same rules as FILE.

◆ INTEGER

esa.opensf.osfi.Parameter.ParamType.INTEGER

Integral number, signed between Integer#MIN_VALUE and Integer#MAX_VALUE. The E2E-ICD defines the limits using the Java type

int

.

◆ STRING

esa.opensf.osfi.Parameter.ParamType.STRING

A string composed of alphanumeric, punctuation or whitespace characters (but excluding control characters e.g.

"\n"

) with length ranging from 0 to 255.

Note that OSFI does not place a limit on string length or contents.

◆ TIME

esa.opensf.osfi.Parameter.ParamType.TIME

Timecode formatted as CCSDS ASCII time format with milli- or micro-second precision.

Note that, notwithstanding the E2E-ICD, OSFI allows up to nanosecond precision.

See also
TimeValue

The documentation for this enum was generated from the following file: