iec61850_cdc.h

Go to the documentation of this file.

/*
 *  cdc.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 CDC_H_
#define CDC_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define CDC_OPTION_PICS_SUBST (1 << 0)
#define CDC_OPTION_BLK_ENA (1 << 1)
 
#define CDC_OPTION_DESC (1 << 2)
 
#define CDC_OPTION_DESC_UNICODE (1 << 3)
 
#define CDC_OPTION_AC_DLNDA (1 << 4)
 
#define CDC_OPTION_AC_DLN (1 << 5)
 
#define CDC_OPTION_UNIT (1 << 6)
 
#define CDC_OPTION_FROZEN_VALUE (1 << 7)
 
#define CDC_OPTION_ADDR (1 << 8)
#define CDC_OPTION_ADDINFO (1 << 9)
 
#define CDC_OPTION_INST_MAG (1 << 10)
#define CDC_OPTION_RANGE (1 << 11)
 
#define CDC_OPTION_UNIT_MULTIPLIER (1 << 12)
 
#define CDC_OPTION_AC_SCAV (1 << 13)
 
#define CDC_OPTION_MIN (1 << 14)
#define CDC_OPTION_MAX (1 << 15)
 
#define CDC_OPTION_AC_CLC_O (1 << 16)
 
#define CDC_OPTION_RANGE_ANG (1 << 17)
 
#define CDC_OPTION_PHASE_A (1 << 18)
#define CDC_OPTION_PHASE_B (1 << 19)
#define CDC_OPTION_PHASE_C (1 << 20)
 
#define CDC_OPTION_PHASE_NEUT (1 << 21)
 
#define CDC_OPTION_PHASES_ABC (CDC_OPTION_PHASE_A | CDC_OPTION_PHASE_B | CDC_OPTION_PHASE_C)
 
#define CDC_OPTION_PHASES_ALL (CDC_OPTION_PHASE_A | CDC_OPTION_PHASE_B | CDC_OPTION_PHASE_C | CDC_OPTION_PHASE_NEUT)
 
#define CDC_OPTION_STEP_SIZE (1 << 22)
 
#define CDC_OPTION_ANGLE_REF (1 << 23)
 
#define CDC_OPTION_DPL_HWREV (1 << 17)
#define CDC_OPTION_DPL_SWREV (1 << 18)
#define CDC_OPTION_DPL_SERNUM (1 << 19)
#define CDC_OPTION_DPL_MODEL (1 << 20)
#define CDC_OPTION_DPL_LOCATION (1 << 21)
 
#define CDC_OPTION_AC_LN0_M (1 << 24)
#define CDC_OPTION_AC_LN0_EX (1 << 25)
#define CDC_OPTION_AC_DLD_M (1 << 26)
 
#define CDC_CTL_MODEL_NONE 0
#define CDC_CTL_MODEL_DIRECT_NORMAL 1
#define CDC_CTL_MODEL_SBO_NORMAL 2
#define CDC_CTL_MODEL_DIRECT_ENHANCED 3
#define CDC_CTL_MODEL_SBO_ENHANCED 4
 
#define CDC_CTL_MODEL_HAS_CANCEL (1 << 4)
#define CDC_CTL_MODEL_IS_TIME_ACTIVATED (1 << 5)
 
#define CDC_CTL_OPTION_ORIGIN (1 << 6)
#define CDC_CTL_OPTION_CTL_NUM (1 << 7)
#define CDC_CTL_OPTION_ST_SELD (1 << 8)
#define CDC_CTL_OPTION_OP_RCVD (1 << 9)
#define CDC_CTL_OPTION_OP_OK (1 << 10)
#define CDC_CTL_OPTION_T_OP_OK (1 << 11)
#define CDC_CTL_OPTION_SBO_TIMEOUT (1 << 12)
#define CDC_CTL_OPTION_SBO_CLASS (1 << 13)
#define CDC_CTL_OPTION_OPER_TIMEOUT (1 << 14)
 
/****************************************************
 * Constructed Attribute Classes (CAC)
 ***************************************************/
 
LIB61850_API DataAttribute*
CAC_AnalogueValue_create(const char* name, ModelNode* parent, FunctionalConstraint fc, uint8_t triggerOptions,
        bool isIntegerNotFloat);
 
 
LIB61850_API DataAttribute*
CAC_ValWithTrans_create(const char* name, ModelNode* parent, FunctionalConstraint fc, uint8_t triggerOptions, bool hasTransientIndicator);
 
 
LIB61850_API DataAttribute*
CAC_Vector_create(const char* name, ModelNode* parent, uint32_t options, FunctionalConstraint fc, uint8_t triggerOptions);
 
LIB61850_API DataAttribute*
CAC_Point_create(const char* name, ModelNode* parent, FunctionalConstraint fc, uint8_t triggerOptions, bool hasZVal);
 
LIB61850_API DataAttribute*
CAC_ScaledValueConfig_create(const char* name, ModelNode* parent);
 
