Cocop.MessageSerialiser.Meas (C#)  2.0.0
API to encode industrial data as standard-based messages
Namespaces | Classes | Enumerations
Cocop.MessageSerialiser.Meas Namespace Reference

Namespaces

namespace  Neutral
 

Classes

class  DataQuality
 Represents observation quality information. More...
 
class  ExtensibleResponse
 Base class for extensible response types. More...
 
class  GetObservationRequest
 A class to process "get observation" requests. More...
 
class  GetObservationResponse
 A class to process "get observation" responses. More...
 
class  InsertObservationRequest
 A class to process "insert observation" requests. More...
 
class  InsertObservationResponse
 A class to process "insert observation" responses. More...
 
class  Item
 Abstract base class for items. More...
 
class  Item_Array
 Represents an array of data. More...
 
class  Item_Boolean
 Represents a boolean value. More...
 
class  Item_Category
 Represents a category observation. It may be a process state or any other enumeration value. This class should not be used for free-form textual data! For that, use the class Item_Text. More...
 
class  Item_CategoryRange
 An item that contains a range of category values (lower bound and upper bound). This type does not exist in the Observations and Measurements standard, but the type appears as a field type for a data record in the SWE common standard. More...
 
class  Item_Count
 Represents a count value, that is, an integer without any unit of measure. More...
 
class  Item_CountRange
 An item that contains a range of count values (lower bound and upper bound). This type does not exist in the Observations and Measurements standard, but the type appears as a field type for a data record in the SWE common standard. More...
 
class  Item_DataRecord
 Represents a complex measurement result with multiple fields. More...
 
class  Item_Measurement
 A measurement result that has a numeric value and unit of measure. More...
 
class  Item_MeasurementRange
 An item that contains a range of measurement values (lower bound and upper bound). This type does not exist in the Observations and Measurements standard, but the type appears as a field type for a data record in the SWE common standard. More...
 
class  Item_Text
 Represents a value from free textual input. This class should not be used for enumeration values (such as process states or similar)! For those, use Item_Category instead. More...
 
class  Item_TimeInstant
 Represents a timestamp either in the past or in the future. More...
 
class  Item_TimeRange
 Represents a time period. More...
 
class  Item_TimeSeries
 Abstract base class for time series. A common base class exists, because the XML structures of time series resemble each other very much. However, in C#, not all structures can be reused. This applies especially because of collection initialisers that require the implementation of the IEnumerable interface. More...
 
class  Item_TimeSeriesConstant
 A class to serialise time series with a constant sampling interval. More...
 
class  Item_TimeSeriesFlexible
 A time series of measurement values. In this time series type, there is no requirement for constant time intervals between measurement points. More...
 
class  MessageDeserialiser
 Helper class for the deserialisation of messages. If you need this class, it may indicate bad design, because you should usually know which message type to expect. More...
 
class  Observation
 Observation class to associate metadata to actual measurement objects. More...
 
class  ResultTypeManager
 A class to manage result typing. It was implemented to facilitate the testing of Item_* classes, as it also needs this functionality.
 
class  TaskingParameterProcessor
 Processes tasking parameters.
 
class  TaskRequest
 Represents a task-related request. More...
 
class  TaskResponse
 Represents a task-related response. More...
 
class  TaskStatusReport
 Represents a status report for a task. More...
 
class  TemporalFilter
 Represents a temporal filter. More...
 

Enumerations

enum  TaskOperationType { TaskOperationType.Submit = 0, TaskOperationType.Update = 1, TaskOperationType.GetStatus = 2, TaskOperationType.Cancel = 3 }
 Specifies a task-related operation. More...
 
enum  RequestResultType {
  RequestResultType.Unknown = 0, RequestResultType.Ok = 1, RequestResultType.ServerError = 2, RequestResultType.NotFound = 3,
  RequestResultType.BadRequest = 4, RequestResultType.Conflict = 5
}
 Represents the result of a request. More...
 
enum  TaskingRequestStatusCodeType { TaskingRequestStatusCodeType.Accepted = 0, TaskingRequestStatusCodeType.Pending = 1, TaskingRequestStatusCodeType.Rejected = 2 }
 Represents the status of a tasking request. More...
 
enum  TaskStatusCodeType {
  TaskStatusCodeType.Unknown = 0, TaskStatusCodeType.Cancelled = 1, TaskStatusCodeType.Completed = 2, TaskStatusCodeType.Failed = 3,
  TaskStatusCodeType.InExecution = 4, TaskStatusCodeType.Reserved = 5, TaskStatusCodeType.Expired = 6
}
 Represents the status of a task. More...
 

Enumeration Type Documentation

◆ RequestResultType

Represents the result of a request.

Enumerator
Unknown 

The result is unknown. This should only be used to indicate that the result has not been specified.

Ok 

The request has been processed successfully.

ServerError 

The server encountered an internal error while processing the request.

NotFound 

The requested resource was not found in the server.

BadRequest 

The server failed to understand the request.

Conflict 

The requested action cannot be performed due to a conflict.

◆ TaskingRequestStatusCodeType

Represents the status of a tasking request.

In this module, the code has been derived from OGC(r) Sensor Planning Service Implementation Standard (OGC 09-000; please see the file "ref_and_license_ogc_sps.txt").

Enumerator
Accepted 

Accepted.

Pending 

Pending.

Rejected 

Rejected.

◆ TaskOperationType

Specifies a task-related operation.

Enumerator
Submit 

Submit (i.e., create) a new task.

Update 

Update an existing task.

GetStatus 

Get the status of a task.

Cancel 

Cancel a task.

◆ TaskStatusCodeType

Represents the status of a task.

In this module, the code has been derived from OGC(r) Sensor Planning Service Implementation Standard (OGC 09-000; please see the file "ref_and_license_ogc_sps.txt").

Enumerator
Unknown 

Unknown. Use this only when the status is truly unknown!

Cancelled 

Cancelled.

Completed 

Completed.

Failed 

Failed.

InExecution 

In execution.

Reserved 

Reserved but not in execution.

Expired 

Task reservation expired.