tase2_model.h

Go to the documentation of this file.

/*
 * tase2_model.h
 *
 * This file is part of libtase2
 *
 * Copyright 2014-2019 MZ Automation GmbH
 *
 * All rights reserved.
 *
 */
 
#ifndef PRIVATE_TASE2_TASE2_SERVER_TASE2_MODEL_H_
#define PRIVATE_TASE2_TASE2_SERVER_TASE2_MODEL_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "tase2_common.h"
 
typedef enum {
    TASE2_EDITION_1996_08 = 1,
    TASE2_EDITION_2000_08 = 2
} Tase2_Edition;
 
typedef struct sTase2_DataModel* Tase2_DataModel;
 
typedef struct sTase2_Domain* Tase2_Domain;
 
typedef struct sTase2_DataPoint* Tase2_DataPoint;
 
typedef struct sTase2_IndicationPoint* Tase2_IndicationPoint;
 
typedef struct sTase2_ProtectionEquipment* Tase2_ProtectionEquipment;
 
typedef struct sTase2_DSTransferSet* Tase2_DSTransferSet;
 
struct sTase2_DataModel {
    Tase2_Domain vcc;
    Tase2_Domain domains;
    bool hideSpecialTSVariables;
    Tase2_Edition edition; /* 1 = 1996-08, 2 = 2000-08 */
};
 
 
typedef enum {
    TASE2_POINT_TYPE_INDICATION,
    TASE2_POINT_TYPE_CONTROL,
    TASE2_POINT_TYPE_PROTECTION_EVENT
} Tase2_DataPointType;
 
typedef struct sTase2_DataSet* Tase2_DataSet;
 
typedef struct sTase2_DataSetEntry* Tase2_DataSetEntry;
 
struct sTase2_DataSet {
    char* name;
    Tase2_DataSet sibling;
    Tase2_DataSetEntry entries;
    Tase2_DataSetEntry lastEntry;
};
 
struct sTase2_DataSetEntry {
    Tase2_Domain domain;
    char* variableName;
    Tase2_DataSetEntry sibling;
};
 
typedef struct sTase2_TransferSet* Tase2_TransferSet;
 
typedef struct sTase2_InformationMessage* Tase2_InformationMessage;
 
struct sTase2_InformationMessage {
    int maxSize;
    void* infoBuf;
    Tase2_InformationMessage sibling;
};
 
 
struct sTase2_Domain {
    char* name;
    char* bilateralTableId;
 
    Tase2_DataPoint dataPoints; /* list of data points */
    void* dataPointHashTree; /* list of data points for efficient name lookup */
    int dataPointCount; /* number of registered data points */
    Tase2_DataPoint lastDataPoint; /* last element of list of data points */
    Tase2_DataSet dataSets;
    Tase2_TransferSet transferSets;
    Tase2_InformationMessage informationMessages;
    Tase2_Domain sibling;
};
 
typedef enum {
    TASE2_TS_TYPE_DATA_SET = 0
} Tase2_TransferSetType;
 
 
typedef enum {
    TASE2_DEVICE_CLASS_SBO = 0,
    TASE2_DEVICE_CLASS_DIRECT = 1
} Tase2_DeviceClass;
 
 
 
typedef enum {
    TASE2_CONTROL_TYPE_COMMAND = 0,
    TASE2_CONTROL_TYPE_SETPOINT_REAL = 1,
    TASE2_CONTROL_TYPE_SETPOINT_DESCRETE = 2
} Tase2_ControlPointType;
 
typedef struct sTase2_ControlPoint* Tase2_ControlPoint;
 
TASE2_API const char*
Tase2_DataPoint_getName(Tase2_DataPoint self);
 
TASE2_API Tase2_Domain
Tase2_DataPoint_getDomain(Tase2_DataPoint self);
 
TASE2_API Tase2_PointValue
Tase2_DataPoint_getPointValue(Tase2_DataPoint self);
 
TASE2_API const char*
Tase2_IndicationPoint_getName(Tase2_IndicationPoint self);
 
TASE2_API Tase2_QualityClass
Tase2_IndicationPoint_getQualityClass(Tase2_IndicationPoint self);
 
