libs/sensorml/src/lib/model/sml/DataInterface.ts
The DataInterface description provides information sufficient for "plug-and-play" access to and parsing of the data stream or file at the particular IO port.
Properties |
Methods |
data |
Type : SweDataStream
|
Decorators :
@DisplayName('Data')
|
The definition of the digital data components and encoding accessed through the data interface. |
interfaceParameters |
Type : SweDataRecord
|
Decorators :
@DisplayName('Interface parameters')
|
A set of property values that define the type and configuration of a data interface (e.g. the port settings of an RS232 interface). |
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
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
|
toString |
toString()
|
Returns :
any
|
toString | ||||||||
toString(fallbackLabel: string)
|
||||||||
Inherited from
AbstractSWEIdentifiable
|
||||||||
Defined in
AbstractSWEIdentifiable:29
|
||||||||
Parameters :
Returns :
string
|
toString |
toString()
|
Inherited from
AbstractSWE
|
Defined in
AbstractSWE:14
|
Returns :
string
|
import { AbstractSWEIdentifiable } from '../swe/AbstractSWEIdentifiable';
import { SweDataStream } from '../swe/SweDataStream';
import { SweDataRecord } from '../swe/SweDataRecord';
import { DisplayName } from '../../common/decorators/DisplayName';
/**
* The DataInterface description provides information sufficient for
* "plug-and-play" access to and parsing of the data stream or file at the
* particular IO port.
*/
export class DataInterface extends AbstractSWEIdentifiable {
/**
* The definition of the digital data components and encoding accessed
* through the data interface.
*/
@DisplayName('Data')
data: SweDataStream;
/**
* A set of property values that define the type and configuration of a data
* interface (e.g. the port settings of an RS232 interface).
*/
@DisplayName('Interface parameters')
interfaceParameters: SweDataRecord;
toString() {
return super.toString('Data interface');
}
}