Server side data model related API parts

Data Structures
struct	Tase2_DataModel
struct	Tase2_DataSet
	Representation of a data set in the server data model. More...
struct	Tase2_DataSetEntry
	Representation of a data set entry in the server data model. More...
struct	Tase2_InformationMessage
struct	Tase2_Domain

Typedefs
typedef struct sTase2_DataPoint *	Tase2_DataPoint
	Abstract type representing data points in the server data model.
typedef struct sTase2_IndicationPoint *	Tase2_IndicationPoint
	Representation of indication points in the server data model.
typedef struct sTase2_ProtectionEquipment *	Tase2_ProtectionEquipment
	Representation of protection equipment in the server data model.
typedef struct sTase2_DSTransferSet *	Tase2_DSTransferSet
	Represents a data set transfer set (DSTS) in the server.
typedef struct sTase2_TransferSet *	Tase2_TransferSet
typedef struct sTase2_ControlPoint *	Tase2_ControlPoint

Enumerations
enum	Tase2_DataPointType { TASE2_POINT_TYPE_INDICATION , TASE2_POINT_TYPE_CONTROL , TASE2_POINT_TYPE_PROTECTION_EVENT }
enum	Tase2_TransferSetType { TASE2_TS_TYPE_DATA_SET = 0 }
enum	Tase2_DeviceClass { TASE2_DEVICE_CLASS_SBO = 0 , TASE2_DEVICE_CLASS_DIRECT = 1 }
enum	Tase2_ControlPointType { TASE2_CONTROL_TYPE_COMMAND = 0 , TASE2_CONTROL_TYPE_SETPOINT_REAL = 1 , TASE2_CONTROL_TYPE_SETPOINT_DESCRETE = 2 }

Functions
TASE2_API const char *	Tase2_DataPoint_getName (Tase2_DataPoint self)
	Get the name of the data point.
TASE2_API Tase2_Domain	Tase2_DataPoint_getDomain (Tase2_DataPoint self)
	Get the Tase2_Domain of the data point.
TASE2_API Tase2_PointValue	Tase2_DataPoint_getPointValue (Tase2_DataPoint self)
	Get the point value (Tase2_PointValue) of this data point.
TASE2_API const char *	Tase2_IndicationPoint_getName (Tase2_IndicationPoint self)
	Get the relative name of the indication point.
TASE2_API Tase2_QualityClass	Tase2_IndicationPoint_getQualityClass (Tase2_IndicationPoint self)
	Get the quality class of the indication point.
TASE2_API Tase2_TimeStampClass	Tase2_IndicationPoint_getTimestampClass (Tase2_IndicationPoint self)
	Get the timestamp class of the indication point.
TASE2_API Tase2_IndicationPointType	Tase2_IndicationPoint_getType (Tase2_IndicationPoint self)
	Get the indication point type.
TASE2_API bool	Tase2_IndicationPoint_hasCOV (Tase2_IndicationPoint self)
	Check if the indication point has a counter of value change (COV) field.
TASE2_API void	Tase2_IndicationPoint_setReal (Tase2_IndicationPoint self, float value)
	Set the value of a data point of type TASE2_IND_POINT_TYPE_REAL.
TASE2_API void	Tase2_IndicationPoint_setRealQ (Tase2_IndicationPoint self, float value, Tase2_DataFlags flags)
	Set the value, and quality of a data point of type TASE2_IND_POINT_TYPE_REAL.
TASE2_API void	Tase2_IndicationPoint_setRealQTimeStamp (Tase2_IndicationPoint self, float value, Tase2_DataFlags flags, uint64_t timestamp)
	Set the value, quality, and timestamp of a data point of type TASE2_IND_POINT_TYPE_REAL.
TASE2_API void	Tase2_IndicationPoint_setDiscrete (Tase2_IndicationPoint self, int32_t value)
	Set the value of a data point of type TASE2_IND_POINT_TYPE_DISCRETE.
TASE2_API void	Tase2_IndicationPoint_setDiscreteQ (Tase2_IndicationPoint self, int32_t value, Tase2_DataFlags flags)
	Set the value, and quality of a data point of type TASE2_IND_POINT_TYPE_DISCRETE.
TASE2_API void	Tase2_IndicationPoint_setDiscreteQTimeStamp (Tase2_IndicationPoint self, int32_t value, Tase2_DataFlags flags, uint64_t timestamp)
	Set the value, quality, and timestamp of a data point of type TASE2_IND_POINT_TYPE_DISCRETE.
TASE2_API void	Tase2_IndicationPoint_setState (Tase2_IndicationPoint self, Tase2_DataState value)
	Set the state and quality of a TASE2_IND_POINT_TYPE_STATE type indication point.
TASE2_API void	Tase2_IndicationPoint_setStateTimeStamp (Tase2_IndicationPoint self, Tase2_DataState value, uint64_t timestamp)
	Set the state, quality, and timestamp of a TASE2_IND_POINT_TYPE_STATE type indication point.
