libs/sensorml/src/lib/model/sml/AbstractProcess.ts
The general base model for any process.
configuration |
Type : Settings
|
Decorators :
@DisplayName('Configuration')
|
Value settings that further constrain the properties of the base process. |
definition |
Type : string
|
Decorators :
@DisplayName('Definition')
|
An optional property that allows one to reference the process instance in an online ontology or dictionary. The value of the property must be a resolvable URI. |
featureOfInterest |
Type : FeatureList
|
Default value : new FeatureList()
|
Decorators :
@DisplayName('Feature of interest')
|
A collection of features relevant to a process (e.g. the Gulf of Mexico, the White House, the set of all Fibonacci Numbers, etc.); can also support a sampling feature. The primary purpose of the Features of Interest is to support discovery. |
inputs |
Type : InputList
|
Default value : new InputList()
|
Decorators :
@DisplayName('Inputs')
|
The list of data components (and their properties and semantics) that the process will accept as input; In the standard linear equation y=mx+b; x is the input, m and b are the parameters, and y is the output. |
modes |
Type : AbstractModes[]
|
Default value : []
|
Decorators :
@DisplayName('Modes')
|
A collection of parameters that can be set at once through the selection of a particular predefined mode. |
outputs |
Type : OutputList
|
Default value : new OutputList()
|
Decorators :
@DisplayName('Outputs')
|
The list of data components (and their properties and semantics) that the process will accept as parameters; In the standard linear equation y=mx+b; x is the input, m and b are the parameters, and y is the output. |
parameters |
Type : ParameterList
|
Default value : new ParameterList()
|
Decorators :
@DisplayName('Parameters')
|
The list of data components (and their properties and semantics) that the process will accept as parameters; In the standard linear equation y=mx+b; x is the input, m and b are the parameters, and y is the output. |
typeOf |
Type : string
|
Default value : null
|
Decorators :
@DisplayName('Type of')
|
A reference to a base process from which this process inherits properties and constraints (e.g. original equipment manufacturer's model description, generic equation, etc.). The uniqueID of the referenced process must be provided using the xlink:title attribute while the URL to the process description must be provided by the xlink:href attribute. |
capabilities |
Type : CapabilityList[]
|
Default value : []
|
Decorators :
@DisplayName('Capabilities')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:77
|
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')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:70
|
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')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:46
|
Classifiers useful for discovery of the process (e.g. process type, sensor type, intended application, etc.) |
contacts |
Type : ContactList[]
|
Default value : []
|
Decorators :
@DisplayName('Contacts')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:83
|
Persons or responsible parties that are relevant to this process (e.g. designer, manufacturer, expert, etc.) |
documentation |
Type : DocumentList[]
|
Default value : []
|
Decorators :
@DisplayName('Documentation')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:90
|
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')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:23
|
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')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:95
|
A collection of time-tagged events relevant to this process. |
identification |
Type : IdentifierList[]
|
Default value : []
|
Decorators :
@DisplayName('Identification')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:40
|
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')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:34
|
Short keywords describing the context of this document to aid in discovery. |
language |
Type : string
|
Decorators :
@DisplayName('Language')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:29
|
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')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:64
|
Legal constraints applied to this description (e.g. copyrights, legal use, etc.) |
securityConstraints |
Type : any[]
|
Default value : []
|
Decorators :
@DisplayName('Security constraints')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:58
|
Overall security tagging of process description; individual tagging of properties can be done using extension element. |
validTime |
Type : AbstractTime[]
|
Default value : []
|
Decorators :
@DisplayName('Valid time')
|
Inherited from
DescribedObject
|
Defined in
DescribedObject:52
|
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
DescribedObject
|
Defined in
DescribedObject:97
|
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 { DescribedObject } from './DescribedObject';
import { Settings } from './Settings';
import { FeatureList } from './FeatureList';
import { InputList } from './InputList';
import { OutputList } from './OutputList';
import { ParameterList } from './ParameterList';
import { AbstractModes } from './AbstractModes';
import { DisplayName } from '../../common/decorators/DisplayName';
/**
* The general base model for any process.
*/
export abstract class AbstractProcess extends DescribedObject {
/**
* An optional property that allows one to reference the process instance in
* an online ontology or dictionary. The value of the property must be a
* resolvable URI.
*/
@DisplayName('Definition')
definition: string;
/**
* A reference to a base process from which this process inherits properties
* and constraints (e.g. original equipment manufacturer's model description,
* generic equation, etc.). The uniqueID of the referenced process must be
* provided using the xlink:title attribute while the URL to the process
* description must be provided by the xlink:href attribute.
*/
@DisplayName('Type of')
typeOf: string = null;
/**
* Value settings that further constrain the properties of the base process.
*/
@DisplayName('Configuration')
configuration: Settings;
/**
* A collection of features relevant to a process (e.g. the Gulf of Mexico,
* the White House, the set of all Fibonacci Numbers, etc.); can also support
* a sampling feature. The primary purpose of the Features of Interest is to
* support discovery.
*/
@DisplayName('Feature of interest')
featureOfInterest: FeatureList = new FeatureList();
/**
* The list of data components (and their properties and semantics) that the
* process will accept as input; In the standard linear equation y=mx+b; x is
* the input, m and b are the parameters, and y is the output.
*/
@DisplayName('Inputs')
inputs: InputList = new InputList();
/**
* The list of data components (and their properties and semantics) that the
* process will accept as parameters; In the standard linear equation y=mx+b;
* x is the input, m and b are the parameters, and y is the output.
*/
@DisplayName('Outputs')
outputs: OutputList = new OutputList();
/**
* The list of data components (and their properties and semantics) that the
* process will accept as parameters; In the standard linear equation y=mx+b;
* x is the input, m and b are the parameters, and y is the output.
*/
@DisplayName('Parameters')
parameters: ParameterList = new ParameterList();
/**
* A collection of parameters that can be set at once through the selection of
* a particular predefined mode.
*/
@DisplayName('Modes')
modes: AbstractModes[] = [];
toString() {
return 'Abstract process';
}
}