Gateway C ABI
Loading...
Searching...
No Matches
Data Structures | Typedefs | Enumerations | Functions
datapoint_value.h File Reference
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  sGCDatapointValue
 The value of a datapoint. More...
 

Typedefs

typedef uint64_t GCDatapointIdentifier
 
typedef uint16_t GCDatapointValueQuality
 
typedef enum eGCDatapointValueType GCDatapointValueType
 
typedef struct sGCDatapointValue * GCDatapointValue
 

Enumerations

enum  eGCDatapointValueType {
  GCOS_DATAPOINT_TYPE_FLOAT32 , GCOS_DATAPOINT_TYPE_FLOAT64 , GCOS_DATAPOINT_TYPE_INT32 , GCOS_DATAPOINT_TYPE_INT64 ,
  GCOS_DATAPOINT_TYPE_BOOLEAN , GCOS_DATAPOINT_TYPE_UINT32 , GCOS_DATAPOINT_TYPE_UINT64 , GCOS_DATAPOINT_TYPE_DOUBLEPOINT ,
  GCOS_DATAPOINT_TYPE_TIMESTAMPNS , GCOS_DATAPOINT_TYPE_BYTE_ARRAY
}
 The type of the datapoint value. More...
 

Functions

void GCDatapointValue_setQualityGood (GCDatapointValue value)
 Set the quality of a datapoint value to good.
 
void GCDatapointValue_setQualityInvalid (GCDatapointValue value)
 Set the quality of a datapoint value to invalid.
 
void GCDatapointValue_setQualityQuestionable (GCDatapointValue value)
 Set the quality of a datapoint value to questionable.
 