TASE2_API void	Tase2_IndicationPoint_setStateSupplemental (Tase2_IndicationPoint self, Tase2_DataStateSupplemental value)
	Set the value of a data point of type TASE2_IND_POINT_TYPE_STATE_SUPPLEMENTAL.
TASE2_API void	Tase2_IndicationPoint_setStateSupplementalQ (Tase2_IndicationPoint self, Tase2_DataStateSupplemental value, Tase2_DataFlags flags)
	Set the value, and quality of a data point of type TASE2_IND_POINT_TYPE_STATE_SUPPLEMENTAL.
TASE2_API void	Tase2_IndicationPoint_setStateSupplementalQTimeStamp (Tase2_IndicationPoint self, Tase2_DataStateSupplemental value, Tase2_DataFlags flags, uint64_t timestamp)
	Set the value, quality, and timestamp of a data point of type TASE2_IND_POINT_TYPE_STATE_SUPPLEMENTAL.
TASE2_API void	Tase2_IndicationPoint_setQuality (Tase2_IndicationPoint self, Tase2_DataFlags flags)
	Sets the quality flags of a data point.
TASE2_API void	Tase2_IndicationPoint_setTimeStamp (Tase2_IndicationPoint self, uint64_t timestamp)
	Sets the timestamp of a data point.
TASE2_API void	Tase2_IndicationPoint_setCOV (Tase2_IndicationPoint self, uint16_t cov)
	Set the COV (cointer of value changes) of the data point.
TASE2_API const char *	Tase2_ProtectionEquipment_getName (Tase2_ProtectionEquipment self)
	Get the name of the protection equipment.
TASE2_API void	Tase2_ProtectionEquipment_setSingleEventFlags (Tase2_ProtectionEquipment self, Tase2_SingleEventFlags eventFlags)
	Set the single event flags (value and quality)
TASE2_API void	Tase2_ProtectionEquipment_setPackedEvent (Tase2_ProtectionEquipment self, Tase2_EventFlags packedEvent)
	Set the event flags of a packed event.
TASE2_API void	Tase2_ProtectionEquipment_setPackedEventFlags (Tase2_ProtectionEquipment self, Tase2_PackedEventFlags flags)
	Set the quality flags of a packed event.
TASE2_API void	Tase2_ProtectionEquipment_setOperatingTime (Tase2_ProtectionEquipment self, int32_t operatingTime)
	Set the operating time (duration) of a protection equipment event.
TASE2_API void	Tase2_ProtectionEquipment_setEventTime (Tase2_ProtectionEquipment self, uint64_t eventTime)
	Set the event time (timestamp when the event started) of a protection equipment event.
TASE2_API const char *	Tase2_ControlPoint_getName (Tase2_ControlPoint self)
	Get the name of the control point.
TASE2_API Tase2_Domain	Tase2_ControlPoint_getDomain (Tase2_ControlPoint self)
	Get the domain of the control point.
TASE2_API Tase2_ControlPointType	Tase2_ControlPoint_getType (Tase2_ControlPoint self)
	Get the type of the control point.
TASE2_API Tase2_TagValue	Tase2_ControlPoint_getTag (Tase2_ControlPoint self, char **reason, Tase2_BilateralTable *tagOwner)
	Get the tag value and additional tag information.
TASE2_API void	Tase2_ControlPoint_setTag (Tase2_ControlPoint self, Tase2_TagValue value, const char *reason, Tase2_BilateralTable tagOwner)
	Set the tag value and additional tag information locally.
TASE2_API Tase2_DataModel	Tase2_DataModel_create ()
	Create a new data model instance.
TASE2_API void	Tase2_DataModel_setEdition (Tase2_DataModel self, Tase2_Edition edition)
	Set the TASE.2/ICCP edition to be used with the data model.
TASE2_API void	Tase2_DataModel_destroy (Tase2_DataModel self)
	Release all resources and memory used by the data model.
TASE2_API void	Tase2_DataModel_hideSpecialTSVariables (Tase2_DataModel self, bool value)
	Option to hide special transfer set variables in data model.
TASE2_API Tase2_Domain	Tase2_DataModel_addDomain (Tase2_DataModel self, const char *domainName)
	Add a TASE.2 domain to the data model.
TASE2_API Tase2_Domain	Tase2_DataModel_getDomain (Tase2_DataModel self, const char *domainName)
	Get the domain instance with a specific name.
TASE2_API Tase2_Domain	Tase2_DataModel_getVCC (Tase2_DataModel self)
	Get the VCC pseudo domain that is representing the VCC scope data model items.
TASE2_API const char *	Tase2_Domain_getName (Tase2_Domain self)
	Get the name of the domain.
TASE2_API void	Tase2_Domain_setBilateralTableId (Tase2_Domain self, const char *id)
	Set the bilateral table (BLT) id of the domain.
TASE2_API Tase2_IndicationPoint	Tase2_Domain_addIndicationPoint (Tase2_Domain self, const char *name, Tase2_IndicationPointType type, Tase2_QualityClass qualityClass, Tase2_TimeStampClass timeStampClass, bool hasCOV, bool readOnly)
	Create a new data point of type indication point.
