iec61850_dynamic_model.h

Go to the documentation of this file.

/*
 *  dynamic_model.h
 *
 *  Copyright 2014 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 DYNAMIC_MODEL_H_
#define DYNAMIC_MODEL_H_
 
#include "iec61850_model.h"
#include "iec61850_cdc.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
LIB61850_API IedModel*
IedModel_create(const char* name);
 
LIB61850_API void
IedModel_setIedNameForDynamicModel(IedModel* self, const char* name);
 
LIB61850_API void
IedModel_destroy(IedModel* model);
 
LIB61850_API LogicalDevice*
LogicalDevice_create(const char* name, IedModel* parent);
 
LIB61850_API LogicalDevice*
LogicalDevice_createEx(const char* inst, IedModel* parent, const char* ldName);
 
LIB61850_API LogicalNode*
LogicalNode_create(const char* name, LogicalDevice* parent);
 
LIB61850_API DataObject*
DataObject_create(const char* name, ModelNode* parent, int arrayElements);
 
LIB61850_API DataAttribute*
DataAttribute_create(const char* name, ModelNode* parent, DataAttributeType type, FunctionalConstraint fc,
        uint8_t triggerOptions, int arrayElements, uint32_t sAddr);
 
LIB61850_API DataAttributeType
DataAttribute_getType(DataAttribute* self);
 
LIB61850_API FunctionalConstraint
DataAttribute_getFC(DataAttribute* self);
 
LIB61850_API uint8_t
DataAttribute_getTrgOps(DataAttribute* self);
 
LIB61850_API void
DataAttribute_setValue(DataAttribute* self, MmsValue* value);
 
LIB61850_API ReportControlBlock*
ReportControlBlock_create(const char* name, LogicalNode* parent, const char* rptId, bool isBuffered, const char*
        dataSetName, uint32_t confRef, uint8_t trgOps, uint8_t options, uint32_t bufTm, uint32_t intgPd);
 
LIB61850_API void
ReportControlBlock_setPreconfiguredClient(ReportControlBlock* self, uint8_t clientType, const uint8_t* clientAddress);
 
LIB61850_API const char*
ReportControlBlock_getName(ReportControlBlock* self);
 
LIB61850_API bool
ReportControlBlock_isBuffered(ReportControlBlock* self);
 
LIB61850_API LogicalNode*
ReportControlBlock_getParent(ReportControlBlock* self);
 
LIB61850_API char*
ReportControlBlock_getRptID(ReportControlBlock* self);
 
LIB61850_API bool
ReportControlBlock_getRptEna(ReportControlBlock* self);
 
LIB61850_API char*
ReportControlBlock_getDataSet(ReportControlBlock* self);
 
LIB61850_API uint32_t
ReportControlBlock_getConfRev(ReportControlBlock* self);
 
LIB61850_API uint32_t
ReportControlBlock_getOptFlds(ReportControlBlock* self);
 
LIB61850_API uint32_t
ReportControlBlock_getBufTm(ReportControlBlock* self);
 
LIB61850_API uint16_t
ReportControlBlock_getSqNum(ReportControlBlock* self);
 
LIB61850_API uint32_t
ReportControlBlock_getTrgOps(ReportControlBlock* self);
 
LIB61850_API uint32_t
ReportControlBlock_getIntgPd(ReportControlBlock* self);
 
LIB61850_API bool
ReportControlBlock_getGI(ReportControlBlock* self);
 
LIB61850_API bool
ReportControlBlock_getPurgeBuf(ReportControlBlock* self);
 
LIB61850_API MmsValue*
ReportControlBlock_getEntryId(ReportControlBlock* self);
 
LIB61850_API uint64_t
ReportControlBlock_getTimeofEntry(ReportControlBlock* self);
 
LIB61850_API int16_t
ReportControlBlock_getResvTms(ReportControlBlock* self);
 
LIB61850_API bool
ReportControlBlock_getResv(ReportControlBlock* self);
 
LIB61850_API MmsValue*
ReportControlBlock_getOwner(ReportControlBlock* self);
 
LIB61850_API LogControlBlock*
LogControlBlock_create(const char* name, LogicalNode* parent, const char* dataSetName, const char* logRef, uint8_t trgOps,
        uint32_t intgPd, bool logEna, bool reasonCode);
 
LIB61850_API const char*
LogControlBlock_getName(LogControlBlock* self);
 
LIB61850_API LogicalNode*
LogControlBlock_getParent(LogControlBlock* self);
 
LIB61850_API Log*
Log_create(const char* name, LogicalNode* parent);
 
LIB61850_API SettingGroupControlBlock*
SettingGroupControlBlock_create(LogicalNode* parent, uint8_t actSG, uint8_t numOfSGs);
 
LIB61850_API GSEControlBlock*
GSEControlBlock_create(const char* name, LogicalNode* parent, const char* appId, const char* dataSet, uint32_t confRev,
        bool fixedOffs, int minTime, int maxTime);
 
LIB61850_API SVControlBlock*
SVControlBlock_create(const char* name, LogicalNode* parent, const char* svID, const char* dataSet, uint32_t confRev, uint8_t smpMod,
        uint16_t smpRate, uint8_t optFlds, bool isUnicast);
 
LIB61850_API void
SVControlBlock_addPhyComAddress(SVControlBlock* self, PhyComAddress* phyComAddress);
 
LIB61850_API void
GSEControlBlock_addPhyComAddress(GSEControlBlock* self, PhyComAddress* phyComAddress);
 
LIB61850_API PhyComAddress*
PhyComAddress_create(uint8_t vlanPriority, uint16_t vlanId, uint16_t appId, uint8_t dstAddress[]);
 
LIB61850_API DataSet*
DataSet_create(const char* name, LogicalNode* parent);
 
LIB61850_API const char*
DataSet_getName(DataSet* self);
 
LIB61850_API int
DataSet_getSize(DataSet* self);
 
LIB61850_API DataSetEntry*
DataSet_getFirstEntry(DataSet* self);
 
LIB61850_API DataSetEntry*
DataSetEntry_getNext(DataSetEntry* self);
 
LIB61850_API DataSetEntry*
DataSetEntry_create(DataSet* dataSet, const char* variable, int index, const char* component);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DYNAMIC_MODEL_H_ */