Point value type

Macros
#define	TASE2_DATA_FLAGS_UNUSED_0   1
#define	TASE2_DATA_FLAGS_UNUSED_1   2
#define	TASE2_DATA_FLAGS_VALIDITY_HI   4
#define	TASE2_DATA_FLAGS_VALIDITY_LO   8
#define	TASE2_DATA_FLAGS_CURRENT_SOURCE_HI   16
#define	TASE2_DATA_FLAGS_CURRENT_SOURCE_LO   32
#define	TASE2_DATA_FLAGS_NORMAL_VALUE   64
#define	TASE2_DATA_FLAGS_TIME_STAMP_QUALITY   128
#define	TASE2_DATA_STATE_HI   1
#define	TASE2_DATA_STATE_LO   2
#define	TASE2_DATA_STATE_VALIDITY_HI   4
#define	TASE2_DATA_STATE_VALIDITY_LO   8
#define	TASE2_DATA_STATE_CURRENT_SOURCE_HI   16
#define	TASE2_DATA_STATE_CURRENT_SOURCE_LO   32
#define	TASE2_DATA_STATE_NORMAL_VALUE   64
#define	TASE2_DATA_STATE_TIME_STAMP_QUALITY   128
#define	TASE2_DATA_STATE_BETWEEN   0
#define	TASE2_DATA_STATE_TRIPPED   2
#define	TASE2_DATA_STATE_OFF   2
#define	TASE2_DATA_STATE_CLOSED   1
#define	TASE2_DATA_STATE_ON   1
#define	TASE2_DATA_STATE_INVALID   3
#define	TASE2_DATA_FLAGS_VALIDITY_VALID   0
#define	TASE2_DATA_FLAGS_VALIDITY_HELD   8
#define	TASE2_DATA_FLAGS_VALIDITY_SUSPECT   4
#define	TASE2_DATA_FLAGS_VALIDITY_NOTVALID   12
#define	TASE2_DATA_FLAGS_CURRENT_SOURCE_TELEMETERED   0
#define	TASE2_DATA_FLAGS_CURRENT_SOURCE_CALCULATED   32
#define	TASE2_DATA_FLAGS_CURRENT_SOURCE_ENTERED   16
#define	TASE2_DATA_FLAGS_CURRENT_SOURCE_ESTIMATED   48
#define	TASE2_DATA_SUPPL_STATE_HI   1
#define	TASE2_DATA_SUPPL_STATE_LO   2
#define	TASE2_DATA_SUPPL_STATE_TAG_HI   4
#define	TASE2_DATA_SUPPL_STATE_TAG_LO   8
#define	TASE2_DATA_SUPPL_STATE_EXPECTED_HI   16
#define	TASE2_DATA_SUPPL_STATE_EXPECTED_LO   32
#define	TASE2_SINGLE_FLAGS_ELAPSED_TIME_VALIDITY   1
#define	TASE2_SINGLE_FLAGS_BLOCKED   2
#define	TASE2_SINGLE_FLAGS_SUBSTITUTED   4
#define	TASE2_SINGLE_FLAGS_TOPICAL   8
#define	TASE2_SINGLE_FLAGS_EVENT_VALIDITY   16
#define	TASE2_SINGLE_FLAGS_UNUSED   32
#define	TASE2_SINGLE_FLAGS_EVENT_STATE_HI   64
#define	TASE2_SINGLE_FLAGS_EVENT_STATE_LO   128
#define	TASE2_EVENT_FLAGS_GENERAL   1
#define	TASE2_EVENT_FLAGS_PHASE_1   2
#define	TASE2_EVENT_FLAGS_PHASE_2   4
#define	TASE2_EVENT_FLAGS_PHASE_3   8
#define	TASE2_EVENT_FLAGS_EARTH   16
#define	TASE2_EVENT_FLAGS_REVERSE   32
#define	TASE2_PACKED_FLAGS_ELAPSED_TIME_VALIDITY   1
#define	TASE2_PACKED_FLAGS_BLOCKED   2
#define	TASE2_PACKED_FLAGS_SUBSTITUTED   4
#define	TASE2_PACKED_FLAGS_TOPICAL   8
#define	TASE2_PACKED_FLAGS_EVENT_VALIDITY   16

Typedefs
typedef struct sTase2_PointValue *	Tase2_PointValue
	A TASE.2 point value with type information.
typedef uint8_t	Tase2_DataFlags
typedef uint8_t	Tase2_DataState
typedef uint8_t	Tase2_DataStateSupplemental
typedef uint8_t	Tase2_SingleEventFlags
typedef uint8_t	Tase2_EventFlags
typedef uint8_t	Tase2_PackedEventFlags

Enumerations
enum	Tase2_PointValueError { TASE2_POINT_VALUE_ERROR_OK = 0 , TASE2_POINT_VALUE_ERROR_WRONG_TYPE = 1 }

Functions
TASE2_API Tase2_PointValueType	Tase2_PointValue_getType (Tase2_PointValue self)
	Get the (estimated) type of the point value.
TASE2_API Tase2_ClientError	Tase2_PointValue_getError (Tase2_PointValue self)
	Get the error code (when point value type is TASE2_VALUE_TYPE_ERROR)
TASE2_API void	Tase2_PointValue_setType (Tase2_PointValue self, Tase2_PointValueType type)
	Set the type of a point value.
TASE2_API void	Tase2_PointValue_destroy (Tase2_PointValue self)
	Release all resource related to the point value instance.
TASE2_API Tase2_PointValue	Tase2_PointValue_getCopy (Tase2_PointValue self)
	Create a copy (clone) of the PointValue instances.
TASE2_API Tase2_PointValue	Tase2_PointValue_createReal (float value)
	Create a new PointValue instance of type "real".
TASE2_API Tase2_PointValue	Tase2_PointValue_createDiscrete (int32_t value)
	Create a new PointValue instance of type "discrete".
TASE2_API Tase2_PointValue	Tase2_PointValue_createState (Tase2_DataState value)
	Create a new PointValue instance of type "state".
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateSupplemental (Tase2_DataStateSupplemental value)
	Create a new PointValue instance of type "state-supplemental".
TASE2_API Tase2_PointValue	Tase2_PointValue_createRealQ (float value, Tase2_DataFlags flags)
	Create a new point value instance of Type RealQ.