TASE2_API Tase2_ControlPoint	Tase2_Domain_addControlPoint (Tase2_Domain self, const char *deviceName, Tase2_ControlPointType pointType, Tase2_DeviceClass deviceClass, bool hasTag, int16_t checkBackId)
	Create a new data point of type control point (device)
TASE2_API Tase2_ProtectionEquipment	Tase2_Domain_addProtectionEquipment (Tase2_Domain self, const char *equipmentName, bool isPacked)
	Create a new data point of type protection equipment.
TASE2_API Tase2_DSTransferSet	Tase2_Domain_addDSTransferSet (Tase2_Domain self, const char *name)
	Add a new data set transfer set (DSTS) to a domain.
TASE2_API Tase2_DataSet	Tase2_Domain_addDataSet (Tase2_Domain self, const char *name)
	Add a new data set to the domain or VCC pseudo-domain.
TASE2_API Tase2_DataPoint	Tase2_Domain_getDataPoint (Tase2_Domain self, const char *pointName)
	Get the data point (indication point, device, or protection equipment) with the given name.
TASE2_API void	Tase2_Domain_addInformationMessageObject (Tase2_Domain self, int maxSize)
	Add an information message object to a domain of VCC scope.
TASE2_API Tase2_DataSetEntry	Tase2_DataSet_addEntry (Tase2_DataSet self, Tase2_Domain domain, const char *variableName)
	Add a data set entry to a static data set.
TASE2_API const char *	Tase2_TransferSet_getName (Tase2_TransferSet self)
	Get the name of the transfer set.
TASE2_API Tase2_Domain	Tase2_TransferSet_getDomain (Tase2_TransferSet self)
	Get the TASE.2 domain of the transfer set.
TASE2_API char *	Tase2_DSTransferSet_getDataSetName (Tase2_DSTransferSet self)
	Get the data set name of the transfer set.
TASE2_API int32_t	Tase2_DSTransferSet_getStartTime (Tase2_DSTransferSet self)
	Get the start time for condition monitoring of the transfer set.
TASE2_API int32_t	Tase2_DSTransferSet_getInterval (Tase2_DSTransferSet self)
	Get the interval value (time interval between server reports)
TASE2_API int32_t	Tase2_DSTransferSet_getTLE (Tase2_DSTransferSet self)
	Get the TLE (time limit for execution) value.
TASE2_API int32_t	Tase2_DSTransferSet_getBufferTime (Tase2_DSTransferSet self)
	Get the buffer time (wait time before report is sent)
TASE2_API int32_t	Tase2_DSTransferSet_getIntegrityCheck (Tase2_DSTransferSet self)
	Get the time interval for integrity checks (Integrity Check)
TASE2_API uint32_t	Tase2_DSTransferSet_getDsConditionsRequested (Tase2_DSTransferSet self)
	Get the DSConditions to trigger a report transmission.
TASE2_API bool	Tase2_DSTransferSet_getBlockData (Tase2_DSTransferSet self)
	Get the block data flag.
TASE2_API bool	Tase2_DSTransferSet_getCritical (Tase2_DSTransferSet self)
	Get the critical flag (report acknowledge by client required when set)
TASE2_API bool	Tase2_DSTransferSet_getRBE (Tase2_DSTransferSet self)
	Get the RBE (report by exception) flag.
TASE2_API bool	Tase2_DSTransferSet_getAllChangesReported (Tase2_DSTransferSet self)
	Get the All Changes Reported flag.
TASE2_API bool	Tase2_DSTransferSet_getStatus (Tase2_DSTransferSet self)
	Get the status of the DS transfer set.
TASE2_API int16_t	Tase2_DSTransferSet_getEventCodeRequested (Tase2_DSTransferSet self)
	Get the event code requested value.

Detailed Description

Typedef Documentation

Tase2_ControlPoint

typedef struct sTase2_ControlPoint* Tase2_ControlPoint

Tase2_DataPoint

typedef struct sTase2_DataPoint* Tase2_DataPoint

Abstract type representing data points in the server data model.

Includes indication points Tase2_IndicationPoint, protection equipment points Tase2_ProtectionEquipment and control points (devices) Tase2_ControlPoint

Tase2_DSTransferSet

typedef struct sTase2_DSTransferSet* Tase2_DSTransferSet

Represents a data set transfer set (DSTS) in the server.

Tase2_IndicationPoint

typedef struct sTase2_IndicationPoint* Tase2_IndicationPoint

Representation of indication points in the server data model.

Tase2_ProtectionEquipment

typedef struct sTase2_ProtectionEquipment* Tase2_ProtectionEquipment

Representation of protection equipment in the server data model.

Tase2_TransferSet

typedef struct sTase2_TransferSet* Tase2_TransferSet

Enumeration Type Documentation

Tase2_ControlPointType

enum Tase2_ControlPointType

Enumerator
TASE2_CONTROL_TYPE_COMMAND
TASE2_CONTROL_TYPE_SETPOINT_REAL
TASE2_CONTROL_TYPE_SETPOINT_DESCRETE

Tase2_DataPointType

enum Tase2_DataPointType

