libs/sensorml/src/lib/model/sml/DescribedObject.ts
A feature with generic metadata which further clarifies the object and supports object discovery.
Properties |
Methods |
| capabilities |
Type : CapabilityList[]
|
Default value : []
|
Decorators :
@DisplayName('Capabilities')
|
|
Properties that further clarify or quantify the output of the process (e.g. dynamic range, sensitivity, threshold, etc.). These can assist in the discovery of processes that meet particular requirements. |
| characteristics |
Type : CharacteristicList[]
|
Default value : []
|
Decorators :
@DisplayName('Characteristics')
|
|
Useful properties of this process that do not further qualify the output values (e.g. component dimensions, battery life, operational limits, etc). |
| classification |
Type : ClassifierList[]
|
Default value : []
|
Decorators :
@DisplayName('Classification')
|
|
Classifiers useful for discovery of the process (e.g. process type, sensor type, intended application, etc.) |
| contacts |
Type : ContactList[]
|
Default value : []
|
Decorators :
@DisplayName('Contacts')
|
|
Persons or responsible parties that are relevant to this process (e.g. designer, manufacturer, expert, etc.) |
| documentation |
Type : DocumentList[]
|
Default value : []
|
Decorators :
@DisplayName('Documentation')
|
|
Additional external online documentation of relevance to this process (e.g. user's guides, product manuals, specification sheets, images, technical papers, etc.) |
| extension |
Type : any[]
|
Default value : []
|
Decorators :
@DisplayName('Extension')
|
|
A property that allows one to extend a document using a schema in a different namespace from the current schema. |
| history |
Type : EventList[]
|
Default value : []
|
Decorators :
@DisplayName('History')
|
|
A collection of time-tagged events relevant to this process. |
| identification |
Type : IdentifierList[]
|
Default value : []
|
Decorators :
@DisplayName('Identification')
|
|
Identifiers useful for discovery of the process (e.g. short name, mission id, wing id, serial number, etc.) |
| keywords |
Type : KeywordList[]
|
Default value : []
|
Decorators :
@DisplayName('Keywords')
|
|
Short keywords describing the context of this document to aid in discovery. |
| language |
Type : string
|
Decorators :
@DisplayName('Language')
|
|
A tag that identifies the language (e.g. english, french, etc.) for the overall document using a two-letters code as defined by ISO 639-1. |
| legalConstraints |
Type : LegalConstraints[]
|
Default value : []
|
Decorators :
@DisplayName('Legal constraints')
|
|
Legal constraints applied to this description (e.g. copyrights, legal use, etc.) |
| validTime |
Type : AbstractTime[]
|
Default value : []
|
Decorators :
@DisplayName('Valid time')
|
|
The time instance or time range during which this instance description is valid. |
| boundedBy |
Type : Envelope
|
Decorators :
@DisplayName('Bounded by')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:18
|
|
The value of the gml:boundedBy property describes an envelope that encloses the entire feature instance, and is primarily useful for supporting rapid searching for features that occur in a particular location. |
| location |
Type : any
|
Decorators :
@DisplayName('Location')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:24
|
|
The value of the gml:location property describes the extent, position or relative location of the feature. |
| description |
Type : string
|
Decorators :
@DisplayName('Description')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:23
|
|
The value of this property is a text description of the object. gml:description uses gml:StringOrRefType as its content model, so it may contain a simple text string content, or carry a reference to an external description. The use of gml:description to reference an external description has been deprecated and replaced by the gml:descriptionReference property. |
| descriptionReference |
Type : string
|
Decorators :
@DisplayName('Description reference')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:30
|
|
The value of this property is a remote text description of the object. The xlink:href attribute of the gml:descriptionReference property references the external description. |
| gmlId |
Type : string
|
Decorators :
@DisplayName('GML ID')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:13
|
| identifier |
Type : CodeType
|
Decorators :
@DisplayName('Identifier')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:51
|
|
Often, a special identifier is assigned to an object by the maintaining authority with the intention that it is used in references to the object. For such cases, the codeSpace shall be provided. That identifier is usually unique either globally or within an application domain. gml:identifier is a pre-defined property for such identifiers. |
| name |
Type : CodeType[]
|
Decorators :
@DisplayName('Name')
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:42
|
|
The gml:name property provides a label or identifier for the object, commonly a descriptive name. An object may have several names, typically assigned by different authorities. gml:name uses the gml:CodeType content model. The authority for a name is indicated by the value of its (optional) codeSpace attribute. The name may or may not be unique, as determined by the rules of the organization responsible for the codeSpace. In common usage there will be one name per authority, so a processing application may select the name from its preferred codeSpace. |
| description |
Type : string
|
Decorators :
@DisplayName('Description')
|
|
Inherited from
AbstractGML
|
|
Defined in
AbstractGML:23
|
|
The value of this property is a text description of the object. gml:description uses gml:StringOrRefType as its content model, so it may contain a simple text string content, or carry a reference to an external description. The use of gml:description to reference an external description has been deprecated and replaced by the gml:descriptionReference property. |
| descriptionReference |
Type : string
|
Decorators :
@DisplayName('Description reference')
|
|
Inherited from
AbstractGML
|
|
Defined in
AbstractGML:30
|
|
The value of this property is a remote text description of the object. The xlink:href attribute of the gml:descriptionReference property references the external description. |
| gmlId |
Type : string
|
Decorators :
@DisplayName('GML ID')
|
|
Inherited from
AbstractGML
|
|
Defined in
AbstractGML:13
|
| identifier |
Type : CodeType
|
Decorators :
@DisplayName('Identifier')
|
|
Inherited from
AbstractGML
|
|
Defined in
AbstractGML:51
|
|
Often, a special identifier is assigned to an object by the maintaining authority with the intention that it is used in references to the object. For such cases, the codeSpace shall be provided. That identifier is usually unique either globally or within an application domain. gml:identifier is a pre-defined property for such identifiers. |
| name |
Type : CodeType[]
|
Decorators :
@DisplayName('Name')
|
|
Inherited from
AbstractGML
|
|
Defined in
AbstractGML:42
|
|
The gml:name property provides a label or identifier for the object, commonly a descriptive name. An object may have several names, typically assigned by different authorities. gml:name uses the gml:CodeType content model. The authority for a name is indicated by the value of its (optional) codeSpace attribute. The name may or may not be unique, as determined by the rules of the organization responsible for the codeSpace. In common usage there will be one name per authority, so a processing application may select the name from its preferred codeSpace. |
| toString |
toString()
|
|
Returns :
string
|
| toString |
toString()
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:26
|
|
Returns :
string
|
| toString |
toString()
|
|
Inherited from
AbstractFeature
|
|
Defined in
AbstractFeature:53
|
|
Returns :
string
|
| toString |
toString()
|
|
Inherited from
AbstractGML
|
|
Defined in
AbstractGML:53
|
|
Returns :
string
|
import { AbstractFeature } from '../gml/AbstractFeature';
import { KeywordList } from './KeywordList';
import { IdentifierList } from './IdentifierList';
import { ClassifierList } from './ClassifierList';
import { AbstractTime } from '../gml/AbstractTime';
import { LegalConstraints } from '../iso/gmd/LegalConstraints';
import { CharacteristicList } from './CharacteristicList';
import { CapabilityList } from './CapabilityList';
import { ContactList } from './ContactList';
import { EventList } from './EventList';
import { DocumentList } from './DocumentList';
import { DisplayName } from '../../common/decorators/DisplayName';
/**
* A feature with generic metadata which further clarifies the object and
* supports object discovery.
*/
export abstract class DescribedObject extends AbstractFeature {
/**
* A property that allows one to extend a document using a schema in a
* different namespace from the current schema.
*/
@DisplayName('Extension')
extension: any[] = [];
/**
* A tag that identifies the language (e.g. english, french, etc.) for the
* overall document using a two-letters code as defined by ISO 639-1.
*/
@DisplayName('Language')
language: string;
/**
* Short keywords describing the context of this document to aid in discovery.
*/
@DisplayName('Keywords')
keywords: KeywordList[] = [];
/**
* Identifiers useful for discovery of the process (e.g. short name, mission
* id, wing id, serial number, etc.)
*/
@DisplayName('Identification')
identification: IdentifierList[] = [];
/**
* Classifiers useful for discovery of the process (e.g. process type, sensor
* type, intended application, etc.)
*/
@DisplayName('Classification')
classification: ClassifierList[] = [];
/**
* The time instance or time range during which this instance description
* is valid.
*/
@DisplayName('Valid time')
validTime: AbstractTime[] = [];
/**
* Overall security tagging of process description; individual tagging of
* properties can be done using extension element.
*/
@DisplayName('Security constraints')
securityConstraints: any[] = [];
/**
* Legal constraints applied to this description (e.g. copyrights, legal
* use, etc.)
*/
@DisplayName('Legal constraints')
legalConstraints: LegalConstraints[] = [];
/**
* Useful properties of this process that do not further qualify the output
* values (e.g. component dimensions, battery life, operational limits, etc).
*/
@DisplayName('Characteristics')
characteristics: CharacteristicList[] = [];
/**
* Properties that further clarify or quantify the output of the process (e.g.
* dynamic range, sensitivity, threshold, etc.). These can assist in the
* discovery of processes that meet particular requirements.
*/
@DisplayName('Capabilities')
capabilities: CapabilityList[] = [];
/**
* Persons or responsible parties that are relevant to this process (e.g.
* designer, manufacturer, expert, etc.)
*/
@DisplayName('Contacts')
contacts: ContactList[] = [];
/**
* Additional external online documentation of relevance to this process (e.g.
* user's guides, product manuals, specification sheets, images, technical
* papers, etc.)
*/
@DisplayName('Documentation')
documentation: DocumentList[] = [];
/**
* A collection of time-tagged events relevant to this process.
*/
@DisplayName('History')
history: EventList[] = [];
toString() {
return 'Described object';
}
}