iec61850_model.h

Go to the documentation of this file.

/*
 *  model.h
 *
 *  Copyright 2013-2024 Michael Zillgith
 *
 *  This file is part of libIEC61850.
 *
 *  libIEC61850 is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  libIEC61850 is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with libIEC61850.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */
 
#ifndef MODEL_H_
#define MODEL_H_
 
#include "iec61850_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sModelNode ModelNode;
 
typedef struct sDataAttribute DataAttribute;
 
typedef struct sDataObject DataObject;
 
typedef struct sLogicalNode LogicalNode;
 
typedef struct sLogicalDevice LogicalDevice;
 
typedef struct sIedModel IedModel;
 
typedef struct sDataSet DataSet;
typedef struct sReportControlBlock ReportControlBlock;
 
typedef struct sSettingGroupControlBlock SettingGroupControlBlock;
 
typedef struct sGSEControlBlock GSEControlBlock;
 
typedef struct sSVControlBlock SVControlBlock;
 
typedef struct sLogControlBlock LogControlBlock;
 
typedef struct sLog Log;
 
typedef enum {
        IEC61850_UNKNOWN_TYPE = -1,
        IEC61850_BOOLEAN = 0,/* int */
        IEC61850_INT8 = 1,   /* int8_t */
        IEC61850_INT16 = 2,  /* int16_t */
        IEC61850_INT32 = 3,  /* int32_t */
        IEC61850_INT64 = 4,  /* int64_t */
        IEC61850_INT128 = 5, /* no native mapping! */
        IEC61850_INT8U = 6,  /* uint8_t */
        IEC61850_INT16U = 7, /* uint16_t */
        IEC61850_INT24U = 8, /* uint32_t */
        IEC61850_INT32U = 9, /* uint32_t */
        IEC61850_FLOAT32 = 10, /* float */
        IEC61850_FLOAT64 = 11, /* double */
        IEC61850_ENUMERATED = 12,
        IEC61850_OCTET_STRING_64 = 13,
        IEC61850_OCTET_STRING_6 = 14,
        IEC61850_OCTET_STRING_8 = 15,
        IEC61850_VISIBLE_STRING_32 = 16,
        IEC61850_VISIBLE_STRING_64 = 17,
        IEC61850_VISIBLE_STRING_65 = 18,
        IEC61850_VISIBLE_STRING_129 = 19,
        IEC61850_VISIBLE_STRING_255 = 20,
        IEC61850_UNICODE_STRING_255 = 21,
        IEC61850_TIMESTAMP = 22,
        IEC61850_QUALITY = 23,
        IEC61850_CHECK = 24,
        IEC61850_CODEDENUM = 25,
        IEC61850_GENERIC_BITSTRING = 26,
        IEC61850_CONSTRUCTED = 27,
        IEC61850_ENTRY_TIME = 28,
        IEC61850_PHYCOMADDR = 29,
        IEC61850_CURRENCY = 30,
        IEC61850_OPTFLDS = 31, /* bit-string(10) */
        IEC61850_TRGOPS = 32 /* bit-string(6) */
} DataAttributeType;
 
typedef enum {
    LogicalDeviceModelType,
    LogicalNodeModelType,
    DataObjectModelType,
    DataAttributeModelType
} ModelNodeType;
 
struct sIedModel {
    char* name;
    LogicalDevice* firstChild;
    DataSet* dataSets;
    ReportControlBlock* rcbs;
    GSEControlBlock* gseCBs;
    SVControlBlock* svCBs;
    SettingGroupControlBlock* sgcbs;
    LogControlBlock* lcbs;
    Log* logs;
    void (*initializer) (void);
};
 
struct sLogicalDevice {
    ModelNodeType modelType;
    char* name; /* LD instance */
    ModelNode* parent;
    ModelNode* sibling;
    ModelNode* firstChild;
    char* ldName; /* ldName (when using functional naming) */
};
 
struct sModelNode {
    ModelNodeType modelType;
    char* name;
    ModelNode* parent;
    ModelNode* sibling;
    ModelNode* firstChild;
};
 
