IEC61850.Common Namespace Reference

Classes
class	LibIEC61850
class	MmsValue
	This class is used to hold MMS data values of different types. More...
class	MmsValueException
class	MmsVariableSpecification
	MMS variable specification. This class is used to represent an MMS variable type definition. More...
class	ObjectReference
	Object reference. Helper function to handle object reference strings.
class	PhyComAddress
class	Quality
	The quality of a data object. More...
class	Timestamp
	Timestamp (represents IEC 61850 timestamps e.g. "t" attribute) More...

Enumerations
enum	ControlModel {   STATUS_ONLY = 0 , DIRECT_NORMAL = 1 , SBO_NORMAL = 2 , DIRECT_ENHANCED = 3 ,   SBO_ENHANCED = 4 }
	Control model. More...
enum	OrCat {   NOT_SUPPORTED = 0 , BAY_CONTROL = 1 , STATION_CONTROL = 2 , REMOTE_CONTROL = 3 ,   AUTOMATIC_BAY = 4 , AUTOMATIC_STATION = 5 , AUTOMATIC_REMOTE = 6 , MAINTENANCE = 7 ,   PROCESS = 8 }
	Originator category. More...
enum	Iec61850Edition : byte { EDITION_1 = 0 , EDITION_2 = 1 , EDITION_2_1 = 2 }
enum	MmsDataAccessError {   NO_RESPONSE = -2 , SUCCESS = -1 , OBJECT_INVALIDATED = 0 , HARDWARE_FAULT = 1 ,   TEMPORARILY_UNAVAILABLE = 2 , OBJECT_ACCESS_DENIED = 3 , OBJECT_UNDEFINED = 4 , INVALID_ADDRESS = 5 ,   TYPE_UNSUPPORTED = 6 , TYPE_INCONSISTENT = 7 , OBJECT_ATTRIBUTE_INCONSISTENT = 8 , OBJECT_ACCESS_UNSUPPORTED = 9 ,   OBJECT_NONE_EXISTENT = 10 , OBJECT_VALUE_INVALID = 11 , UNKNOWN = 12 }
	MMS data access error for MmsValue type MMS_DATA_ACCESS_ERROR. More...
enum	TriggerOptions {   NONE = 0 , DATA_CHANGED = 1 , QUALITY_CHANGED = 2 , DATA_UPDATE = 4 ,   INTEGRITY = 8 , GI = 16 , TRG_OPT_TRANSIENT = 128 }
enum	SmpMod { SAMPLES_PER_PERIOD = 0 , SAMPLES_PER_SECOND = 1 , SECONDS_PER_SAMPLE = 2 }
	SmpMod values. More...
enum	SVOptions {   NONE = 0 , REFRESH_TIME = 1 , SAMPLE_SYNC = 2 , SAMPLE_RATE = 4 ,   DATA_SET = 8 , SECURITY = 16 , ALL = 31 }
	Values for Sampled Values (SV) OptFlds. More...
enum	ReportOptions {   NONE = 0 , SEQ_NUM = 1 , TIME_STAMP = 2 , REASON_FOR_INCLUSION = 4 ,   DATA_SET = 8 , DATA_REFERENCE = 16 , BUFFER_OVERFLOW = 32 , ENTRY_ID = 64 ,   CONF_REV = 128 , SEGMENTATION = 256 , ALL }
enum	Validity { GOOD = 0 , RESERVED = 1 , INVALID = 2 , QUESTIONABLE = 3 }
enum	ACSIClass {   ACSI_CLASS_DATA_OBJECT , ACSI_CLASS_DATA_SET , ACSI_CLASS_BRCB , ACSI_CLASS_URCB ,   ACSI_CLASS_LCB , ACSI_CLASS_LOG , ACSI_CLASS_SGCB , ACSI_CLASS_GoCB ,   ACSI_CLASS_GsCB , ACSI_CLASS_MSVCB , ACSI_CLASS_USVCB }
enum	FunctionalConstraint {   ST = 0 , MX = 1 , SP = 2 , SV = 3 ,   CF = 4 , DC = 5 , SG = 6 , SE = 7 ,   SR = 8 , OR = 9 , BL = 10 , EX = 11 ,   CO = 12 , US = 13 , MS = 14 , RP = 15 ,   BR = 16 , LG = 17 , ALL = 99 , NONE = -1 }
enum	ControlLastApplError { NO_ERROR = 0 , UNKNOWN = 1 , TIMEOUT_TEST = 2 , OPERATOR_TEST = 3 }
	Definition for LastAppError error type for control models Used in LastApplError and CommandTermination messages. More...
