File

libs/sensorml/src/lib/model/sml/Event.ts

Description

A time tagged Event with description and relevant property values.

Extends

AbstractSWEIdentifiable

Index

Properties
Methods

Properties

classification
Type : ClassifierList[]
Default value : []
Decorators :
@DisplayName('Classification')

Type of event (useful for discovery)

configuration
Type : Settings
Decorators :
@DisplayName('Configuration')

Configuration settings adjusted during event

contacts
Type : ContactList[]
Default value : []
Decorators :
@DisplayName('Contacts')

Persons or parties relevant to this event

definition
Type : CodeWithAuthority
Decorators :
@DisplayName('Definition')
documentation
Type : DocumentList[]
Default value : []
Decorators :
@DisplayName('Documentation')

Additional documentation relevant to this event

identification
Type : IdentifierList[]
Default value : []
Decorators :
@DisplayName('Identification')

Identifiers relevant to the event

keywords
Type : KeywordList[]
Default value : []
Decorators :
@DisplayName('Keywords')

keywords useful for discovery of the event

properties
Type : SweDataComponent[]
Default value : []
Decorators :
@DisplayName('Properties')

Properties of interest to the event (e.g. calibration values, condition category, error codes, etc)

time
Type : AbstractTime
Default value : null
Decorators :
@DisplayName('Time')

DateTime of the event

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

toString
toString()
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 { CodeWithAuthority } from '../gml/CodeWithAuthority';
import { AbstractSWEIdentifiable } from '../swe/AbstractSWEIdentifiable';
import { SweDataComponent } from '../swe/SweDataComponent';
import { KeywordList } from './KeywordList';
import { IdentifierList } from './IdentifierList';
import { ClassifierList } from './ClassifierList';
import { ContactList } from './ContactList';
import { DocumentList } from './DocumentList';
import { Settings } from './Settings';
import { AbstractTime } from '../gml/AbstractTime';
import { DisplayName } from '../../common/decorators/DisplayName';

/**
 * A time tagged Event with description and relevant property values.
 */
export class Event extends AbstractSWEIdentifiable {
    @DisplayName('Definition')
    definition: CodeWithAuthority;
    /**
     * keywords useful for discovery of the event
     */
    @DisplayName('Keywords')
    keywords: KeywordList[] = [];
    /**
     * Identifiers relevant to the event
     */
    @DisplayName('Identification')
    identification: IdentifierList[] = [];
    /**
     * Type of event (useful for discovery)
     */
    @DisplayName('Classification')
    classification: ClassifierList[] = [];
    /**
     * Persons or parties relevant to this event
     */
    @DisplayName('Contacts')
    contacts: ContactList[] = [];
    /**
     * Additional documentation relevant to this event
     */
    @DisplayName('Documentation')
    documentation: DocumentList[] = [];
    /**
     * DateTime of the event
     */
    @DisplayName('Time')
    time: AbstractTime = null;
    /**
     * Properties of interest to the event (e.g. calibration values, condition
     * category, error codes, etc)
     */
    @DisplayName('Properties')
    properties: SweDataComponent[] = [];
    /**
     * Configuration settings adjusted during event
     */
    @DisplayName('Configuration')
    configuration: Settings;

    toString() {
        return super.toString('Event');
    }
}

result-matching ""

    No results matching ""