struct sLogicalNode {
    ModelNodeType modelType;
    char* name;
    ModelNode* parent;
    ModelNode* sibling;
    ModelNode* firstChild;
};
 
struct sDataObject {
    ModelNodeType modelType;
    char* name;
    ModelNode* parent;
    ModelNode* sibling;
    ModelNode* firstChild;
 
    int elementCount; /* value > 0 if this is an array */
    int arrayIndex; /* value > -1 when this is an array element */
};
 
struct sDataAttribute {
    ModelNodeType modelType;
    char* name;
    ModelNode* parent;
    ModelNode* sibling;
    ModelNode* firstChild;
 
    int elementCount; /* value > 0 if this is an array */
    int arrayIndex; /* value > -1 when this is an array element */
 
    FunctionalConstraint fc;
    DataAttributeType type;
 
    uint8_t triggerOptions; /* TRG_OPT_DATA_CHANGED | TRG_OPT_QUALITY_CHANGED | TRG_OPT_DATA_UPDATE */
 
    MmsValue* mmsValue;
 
    uint32_t sAddr; /* TODO remove in version 2.0 */
};
 
typedef struct sDataSetEntry {
    char* logicalDeviceName; /* logical device instance name */
    bool isLDNameDynamicallyAllocated;
    char* variableName;
    int index;
    char* componentName;
    MmsValue* value;
    struct sDataSetEntry* sibling;
} DataSetEntry;
 
struct sDataSet {
    char* logicalDeviceName; /* logical device instance name */
    char* name; /* eg. MMXU1$dataset1 */
    int elementCount;
    DataSetEntry* fcdas;
    DataSet* sibling;
};
 
struct sReportControlBlock {
    LogicalNode* parent;
    char* name;
    char* rptId;
    bool buffered;
    char* dataSetName; /* pre loaded with relative name in logical node */
 
    uint32_t confRef; /* ConfRef - configuration revision */
    uint8_t trgOps; /* TrgOps - trigger conditions */
    uint8_t options; /* OptFlds */
    uint32_t bufferTime; /* BufTm - time to buffer events until a report is generated */
    uint32_t intPeriod; /* IntgPd - integrity period */
 
    /* type (first byte) and address of the pre-configured client
       type can be one of (0 - no reservation, 4 - IPv4 client, 6 - IPv6 client) */
    uint8_t clientReservation[17];
 
    ReportControlBlock* sibling; /* next control block in list or NULL if this is the last entry
                                  * at runtime reuse as pointer to ReportControl instance!
                                  **/
};
 
struct sLogControlBlock {
    LogicalNode* parent;
 
    char* name;
 
    char* dataSetName;
    char* logRef;        /* object reference to the journal */
 
    uint8_t trgOps;      /* TrgOps - trigger conditions */
    uint32_t intPeriod;  /* IntgPd - integrity period */
 
    bool logEna;         /* enable log by default */
    bool reasonCode;     /* include reason code in log */
 
    LogControlBlock* sibling; /* next control block in list or NULL if this is the last entry */
};
 
struct sLog {
    LogicalNode* parent;
 
    char* name;
 
    Log* sibling; /* next log instance in list or NULL if this is the last entry */
};
 
struct sSettingGroupControlBlock {
    LogicalNode* parent;
 
    uint8_t actSG;       /* value from SCL file */
    uint8_t numOfSGs;    /* value from SCL file */
 
    uint8_t editSG;      /* 0 at power-up */
    bool cnfEdit;        /* false at power-up */
    uint64_t timestamp;
    uint16_t resvTms;
 
    SettingGroupControlBlock* sibling; /* next control block in list or NULL if this is the last entry */
};
 
struct sGSEControlBlock {
    LogicalNode* parent;
    char* name;
    char* appId;
    char* dataSetName; /* pre loaded with relative name in logical node */
    uint32_t confRev;  /* ConfRev - configuration revision */
    bool fixedOffs;    /* fixed offsets */
    PhyComAddress* address; /* GSE communication parameters */
    int minTime; /* optional minTime parameter --> -1 if not present */
    int maxTime; /* optional maxTime parameter --> -1 if not present */
    GSEControlBlock* sibling; /* next control block in list or NULL if this is the last entry */
};
 
