tase2_model.h File Reference

#include "tase2_common.h"

Go to the source code of this file.

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_Edition { TASE2_EDITION_1996_08 = 1 , TASE2_EDITION_2000_08 = 2 }
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.

Enumeration Type Documentation

Tase2_Edition

enum Tase2_Edition

Enumerator
TASE2_EDITION_1996_08
TASE2_EDITION_2000_08