TASE2_API Tase2_TimeStampClass
Tase2_IndicationPoint_getTimestampClass(Tase2_IndicationPoint self);
 
TASE2_API Tase2_IndicationPointType
Tase2_IndicationPoint_getType(Tase2_IndicationPoint self);
 
TASE2_API bool
Tase2_IndicationPoint_hasCOV(Tase2_IndicationPoint self);
 
TASE2_API void
Tase2_IndicationPoint_setReal(Tase2_IndicationPoint self, float value);
 
TASE2_API void
Tase2_IndicationPoint_setRealQ(Tase2_IndicationPoint self, float value, Tase2_DataFlags flags);
 
TASE2_API void
Tase2_IndicationPoint_setRealQTimeStamp(Tase2_IndicationPoint self, float value, Tase2_DataFlags flags, uint64_t timestamp);
 
TASE2_API void
Tase2_IndicationPoint_setDiscrete(Tase2_IndicationPoint self, int32_t value);
 
TASE2_API void
Tase2_IndicationPoint_setDiscreteQ(Tase2_IndicationPoint self, int32_t value, Tase2_DataFlags flags);
 
TASE2_API void
Tase2_IndicationPoint_setDiscreteQTimeStamp(Tase2_IndicationPoint self, int32_t value, Tase2_DataFlags flags, uint64_t timestamp);
 
TASE2_API void
Tase2_IndicationPoint_setState(Tase2_IndicationPoint self, Tase2_DataState value);
 
TASE2_API void
Tase2_IndicationPoint_setStateTimeStamp(Tase2_IndicationPoint self, Tase2_DataState value, uint64_t timestamp);
 
TASE2_API void
Tase2_IndicationPoint_setStateSupplemental(Tase2_IndicationPoint self, Tase2_DataStateSupplemental value);
 
TASE2_API void
Tase2_IndicationPoint_setStateSupplementalQ(Tase2_IndicationPoint self, Tase2_DataStateSupplemental value, Tase2_DataFlags flags);
 
TASE2_API void
Tase2_IndicationPoint_setStateSupplementalQTimeStamp(Tase2_IndicationPoint self, Tase2_DataStateSupplemental value, Tase2_DataFlags flags, uint64_t timestamp);
 
TASE2_API void
Tase2_IndicationPoint_setQuality(Tase2_IndicationPoint self, Tase2_DataFlags flags);
 
TASE2_API void
Tase2_IndicationPoint_setTimeStamp(Tase2_IndicationPoint self, uint64_t timestamp);
 
TASE2_API void
Tase2_IndicationPoint_setCOV(Tase2_IndicationPoint self, uint16_t cov);
 
 
TASE2_API const char*
Tase2_ProtectionEquipment_getName(Tase2_ProtectionEquipment self);
 
TASE2_API void
Tase2_ProtectionEquipment_setSingleEventFlags(Tase2_ProtectionEquipment self, Tase2_SingleEventFlags eventFlags);
 
TASE2_API void
Tase2_ProtectionEquipment_setPackedEvent(Tase2_ProtectionEquipment self, Tase2_EventFlags packedEvent);
 
TASE2_API void
Tase2_ProtectionEquipment_setPackedEventFlags(Tase2_ProtectionEquipment self, Tase2_PackedEventFlags flags);
 
TASE2_API void
Tase2_ProtectionEquipment_setOperatingTime(Tase2_ProtectionEquipment self, int32_t operatingTime);
 
TASE2_API void
Tase2_ProtectionEquipment_setEventTime(Tase2_ProtectionEquipment self, uint64_t eventTime);
 
TASE2_API const char*
Tase2_ControlPoint_getName(Tase2_ControlPoint self);
 
TASE2_API Tase2_Domain
Tase2_ControlPoint_getDomain(Tase2_ControlPoint self);
 
TASE2_API Tase2_ControlPointType
Tase2_ControlPoint_getType(Tase2_ControlPoint self);
 
TASE2_API Tase2_TagValue
Tase2_ControlPoint_getTag(Tase2_ControlPoint self, char** reason, Tase2_BilateralTable* tagOwner);
 