Enumerator
TASE2_POINT_TYPE_INDICATION
TASE2_POINT_TYPE_CONTROL
TASE2_POINT_TYPE_PROTECTION_EVENT

Tase2_DeviceClass

enum Tase2_DeviceClass

Enumerator
TASE2_DEVICE_CLASS_SBO
TASE2_DEVICE_CLASS_DIRECT

Tase2_TransferSetType

enum Tase2_TransferSetType

Enumerator
TASE2_TS_TYPE_DATA_SET

Function Documentation

Tase2_ControlPoint_getDomain()

TASE2_API Tase2_Domain Tase2_ControlPoint_getDomain

(

Tase2_ControlPoint

self

)

Get the domain of the control point.

Parameters

self	Tase2_ControlPoint instance

Returns

domain of the control point

Tase2_ControlPoint_getName()

TASE2_API const char * Tase2_ControlPoint_getName

(

Tase2_ControlPoint

self

)

Get the name of the control point.

NOTE: the control point instance is the owner of the returned string.

Parameters

self	Tase2_ControlPoint instance

Returns

name of the control point

Tase2_ControlPoint_getTag()

TASE2_API Tase2_TagValue Tase2_ControlPoint_getTag	(	Tase2_ControlPoint	self,
		char **	reason,
		Tase2_BilateralTable *	tagOwner )

Get the tag value and additional tag information.

NOTES:

• The control point needs the tag attribute. Otherwise TAG_INVALID is returned.
• When returned the reason string is newly allocated and owned by the caller
• Function can only be called after the Tase2_Server instance was created

Parameters

self	Tase2_ControlPoint instance
reason	pointer to store the reason message, or NULL if the reason message is not required
tagOwner	a pointer to store the Tase2_BilateralTable that is representing the owner, can be NULL if owner information is not required.

Returns

the value of the tag, if the control point has not tag, TASE2_TAG_INVALID is returned.

Tase2_ControlPoint_getType()

TASE2_API Tase2_ControlPointType Tase2_ControlPoint_getType

(

Tase2_ControlPoint

self

)

Get the type of the control point.

Parameters

self	Tase2_ControlPoint instance

Returns

the type of the control point

Tase2_ControlPoint_setTag()

TASE2_API void Tase2_ControlPoint_setTag	(	Tase2_ControlPoint	self,
		Tase2_TagValue	value,
		const char *	reason,
		Tase2_BilateralTable	tagOwner )

Set the tag value and additional tag information locally.

Parameters

self	Tase2_ControlPoint instance
value	the Tase2_TagValue value
reason	the reason as a human readable message
tagOwner	should be NULL to indicate that the tag was set locally (cannot overwritten by remote client)

Tase2_DataModel_addDomain()

TASE2_API Tase2_Domain Tase2_DataModel_addDomain	(	Tase2_DataModel	self,
		const char *	domainName )

Add a TASE.2 domain to the data model.

Parameters

domainName

the name of the domain (max. 32 characters)

Returns

the new domain instance

Tase2_DataModel_create()

TASE2_API Tase2_DataModel Tase2_DataModel_create

(

)

Create a new data model instance.

NOTE: a data model can only be used by a single Tase2_Server instance!

Tase2_DataModel_destroy()

TASE2_API void Tase2_DataModel_destroy

(

Tase2_DataModel

self

)

Release all resources and memory used by the data model.

Tase2_DataModel_getDomain()

TASE2_API Tase2_Domain Tase2_DataModel_getDomain	(	Tase2_DataModel	self,
		const char *	domainName )

Get the domain instance with a specific name.

Parameters

domainName

the domain name

Returns

the domain with the specified name

Tase2_DataModel_getVCC()

TASE2_API Tase2_Domain Tase2_DataModel_getVCC

(

Tase2_DataModel

self

)

Get the VCC pseudo domain that is representing the VCC scope data model items.

Returns

domain object the is representing the VCC scope

Tase2_DataModel_hideSpecialTSVariables()

TASE2_API void Tase2_DataModel_hideSpecialTSVariables	(	Tase2_DataModel	self,
		bool	value )

Option to hide special transfer set variables in data model.

When enabled the special transfer set variables (like "Transfer_Set_Name") will not appear in the get-name-list response of the server.

Parameters

value,when

true the special variables are hidden, otherwise they are visible

Tase2_DataModel_setEdition()

TASE2_API void Tase2_DataModel_setEdition	(	Tase2_DataModel	self,
		Tase2_Edition	edition )

Set the TASE.2/ICCP edition to be used with the data model.

Parameters

edition

the TASE.2/ICCP standard edition to be used

Tase2_DataPoint_getDomain()

TASE2_API Tase2_Domain Tase2_DataPoint_getDomain

(

Tase2_DataPoint

self

)

Get the Tase2_Domain of the data point.

The data point can be of type Tase2_IndicationPoint, Tase2_ProtectionEquipment, or Tase2_ControlPoint

Parameters

self	the data point instance

Returns

the domain of the data point

Tase2_DataPoint_getName()

TASE2_API const char * Tase2_DataPoint_getName

(

Tase2_DataPoint

self

)

