mms_device_model.h

Go to the documentation of this file.

/*
 *  mms_model.h
 *
 *  Copyright 2013 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 MMS_DEVICE_MODEL_H_
#define MMS_DEVICE_MODEL_H_

#include "libiec61850_common_api.h"

#include "mms_type_spec.h"
#include "mms_common.h"
#include "mms_named_variable_list.h"
#include "logging_api.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    char* deviceName;

    /* MMS VMD scope variables support */
    int namedVariablesCount;
    MmsVariableSpecification** namedVariables;

    /* MMS VMD scope named variables list support */
    LinkedList /*<MmsNamedVariableList>*/ namedVariableLists;

    /* MMS domain support */
    int domainCount;
    MmsDomain** domains;
} MmsDevice;


struct sMmsJournal {
    char* name;
    LogStorage logStorage;
};

typedef struct sMmsJournal* MmsJournal;

/*
 * Server side data structure to hold information of an MMS domain (Logical Device)
 */
struct sMmsDomain {
    char* domainName;
    int namedVariablesCount;
    MmsVariableSpecification** namedVariables;
    LinkedList /*<MmsNamedVariableList>*/ namedVariableLists;
    LinkedList /* <MmsJournal> */ journals;
};

MmsDomain*
MmsDomain_create(char* domainName);

char*
MmsDomain_getName(MmsDomain* self);

void
MmsDomain_addJournal(MmsDomain* self, const char* name);

MmsJournal
MmsDomain_getJournal(MmsDomain* self, const char* name);

void
MmsDomain_destroy(MmsDomain* self);

bool
MmsDomain_addNamedVariableList(MmsDomain* self, MmsNamedVariableList variableList);

void
MmsDomain_deleteNamedVariableList(MmsDomain* self, char* variableListName);

MmsNamedVariableList
MmsDomain_getNamedVariableList(MmsDomain* self, const char* variableListName);

LinkedList
MmsDomain_getNamedVariableLists(MmsDomain* self);

LinkedList
MmsDomain_getNamedVariableListValues(MmsDomain* self, char* variableListName);

LinkedList
MmsDomain_createNamedVariableListValues(MmsDomain* self, char* variableListName);

MmsVariableSpecification*
MmsDomain_getNamedVariable(MmsDomain* self, char* nameId);

MmsDevice*
MmsDevice_create(char* deviceName);

void
MmsDevice_destroy(MmsDevice* self);

MmsDomain*
MmsDevice_getDomain(MmsDevice* self, const char* domainId);

MmsVariableSpecification*
MmsDevice_getNamedVariable(MmsDevice* self, char* variableName);

LinkedList
MmsDevice_getNamedVariableLists(MmsDevice* self);

MmsNamedVariableList
MmsDevice_getNamedVariableListWithName(MmsDevice* self, const char* variableListName);

MmsJournal
MmsJournal_create(const char* name);

void
MmsJournal_destroy(MmsJournal self);

#ifdef __cplusplus
}
#endif

#endif /* MMS_DEVICE_MODEL_H_ */