helgoland-toolbox documentation
  1. Classes
  2. SweTime

File

libs/sensorml/src/lib/model/swe/SweTime.ts

Description

Scalar component used to represent a time quantity either as ISO 8601 (e.g. 2004-04-18T12:03:04.6Z) or as a duration relative to a time of reference

Extends

AbstractSimpleComponent

Index

Properties
Methods

Properties

constraint
Type : AllowedTimes
Default value : new AllowedTimes()
Decorators :
@DisplayName('Constraint')
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:38
localFrame
Type : string
Decorators :
@DisplayName('Local frame')
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:30

Temporal frame of reference whose origin is located by the value of this component
referenceTime
Type : Date
Decorators :
@DisplayName('Reference time')
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:24

Specifies the origin of the temporal reference frame as an ISO8601 date (used to specify time after an epoch that is to say in a custom frame)
uom
Type : UnitOfMeasure
Default value : new UnitOfMeasure()
Decorators :
@DisplayName('Unit of measure')
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:35

Temporal unit of measure used to express the value of this data component
value
Type : TimePosition
Decorators :
@DisplayName('Value')
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:18

Value is optional, to enable structure to act as a schema for values provided using other encodings
axisId
Type : string
Decorators :
@DisplayName('Axis id')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:20

Specifies the reference axis (refer to gml:axisID). The reference frame URI should also be specified unless it is inherited from parent Vector
constraint
Type : AbstractAllowedValues
Decorators :
@DisplayName('Constraint')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:29
nilValues
Type : SweNilValue[]
Default value : []
Decorators :
@DisplayName('Nil values')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:32
quality
Type : SweQuality[]
Default value : []
Decorators :
@DisplayName('Quality')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:23
referenceFrame
Type : string
Decorators :
@DisplayName('Reference frame')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:14

Frame of reference (usually temporal or spatial) with respect to which the value of the component is expressed. A reference frame anchors a value to a real world datum.
value
Type : any
Decorators :
@DisplayName('Value')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:26
definition
Type : string
Decorators :
@DisplayName('Definition')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:13

Reference to semantic information defining the precise nature of the component
optional
Type : boolean
Decorators :
@DisplayName('Optional')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:18

Specifies that data for this component can be omitted in the datastream
updatable
Type : boolean
Decorators :
@DisplayName('Updatable')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:24

Specifies if the value of a data component can be updated externally (i.e. is variable)
description
Type : string
Decorators :
@DisplayName('Description')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:27

Textual description (i.e. human readable) of the data component usually used to clarify its nature
identifier
Type : string
Decorators :
@DisplayName('Identifier')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:15

Unique identifier of the data component. It can be used to globally identify a particular component of the dataset, a process input/output or a universal constant
label
Type : string
Decorators :
@DisplayName('Label')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:21

Textual label for the data component . This is often used for displaying a human readable name for a dataset field or a process input/output
extension
Type : any[]
Decorators :
@DisplayName('Extension')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:12

Extension slot for future extensions to this standard.
id
Type : string
Decorators :
@DisplayName('Id')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:7
description
Type : string
Decorators :
@DisplayName('Description')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:27

Textual description (i.e. human readable) of the data component usually used to clarify its nature
identifier
Type : string
Decorators :
@DisplayName('Identifier')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:15

Unique identifier of the data component. It can be used to globally identify a particular component of the dataset, a process input/output or a universal constant
label
Type : string
Decorators :
@DisplayName('Label')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:21

Textual label for the data component . This is often used for displaying a human readable name for a dataset field or a process input/output
extension
Type : any[]
Decorators :
@DisplayName('Extension')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:12

Extension slot for future extensions to this standard.
id
Type : string
Decorators :
@DisplayName('Id')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:7
extension
Type : any[]
Decorators :
@DisplayName('Extension')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:12

Extension slot for future extensions to this standard.
id
Type : string
Decorators :
@DisplayName('Id')
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:7
definition
Type : string
Decorators :
@DisplayName('Definition')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:13

Reference to semantic information defining the precise nature of the component
optional
Type : boolean
Decorators :
@DisplayName('Optional')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:18

Specifies that data for this component can be omitted in the datastream
updatable
Type : boolean
Decorators :
@DisplayName('Updatable')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:24

Specifies if the value of a data component can be updated externally (i.e. is variable)
description
Type : string
Decorators :
@DisplayName('Description')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:27

Textual description (i.e. human readable) of the data component usually used to clarify its nature
identifier
Type : string
Decorators :
@DisplayName('Identifier')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:15