Get the name of the data point.

The data point can be of type Tase2_IndicationPoint, Tase2_ProtectionEquipment, or Tase2_ControlPoint

Parameters

self	the data point instance

Tase2_DataPoint_getPointValue()

TASE2_API Tase2_PointValue Tase2_DataPoint_getPointValue

(

Tase2_DataPoint

self

)

Get the point value (Tase2_PointValue) of this data point.

Parameters

self	the data point instance

Returns

the point value instance of this data point

Tase2_DataSet_addEntry()

TASE2_API Tase2_DataSetEntry Tase2_DataSet_addEntry	(	Tase2_DataSet	self,
		Tase2_Domain	domain,
		const char *	variableName )

Add a data set entry to a static data set.

Parameters

domain	the domain of the entry variable
varibaleName	the name of the entry variable

Returns

the new data set entry instance

Tase2_Domain_addControlPoint()

TASE2_API Tase2_ControlPoint Tase2_Domain_addControlPoint	(	Tase2_Domain	self,
		const char *	deviceName,
		Tase2_ControlPointType	pointType,
		Tase2_DeviceClass	deviceClass,
		bool	hasTag,
		int16_t	checkBackId )

Create a new data point of type control point (device)

NOTE: A control point (device) is used to control outputs or set points.

Parameters

deviceName	name of the control point
pointType	type of the control point (one of COMMAND, SETPOINT_REAL, SETPOINT_DISCRETE)
deviceClass	the device class (one of TASE2_DEVICE_CLASS_SBO or TASE2_DEVICE_CLASS_DIRECT)
hasTag	define if the device has a tag (a tag is a restriction that prohibits specific usage of the device)
checkBackId	Set the check back ID for SBO.

Returns

the new control point instance

Tase2_Domain_addDataSet()

TASE2_API Tase2_DataSet Tase2_Domain_addDataSet	(	Tase2_Domain	self,
		const char *	name )

Add a new data set to the domain or VCC pseudo-domain.

A data set is a group of VCC or ICC scope variables.

Parameters

self	the domain instance or VCC pseudo domain (see Tase2_DataModel_getVCC)
name	the name of the new data set

Returns

the new data set instance

Tase2_Domain_addDSTransferSet()

TASE2_API Tase2_DSTransferSet Tase2_Domain_addDSTransferSet	(	Tase2_Domain	self,
		const char *	name )

Add a new data set transfer set (DSTS) to a domain.

Note

Cannot be used with VCC pseudo-domain because transfer set are not allowed in VCC scope

Parameters

self	the domain instance
name	the name of the DSTS

Returns

the new DSTS instance

Tase2_Domain_addIndicationPoint()

TASE2_API Tase2_IndicationPoint Tase2_Domain_addIndicationPoint	(	Tase2_Domain	self,
		const char *	name,
		Tase2_IndicationPointType	type,
		Tase2_QualityClass	qualityClass,
		Tase2_TimeStampClass	timeStampClass,
		bool	hasCOV,
		bool	readOnly )

Create a new data point of type indication point.

NOTE: An indication point represents measurement or status data. There are some combinations that don't result in valid types. The type StateQ is not required (because State already supports quality information) and should not be used (also it is not accepted by some third-party implementations).

Parameters

name	the name of the data point
type	the type of the indication point
qualityClass	defines if a quality flag is available
timeStampClass	defines if and what kind of time stamp is available
hasCOV	has a COV counter
readOnly	true when indication point is read-only, false when read-write.

Returns

the new indication point instance

Allowed parameter combinations are:

Resulting type (specification)	type	qualityClass	timeStampClass	hasCOV
Data_State	STATE	NO_QUALITY	NO_TIMESTAMP	false
Data_Discrete	DISCRETE	NO_QUALITY	NO_TIMESTAMP	false
Data_Real	REAL	NO_QUALITY	NO_TIMESTAMP	false
Data_StateSupplemental	STATE_SUPPLEMENTAL	NO_QUALITY	NO_TIMESTAMP	false
Data_RealQ	REAL	QUALITY	NO_TIMESTAMP	false
Data_DiscreteQ	DISCRETE	QUALITY	NO_TIMESTAMP	false
Data_StateSupplementalQ	STATE_SUPPLEMENTAL	QUALITY	NO_TIMESTAMP	false
Data_RealQTimeTag	REAL	QUALITY	TIMESTAMP	false
Data_StateQTimeTag	STATE	QUALITY	TIMESTAMP	false
Data_DiscreteQTimeTag	DISCRETE	QUALITY	TIMESTAMP	false
Data_StateSupplementalQTimeTag	STATE_SUPPLEMENTAL	QUALITY	TIMESTAMP	false
Data_RealExtended	REAL	QUALITY	TIMESTAMP	true
Data_StateExtended	STATE	QUALITY	TIMESTAMP	true
Data_DiscreteExtended	STATE	QUALITY	TIMESTAMP	true
Data_StateSupplementalExtended	STATE_SUPPLEMENTAL	QUALITY	TIMESTAMP	true
Data_RealQTimeTagExtended	REAL	QUALITY	TIMESTAMP_EXTENDED	false
Data_StateQTimeTagExtended	STATE	QUALITY	TIMESTAMP_EXTENDED	false
Data_DiscreteQTimeTagExtended	DISCRETE	QUALITY	TIMESTAMP_EXTENDED	false
Data_StateSupplementalQTimeTagExtended	STATE_SUPPLEMENTAL	QUALITY	TIMESTAMP_EXTENDED	false