LIB61850_API DataAttribute*
CAC_Unit_create(const char* name, ModelNode* parent, bool hasMagnitude);
 
LIB61850_API DataAttribute*
CDA_OperBoolean(ModelNode* parent, bool isTImeActivated);
 
/****************************************************
 * Common Data Classes (CDC)
 ***************************************************/
 
LIB61850_API DataObject*
CDC_SPS_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_DPS_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_INS_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_ENS_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_BCR_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_VSS_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_SEC_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_MV_create(const char* dataObjectName, ModelNode* parent, uint32_t options, bool isIntegerNotFloat);
 
LIB61850_API DataObject*
CDC_CMV_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_SAV_create(const char* dataObjectName, ModelNode* parent, uint32_t options, bool isIntegerNotFloat);
 
LIB61850_API DataObject*
CDC_LPL_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_DPL_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_HST_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint16_t maxPts);
 
LIB61850_API DataObject*
CDC_ACD_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_ACT_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_SPG_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_VSG_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_ENG_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_ING_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_ASG_create(const char* dataObjectName, ModelNode* parent, uint32_t options, bool isIntegerNotFloat);
 
LIB61850_API DataObject*
CDC_WYE_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
LIB61850_API DataObject*
CDC_DEL_create(const char* dataObjectName, ModelNode* parent, uint32_t options);
 
/***************************
 * Controls
 ***************************/
 
LIB61850_API DataObject*
CDC_SPC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions);
 
LIB61850_API DataObject*
CDC_DPC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions);
 
LIB61850_API DataObject*
CDC_INC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions);
 
LIB61850_API DataObject*
CDC_ENC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions);
 
LIB61850_API DataObject*
CDC_BSC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions, bool hasTransientIndicator);
 
LIB61850_API DataObject*
CDC_ISC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions, bool hasTransientIndicator);
 
LIB61850_API DataObject*
CDC_APC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions, bool isIntegerNotFloat);
 
LIB61850_API DataObject*
CDC_BAC_create(const char* dataObjectName, ModelNode* parent, uint32_t options, uint32_t controlOptions, bool isIntegerNotFloat);
 
#define CDC_OPTION_61400_MIN_MX_VAL (1 << 10)
 
#define CDC_OPTION_61400_MAX_MX_VAL (1 << 11)
 
#define CDC_OPTION_61400_TOT_AV_VAL (1 << 12)
 
#define CDC_OPTION_61400_SDV_VAL (1 << 13)
 
#define CDC_OPTION_61400_INC_RATE (1 << 14)
 
#define CDC_OPTION_61400_DEC_RATE (1 << 15)
 
#define CDC_OPTION_61400_SP_ACS (1 << 16)
 
#define CDC_OPTION_61400_CHA_PER_RS (1 << 17)
 
#define CDC_OPTION_61400_CM_ACS (1 << 18)
 
#define CDC_OPTION_61400_TM_TOT (1 << 19)
 
#define CDC_OPTION_61400_COUNTING_DAILY (1 << 20)
 
#define CDC_OPTION_61400_COUNTING_MONTHLY (1 << 21)
 
#define CDC_OPTION_61400_COUNTING_YEARLY (1 << 22)
 
#define CDC_OPTION_61400_COUNTING_TOTAL (1 << 23)
 
#define CDC_OPTION_61400_COUNTING_ALL (CDC_OPTION_61400_COUNTING_DAILY | CDC_OPTION_61400_COUNTING_MONTHLY | CDC_OPTION_61400_COUNTING_YEARLY | CDC_OPTION_61400_COUNTING_TOTAL)
 
LIB61850_API DataObject*
CDC_SPV_create(const char* dataObjectName, ModelNode* parent,
        uint32_t options,
        uint32_t controlOptions,
        uint32_t wpOptions,
        bool hasChaManRs);
 
LIB61850_API DataObject*
CDC_STV_create(const char* dataObjectName, ModelNode* parent,
        uint32_t options,
        uint32_t controlOptions,
        uint32_t wpOptions,
        bool hasOldStatus);
 
LIB61850_API DataObject*
CDC_CMD_create(const char* dataObjectName, ModelNode* parent,
        uint32_t options,
        uint32_t controlOptions,
        uint32_t wpOptions,
        bool hasOldStatus,
        bool hasCmTm,
        bool hasCmCt);
 
LIB61850_API DataObject*
CDC_ALM_create(const char* dataObjectName, ModelNode* parent,
        uint32_t options,
        uint32_t controlOptions,
        uint32_t wpOptions,
        bool hasOldStatus);
 
LIB61850_API DataObject*
CDC_CTE_create(const char* dataObjectName, ModelNode* parent,
        uint32_t options,
        uint32_t controlOptions,
        uint32_t wpOptions,
        bool hasHisRs);
 
LIB61850_API DataObject*
CDC_TMS_create(const char* dataObjectName, ModelNode* parent,
        uint32_t options,
        uint32_t controlOptions,
        uint32_t wpOptions,
        bool hasHisRs);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CDC_H_ */