Cocop.MessageSerialiser.Meas (C#)  2.0.0
API to encode industrial data as standard-based messages
Public Member Functions | Properties | List of all members
Cocop.MessageSerialiser.Meas.Observation Class Reference

Observation class to associate metadata to actual measurement objects. More...

Public Member Functions

 Observation (Item r)
 Constructor. Use this populate the observation manually. More...
 
 Observation (byte[] xmlBytes)
 Constructor to populate the information from XML. More...
 
byte [] ToXmlBytes ()
 Serialises the object to XML. More...
 

Properties

string Name [get, set]
 Gets observation name. More...
 
string Description [get, set]
 Description. More...
 
DateTime PhenomenonTime [get, set]
 Phenomenon time. More...
 
DateTime ResultTime [get, set]
 Result time. More...
 
string Procedure [get, set]
 Procedure. More...
 
string ObservedProperty [get, set]
 Observed property. More...
 
string FeatureOfInterest [get, set]
 Feature of interest. More...
 
Item_DataRecord FeatureOfInterestDetails [get, set]
 The details of the feature of interest. More...
 
DataQuality ResultQuality [get, set]
 Result quality. More...
 
Item Result [get]
 Result. More...
 

Detailed Description

Observation class to associate metadata to actual measurement objects.

In this module, the code has been derived from Observations and Measurements - XML Implementation (OGC 10-025r1; please see the file "ref_and_license_ogc_om.txt").

Constructor & Destructor Documentation

◆ Observation() [1/2]

Cocop.MessageSerialiser.Meas.Observation.Observation ( Item  r)

Constructor. Use this populate the observation manually.

Parameters
rResult object.
Exceptions
XNeut.InvalidMessageExceptionThrown if an error is encountered.

◆ Observation() [2/2]

Cocop.MessageSerialiser.Meas.Observation.Observation ( byte []  xmlBytes)

Constructor to populate the information from XML.

Parameters
xmlBytesSerialised XML document.
Exceptions
XNeut.InvalidMessageExceptionThrown if an error is encountered.

Member Function Documentation

◆ ToXmlBytes()

byte [] Cocop.MessageSerialiser.Meas.Observation.ToXmlBytes ( )

Serialises the object to XML.

Returns
Object as XML.

Property Documentation

◆ Description

string Cocop.MessageSerialiser.Meas.Observation.Description
getset

Description.

◆ FeatureOfInterest

string Cocop.MessageSerialiser.Meas.Observation.FeatureOfInterest
getset

Feature of interest.

◆ FeatureOfInterestDetails

Item_DataRecord Cocop.MessageSerialiser.Meas.Observation.FeatureOfInterestDetails
getset

The details of the feature of interest.

◆ Name

string Cocop.MessageSerialiser.Meas.Observation.Name
getset

Gets observation name.

◆ ObservedProperty

string Cocop.MessageSerialiser.Meas.Observation.ObservedProperty
getset

Observed property.

◆ PhenomenonTime

DateTime Cocop.MessageSerialiser.Meas.Observation.PhenomenonTime
getset

Phenomenon time.

Exceptions
XNeut.DateTimeExceptionThrown if there is an attempt to set a non-UTC value.

◆ Procedure

string Cocop.MessageSerialiser.Meas.Observation.Procedure
getset

Procedure.

◆ Result

Item Cocop.MessageSerialiser.Meas.Observation.Result
get

Result.

◆ ResultQuality

DataQuality Cocop.MessageSerialiser.Meas.Observation.ResultQuality
getset

Result quality.

◆ ResultTime

DateTime Cocop.MessageSerialiser.Meas.Observation.ResultTime
getset

Result time.

Exceptions
XNeut.DateTimeExceptionThrown if there is an attempt to set a non-UTC value.
The documentation for this class was generated from the following file:

Before using this software, please make sure to read and understand LICENSE.txt.

Although this software is a derivative work from certain standards from the Open Geospatial Consortium, Inc. (OGC®), OGC has not created this software. Furthermore, this software has not been certified for compliance with any OGC standard.

Open Geospatial Consortium, Inc.®, OpenGIS® and OGC® are registered trademarks of the Open Geospatial Consortium, Inc.

To find the referred OGC standards and/or their licenses, please see the following:

Document Notice ogc_document_notice.txt
Software Notice ogc_software_notice.txt
OGC 09-026r2 OGC Filter Encoding 2.0 Encoding Standard - With Corrigendum ref_and_license_ogc_filter.txt
OGC 07-036 OpenGIS® Geography Markup Language (GML) Encoding Standard ref_and_license_ogc_gml.txt
OGC 10-025r1 Observations and Measurements - XML Implementation ref_and_license_ogc_om.txt
OGC 12-006 OGC® Sensor Observation Service Interface Standard ref_and_license_ogc_sos.txt
OGC 09-000 OGC® Sensor Planning Service Implementation Standard ref_and_license_ogc_sps.txt
OGC 08-094r1 OGC® SWE Common Data Model Encoding Standard ref_and_license_ogc_swecommon.txt
OGC 09-001 OpenGIS® SWE Service Model Implementation Standard ref_and_license_ogc_swes.txt
OGC 15-042r3 TimeseriesML 1.0 - XML Encoding of the Timeseries Profile of Observations and Measurements ref_and_license_ogc_tsml.txt
COCOP and EU

COCOP - Coordinating Optimisation of Complex Industrial Processes
https://cocop-spire.eu/

This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 723661. This piece of software reflects only the authors' views, and the Commission is not responsible for any use that may be made of the information contained therein.

Generated by   doxygen