DFDL4S (DFDL for Space Library)
Classes | Public Member Functions | List of all members
org.esa.s2g.dfdllib.CCSDSTimeTrait Class Reference
Inheritance diagram for org.esa.s2g.dfdllib.CCSDSTimeTrait:
org.esa.s2g.dfdllib.ElementTrait

Classes

enum  Property
 

Public Member Functions

boolean check (Element element) throws UnableToParseCCSDSTimeException
 
String getType ()
 
long getSize (String property) throws IllegalArgumentException
 

Detailed Description

CCSDSTimeTrait implements a generic trait that can be use to check for traits on Elements This concrete implementation allows checking for CCSDS Time Traits (as also storing its properties)

Member Function Documentation

◆ check()

boolean org.esa.s2g.dfdllib.CCSDSTimeTrait.check ( Element  element) throws UnableToParseCCSDSTimeException

Check for traits on Element

Parameters
elementto be checked
Returns
true if check succeeds, false otherwise
Exceptions
Exceptionwhenever an exception is thrown

Implements org.esa.s2g.dfdllib.ElementTrait.

◆ getSize()

long org.esa.s2g.dfdllib.CCSDSTimeTrait.getSize ( String  property) throws IllegalArgumentException

Get the size in bits associated with the given property

Parameters
propertythe property for the correspondent CCSDSTime type
    CUC or CUC_seconds_nanoseconds:
                    - CCSDSTimeTrait.Property.CUC_Coarse_Time or "Coarse_Time"
                    - CCSDSTimeTrait.Property.CUC_Fine_Time or "Fine_Time"
    CDS:
                    - CCSDSTimeTrait.Property.CDS_Days or "Days"
                    - CCSDSTimeTrait.Property.CDS_Milliseconds or "Milliseconds"
                    - CCSDSTimeTrait.Property.CDS_Submilliseconds or "Submilliseconds"
    CCS
                    - CCSDSTimeTrait.Property.CCS_Year or "Year"
                    - CCSDSTimeTrait.Property.CCS_Month or "Month"
                    - CCSDSTimeTrait.Property.CCS_Hours or "Hours"
                    - CCSDSTimeTrait.Property.CCS_Minutes or "Minutes"
                    - CCSDSTimeTrait.Property.CCS_Seconds or "Seconds"
                    - CCSDSTimeTrait.Property.CCS_Subseconds or "Subseconds"
                    - CCSDSTimeTrait.Property.CCS_Day_of_Month or "Day_of_Month"
                    - CCSDSTimeTrait.Property.CCS_Day_of_Year or "Day_of_Year"
    A_DEF
                    - CCSDSTimeTrait.Property.A_DEF_Counter or "Counter"
Returns
the size of the CCSDSTime property as defined in the associated Element (i.e. DMXSize) or -1 is property doesn't exists

◆ getType()

String org.esa.s2g.dfdllib.CCSDSTimeTrait.getType ( )

Get CCSDSTime.Type name

Returns
the CCSDSTime.Type enum name

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