TASE2_API Tase2_PointValue	Tase2_PointValue_createDiscreteQ (int32_t value, Tase2_DataFlags flags)
	Create a new point value instance of Type DiscreteQ.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateQ (Tase2_DataState value, Tase2_DataFlags flags)
	Create a new PointValue instance of type StateQ.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateSupplementalQ (Tase2_DataStateSupplemental value, Tase2_DataFlags flags)
	Create a new PointValue instance of type StateSupplementalQ.
TASE2_API Tase2_PointValue	Tase2_PointValue_createRealQTimeTag (float value, Tase2_DataFlags flags, int32_t timeTag)
	Create a new point value instance of Type RealQTimeTag.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateQTimeTag (Tase2_DataFlags valueAndFlags, int32_t timeTag)
	Create a new point value instance of Type StateQTimeTag.
TASE2_API Tase2_PointValue	Tase2_PointValue_createDiscreteQTimeTag (int32_t value, Tase2_DataFlags flags, int32_t timeTag)
	Create a new point value instance of Type DiscreteQTimeTag.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateSupplementalQTimeTag (Tase2_DataStateSupplemental value, Tase2_DataFlags flags, int32_t timeTag)
	Create a new PointValue instance of type StateSupplementalQTimeTag.
TASE2_API Tase2_PointValue	Tase2_PointValue_createRealExtended (float value, Tase2_DataFlags flags, int32_t timeTag, uint16_t cov)
	Create a new point value instance of Type RealExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateExtended (Tase2_DataFlags valueAndFlags, int32_t timeTag, uint16_t cov)
	Create a new point value instance of Type StateExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createDiscreteExtended (int32_t value, Tase2_DataFlags flags, int32_t timeTag, uint16_t cov)
	Create a new point value instance of Type DiscreteExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateSupplementalExtended (Tase2_DataStateSupplemental value, Tase2_DataFlags flags, int32_t timeTag, uint16_t cov)
	Create a new PointValue instance of type StateSupplementalExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createRealQTimeTagExtended (float value, Tase2_DataFlags flags, uint64_t timeTagExtended)
	Create a new point value instance of Type RealQTimeTagExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateQTimeTagExtended (Tase2_DataFlags valueAndFlags, uint64_t timeTagExtended)
	Create a new point value instance of Type StateQTimeTagExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createDiscreteQTimeTagExtended (int32_t value, Tase2_DataFlags flags, uint64_t timeTagExtended)
	Create a new point value instance of Type DiscreteQTimeTagExtended.
TASE2_API Tase2_PointValue	Tase2_PointValue_createStateSupplementalQTimeTagExtended (Tase2_DataStateSupplemental value, Tase2_DataFlags flags, uint64_t timeTagExtended)
	Create a new PointValue instance of type StateSupplementalQTimeTagExtended.
TASE2_API float	Tase2_PointValue_getValueReal (Tase2_PointValue self)
	Get the real value.
TASE2_API float	Tase2_PointValue_getValueRealEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the real value.
TASE2_API void	Tase2_PointValue_setValueReal (Tase2_PointValue self, float value)
	Set the real value.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setValueRealEx (Tase2_PointValue self, float value)
	Set the real value.
TASE2_API int32_t	Tase2_PointValue_getValueDiscrete (Tase2_PointValue self)
	Get the value of an indication point of type DISCRETE.
TASE2_API int32_t	Tase2_PointValue_getValueDiscreteEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the value of an indication point of type DISCRETE.
TASE2_API void	Tase2_PointValue_setValueDiscrete (Tase2_PointValue self, int32_t value)
	Set the value of an indication point of type DISCRETE.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setValueDiscreteEx (Tase2_PointValue self, int32_t value)
	Set the value of an indication point of type DISCRETE.
TASE2_API Tase2_DataState	Tase2_PointValue_getValueState (Tase2_PointValue self)
	Get the value of an indication point of type STATE.
TASE2_API Tase2_DataState	Tase2_PointValue_getValueStateEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the value of an indication point of type STATE.
TASE2_API void	Tase2_PointValue_setValueState (Tase2_PointValue self, Tase2_DataState value)
	Set the value of an indication point of type STATE.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setValueStateEx (Tase2_PointValue self, Tase2_DataState value)
	Set the value of an indication point of type STATE.
TASE2_API Tase2_DataStateSupplemental	Tase2_PointValue_getValueStateSupplemental (Tase2_PointValue self)
	Get the value of an indication point of type STATE_SUPPLEMENTAL.
TASE2_API Tase2_DataStateSupplemental	Tase2_PointValue_getValueStateSupplementalEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the value of an indication point of type STATE_SUPPLEMENTAL.
TASE2_API void	Tase2_PointValue_setValueStateSupplemental (Tase2_PointValue self, Tase2_DataStateSupplemental value)
	Set the value of an indication point of type STATE_SUPPLEMENTAL.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setValueStateSupplementalEx (Tase2_PointValue self, Tase2_DataStateSupplemental value)
	Set the value of an indication point of type STATE_SUPPLEMENTAL.
TASE2_API bool	Tase2_PointValue_hasTimeStamp (Tase2_PointValue self)
	Try to determine if the value has a timestamp.
TASE2_API Tase2_TimeStampClass	Tase2_PointValue_getTimeStampClass (Tase2_PointValue self)
	Get the timestamp class of the value.
TASE2_API uint64_t	Tase2_PointValue_getTimeStamp (Tase2_PointValue self)
	Get the time stamp of the last data point change or update.
TASE2_API uint64_t	Tase2_PointValue_getTimeStampEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the time stamp of the last data point change or update.
TASE2_API void	Tase2_PointValue_setTimeStamp (Tase2_PointValue self, uint64_t timestamp)
	Set the time stamp of the last data point change or update.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setTimeStampEx (Tase2_PointValue self, uint64_t timestamp)
	Set the time stamp of the last data point change or update.
TASE2_API Tase2_DataFlags	Tase2_PointValue_getFlags (Tase2_PointValue self)
	Get the quality flags of a data point.
TASE2_API Tase2_DataFlags	Tase2_PointValue_getFlagsEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the quality flags of a data point.
TASE2_API void	Tase2_PointValue_setFlags (Tase2_PointValue self, Tase2_DataFlags flags)
	Set the quality flags of a data point.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setFlagsEx (Tase2_PointValue self, Tase2_DataFlags flags)
	Set the quality flags of a data point.