TASE2_API void
Tase2_ControlPoint_setTag(Tase2_ControlPoint self, Tase2_TagValue value, const char* reason, Tase2_BilateralTable tagOwner);
 
 
TASE2_API Tase2_DataModel
Tase2_DataModel_create();
 
TASE2_API void
Tase2_DataModel_setEdition(Tase2_DataModel self, Tase2_Edition edition);
 
TASE2_API void
Tase2_DataModel_destroy(Tase2_DataModel self);
 
TASE2_API void
Tase2_DataModel_hideSpecialTSVariables(Tase2_DataModel self, bool value);
 
TASE2_API Tase2_Domain
Tase2_DataModel_addDomain(Tase2_DataModel self, const char* domainName);
 
TASE2_API Tase2_Domain
Tase2_DataModel_getDomain(Tase2_DataModel self, const char* domainName);
 
TASE2_API Tase2_Domain
Tase2_DataModel_getVCC(Tase2_DataModel self);
 
TASE2_API const char*
Tase2_Domain_getName(Tase2_Domain self);
 
TASE2_API void
Tase2_Domain_setBilateralTableId(Tase2_Domain self, const char* id);
 
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);
 
TASE2_API Tase2_ControlPoint
Tase2_Domain_addControlPoint(Tase2_Domain self, const char* deviceName, Tase2_ControlPointType pointType, Tase2_DeviceClass deviceClass, bool hasTag, int16_t checkBackId);
 
TASE2_API Tase2_ProtectionEquipment
Tase2_Domain_addProtectionEquipment(Tase2_Domain self, const char* equipmentName, bool isPacked);
 
TASE2_API Tase2_DSTransferSet
Tase2_Domain_addDSTransferSet(Tase2_Domain self, const char* name);
 
TASE2_API Tase2_DataSet
Tase2_Domain_addDataSet(Tase2_Domain self, const char* name);
 
TASE2_API Tase2_DataPoint
Tase2_Domain_getDataPoint(Tase2_Domain self, const char* pointName);
 
TASE2_API void
Tase2_Domain_addInformationMessageObject(Tase2_Domain self, int maxSize);
 
TASE2_API Tase2_DataSetEntry
Tase2_DataSet_addEntry(Tase2_DataSet self, Tase2_Domain domain, const char* variableName);
 
TASE2_API const char*
Tase2_TransferSet_getName(Tase2_TransferSet self);
 
TASE2_API Tase2_Domain
Tase2_TransferSet_getDomain(Tase2_TransferSet self);
 
TASE2_API char*
Tase2_DSTransferSet_getDataSetName(Tase2_DSTransferSet self);
 
TASE2_API int32_t
Tase2_DSTransferSet_getStartTime(Tase2_DSTransferSet self);
 
TASE2_API int32_t
Tase2_DSTransferSet_getInterval(Tase2_DSTransferSet self);
 
TASE2_API int32_t
Tase2_DSTransferSet_getTLE(Tase2_DSTransferSet self);
 
TASE2_API int32_t
Tase2_DSTransferSet_getBufferTime(Tase2_DSTransferSet self);
 
TASE2_API int32_t
Tase2_DSTransferSet_getIntegrityCheck(Tase2_DSTransferSet self);
 
TASE2_API uint32_t
Tase2_DSTransferSet_getDsConditionsRequested(Tase2_DSTransferSet self);
 
TASE2_API bool
Tase2_DSTransferSet_getBlockData(Tase2_DSTransferSet self);
 
TASE2_API bool
Tase2_DSTransferSet_getCritical(Tase2_DSTransferSet self);
 
TASE2_API bool
Tase2_DSTransferSet_getRBE(Tase2_DSTransferSet self);
 
TASE2_API bool
Tase2_DSTransferSet_getAllChangesReported(Tase2_DSTransferSet self);
 
TASE2_API bool
Tase2_DSTransferSet_getStatus(Tase2_DSTransferSet self);
 
TASE2_API int16_t
Tase2_DSTransferSet_getEventCodeRequested(Tase2_DSTransferSet self);
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* PRIVATE_TASE2_TASE2_SERVER_TASE2_MODEL_H_ */