void GCDatapointValue_setQualityOverflow (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to overflow.
 
void GCDatapointValue_setQualityOutOfRange (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to out of range.
 
void GCDatapointValue_setQualityBadReference (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to bad reference.
 
void GCDatapointValue_setQualityOscillatory (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to oscillatory.
 
void GCDatapointValue_setQualityFailure (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to failure.
 
void GCDatapointValue_setQualityOldData (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to old data.
 
void GCDatapointValue_setQualityInconsistent (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to inconsistent.
 
void GCDatapointValue_setQualityInaccurate (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to inaccurate.
 
void GCDatapointValue_setQualitySourceProcessing (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to source processing.
 
void GCDatapointValue_setQualityTest (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to test.
 
void GCDatapointValue_setQualityOperatorBlocked (GCDatapointValue value)
 Set the bit flag quality of a datapoint value to operator blocked.
 
bool GCDatapointValue_isQualityGood (GCDatapointValue value)
 Check if the quality of a datapoint value is good.
 
bool GCDatapointValue_isQualityInvalid (GCDatapointValue value)
 Check if the quality of a datapoint value is invalid.
 
bool GCDatapointValue_isQualityQuestionable (GCDatapointValue value)
 Check if the quality of a datapoint value is questionable.
 
bool GCDatapointValue_isQualityOverflow (GCDatapointValue value)
 Check if the quality of a datapoint value is overflow.
 
bool GCDatapointValue_isQualityOutOfRange (GCDatapointValue value)
 Check if the quality of a datapoint value is out of range.
 
bool GCDatapointValue_isQualityBadReference (GCDatapointValue value)
 Check if the quality of a datapoint value is bad reference.
 
bool GCDatapointValue_isQualityOscillatory (GCDatapointValue value)
 Check if the quality of a datapoint value is oscillatory.
 
bool GCDatapointValue_isQualityFailure (GCDatapointValue value)
 Check if the quality of a datapoint value is failure.
 
bool GCDatapointValue_isQualityOldData (GCDatapointValue value)
 Check if the quality of a datapoint value is old data.
 
bool GCDatapointValue_isQualityInconsistent (GCDatapointValue value)
 Check if the quality of a datapoint value is inconsistent.
 
bool GCDatapointValue_isQualityInaccurate (GCDatapointValue value)
 Check if the quality of a datapoint value is inaccurate.
 
bool GCDatapointValue_isQualitySourceProcessing (GCDatapointValue value)
 Check if the quality of a datapoint value is source processing.
 
bool GCDatapointValue_isQualityTest (GCDatapointValue value)
 Check if the quality of a datapoint value is test.
 
bool GCDatapointValue_isQualityOperatorBlocked (GCDatapointValue value)
 Check if the quality of a datapoint value is operator blocked.
 

Typedef Documentation

◆ GCDatapointIdentifier

typedef uint64_t GCDatapointIdentifier

◆ GCDatapointValue

typedef struct sGCDatapointValue* GCDatapointValue

◆ GCDatapointValueQuality

typedef uint16_t GCDatapointValueQuality

◆ GCDatapointValueType

typedef enum eGCDatapointValueType GCDatapointValueType

Enumeration Type Documentation

◆ eGCDatapointValueType

enum eGCDatapointValueType

The type of the datapoint value.

Enumerator
GCOS_DATAPOINT_TYPE_FLOAT32 
GCOS_DATAPOINT_TYPE_FLOAT64 
GCOS_DATAPOINT_TYPE_INT32 
GCOS_DATAPOINT_TYPE_INT64 
GCOS_DATAPOINT_TYPE_BOOLEAN 
GCOS_DATAPOINT_TYPE_UINT32 
GCOS_DATAPOINT_TYPE_UINT64 
GCOS_DATAPOINT_TYPE_DOUBLEPOINT 
GCOS_DATAPOINT_TYPE_TIMESTAMPNS 
GCOS_DATAPOINT_TYPE_BYTE_ARRAY 

Function Documentation

◆ GCDatapointValue_isQualityBadReference()

bool GCDatapointValue_isQualityBadReference ( GCDatapointValue value)

Check if the quality of a datapoint value is bad reference.

◆ GCDatapointValue_isQualityFailure()

bool GCDatapointValue_isQualityFailure ( GCDatapointValue value)

Check if the quality of a datapoint value is failure.

◆ GCDatapointValue_isQualityGood()

bool GCDatapointValue_isQualityGood ( GCDatapointValue value)

Check if the quality of a datapoint value is good.

◆ GCDatapointValue_isQualityInaccurate()

bool GCDatapointValue_isQualityInaccurate ( GCDatapointValue value)

Check if the quality of a datapoint value is inaccurate.

◆ GCDatapointValue_isQualityInconsistent()

bool GCDatapointValue_isQualityInconsistent ( GCDatapointValue value)

Check if the quality of a datapoint value is inconsistent.

◆ GCDatapointValue_isQualityInvalid()

bool GCDatapointValue_isQualityInvalid ( GCDatapointValue value)

Check if the quality of a datapoint value is invalid.

◆ GCDatapointValue_isQualityOldData()

bool GCDatapointValue_isQualityOldData ( GCDatapointValue value)

Check if the quality of a datapoint value is old data.

◆ GCDatapointValue_isQualityOperatorBlocked()

bool GCDatapointValue_isQualityOperatorBlocked ( GCDatapointValue value)

Check if the quality of a datapoint value is operator blocked.

◆ GCDatapointValue_isQualityOscillatory()

bool GCDatapointValue_isQualityOscillatory ( GCDatapointValue value)

Check if the quality of a datapoint value is oscillatory.

◆ GCDatapointValue_isQualityOutOfRange()

bool GCDatapointValue_isQualityOutOfRange ( GCDatapointValue value)

Check if the quality of a datapoint value is out of range.

◆ GCDatapointValue_isQualityOverflow()

bool GCDatapointValue_isQualityOverflow ( GCDatapointValue value)

Check if the quality of a datapoint value is overflow.

◆ GCDatapointValue_isQualityQuestionable()

bool GCDatapointValue_isQualityQuestionable ( GCDatapointValue value)

Check if the quality of a datapoint value is questionable.

◆ GCDatapointValue_isQualitySourceProcessing()

bool GCDatapointValue_isQualitySourceProcessing ( GCDatapointValue value)

Check if the quality of a datapoint value is source processing.

◆ GCDatapointValue_isQualityTest()

bool GCDatapointValue_isQualityTest ( GCDatapointValue value)

Check if the quality of a datapoint value is test.

◆ GCDatapointValue_setQualityBadReference()

void GCDatapointValue_setQualityBadReference ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to bad reference.

◆ GCDatapointValue_setQualityFailure()

void GCDatapointValue_setQualityFailure ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to failure.

◆ GCDatapointValue_setQualityGood()

void GCDatapointValue_setQualityGood ( GCDatapointValue value)

Set the quality of a datapoint value to good.

Setting the quality of a datapoint value to good means will override the following flags:

  • Invalid
  • Questionable

◆ GCDatapointValue_setQualityInaccurate()

void GCDatapointValue_setQualityInaccurate ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to inaccurate.

◆ GCDatapointValue_setQualityInconsistent()

void GCDatapointValue_setQualityInconsistent ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to inconsistent.

◆ GCDatapointValue_setQualityInvalid()

void GCDatapointValue_setQualityInvalid ( GCDatapointValue value)

Set the quality of a datapoint value to invalid.

Setting the quality of a datapoint value to invalid will override the following flags:

  • Good
  • Questionable

◆ GCDatapointValue_setQualityOldData()

void GCDatapointValue_setQualityOldData ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to old data.

◆ GCDatapointValue_setQualityOperatorBlocked()

void GCDatapointValue_setQualityOperatorBlocked ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to operator blocked.

◆ GCDatapointValue_setQualityOscillatory()

void GCDatapointValue_setQualityOscillatory ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to oscillatory.

◆ GCDatapointValue_setQualityOutOfRange()

void GCDatapointValue_setQualityOutOfRange ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to out of range.

◆ GCDatapointValue_setQualityOverflow()

void GCDatapointValue_setQualityOverflow ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to overflow.

◆ GCDatapointValue_setQualityQuestionable()

void GCDatapointValue_setQualityQuestionable ( GCDatapointValue value)

Set the quality of a datapoint value to questionable.

Setting the quality of a datapoint value to questionable will override the following flags:

  • Good
  • Invalid

◆ GCDatapointValue_setQualitySourceProcessing()

void GCDatapointValue_setQualitySourceProcessing ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to source processing.

◆ GCDatapointValue_setQualityTest()

void GCDatapointValue_setQualityTest ( GCDatapointValue value)

Set the bit flag quality of a datapoint value to test.

Generated by doxygen 1.12.0