TASE2_API uint16_t	Tase2_PointValue_getCOV (Tase2_PointValue self)
	Get the COV (counter of value changes) of a data point.
TASE2_API uint16_t	Tase2_PointValue_getCOVEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the COV (counter of value changes) of a data point.
TASE2_API void	Tase2_PointValue_setCOV (Tase2_PointValue self, uint16_t cov)
	Set the COV (counter of value changes) of a data point.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setCOVEx (Tase2_PointValue self, uint16_t cov)
	Set the COV (counter of value changes) of a data point.
TASE2_API Tase2_PointValue	Tase2_PointValue_createSingleProtectionEvent (Tase2_SingleEventFlags eventFlags, int32_t operatingTime, uint64_t eventTime)
	Create a new point value instance of type single event (TASE2_VALUE_TYPE_SINGLE_EVENT)
TASE2_API Tase2_PointValue	Tase2_PointValue_createPackedProtectionEvent (Tase2_EventFlags packedEvent, Tase2_PackedEventFlags packedEventFlags, int32_t operatingTime, uint64_t eventTime)
	Create a new point value instance of type packed event (TASE2_VALUE_TYPE_PACKED_EVENT)
TASE2_API Tase2_SingleEventFlags	Tase2_PointValue_getSingleEventFlags (Tase2_PointValue self)
	Get the single event flags value.
TASE2_API Tase2_SingleEventFlags	Tase2_PointValue_getSingleEventFlagsEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the single event flags value.
TASE2_API void	Tase2_PointValue_setSingleEventFlags (Tase2_PointValue self, Tase2_SingleEventFlags eventFlags)
	Set the single event flags value.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setSingleEventFlagsEx (Tase2_PointValue self, Tase2_SingleEventFlags eventFlags)
	Set the single event flags value.
TASE2_API Tase2_EventFlags	Tase2_PointValue_getPackedEvent (Tase2_PointValue self)
	Get the packed event flags values.
TASE2_API Tase2_EventFlags	Tase2_PointValue_getPackedEventEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the packed event values.
TASE2_API void	Tase2_PointValue_setPackedEvent (Tase2_PointValue self, Tase2_EventFlags packedEvent)
	Set the packed event values.
Tase2_PointValueError	Tase2_PointValue_setPackedEventEx (Tase2_PointValue self, Tase2_EventFlags packedEvent)
	Set the packed event values.
TASE2_API Tase2_PackedEventFlags	Tase2_PointValue_getPackedEventFlags (Tase2_PointValue self)
	Get the packed event flags value.
TASE2_API Tase2_PackedEventFlags	Tase2_PointValue_getPackedEventFlagsEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the packed event flags value.
TASE2_API void	Tase2_PointValue_setPackedEventFlags (Tase2_PointValue self, Tase2_PackedEventFlags flags)
	Set the packed event flags.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setPackedEventFlagsEx (Tase2_PointValue self, Tase2_PackedEventFlags flags)
	Set the packed event flags.
TASE2_API int32_t	Tase2_PointValue_getOperatingTime (Tase2_PointValue self)
	Get the operation or event duration.
TASE2_API int32_t	Tase2_PointValue_getOperatingTimeEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the operation or event duration.
TASE2_API void	Tase2_PointValue_setOperatingTime (Tase2_PointValue self, int32_t operatingTime)
	Set the operation or event duration.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setOperatingTimeEx (Tase2_PointValue self, int32_t operatingTime)
	Set the operation or event duration.
TASE2_API uint64_t	Tase2_PointValue_getEventTime (Tase2_PointValue self)
	Get the event/operation start time.
TASE2_API uint64_t	Tase2_PointValue_getEventTimeEx (Tase2_PointValue self, Tase2_PointValueError *err)
	Get the event/operation start time.
TASE2_API void	Tase2_PointValue_setEventTime (Tase2_PointValue self, uint64_t eventTime)
	Set the event/operation start time.
TASE2_API Tase2_PointValueError	Tase2_PointValue_setEventTimeEx (Tase2_PointValue self, uint64_t eventTime)
	Set the event/operation start time.

Detailed Description

Macro Definition Documentation

TASE2_DATA_FLAGS_CURRENT_SOURCE_CALCULATED

#define TASE2_DATA_FLAGS_CURRENT_SOURCE_CALCULATED   32

TASE2_DATA_FLAGS_CURRENT_SOURCE_ENTERED

#define TASE2_DATA_FLAGS_CURRENT_SOURCE_ENTERED   16

TASE2_DATA_FLAGS_CURRENT_SOURCE_ESTIMATED

#define TASE2_DATA_FLAGS_CURRENT_SOURCE_ESTIMATED   48

TASE2_DATA_FLAGS_CURRENT_SOURCE_HI

#define TASE2_DATA_FLAGS_CURRENT_SOURCE_HI   16

TASE2_DATA_FLAGS_CURRENT_SOURCE_LO

#define TASE2_DATA_FLAGS_CURRENT_SOURCE_LO   32

TASE2_DATA_FLAGS_CURRENT_SOURCE_TELEMETERED

#define TASE2_DATA_FLAGS_CURRENT_SOURCE_TELEMETERED   0

TASE2_DATA_FLAGS_NORMAL_VALUE

#define TASE2_DATA_FLAGS_NORMAL_VALUE   64

TASE2_DATA_FLAGS_TIME_STAMP_QUALITY

#define TASE2_DATA_FLAGS_TIME_STAMP_QUALITY   128

TASE2_DATA_FLAGS_UNUSED_0

#define TASE2_DATA_FLAGS_UNUSED_0   1

TASE2_DATA_FLAGS_UNUSED_1

#define TASE2_DATA_FLAGS_UNUSED_1   2

TASE2_DATA_FLAGS_VALIDITY_HELD

#define TASE2_DATA_FLAGS_VALIDITY_HELD   8

TASE2_DATA_FLAGS_VALIDITY_HI

#define TASE2_DATA_FLAGS_VALIDITY_HI   4

TASE2_DATA_FLAGS_VALIDITY_LO

#define TASE2_DATA_FLAGS_VALIDITY_LO   8

TASE2_DATA_FLAGS_VALIDITY_NOTVALID

#define TASE2_DATA_FLAGS_VALIDITY_NOTVALID   12

TASE2_DATA_FLAGS_VALIDITY_SUSPECT

