helgoland-toolbox documentation
  1. Classes
  2. SweDataStream

File

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

Description

Defines the structure of the element that will be repeated in the stream

Extends

AbstractSWEIdentifiable

Index

Properties
Methods

Properties

elementCount
Type : SweCount[]
Decorators :
@DisplayName('Element count')
Defined in libs/sensorml/src/lib/model/swe/SweDataStream.ts:16

Number of elements of the defined type that the stream contains
elementType
Type : SweElementType
Decorators :
@DisplayName('Element type')
Defined in libs/sensorml/src/lib/model/swe/SweDataStream.ts:21

Definition and structure of one stream element
encoding
Type : SweEncoding
Decorators :
@DisplayName('Encoding')
Defined in libs/sensorml/src/lib/model/swe/SweDataStream.ts:26

Method used to encode the stream values
values
Type : EncodedValues
Decorators :
@DisplayName('Values')
Defined in libs/sensorml/src/lib/model/swe/SweDataStream.ts:31

Encoded values for the stream (can be out of band)
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

toString
toString()
Defined in libs/sensorml/src/lib/model/swe/SweDataStream.ts:33
Returns : any
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 { AbstractSWEIdentifiable } from './AbstractSWEIdentifiable';
import { EncodedValues } from './EncodedValues';
import { SweCount } from './SweCount';
import { SweEncoding } from './SweEncoding';
import { SweElementType } from './SweElementType';
import { DisplayName } from '../../common/decorators/DisplayName';

/**
 * Defines the structure of the element that will be repeated in the stream
 */
export class SweDataStream extends AbstractSWEIdentifiable {
    /**
     * Number of elements of the defined type that the stream contains
     */
    @DisplayName('Element count')
    elementCount: SweCount[];
    /**
     * Definition and structure of one stream element
     */
    @DisplayName('Element type')
    elementType: SweElementType;
    /**
     * Method used to encode the stream values
     */
    @DisplayName('Encoding')
    encoding: SweEncoding;
    /**
     * Encoded values for the stream (can be out of band)
     */
    @DisplayName('Values')
    values: EncodedValues;

    toString() {
        return super.toString('SWE data stream');
    }
}

result-matching ""

    No results matching ""