helgoland-toolbox documentation
  1. Classes
  2. SweDataArray

File

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

Description

Implementation of ISO-11404 Array datatype. This defines an array of identical data components with a elementCount. Values are given as a block and can be encoded in different ways

Extends

AbstractDataComponent

Index

Properties
Methods

Properties

elementCount
Type : number
Decorators :
@DisplayName('Element count')
Defined in libs/sensorml/src/lib/model/swe/SweDataArray.ts:18

Specifies the size of the array (i.e. the number of elements of the defined type it contains)
elementType
Type : SweElementType
Decorators :
@DisplayName('Element type')
Defined in libs/sensorml/src/lib/model/swe/SweDataArray.ts:23

Defines the structure of the element that will be repeated in the array
encoding
Type : SweEncoding
Decorators :
@DisplayName('Encoding')
Defined in libs/sensorml/src/lib/model/swe/SweDataArray.ts:28

Specifies the type of method used to encode the array values
values
Type : EncodedValues
Decorators :
@DisplayName('Values')
Defined in libs/sensorml/src/lib/model/swe/SweDataArray.ts:35

If present, contains an encoded block of the values contained in the array. Values are optional so that the array definition can be used a as a schema for values provided externally
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/SweDataArray.ts:41
Returns : string
toString
toString(fallbackLabel: string)
Defined in libs/sensorml/src/lib/model/swe/SweDataArray.ts:37
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Data Array Component'
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 { EncodedValues } from './EncodedValues';
import { AbstractDataComponent } from './AbstractDataComponent';
import { SweElementType } from './SweElementType';
import { SweEncoding } from './SweEncoding';
import { DisplayName } from '../../common/decorators/DisplayName';

/**
 * Implementation of ISO-11404 Array datatype. This defines an array of
 * identical data components with a elementCount. Values are given as a block
 * and can be encoded in different ways
 */
export class SweDataArray extends AbstractDataComponent {
    /**
     * Specifies the size of the array (i.e. the number of elements of the defined
     * type it contains)
     */
    @DisplayName('Element count')
    elementCount: number;
    /**
     * Defines the structure of the element that will be repeated in the array
     */
    @DisplayName('Element type')
    elementType: SweElementType;
    /**
     * Specifies the type of method used to encode the array values
     */
    @DisplayName('Encoding')
    encoding: SweEncoding;
    /**
     * If present, contains an encoded block of the values contained in the array.
     * Values are optional so that the array definition can be used a as a schema
     * for values provided externally
     */
    @DisplayName('Values')
    values: EncodedValues;

    toString(fallbackLabel = 'Data Array Component') {
        return fallbackLabel;
    }

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

result-matching ""

    No results matching ""