#define TASE2_DATA_FLAGS_VALIDITY_SUSPECT   4

TASE2_DATA_FLAGS_VALIDITY_VALID

#define TASE2_DATA_FLAGS_VALIDITY_VALID   0

TASE2_DATA_STATE_BETWEEN

#define TASE2_DATA_STATE_BETWEEN   0

TASE2_DATA_STATE_CLOSED

#define TASE2_DATA_STATE_CLOSED   1

TASE2_DATA_STATE_CURRENT_SOURCE_HI

#define TASE2_DATA_STATE_CURRENT_SOURCE_HI   16

TASE2_DATA_STATE_CURRENT_SOURCE_LO

#define TASE2_DATA_STATE_CURRENT_SOURCE_LO   32

TASE2_DATA_STATE_HI

#define TASE2_DATA_STATE_HI   1

TASE2_DATA_STATE_INVALID

#define TASE2_DATA_STATE_INVALID   3

TASE2_DATA_STATE_LO

#define TASE2_DATA_STATE_LO   2

TASE2_DATA_STATE_NORMAL_VALUE

#define TASE2_DATA_STATE_NORMAL_VALUE   64

TASE2_DATA_STATE_OFF

#define TASE2_DATA_STATE_OFF   2

TASE2_DATA_STATE_ON

#define TASE2_DATA_STATE_ON   1

TASE2_DATA_STATE_TIME_STAMP_QUALITY

#define TASE2_DATA_STATE_TIME_STAMP_QUALITY   128

TASE2_DATA_STATE_TRIPPED

#define TASE2_DATA_STATE_TRIPPED   2

TASE2_DATA_STATE_VALIDITY_HI

#define TASE2_DATA_STATE_VALIDITY_HI   4

TASE2_DATA_STATE_VALIDITY_LO

#define TASE2_DATA_STATE_VALIDITY_LO   8

TASE2_DATA_SUPPL_STATE_EXPECTED_HI

#define TASE2_DATA_SUPPL_STATE_EXPECTED_HI   16

TASE2_DATA_SUPPL_STATE_EXPECTED_LO

#define TASE2_DATA_SUPPL_STATE_EXPECTED_LO   32

TASE2_DATA_SUPPL_STATE_HI

#define TASE2_DATA_SUPPL_STATE_HI   1

TASE2_DATA_SUPPL_STATE_LO

#define TASE2_DATA_SUPPL_STATE_LO   2

TASE2_DATA_SUPPL_STATE_TAG_HI

#define TASE2_DATA_SUPPL_STATE_TAG_HI   4

TASE2_DATA_SUPPL_STATE_TAG_LO

#define TASE2_DATA_SUPPL_STATE_TAG_LO   8

TASE2_EVENT_FLAGS_EARTH

#define TASE2_EVENT_FLAGS_EARTH   16

TASE2_EVENT_FLAGS_GENERAL

#define TASE2_EVENT_FLAGS_GENERAL   1

TASE2_EVENT_FLAGS_PHASE_1

#define TASE2_EVENT_FLAGS_PHASE_1   2

TASE2_EVENT_FLAGS_PHASE_2

#define TASE2_EVENT_FLAGS_PHASE_2   4

TASE2_EVENT_FLAGS_PHASE_3

#define TASE2_EVENT_FLAGS_PHASE_3   8

TASE2_EVENT_FLAGS_REVERSE

#define TASE2_EVENT_FLAGS_REVERSE   32

TASE2_PACKED_FLAGS_BLOCKED

#define TASE2_PACKED_FLAGS_BLOCKED   2

TASE2_PACKED_FLAGS_ELAPSED_TIME_VALIDITY

#define TASE2_PACKED_FLAGS_ELAPSED_TIME_VALIDITY   1

TASE2_PACKED_FLAGS_EVENT_VALIDITY

#define TASE2_PACKED_FLAGS_EVENT_VALIDITY   16

TASE2_PACKED_FLAGS_SUBSTITUTED

#define TASE2_PACKED_FLAGS_SUBSTITUTED   4

TASE2_PACKED_FLAGS_TOPICAL

#define TASE2_PACKED_FLAGS_TOPICAL   8

TASE2_SINGLE_FLAGS_BLOCKED

#define TASE2_SINGLE_FLAGS_BLOCKED   2

TASE2_SINGLE_FLAGS_ELAPSED_TIME_VALIDITY

#define TASE2_SINGLE_FLAGS_ELAPSED_TIME_VALIDITY   1

TASE2_SINGLE_FLAGS_EVENT_STATE_HI

#define TASE2_SINGLE_FLAGS_EVENT_STATE_HI   64

TASE2_SINGLE_FLAGS_EVENT_STATE_LO

#define TASE2_SINGLE_FLAGS_EVENT_STATE_LO   128

TASE2_SINGLE_FLAGS_EVENT_VALIDITY

#define TASE2_SINGLE_FLAGS_EVENT_VALIDITY   16

TASE2_SINGLE_FLAGS_SUBSTITUTED

#define TASE2_SINGLE_FLAGS_SUBSTITUTED   4

TASE2_SINGLE_FLAGS_TOPICAL

#define TASE2_SINGLE_FLAGS_TOPICAL   8

TASE2_SINGLE_FLAGS_UNUSED

#define TASE2_SINGLE_FLAGS_UNUSED   32

Typedef Documentation

Tase2_DataFlags

typedef uint8_t Tase2_DataFlags

Tase2_DataState

typedef uint8_t Tase2_DataState

Tase2_DataStateSupplemental

typedef uint8_t Tase2_DataStateSupplemental

Tase2_EventFlags

typedef uint8_t Tase2_EventFlags

Tase2_PackedEventFlags

typedef uint8_t Tase2_PackedEventFlags

Tase2_PointValue

typedef struct sTase2_PointValue* Tase2_PointValue

A TASE.2 point value with type information.

A point value can have the following types defined here: Tase2_PointValueType

NOTE: type information may be inaccurate depending on context

Tase2_SingleEventFlags

typedef uint8_t Tase2_SingleEventFlags

Enumeration Type Documentation

Tase2_PointValueError

enum Tase2_PointValueError

Enumerator
TASE2_POINT_VALUE_ERROR_OK
TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Function Documentation

Tase2_PointValue_createDiscrete()

TASE2_API Tase2_PointValue Tase2_PointValue_createDiscrete

