File

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

Description

Abstract base class for all data components

Extends

AbstractSWEIdentifiable

Index

Properties
Methods

Properties

definition
Type : string
Decorators :
@DisplayName('Definition')

Reference to semantic information defining the precise nature of the component

optional
Type : boolean
Decorators :
@DisplayName('Optional')

Specifies that data for this component can be omitted in the datastream

updatable
Type : boolean
Decorators :
@DisplayName('Updatable')

Specifies if the value of a data component can be updated externally (i.e. is variable)

description
Type : string
Decorators :
@DisplayName('Description')
Inherited from AbstractSWEIdentifiable

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

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

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 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

Public getLabel
getLabel()
Returns : any
Abstract getValue
getValue()
Returns : any
toString
toString(fallbackLabel: string)
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract data component'
Returns : any
toString
toString(fallbackLabel: string)
Inherited from AbstractSWEIdentifiable
Parameters :
Name Type Optional Default value
fallbackLabel string No 'Abstract SWE identifiable'
Returns : string
toString
toString()
Inherited from AbstractSWE
Defined in AbstractSWE:14
Returns : string
import { AbstractSWEIdentifiable } from './AbstractSWEIdentifiable';
import { DisplayName } from '../../common/decorators/DisplayName';

/**
 * Abstract base class for all data components
 */
export abstract class AbstractDataComponent extends AbstractSWEIdentifiable {
    /**
     * Reference to semantic information defining the precise nature of the
     * component
     */
    @DisplayName('Definition')
    definition: string;
    /**
     * Specifies that data for this component can be omitted in the datastream
     */
    @DisplayName('Optional')
    optional: boolean;
    /**
     * Specifies if the value of a data component can be updated externally
     * (i.e. is variable)
     */
    @DisplayName('Updatable')
    updatable: boolean;

    toString(fallbackLabel = 'Abstract data component') {
        return super.toString(fallbackLabel);
    }

    public getLabel() {
        return this.label;
    }

    abstract getValue();
}

result-matching ""

    No results matching ""