enum	ControlAddCause {   ADD_CAUSE_UNKNOWN = 0 , ADD_CAUSE_NOT_SUPPORTED = 1 , ADD_CAUSE_BLOCKED_BY_SWITCHING_HIERARCHY = 2 , ADD_CAUSE_SELECT_FAILED = 3 ,   ADD_CAUSE_INVALID_POSITION = 4 , ADD_CAUSE_POSITION_REACHED = 5 , ADD_CAUSE_PARAMETER_CHANGE_IN_EXECUTION = 6 , ADD_CAUSE_STEP_LIMIT = 7 ,   ADD_CAUSE_BLOCKED_BY_MODE = 8 , ADD_CAUSE_BLOCKED_BY_PROCESS = 9 , ADD_CAUSE_BLOCKED_BY_INTERLOCKING = 10 , ADD_CAUSE_BLOCKED_BY_SYNCHROCHECK = 11 ,   ADD_CAUSE_COMMAND_ALREADY_IN_EXECUTION = 12 , ADD_CAUSE_BLOCKED_BY_HEALTH = 13 , ADD_CAUSE_1_OF_N_CONTROL = 14 , ADD_CAUSE_ABORTION_BY_CANCEL = 15 ,   ADD_CAUSE_TIME_LIMIT_OVER = 16 , ADD_CAUSE_ABORTION_BY_TRIP = 17 , ADD_CAUSE_OBJECT_NOT_SELECTED = 18 , ADD_CAUSE_OBJECT_ALREADY_SELECTED = 19 ,   ADD_CAUSE_NO_ACCESS_AUTHORITY = 20 , ADD_CAUSE_ENDED_WITH_OVERSHOOT = 21 , ADD_CAUSE_ABORTION_DUE_TO_DEVIATION = 22 , ADD_CAUSE_ABORTION_BY_COMMUNICATION_LOSS = 23 ,   ADD_CAUSE_ABORTION_BY_COMMAND = 24 , ADD_CAUSE_NONE = 25 , ADD_CAUSE_INCONSISTENT_PARAMETERS = 26 , ADD_CAUSE_LOCKED_BY_OTHER_CLIENT = 27 }
	AddCause - additional cause information for control model errors Used in LastApplError and CommandTermination messages. More...
enum	MmsType {   MMS_ARRAY = 0 , MMS_STRUCTURE = 1 , MMS_BOOLEAN = 2 , MMS_BIT_STRING = 3 ,   MMS_INTEGER = 4 , MMS_UNSIGNED = 5 , MMS_FLOAT = 6 , MMS_OCTET_STRING = 7 ,   MMS_VISIBLE_STRING = 8 , MMS_GENERALIZED_TIME = 9 , MMS_BINARY_TIME = 10 , MMS_BCD = 11 ,   MMS_OBJ_ID = 12 , MMS_STRING = 13 , MMS_UTC_TIME = 14 , MMS_DATA_ACCESS_ERROR = 15 }

Enumeration Type Documentation

ACSIClass

enum IEC61850.Common.ACSIClass

Enumerator
ACSI_CLASS_DATA_OBJECT	data objects
ACSI_CLASS_DATA_SET	data sets (container for multiple data objects)
ACSI_CLASS_BRCB	buffered report control blocks
ACSI_CLASS_URCB	unbuffered report control blocks
ACSI_CLASS_LCB	log control blocks
ACSI_CLASS_LOG	logs (journals)
ACSI_CLASS_SGCB	setting group control blocks
ACSI_CLASS_GoCB	GOOSE control blocks
ACSI_CLASS_GsCB	GSE control blocks
ACSI_CLASS_MSVCB	multicast sampled values control blocks
ACSI_CLASS_USVCB	unicast sampled values control blocks