(

int32_t

value

)

Create a new PointValue instance of type "discrete".

Parameters

value

the value of the new instance

Returns

the new PointValue instance

Tase2_PointValue_createDiscreteExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createDiscreteExtended	(	int32_t	value,
		Tase2_DataFlags	flags,
		int32_t	timeTag,
		uint16_t	cov )

Create a new point value instance of Type DiscreteExtended.

Parameters

value	the discrete value
flags	the quality flags of the value
timeTag	the time tag in seconds since Epoch (Unix time)
cov	the counter of events of the value

Returns

the new point value instance

Tase2_PointValue_createDiscreteQ()

TASE2_API Tase2_PointValue Tase2_PointValue_createDiscreteQ	(	int32_t	value,
		Tase2_DataFlags	flags )

Create a new point value instance of Type DiscreteQ.

Parameters

value	the discrete value
flags	the quality flags of the value

Returns

the new point value instance

Tase2_PointValue_createDiscreteQTimeTag()

TASE2_API Tase2_PointValue Tase2_PointValue_createDiscreteQTimeTag	(	int32_t	value,
		Tase2_DataFlags	flags,
		int32_t	timeTag )

Create a new point value instance of Type DiscreteQTimeTag.

Parameters

value	the discrete value
flags	the quality flags of the value
timeTag	the time tag in seconds since Epoch (Unix time)

Returns

the new point value instance

Tase2_PointValue_createDiscreteQTimeTagExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createDiscreteQTimeTagExtended	(	int32_t	value,
		Tase2_DataFlags	flags,
		uint64_t	timeTagExtended )

Create a new point value instance of Type DiscreteQTimeTagExtended.

Parameters

value	the discrete value
flags	the quality flags of the value
timeTag	the extended time tag in milliseconds since Epoch

Returns

the new point value instance

Tase2_PointValue_createPackedProtectionEvent()

TASE2_API Tase2_PointValue Tase2_PointValue_createPackedProtectionEvent	(	Tase2_EventFlags	packedEvent,
		Tase2_PackedEventFlags	packedEventFlags,
		int32_t	operatingTime,
		uint64_t	eventTime )

Create a new point value instance of type packed event (TASE2_VALUE_TYPE_PACKED_EVENT)

Parameters

packedEvend	the packed event values
packedEventFlags	the packed event flags
operatingTime	duration of the event in milliseconds
eventTime	the event time in milliseconds since epoch

Returns

the new point value instance

Tase2_PointValue_createReal()

TASE2_API Tase2_PointValue Tase2_PointValue_createReal

(

float

value

)

Create a new PointValue instance of type "real".

Parameters

value

the value of the new instance

Returns

the new PointValue instance

Tase2_PointValue_createRealExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createRealExtended	(	float	value,
		Tase2_DataFlags	flags,
		int32_t	timeTag,
		uint16_t	cov )

Create a new point value instance of Type RealExtended.

Parameters

value	the real (floating point) value
flags	the quality flags of the value
timeTag	the time tag in seconds since Epoch (Unix time)
cov	the counter of events of the value

Returns

the new point value instance

Tase2_PointValue_createRealQ()

TASE2_API Tase2_PointValue Tase2_PointValue_createRealQ	(	float	value,
		Tase2_DataFlags	flags )

Create a new point value instance of Type RealQ.

Parameters

value	the real (floating point) value
flags	the quality flags of the value

Returns

the new point value instance

Tase2_PointValue_createRealQTimeTag()

TASE2_API Tase2_PointValue Tase2_PointValue_createRealQTimeTag	(	float	value,
		Tase2_DataFlags	flags,
		int32_t	timeTag )

Create a new point value instance of Type RealQTimeTag.

Parameters

value	the real (floating point) value
flags	the quality flags of the value
timeTag	the time tag in seconds since Epoch (Unix time)

Returns

the new point value instance

Tase2_PointValue_createRealQTimeTagExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createRealQTimeTagExtended	(	float	value,
		Tase2_DataFlags	flags,
		uint64_t	timeTagExtended )

Create a new point value instance of Type RealQTimeTagExtended.

Parameters

value	the real (floating point) value
flags	the quality flags of the value
timeTag	the extended time tag in milliseconds since Epoch

Returns

the new point value instance

Tase2_PointValue_createSingleProtectionEvent()

TASE2_API Tase2_PointValue Tase2_PointValue_createSingleProtectionEvent	(	Tase2_SingleEventFlags	eventFlags,
		int32_t	operatingTime,
		uint64_t	eventTime )

Create a new point value instance of type single event (TASE2_VALUE_TYPE_SINGLE_EVENT)

Parameters

eventFlags	the single event flags
operatingTime	duration of the event in milliseconds
eventTime	the event time in milliseconds since epoch

Returns

the new point value instance

Tase2_PointValue_createState()

TASE2_API Tase2_PointValue Tase2_PointValue_createState

(

Tase2_DataState

value

)

Create a new PointValue instance of type "state".

Parameters

value

the value of the new instance

Returns

the new PointValue instance

Tase2_PointValue_createStateExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateExtended	(	Tase2_DataFlags	valueAndFlags,
		int32_t	timeTag,
		uint16_t	cov )

Create a new point value instance of Type StateExtended.

Parameters

valueAndFlags	the combined value and flags value
timeTag	the time tag in seconds since Epoch (Unix time)
cov	the counter of events of the value

Returns

the new point value instance

Tase2_PointValue_createStateQ()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateQ	(	Tase2_DataState	value,
		Tase2_DataFlags	flags )

Create a new PointValue instance of type StateQ.

Parameters

value	the state value
flags	the quality flags of the value

Returns

the new PointValue instance

Tase2_PointValue_createStateQTimeTag()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateQTimeTag	(	Tase2_DataFlags	valueAndFlags,
		int32_t	timeTag )

Create a new point value instance of Type StateQTimeTag.

Parameters

valueAndFlags	the combined value and flags value
timeTag	the time tag in seconds since Epoch (Unix time)

Returns

the new point value instance

Tase2_PointValue_createStateQTimeTagExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateQTimeTagExtended	(	Tase2_DataFlags	valueAndFlags,
		uint64_t	timeTagExtended )

Create a new point value instance of Type StateQTimeTagExtended.

Parameters