Tase2_Domain_addInformationMessageObject()

TASE2_API void Tase2_Domain_addInformationMessageObject	(	Tase2_Domain	self,
		int	maxSize )

Add an information message object to a domain of VCC scope.

Parameters

self	the domain instance or VCC pseudo domain (see Tase2_DataModel_getVCC)
maxSize	maximum size of the information message buffer

Tase2_Domain_addProtectionEquipment()

TASE2_API Tase2_ProtectionEquipment Tase2_Domain_addProtectionEquipment	(	Tase2_Domain	self,
		const char *	equipmentName,
		bool	isPacked )

Create a new data point of type protection equipment.

Parameters

equipmentName	the name of the data point
isPacked	specify if packed type is used

Returns

the new protection equipment instance

Tase2_Domain_getDataPoint()

TASE2_API Tase2_DataPoint Tase2_Domain_getDataPoint	(	Tase2_Domain	self,
		const char *	pointName )

Get the data point (indication point, device, or protection equipment) with the given name.

Parameters

self	the domain instance or VCC pseudo domain (see Tase2_DataModel_getVCC)
name	the name of the data point

Returns

the data point instance or NULL if the data point doesn't exist.

Tase2_Domain_getName()

TASE2_API const char * Tase2_Domain_getName

(

Tase2_Domain

self

)

Get the name of the domain.

Returns

the name of the domain as C string (only valid as long as the domain object exists)

Tase2_Domain_setBilateralTableId()

TASE2_API void Tase2_Domain_setBilateralTableId	(	Tase2_Domain	self,
		const char *	id )

Set the bilateral table (BLT) id of the domain.

NOTE: a domain is related to a specific bilateral table that is an agreement between client and server on what data is accessible by the client. Usually a (server) domain is dedicated to a specific other control center (client).

Parameters

id	the BLT ID

Tase2_DSTransferSet_getAllChangesReported()

TASE2_API bool Tase2_DSTransferSet_getAllChangesReported

(

Tase2_DSTransferSet

self

)

Get the All Changes Reported flag.

Returns

when all changes reported is enabled, false otherwise

Tase2_DSTransferSet_getBlockData()

TASE2_API bool Tase2_DSTransferSet_getBlockData

(

Tase2_DSTransferSet

self

)

Get the block data flag.

Returns

when block data is enabled, false otherwise

Tase2_DSTransferSet_getBufferTime()

TASE2_API int32_t Tase2_DSTransferSet_getBufferTime

(

Tase2_DSTransferSet

self

)

Get the buffer time (wait time before report is sent)

Returns

the buffer time in seconds (TimeIntervalS)

Tase2_DSTransferSet_getCritical()

TASE2_API bool Tase2_DSTransferSet_getCritical

(

Tase2_DSTransferSet

self

)

Get the critical flag (report acknowledge by client required when set)

Returns

when critical reports are enabled, false otherwise

Tase2_DSTransferSet_getDataSetName()

TASE2_API char * Tase2_DSTransferSet_getDataSetName

(

Tase2_DSTransferSet

self

)

Get the data set name of the transfer set.

The data set name is a string with the format:

domain_name/data_set_name for domain scope data sets

or

data_set_name for VCC scope data sets

NOTE: The returned value has to be released by the caller!

Returns

a copy of the data set name or NULL

Tase2_DSTransferSet_getDsConditionsRequested()

TASE2_API uint32_t Tase2_DSTransferSet_getDsConditionsRequested

(

Tase2_DSTransferSet

self

)

Get the DSConditions to trigger a report transmission.

Returns

the DSConditions value (DS conditions (DS transfer sets))

Tase2_DSTransferSet_getEventCodeRequested()

TASE2_API int16_t Tase2_DSTransferSet_getEventCodeRequested

(

Tase2_DSTransferSet

self

)

Get the event code requested value.

Returns

event code requested value

Tase2_DSTransferSet_getIntegrityCheck()

TASE2_API int32_t Tase2_DSTransferSet_getIntegrityCheck

(

Tase2_DSTransferSet

self

)

Get the time interval for integrity checks (Integrity Check)

When the integrity check condition is used an integrity report is sent after the timeout elapsed containing the whole data set

Returns

the integrity check value in milliseconds (TimeIntervalL32)

Tase2_DSTransferSet_getInterval()

TASE2_API int32_t Tase2_DSTransferSet_getInterval

(

Tase2_DSTransferSet

self

)

Get the interval value (time interval between server reports)

Returns

the interval value in milliseconds (TimeIntervalL32)

Tase2_DSTransferSet_getRBE()

TASE2_API bool Tase2_DSTransferSet_getRBE