ControlAddCause

enum IEC61850.Common.ControlAddCause

AddCause - additional cause information for control model errors Used in LastApplError and CommandTermination messages.

Enumerator
ADD_CAUSE_UNKNOWN	0
ADD_CAUSE_NOT_SUPPORTED	1
ADD_CAUSE_BLOCKED_BY_SWITCHING_HIERARCHY	2
ADD_CAUSE_SELECT_FAILED	3
ADD_CAUSE_INVALID_POSITION	4
ADD_CAUSE_POSITION_REACHED	5
ADD_CAUSE_PARAMETER_CHANGE_IN_EXECUTION	6
ADD_CAUSE_STEP_LIMIT	7
ADD_CAUSE_BLOCKED_BY_MODE	8
ADD_CAUSE_BLOCKED_BY_PROCESS	9
ADD_CAUSE_BLOCKED_BY_INTERLOCKING	10
ADD_CAUSE_BLOCKED_BY_SYNCHROCHECK	11
ADD_CAUSE_COMMAND_ALREADY_IN_EXECUTION	12
ADD_CAUSE_BLOCKED_BY_HEALTH	13
ADD_CAUSE_1_OF_N_CONTROL	14
ADD_CAUSE_ABORTION_BY_CANCEL	15
ADD_CAUSE_TIME_LIMIT_OVER	16
ADD_CAUSE_ABORTION_BY_TRIP	17
ADD_CAUSE_OBJECT_NOT_SELECTED	18
ADD_CAUSE_OBJECT_ALREADY_SELECTED	19
ADD_CAUSE_NO_ACCESS_AUTHORITY	20
ADD_CAUSE_ENDED_WITH_OVERSHOOT	21
ADD_CAUSE_ABORTION_DUE_TO_DEVIATION	22
ADD_CAUSE_ABORTION_BY_COMMUNICATION_LOSS	23
ADD_CAUSE_ABORTION_BY_COMMAND	24
ADD_CAUSE_NONE	25
ADD_CAUSE_INCONSISTENT_PARAMETERS	26
ADD_CAUSE_LOCKED_BY_OTHER_CLIENT	27

ControlLastApplError

enum IEC61850.Common.ControlLastApplError

Definition for LastAppError error type for control models Used in LastApplError and CommandTermination messages.

Enumerator
NO_ERROR	0
UNKNOWN	1
TIMEOUT_TEST	2
OPERATOR_TEST	3

ControlModel

enum IEC61850.Common.ControlModel

Control model.

Enumerator
STATUS_ONLY	0	status only
DIRECT_NORMAL	1	direct with normal security
SBO_NORMAL	2	select before operate (SBO) with normal security
DIRECT_ENHANCED	3	direct with enhanced security
SBO_ENHANCED	4	select before operate (SBO) with enhanced security

FunctionalConstraint

enum IEC61850.Common.FunctionalConstraint

Enumerator
ST	0	Status information
MX	1	Measurands - analog values
SP	2	Setpoint
SV	3	Substitution
CF	4	Configuration
DC	5	Description
SG	6	Setting group
SE	7	Setting group editable
SR	8	Service response / Service tracking
OR	9	Operate received
BL	10	Blocking
EX	11	Extended definition
CO	12	Control
US	13	Unicast SV
MS	14	Multicast SV
RP	15	Unbuffered report
BR	16	Buffered report
LG	17	Log control blocks
ALL	99	All FCs - wildcard value
NONE	-1

Iec61850Edition

enum IEC61850.Common.Iec61850Edition : byte

Enumerator
EDITION_1	0
EDITION_2	1
EDITION_2_1	2

MmsDataAccessError

enum IEC61850.Common.MmsDataAccessError

MMS data access error for MmsValue type MMS_DATA_ACCESS_ERROR.