value	the discrete value
flags	the quality flags of the value
timeTag	the extended time tag in milliseconds since Epoch

Returns

the new point value instance

Tase2_PointValue_createStateSupplemental()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateSupplemental

(

Tase2_DataStateSupplemental

value

)

Create a new PointValue instance of type "state-supplemental".

Parameters

value

the value of the new instance

Returns

the new PointValue instance

Tase2_PointValue_createStateSupplementalExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateSupplementalExtended	(	Tase2_DataStateSupplemental	value,
		Tase2_DataFlags	flags,
		int32_t	timeTag,
		uint16_t	cov )

Create a new PointValue instance of type StateSupplementalExtended.

Parameters

value	the state supplemental value
flags	the quality flags of the value
timeTag	the time tag in seconds since Epoch (Unix time)
cov	the counter of events of the value

Returns

the new PointValue instance

Tase2_PointValue_createStateSupplementalQ()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateSupplementalQ	(	Tase2_DataStateSupplemental	value,
		Tase2_DataFlags	flags )

Create a new PointValue instance of type StateSupplementalQ.

Parameters

value	the state supplemental value
flags	the quality flags of the value

Returns

the new PointValue instance

Tase2_PointValue_createStateSupplementalQTimeTag()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateSupplementalQTimeTag	(	Tase2_DataStateSupplemental	value,
		Tase2_DataFlags	flags,
		int32_t	timeTag )

Create a new PointValue instance of type StateSupplementalQTimeTag.

Parameters

value	the state supplemental value
flags	the quality flags of the value
timeTag	the time tag in seconds since Epoch (Unix time)

Returns

the new PointValue instance

Tase2_PointValue_createStateSupplementalQTimeTagExtended()

TASE2_API Tase2_PointValue Tase2_PointValue_createStateSupplementalQTimeTagExtended	(	Tase2_DataStateSupplemental	value,
		Tase2_DataFlags	flags,
		uint64_t	timeTagExtended )

Create a new PointValue instance of type StateSupplementalQTimeTagExtended.

Parameters

value	the state supplemental value
flags	the quality flags of the value
timeTag	the extended time tag in milliseconds since Epoch

Returns

the new PointValue instance

Tase2_PointValue_destroy()

TASE2_API void Tase2_PointValue_destroy

(

Tase2_PointValue

self

)

Release all resource related to the point value instance.

NOTE: Do not use the instance after this call!

Parameters

self	the PointValue instance

Tase2_PointValue_getCopy()

TASE2_API Tase2_PointValue Tase2_PointValue_getCopy

(

Tase2_PointValue

self

)

Create a copy (clone) of the PointValue instances.

Parameters

self	the PointValue instance to clone

Tase2_PointValue_getCOV()

TASE2_API uint16_t Tase2_PointValue_getCOV

(

Tase2_PointValue

self

)

Get the COV (counter of value changes) of a data point.

NOTE: the result is only valid when the data point type includes COV

Parameters

the	point value instance

Returns

the COV value

Tase2_PointValue_getCOVEx()

TASE2_API uint16_t Tase2_PointValue_getCOVEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the COV (counter of value changes) of a data point.

New in version 2.1.0

NOTE: the result is only valid when the data point type includes COV

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the COV value

Tase2_PointValue_getError()

TASE2_API Tase2_ClientError Tase2_PointValue_getError

(

Tase2_PointValue

self

)

Get the error code (when point value type is TASE2_VALUE_TYPE_ERROR)

Parameters

self	the PointValue instance

Returns

the error code

Tase2_PointValue_getEventTime()

TASE2_API uint64_t Tase2_PointValue_getEventTime

(

Tase2_PointValue

self

)

Get the event/operation start time.

Parameters

the	point value instance

Returns

the operation or event start time in milliseconds since epoch

Tase2_PointValue_getEventTimeEx()

TASE2_API uint64_t Tase2_PointValue_getEventTimeEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the event/operation start time.

New in version 2.1.0

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the operation or event start time in milliseconds since epoch

Tase2_PointValue_getFlags()

TASE2_API Tase2_DataFlags Tase2_PointValue_getFlags

(

Tase2_PointValue

self

)

Get the quality flags of a data point.

NOTE: the result is only valid when the data point type includes quality

Parameters

the	point value instance

Returns

the quality flags of a data point (or 0xff when the point value type has no flags)

Tase2_PointValue_getFlagsEx()

TASE2_API Tase2_DataFlags Tase2_PointValue_getFlagsEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the quality flags of a data point.

New in version 2.1.0

NOTE: the result is only valid when the data point type includes quality

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the quality flags of a data point (or 0xff when the point value type has no flags)

Tase2_PointValue_getOperatingTime()

TASE2_API int32_t Tase2_PointValue_getOperatingTime

(

Tase2_PointValue

self

)

Get the operation or event duration.

Parameters

the	point value instance

Returns

the operation or event duration in milliseconds.

Tase2_PointValue_getOperatingTimeEx()

TASE2_API int32_t Tase2_PointValue_getOperatingTimeEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the operation or event duration.

New in version 2.1.0

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the operation or event duration in milliseconds.

Tase2_PointValue_getPackedEvent()

TASE2_API Tase2_EventFlags Tase2_PointValue_getPackedEvent

(

Tase2_PointValue

self

)

Get the packed event flags values.

NOTE: the result is only valid when data point is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

the	point value instance

Returns

the packed event flags value

Tase2_PointValue_getPackedEventEx()

TASE2_API Tase2_EventFlags Tase2_PointValue_getPackedEventEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the packed event values.

New in version 2.1.0

NOTE: the result is only valid when data point is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the packed event value

Tase2_PointValue_getPackedEventFlags()

TASE2_API Tase2_PackedEventFlags Tase2_PointValue_getPackedEventFlags

(

Tase2_PointValue

self

)

Get the packed event flags value.

NOTE: the result is only valid when data point is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

the	point value instance

Returns

the packed event flags values

Tase2_PointValue_getPackedEventFlagsEx()

TASE2_API Tase2_PackedEventFlags Tase2_PointValue_getPackedEventFlagsEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the packed event flags value.

New in version 2.1.0

NOTE: the result is only valid when data point is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the packed event flags values

Tase2_PointValue_getSingleEventFlags()

TASE2_API Tase2_SingleEventFlags Tase2_PointValue_getSingleEventFlags