Unique identifier of the data component. It can be used to globally identify a particular component of the dataset, a process input/output or a universal constant
label
Type : string
Decorators :
@DisplayName('Label')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:21

Textual label for the data component . This is often used for displaying a human readable name for a dataset field or a process input/output
extension
Type : any[]
Decorators :
@DisplayName('Extension')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:12

Extension slot for future extensions to this standard.
id
Type : string
Decorators :
@DisplayName('Id')
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:7
description
Type : string
Decorators :
@DisplayName('Description')
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:27

Textual description (i.e. human readable) of the data component usually used to clarify its nature
identifier
Type : string
Decorators :
@DisplayName('Identifier')
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:15

Unique identifier of the data component. It can be used to globally identify a particular component of the dataset, a process input/output or a universal constant
label
Type : string
Decorators :
@DisplayName('Label')
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:21

Textual label for the data component . This is often used for displaying a human readable name for a dataset field or a process input/output
extension
Type : any[]
Decorators :
@DisplayName('Extension')
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:12

Extension slot for future extensions to this standard.
id
Type : string
Decorators :
@DisplayName('Id')
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:7
extension
Type : any[]
Decorators :
@DisplayName('Extension')
Inherited from AbstractSWE
Defined in AbstractSWE:12

Extension slot for future extensions to this standard.
id
Type : string
Decorators :
@DisplayName('Id')
Inherited from AbstractSWE
Defined in AbstractSWE:7

Methods

getValue
getValue()
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:44
Returns : string
toString
toString()
Defined in libs/sensorml/src/lib/model/swe/SweTime.ts:40
Returns : string
toString
toString(fallbackLabel: string)
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:34
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract simple component'
Returns : any
Public getLabel
getLabel()
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:30
Returns : any
Abstract getValue
getValue()
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:34
Returns : any
toString
toString(fallbackLabel: string)
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:26
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract data component'
Returns : any
toString
toString(fallbackLabel: string)
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:29
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract SWE identifiable'
Returns : string
toString
toString()
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:14
Returns : string
toString
toString(fallbackLabel: string)
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:29
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract SWE identifiable'
Returns : string
toString
toString()
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:14
Returns : string
toString
toString()
Inherited from AbstractSimpleComponent
Defined in AbstractSimpleComponent:14
Returns : string
Public getLabel
getLabel()
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:30
Returns : any
Abstract getValue
getValue()
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:34
Returns : any
toString
toString(fallbackLabel: string)
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:26
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract data component'
Returns : any
toString
toString(fallbackLabel: string)
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:29
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract SWE identifiable'
Returns : string
toString
toString()
Inherited from AbstractDataComponent
Defined in AbstractDataComponent:14
Returns : string
toString
toString(fallbackLabel: string)
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:29
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract SWE identifiable'
Returns : string
toString
toString()
Inherited from AbstractSWEIdentifiable
Defined in AbstractSWEIdentifiable:14
Returns : string
toString
toString()
Inherited from AbstractSWE
Defined in AbstractSWE:14
Returns : string 
import { AbstractSimpleComponent } from './AbstractSimpleComponent';
import { TimePosition } from './TimePosition';
import { UnitOfMeasure } from './UnitOfMeasure';
import { AllowedTimes } from './AllowedTimes';
import { DisplayName } from '../../common/decorators/DisplayName';

/**
 * Scalar component used to represent a time quantity either as ISO 8601
 * (e.g. 2004-04-18T12:03:04.6Z) or as a duration relative to a time of
 * reference
 */
export class SweTime extends AbstractSimpleComponent {
    /**
     * Value is optional, to enable structure to act as a schema for values
     * provided using other encodings
     */
    @DisplayName('Value')
    value: TimePosition;
    /**
     * Specifies the origin of the temporal reference frame as an ISO8601 date
     * (used to specify time after an epoch that is to say in a custom frame)
     */
    @DisplayName('Reference time')
    referenceTime: Date;
    /**
     * Temporal frame of reference whose origin is located by the value of this
     * component
     */
    @DisplayName('Local frame')
    localFrame: string;
    /**
     * Temporal unit of measure used to express the value of this data component
     */
    @DisplayName('Unit of measure')
    uom: UnitOfMeasure = new UnitOfMeasure();

    @DisplayName('Constraint')
    constraint: AllowedTimes = new AllowedTimes();

    toString() {
        return 'Time Component';
    }

    getValue() {
        return this.toString();
    }
}

result-matching ""

    No results matching ""