Enumerator
NO_RESPONSE	-2
SUCCESS	-1
OBJECT_INVALIDATED	0
HARDWARE_FAULT	1
TEMPORARILY_UNAVAILABLE	2
OBJECT_ACCESS_DENIED	3
OBJECT_UNDEFINED	4
INVALID_ADDRESS	5
TYPE_UNSUPPORTED	6
TYPE_INCONSISTENT	7
OBJECT_ATTRIBUTE_INCONSISTENT	8
OBJECT_ACCESS_UNSUPPORTED	9
OBJECT_NONE_EXISTENT	10
OBJECT_VALUE_INVALID	11
UNKNOWN	12

MmsType

enum IEC61850.Common.MmsType

Enumerator
MMS_ARRAY	0	array type (multiple elements of the same type)
MMS_STRUCTURE	1	structure type (multiple elements of different types)
MMS_BOOLEAN	2	boolean
MMS_BIT_STRING	3	bit string
MMS_INTEGER	4	signed integer
MMS_UNSIGNED	5	unsigned integer
MMS_FLOAT	6	floating point value (32 or 64 bit)
MMS_OCTET_STRING	7	octet string
MMS_VISIBLE_STRING	8	visible string - ANSI string
MMS_GENERALIZED_TIME	9	Generalized time
MMS_BINARY_TIME	10	Binary time
MMS_BCD	11	Binary coded decimal (BCD) - not used
MMS_OBJ_ID	12	object ID - not used
MMS_STRING	13	Unicode string
MMS_UTC_TIME	14	UTC time
MMS_DATA_ACCESS_ERROR	15	will be returned in case of an error (contains error code)

OrCat

enum IEC61850.Common.OrCat

Originator category.

Enumerator
NOT_SUPPORTED	0	Not supported - should not be used
BAY_CONTROL	1	Control operation issued from an operator using a client located at bay level
STATION_CONTROL	2	Control operation issued from an operator using a client located at station level
REMOTE_CONTROL	3	Control operation from a remote operator outside the substation (for example network control center)
AUTOMATIC_BAY	4	Control operation issued from an automatic function at bay level
AUTOMATIC_STATION	5	Control operation issued from an automatic function at station level
AUTOMATIC_REMOTE	6	Control operation issued from a automatic function outside of the substation
MAINTENANCE	7	Control operation issued from a maintenance/service tool
PROCESS	8	Status change occurred without control action (for example external trip of a circuit breaker or failure inside the breaker)

ReportOptions

enum IEC61850.Common.ReportOptions

Enumerator
NONE	0
SEQ_NUM	1
TIME_STAMP	2
REASON_FOR_INCLUSION	4
DATA_SET	8
DATA_REFERENCE	16
BUFFER_OVERFLOW	32
ENTRY_ID	64
CONF_REV	128
SEGMENTATION	256
ALL	SEQ_NUM | TIME_STAMP | REASON_FOR_INCLUSION | DATA_SET | DATA_REFERENCE | BUFFER_OVERFLOW | ENTRY_ID | CONF_REV | SEGMENTATION

SmpMod

enum IEC61850.Common.SmpMod

SmpMod values.

Enumerator
SAMPLES_PER_PERIOD	0
SAMPLES_PER_SECOND	1
SECONDS_PER_SAMPLE	2

SVOptions

enum IEC61850.Common.SVOptions

Values for Sampled Values (SV) OptFlds.

Enumerator
NONE	0
REFRESH_TIME	1
SAMPLE_SYNC	2
SAMPLE_RATE	4
DATA_SET	8
SECURITY	16
ALL	31

TriggerOptions

enum IEC61850.Common.TriggerOptions

Enumerator
NONE	0
DATA_CHANGED	1	send report when value of data changed
QUALITY_CHANGED	2	send report when quality of data changed
DATA_UPDATE	4	send report when data or quality is updated
INTEGRITY	8	periodic transmission of all data set values
GI	16	general interrogation (on client request)
TRG_OPT_TRANSIENT	128	Report will be triggered only on rising edge (transient variable)

Validity

enum IEC61850.Common.Validity

Enumerator
GOOD	0
RESERVED	1
INVALID	2
QUESTIONABLE	3