(

Tase2_DSTransferSet

self

)

Get the RBE (report by exception) flag.

Returns

when RBE is enabled, false otherwise

Tase2_DSTransferSet_getStartTime()

TASE2_API int32_t Tase2_DSTransferSet_getStartTime

(

Tase2_DSTransferSet

self

)

Get the start time for condition monitoring of the transfer set.

Returns

start time in seconds sonce epoch (GMTBasedS)

Tase2_DSTransferSet_getStatus()

TASE2_API bool Tase2_DSTransferSet_getStatus

(

Tase2_DSTransferSet

self

)

Get the status of the DS transfer set.

Returns

true, when the transfer set is enabled, false otherwise

Tase2_DSTransferSet_getTLE()

TASE2_API int32_t Tase2_DSTransferSet_getTLE

(

Tase2_DSTransferSet

self

)

Get the TLE (time limit for execution) value.

Returns

the TLE value in seconds (TimeIntervalS)

Tase2_IndicationPoint_getName()

TASE2_API const char * Tase2_IndicationPoint_getName

(

Tase2_IndicationPoint

self

)

Get the relative name of the indication point.

Returns

name (only valid during the lifetime of the Tase2_IndicationPoint object)

Tase2_IndicationPoint_getQualityClass()

TASE2_API Tase2_QualityClass Tase2_IndicationPoint_getQualityClass

(

Tase2_IndicationPoint

self

)

Get the quality class of the indication point.

Returns

TASE2_QUALITY when the indication point has a quality indication, otherwise TASE2_NO_QUALITY

Tase2_IndicationPoint_getTimestampClass()

TASE2_API Tase2_TimeStampClass Tase2_IndicationPoint_getTimestampClass

(

Tase2_IndicationPoint

self

)

Get the timestamp class of the indication point.

Returns

the timestamp class

Tase2_IndicationPoint_getType()

TASE2_API Tase2_IndicationPointType Tase2_IndicationPoint_getType

(

Tase2_IndicationPoint

self

)

Get the indication point type.

Returns

the indication point type (REAL, DISCRETE, STATE, STATE_SUPPLEMENTAL)

Tase2_IndicationPoint_hasCOV()

TASE2_API bool Tase2_IndicationPoint_hasCOV

(

Tase2_IndicationPoint

self

)

Check if the indication point has a counter of value change (COV) field.

Returns

true, when a COV field is present, otherwise false

Tase2_IndicationPoint_setCOV()

TASE2_API void Tase2_IndicationPoint_setCOV	(	Tase2_IndicationPoint	self,
		uint16_t	cov )

Set the COV (cointer of value changes) of the data point.

NOTE: This has no effect when the data point type has no COV.

Parameters

cov	the COV value

Tase2_IndicationPoint_setDiscrete()

TASE2_API void Tase2_IndicationPoint_setDiscrete	(	Tase2_IndicationPoint	self,
		int32_t	value )

Set the value of a data point of type TASE2_IND_POINT_TYPE_DISCRETE.

Parameters

value

new value

Tase2_IndicationPoint_setDiscreteQ()

TASE2_API void Tase2_IndicationPoint_setDiscreteQ	(	Tase2_IndicationPoint	self,
		int32_t	value,
		Tase2_DataFlags	flags )

Set the value, and quality of a data point of type TASE2_IND_POINT_TYPE_DISCRETE.

Parameters

value	new value
flags	the quality flags

Tase2_IndicationPoint_setDiscreteQTimeStamp()

TASE2_API void Tase2_IndicationPoint_setDiscreteQTimeStamp	(	Tase2_IndicationPoint	self,
		int32_t	value,
		Tase2_DataFlags	flags,
		uint64_t	timestamp )

Set the value, quality, and timestamp of a data point of type TASE2_IND_POINT_TYPE_DISCRETE.

Parameters

value	new value
flags	the quality flags \paran timestamp the time stamp in ms since Epoch

Tase2_IndicationPoint_setQuality()

TASE2_API void Tase2_IndicationPoint_setQuality	(	Tase2_IndicationPoint	self,
		Tase2_DataFlags	flags )

Sets the quality flags of a data point.

NOTE: for STATE type indication points the quality can also be set with the Tase2_IndicationPoint_setState or Tase2_IndicationPoint_setStateTimeStamp functions.

Parameters

flags

the quality flags values

Tase2_IndicationPoint_setReal()

TASE2_API void Tase2_IndicationPoint_setReal	(	Tase2_IndicationPoint	self,
		float	value )

Set the value of a data point of type TASE2_IND_POINT_TYPE_REAL.

Parameters

value

new value

Tase2_IndicationPoint_setRealQ()

TASE2_API void Tase2_IndicationPoint_setRealQ	(	Tase2_IndicationPoint	self,
		float	value,
		Tase2_DataFlags	flags )

Set the value, and quality of a data point of type TASE2_IND_POINT_TYPE_REAL.

Parameters

value	new value
flags	the quality flags

Tase2_IndicationPoint_setRealQTimeStamp()