(

Tase2_PointValue

self

)

Get the single event flags value.

NOTE: the result is only valid when data point is of type TASE2_VALUE_TYPE_SINGLE_EVENT

Parameters

the	point value instance

Returns

the single event flags value

Tase2_PointValue_getSingleEventFlagsEx()

TASE2_API Tase2_SingleEventFlags Tase2_PointValue_getSingleEventFlagsEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the single event flags value.

New in version 2.1.0

NOTE: the result is only valid when data point is of type TASE2_VALUE_TYPE_SINGLE_EVENT

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the single event flags value

Tase2_PointValue_getTimeStamp()

TASE2_API uint64_t Tase2_PointValue_getTimeStamp

(

Tase2_PointValue

self

)

Get the time stamp of the last data point change or update.

NOTE: the result is only valid when the data point type includes a time stamp

Parameters

the	point value instance

Returns

the time stamp in ms since epoch

Tase2_PointValue_getTimeStampClass()

TASE2_API Tase2_TimeStampClass Tase2_PointValue_getTimeStampClass

(

Tase2_PointValue

self

)

Get the timestamp class of the value.

NOTE: When the Tase2_PointValue_getType function returns TASE2_VALUE_TYPE_STATE_OR_DISCRETE the function cannot determine if there is a timestamp or not. In this case the function returns TASE2_NO_TIMESTAMP

Returns

the timestamp class of the point value

Tase2_PointValue_getTimeStampEx()

TASE2_API uint64_t Tase2_PointValue_getTimeStampEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the time stamp of the last data point change or update.

New in version 2.1.0

NOTE: the result is only valid when the data point type includes a time stamp

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the time stamp in ms since epoch

Tase2_PointValue_getType()

TASE2_API Tase2_PointValueType Tase2_PointValue_getType

(

Tase2_PointValue

self

)

Get the (estimated) type of the point value.

Parameters

self	the PointValue instance

Returns

type information

Tase2_PointValue_getValueDiscrete()

TASE2_API int32_t Tase2_PointValue_getValueDiscrete

(

Tase2_PointValue

self

)

Get the value of an indication point of type DISCRETE.

Parameters

the	point value instance

Returns

the discrete value or 0 when the Tase2_PointValue object has the wrong type

Tase2_PointValue_getValueDiscreteEx()

TASE2_API int32_t Tase2_PointValue_getValueDiscreteEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the value of an indication point of type DISCRETE.

New in version 2.1.0

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the discrete value or 0 when the Tase2_PointValue object has the wrong type

Tase2_PointValue_getValueReal()

TASE2_API float Tase2_PointValue_getValueReal

(

Tase2_PointValue

self

)

Get the real value.

Parameters

the	point value instance

Returns

the real value or NAN when the Tase2_PointValue object has the wrong type

Tase2_PointValue_getValueRealEx()

TASE2_API float Tase2_PointValue_getValueRealEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the real value.

New in version 2.1.0

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the real value or NAN when the Tase2_PointValue object has the wrong type

Tase2_PointValue_getValueState()

TASE2_API Tase2_DataState Tase2_PointValue_getValueState

(

Tase2_PointValue

self

)

Get the value of an indication point of type STATE.

Parameters

the	point value instance

Returns

the state value

Tase2_PointValue_getValueStateEx()

TASE2_API Tase2_DataState Tase2_PointValue_getValueStateEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the value of an indication point of type STATE.

New in version 2.1.0

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the state value

Tase2_PointValue_getValueStateSupplemental()

TASE2_API Tase2_DataStateSupplemental Tase2_PointValue_getValueStateSupplemental

(

Tase2_PointValue

self

)

Get the value of an indication point of type STATE_SUPPLEMENTAL.

Parameters

the	point value instance

Returns

the state value

Tase2_PointValue_getValueStateSupplementalEx()

TASE2_API Tase2_DataStateSupplemental Tase2_PointValue_getValueStateSupplementalEx	(	Tase2_PointValue	self,
		Tase2_PointValueError *	err )

Get the value of an indication point of type STATE_SUPPLEMENTAL.

New in version 2.1.0

Parameters

	the	point value instance
[out]	err	TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Returns

the state value

Tase2_PointValue_hasTimeStamp()

TASE2_API bool Tase2_PointValue_hasTimeStamp

(

Tase2_PointValue

self

)

Try to determine if the value has a timestamp.

NOTE: When the Tase2_PointValue_getType function returns TASE2_VALUE_TYPE_STATE_OR_DISCRETE the function cannot determine if there is a timestamp or not. In this case the function returns false

Returns

true when the value contains a timestamp, false otherwise

Tase2_PointValue_setCOV()

TASE2_API void Tase2_PointValue_setCOV	(	Tase2_PointValue	self,
		uint16_t	cov )

Set the COV (counter of value changes) of a data point.

NOTE: has no effect when the data point type doesn't include a COV

Parameters

the	point value instance
cov	the COV value

Tase2_PointValue_setCOVEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setCOVEx	(	Tase2_PointValue	self,
		uint16_t	cov )

Set the COV (counter of value changes) of a data point.

New in version 2.1.0

NOTE: has no effect when the data point type doesn't include a COV

Parameters

the	point value instance
cov	the COV value

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setEventTime()

TASE2_API void Tase2_PointValue_setEventTime	(	Tase2_PointValue	self,
		uint64_t	eventTime )

Set the event/operation start time.

Parameters

the	point value instance
eventTime	the operation or event start time in milliseconds since epoch

Tase2_PointValue_setEventTimeEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setEventTimeEx	(	Tase2_PointValue	self,
		uint64_t	eventTime )

Set the event/operation start time.

New in version 2.1.0

Parameters

the	point value instance
eventTime	the operation or event start time in milliseconds since epoch

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setFlags()

TASE2_API void Tase2_PointValue_setFlags	(	Tase2_PointValue	self,
		Tase2_DataFlags	flags )

Set the quality flags of a data point.

NOTE: has no effect when the data point type doesn't include a quality

Parameters

the	point value instance
flags	the quality flags of a data point

Tase2_PointValue_setFlagsEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setFlagsEx	(	Tase2_PointValue	self,
		Tase2_DataFlags	flags )

Set the quality flags of a data point.

New in version 2.1.0

NOTE: has no effect when the data point type doesn't include a quality

Parameters

the	point value instance
flags	the quality flags of a data point

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setOperatingTime()

