helgoland-toolbox documentation
  1. Classes
  2. SweDataRecord

File

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

Description

Implementation of ISO-11404 Record datatype. This allows grouping (sequence) of data components which can themselves be simple types, records, arrays or choices

Extends

AbstractDataComponent

Index

Properties
Methods

Properties

fields
Type : SweField[]
Default value : []
Decorators :
@DisplayName('Fields')
Defined in libs/sensorml/src/lib/model/swe/SweDataRecord.ts:16

Definition of the field provided as a nested data component. The field can be scalar or can itself be an aggregate such as a record, choice or array
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/SweDataRecord.ts:22
Returns : void
toString
toString()
Defined in libs/sensorml/src/lib/model/swe/SweDataRecord.ts:18
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 { AbstractDataComponent } from './AbstractDataComponent';
import { SweField } from './SweField';
import { DisplayName } from '../../common/decorators/DisplayName';

/**
 * Implementation of ISO-11404 Record datatype. This allows grouping (sequence)
 * of data components which can themselves be simple types, records, arrays or
 * choices
 */
export class SweDataRecord extends AbstractDataComponent {
    /**
     * Definition of the field provided as a nested data component. The field can
     * be scalar or can itself be an aggregate such as a record, choice or array
     */
    @DisplayName('Fields')
    fields: SweField[] = [];

    toString() {
        return 'Data Record Component';
    }

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

result-matching ""

    No results matching ""