TASE2_API void Tase2_IndicationPoint_setRealQTimeStamp	(	Tase2_IndicationPoint	self,
		float	value,
		Tase2_DataFlags	flags,
		uint64_t	timestamp )

Set the value, quality, and timestamp of a data point of type TASE2_IND_POINT_TYPE_REAL.

Parameters

value	new value
flags	the quality flags \paran timestamp the time stamp in ms since Epoch

Tase2_IndicationPoint_setState()

TASE2_API void Tase2_IndicationPoint_setState	(	Tase2_IndicationPoint	self,
		Tase2_DataState	value )

Set the state and quality of a TASE2_IND_POINT_TYPE_STATE type indication point.

NOTE: the Tase2_DataState type represents the state and the quality.

Parameters

value

the state (and quality) value

Tase2_IndicationPoint_setStateSupplemental()

TASE2_API void Tase2_IndicationPoint_setStateSupplemental	(	Tase2_IndicationPoint	self,
		Tase2_DataStateSupplemental	value )

Set the value of a data point of type TASE2_IND_POINT_TYPE_STATE_SUPPLEMENTAL.

Parameters

value

new value

Tase2_IndicationPoint_setStateSupplementalQ()

TASE2_API void Tase2_IndicationPoint_setStateSupplementalQ	(	Tase2_IndicationPoint	self,
		Tase2_DataStateSupplemental	value,
		Tase2_DataFlags	flags )

Set the value, and quality of a data point of type TASE2_IND_POINT_TYPE_STATE_SUPPLEMENTAL.

Parameters

value	new value
flags	the quality flags

Tase2_IndicationPoint_setStateSupplementalQTimeStamp()

TASE2_API void Tase2_IndicationPoint_setStateSupplementalQTimeStamp	(	Tase2_IndicationPoint	self,
		Tase2_DataStateSupplemental	value,
		Tase2_DataFlags	flags,
		uint64_t	timestamp )

Set the value, quality, and timestamp of a data point of type TASE2_IND_POINT_TYPE_STATE_SUPPLEMENTAL.

Parameters

value	new value
flags	the quality flags \paran timestamp the time stamp in ms since Epoch

Tase2_IndicationPoint_setStateTimeStamp()

TASE2_API void Tase2_IndicationPoint_setStateTimeStamp	(	Tase2_IndicationPoint	self,
		Tase2_DataState	value,
		uint64_t	timestamp )

Set the state, quality, and timestamp of a TASE2_IND_POINT_TYPE_STATE type indication point.

Parameters

value

the state (and quality) value

Tase2_IndicationPoint_setTimeStamp()

TASE2_API void Tase2_IndicationPoint_setTimeStamp	(	Tase2_IndicationPoint	self,
		uint64_t	timestamp )

Sets the timestamp of a data point.

NOTE: This has no effect when the data point type has no timestamp.

Parameters

timestamp

the time stamp in ms since Epoch

Tase2_ProtectionEquipment_getName()

TASE2_API const char * Tase2_ProtectionEquipment_getName

(

Tase2_ProtectionEquipment

self

)

Get the name of the protection equipment.

Tase2_ProtectionEquipment_setEventTime()

TASE2_API void Tase2_ProtectionEquipment_setEventTime	(	Tase2_ProtectionEquipment	self,
		uint64_t	eventTime )

Set the event time (timestamp when the event started) of a protection equipment event.

Parameters

eventTime

the time stamp in ms since Epoch

Tase2_ProtectionEquipment_setOperatingTime()

TASE2_API void Tase2_ProtectionEquipment_setOperatingTime	(	Tase2_ProtectionEquipment	self,
		int32_t	operatingTime )

Set the operating time (duration) of a protection equipment event.

Parameters

operatingTime

the operating time in ms

Tase2_ProtectionEquipment_setPackedEvent()

TASE2_API void Tase2_ProtectionEquipment_setPackedEvent	(	Tase2_ProtectionEquipment	self,
		Tase2_EventFlags	packedEvent )

Set the event flags of a packed event.

Parameters

packedEvent

the event flags

Tase2_ProtectionEquipment_setPackedEventFlags()

TASE2_API void Tase2_ProtectionEquipment_setPackedEventFlags	(	Tase2_ProtectionEquipment	self,
		Tase2_PackedEventFlags	flags )

Set the quality flags of a packed event.

Parameters

flags

the quality flags

Tase2_ProtectionEquipment_setSingleEventFlags()

TASE2_API void Tase2_ProtectionEquipment_setSingleEventFlags	(	Tase2_ProtectionEquipment	self,
		Tase2_SingleEventFlags	eventFlags )

Set the single event flags (value and quality)

Parameters

eventFlags

the single event flags

Tase2_TransferSet_getDomain()

TASE2_API Tase2_Domain Tase2_TransferSet_getDomain

(

Tase2_TransferSet

self

)

Get the TASE.2 domain of the transfer set.

Returns

the domain object of the transfer set

Tase2_TransferSet_getName()

TASE2_API const char * Tase2_TransferSet_getName

(

Tase2_TransferSet

self

)

Get the name of the transfer set.

Returns

the name string (only valid as long the the transfer set object exists)