TASE2_API void Tase2_PointValue_setOperatingTime	(	Tase2_PointValue	self,
		int32_t	operatingTime )

Set the operation or event duration.

Parameters

the	point value instance
operatingTime	the operation or event duration in milliseconds.

Tase2_PointValue_setOperatingTimeEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setOperatingTimeEx	(	Tase2_PointValue	self,
		int32_t	operatingTime )

Set the operation or event duration.

New in version 2.1.0

Parameters

the	point value instance
operatingTime	the operation or event duration in milliseconds.

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setPackedEvent()

TASE2_API void Tase2_PointValue_setPackedEvent	(	Tase2_PointValue	self,
		Tase2_EventFlags	packedEvent )

Set the packed event values.

NOTE: the function has only an effect when point value is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

the	point value instance
packedEvent	the packed event values

Tase2_PointValue_setPackedEventEx()

Tase2_PointValueError Tase2_PointValue_setPackedEventEx	(	Tase2_PointValue	self,
		Tase2_EventFlags	packedEvent )

Set the packed event values.

New in version 2.1.0

NOTE: the function has only an effect when point value is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

the	point value instance
packedEvent	the packed event values

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setPackedEventFlags()

TASE2_API void Tase2_PointValue_setPackedEventFlags	(	Tase2_PointValue	self,
		Tase2_PackedEventFlags	flags )

Set the packed event flags.

NOTE: the function has only an effect when point value is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

the	point value instance
packedEvent	the packed event flags

Tase2_PointValue_setPackedEventFlagsEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setPackedEventFlagsEx	(	Tase2_PointValue	self,
		Tase2_PackedEventFlags	flags )

Set the packed event flags.

New in version 2.1.0

NOTE: the function has only an effect when point value is of type TASE2_VALUE_TYPE_PACKED_EVENT

Parameters

the	point value instance
packedEvent	the packed event flags

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setSingleEventFlags()

TASE2_API void Tase2_PointValue_setSingleEventFlags	(	Tase2_PointValue	self,
		Tase2_SingleEventFlags	eventFlags )

Set the single event flags value.

NOTE: the function has only an effect when point value is of type TASE2_VALUE_TYPE_SINGLE_EVENT

Parameters

the	point value instance
eventFlags	the single event flags

Tase2_PointValue_setSingleEventFlagsEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setSingleEventFlagsEx	(	Tase2_PointValue	self,
		Tase2_SingleEventFlags	eventFlags )

Set the single event flags value.

New in version 2.1.0

NOTE: the function has only an effect when point value is of type TASE2_VALUE_TYPE_SINGLE_EVENT

Parameters

the	point value instance
eventFlags	the single event flags

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setTimeStamp()

TASE2_API void Tase2_PointValue_setTimeStamp	(	Tase2_PointValue	self,
		uint64_t	timestamp )

Set the time stamp of the last data point change or update.

NOTE: has no effect when the data point type doesn't include a time stamp

Parameters

timestamp

the time stamp in ms since epoch

Tase2_PointValue_setTimeStampEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setTimeStampEx	(	Tase2_PointValue	self,
		uint64_t	timestamp )

Set the time stamp of the last data point change or update.

New in version 2.1.0

Parameters

the	point value instance
timestamp	the time stamp in ms since epoch

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setType()

TASE2_API void Tase2_PointValue_setType	(	Tase2_PointValue	self,
		Tase2_PointValueType	type )

Set the type of a point value.

The elements of a point value can only be interpreted correctly when the TASE.2 type is known. In most cases the TASE.2 type can be derived from the MMS type of the MMS value that has been received. However, in some cases this is not possible because the same MMS type is used for different TASE.2 types. In this case it is required to tell the library what TASE.2 type has to be assumed to interpret the value elements. When you get a type of TASE2_VALUE_TYPE_UNKNOWN, TASE2_VALUE_TYPE_STATE_OR_STATE_SUPPLEMENTAL, or TASE2_VALUE_TYPE_STATE_OR_DISCRETE you have to use this function to advise the correct type.

Parameters

self	the PointValue instance
type	the TASE.2 type to be used for value interpretation.

Tase2_PointValue_setValueDiscrete()

TASE2_API void Tase2_PointValue_setValueDiscrete	(	Tase2_PointValue	self,
		int32_t	value )

Set the value of an indication point of type DISCRETE.

Parameters

the	point value instance
value	the new value

Tase2_PointValue_setValueDiscreteEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setValueDiscreteEx	(	Tase2_PointValue	self,
		int32_t	value )

Set the value of an indication point of type DISCRETE.

New in version 2.1.0

Parameters

the	point value instance
value	the new value

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setValueReal()

TASE2_API void Tase2_PointValue_setValueReal	(	Tase2_PointValue	self,
		float	value )

Set the real value.

Parameters

the	point value instance
value	the new value

Tase2_PointValue_setValueRealEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setValueRealEx	(	Tase2_PointValue	self,
		float	value )

Set the real value.

New in version 2.1.0

Parameters

the	point value instance
value	the new value

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setValueState()

TASE2_API void Tase2_PointValue_setValueState	(	Tase2_PointValue	self,
		Tase2_DataState	value )

Set the value of an indication point of type STATE.

Parameters

the	point value instance
value	the state value

Tase2_PointValue_setValueStateEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setValueStateEx	(	Tase2_PointValue	self,
		Tase2_DataState	value )

Set the value of an indication point of type STATE.

New in version 2.1.0

Parameters

the	point value instance
value	the state value

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE

Tase2_PointValue_setValueStateSupplemental()

TASE2_API void Tase2_PointValue_setValueStateSupplemental	(	Tase2_PointValue	self,
		Tase2_DataStateSupplemental	value )

Set the value of an indication point of type STATE_SUPPLEMENTAL.

Parameters

the	point value instance
value	the state value

Tase2_PointValue_setValueStateSupplementalEx()

TASE2_API Tase2_PointValueError Tase2_PointValue_setValueStateSupplementalEx	(	Tase2_PointValue	self,
		Tase2_DataStateSupplemental	value )

Set the value of an indication point of type STATE_SUPPLEMENTAL.

New in version 2.1.0

Parameters

the	point value instance
value	the state value

Returns

TASE2_POINT_VALUE_ERROR_OK or TASE2_POINT_VALUE_ERROR_WRONG_TYPE