struct sSVControlBlock {
    LogicalNode* parent;
    char* name;
 
    char* svId; /* MsvUD/UsvID */
    char* dataSetName; /* pre loaded with relative name in logical node */
 
    uint8_t optFlds;
 
    uint8_t smpMod;
    uint16_t smpRate;
 
    uint32_t confRev;  /* ConfRev - configuration revision */
 
    PhyComAddress* dstAddress; /* SV communication parameters */
 
    bool isUnicast;
 
    int noASDU;
 
    SVControlBlock* sibling; /* next control block in list or NULL if this is the last entry */
};
 
LIB61850_API int
ModelNode_getChildCount(ModelNode* self);
 
LIB61850_API ModelNode*
ModelNode_getChild(ModelNode* self, const char* name);
 
LIB61850_API ModelNode*
ModelNode_getChildWithIdx(ModelNode* self, int idx);
 
LIB61850_API ModelNode*
ModelNode_getChildWithFc(ModelNode* self, const char* name, FunctionalConstraint fc);
 
LIB61850_API char*
ModelNode_getObjectReference(ModelNode* self, char* objectReference);
 
LIB61850_API char*
ModelNode_getObjectReferenceEx(ModelNode* node, char* objectReference, bool withoutIedName);
 
LIB61850_API ModelNodeType
ModelNode_getType(ModelNode* self);
 
LIB61850_API const char*
ModelNode_getName(ModelNode* self);
 
LIB61850_API ModelNode*
ModelNode_getParent(ModelNode* self);
 
LIB61850_API LinkedList
ModelNode_getChildren(ModelNode* self);
 
LIB61850_API void
IedModel_setIedName(IedModel* self, const char* iedName);
 
LIB61850_API ModelNode*
IedModel_getModelNodeByObjectReference(IedModel* self, const char* objectReference);
 
LIB61850_API SVControlBlock*
IedModel_getSVControlBlock(IedModel* self, LogicalNode* parentLN, const char* svcbName);
 
LIB61850_API ModelNode*
IedModel_getModelNodeByShortObjectReference(IedModel* self, const char* objectReference);
 
LIB61850_API ModelNode*
IedModel_getModelNodeByShortAddress(IedModel* self, uint32_t shortAddress);
 
LIB61850_API LogicalDevice*
IedModel_getDeviceByInst(IedModel* self, const char* ldInst);
 
LIB61850_API LogicalDevice*
IedModel_getDeviceByIndex(IedModel* self, int index);
 
 
LIB61850_API LogicalNode*
LogicalDevice_getLogicalNode(LogicalDevice* self, const char* lnName);
 
LIB61850_API SettingGroupControlBlock*
LogicalDevice_getSettingGroupControlBlock(LogicalDevice* self);
 
LIB61850_API void
IedModel_setAttributeValuesToNull(IedModel* self);
 
LIB61850_API LogicalDevice*
IedModel_getDevice(IedModel* self, const char* ldName);
 
LIB61850_API DataSet*
IedModel_lookupDataSet(IedModel* self, const char* dataSetReference);
 
LIB61850_API DataAttribute*
IedModel_lookupDataAttributeByMmsValue(IedModel* self, MmsValue* value);
 
 
LIB61850_API int
IedModel_getLogicalDeviceCount(IedModel* self);
 
LIB61850_API int
LogicalDevice_getLogicalNodeCount(LogicalDevice* self);
 
LIB61850_API ModelNode*
LogicalDevice_getChildByMmsVariableName(LogicalDevice* self, const char* mmsVariableName);
 
LIB61850_API bool
LogicalNode_hasFCData(LogicalNode* self, FunctionalConstraint fc);
 
LIB61850_API bool
LogicalNode_hasBufferedReports(LogicalNode* self);
 
LIB61850_API bool
LogicalNode_hasUnbufferedReports(LogicalNode* self);
 
LIB61850_API DataSet*
LogicalNode_getDataSet(LogicalNode* self, const char* dataSetName);
 
LIB61850_API bool
DataObject_hasFCData(DataObject* self, FunctionalConstraint fc);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* MODEL_H_ */