libiec61850.NET 1.6.1
IEC 61850 .NET API for libiec61850 protocol library
Loading...
Searching...
No Matches
Classes | Enumerations | Functions
IEC61850.Server Namespace Reference

Classes

class  CDC
 The CDC class contains helper functions to create DataObject instances for the most common Common Data Classes. More...
 
class  ClientConnection
 
class  ConfigFileParser
 Config file parser. More...
 
class  ControlAction
 Represents additional context information of the control action that caused the callback invokation. More...
 
class  DataAttribute
 
class  DataObject
 
class  DataSet
 
class  DataSetEntry
 
class  GSEControlBlock
 GOOSE/GSE control block instance for server data model. More...
 
class  IedModel
 Representation of the IED server data model. More...
 
class  IedServer
 This class acts as the entry point for the IEC 61850 client API. It represents a single (MMS) connection to a server. More...
 
class  IedServerConfig
 IedServer configuration object. More...
 
class  LogControlBlock
 Log control block (LCB) instance for server data model. More...
 
class  LogicalDevice
 Logical device. Representation of a logical device (LD) in a data model. More...
 
class  LogicalNode
 Logical node. Representation of a logical node (LN) in a data model. More...
 
class  LogStorage
 
class  MmsGooseControlBlock
 
class  ModelNode
 
class  ReportControlBlock
 Report control block (RCB) instance for server data model. More...
 
class  SettingGroupControlBlock
 Setting group control block for server data model. More...
 
class  SqliteLogStorage
 

Enumerations

enum  AccessPolicy { ACCESS_POLICY_ALLOW = 0 , ACCESS_POLICY_DENY = 1 }
 
enum  DataAttributeType {
  BOOLEAN = 0 , INT8 = 1 , INT16 = 2 , INT32 = 3 ,
  INT64 = 4 , INT128 = 5 , INT8U = 6 , INT16U = 7 ,
  INT24U = 8 , INT32U = 9 , FLOAT32 = 10 , FLOAT64 = 11 ,
  ENUMERATED = 12 , OCTET_STRING_64 = 13 , OCTET_STRING_6 = 14 , OCTET_STRING_8 = 15 ,
  VISIBLE_STRING_32 = 16 , VISIBLE_STRING_64 = 17 , VISIBLE_STRING_65 = 18 , VISIBLE_STRING_129 = 19 ,
  VISIBLE_STRING_255 = 20 , UNICODE_STRING_255 = 21 , TIMESTAMP = 22 , QUALITY = 23 ,
  CHECK = 24 , CODEDENUM = 25 , GENERIC_BITSTRING = 26 , CONSTRUCTED = 27 ,
  ENTRY_TIME = 28 , PHYCOMADDR = 29 , CURRENCY = 30
}
 
enum  ModeValues {
  ON = 1 , BLOCKED = 2 , TEST = 3 , TEST_BLOCKED = 4 ,
  OFF = 5
}
 
enum  HealthValues { OK = 1 , WARNING = 2 , ALARM = 3 }
 
enum  RCBEventType {
  GET_PARAMETER = 0 , SET_PARAMETER = 1 , UNRESERVED = 2 , RESERVED = 3 ,
  ENABLED = 4 , DISABLED = 5 , GI = 6 , PURGEBUF = 7 ,
  OVERFLOW = 8 , REPORT_CREATED = 9
}
 Report control block event types. More...
 
enum  SelectStateChangedReason {
  SELECT_STATE_REASON_SELECTED = 0 , SELECT_STATE_REASON_CANCELED = 1 , SELECT_STATE_REASON_TIMEOUT = 2 , SELECT_STATE_REASON_OPERATED = 3 ,
  SELECT_STATE_REASON_OPERATE_FAILED = 4 , SELECT_STATE_REASON_DISCONNECTED = 5
}
 Reason for the select state change. More...
 
enum  ControlHandlerResult { FAILED = 0 , OK = 1 , WAITING = 2 }
 Return type of ControlHandler and ControlWaitForExecutionHandler. More...
 
enum  CheckHandlerResult {
  ACCEPTED = -1 , HARDWARE_FAULT = 1 , TEMPORARILY_UNAVAILABLE = 2 , OBJECT_ACCESS_DENIED = 3 ,
  OBJECT_UNDEFINED = 4
}
 
enum  ControlBlockAccessType { IEC61850_CB_ACCESS_TYPE_READ , IEC61850_CB_ACCESS_TYPE_WRITE }
 
enum  DataSetOperation {
  DATASET_CREATE , DATASET_DELETE , DATASET_READ , DATASET_WRITE ,
  DATASET_GET_DIRECTORY
}
 
enum  ReportSettings {
  RPT_ID = 1 , BUF_TIME = 2 , DATSET = 4 , TRG_OPS = 8 ,
  OPT_FIELDS = 16 , INTG_PD = 32
}
 RCB properties that are configurable to be writable or read-only. More...
 

Functions

delegate void GoCBEventHandler (MmsGooseControlBlock goCB, int cbEvent, object parameter)
 
delegate void RCBEventHandler (object parameter, ReportControlBlock rcb, ClientConnection con, RCBEventType eventType, string parameterName, MmsDataAccessError serviceError)
 
delegate MmsDataAccessError WriteAccessHandler (DataAttribute dataAttr, MmsValue value, ClientConnection connection, object parameter)
 
delegate void ControlSelectStateChangedHandler (ControlAction action, object parameter, bool isSelected, SelectStateChangedReason reason)
 
delegate ControlHandlerResult ControlWaitForExecutionHandler (ControlAction action, object parameter, MmsValue ctlVal, bool test, bool synchroCheck)
 
delegate ControlHandlerResult ControlHandler (ControlAction action, object parameter, MmsValue ctlVal, bool test)
 
delegate CheckHandlerResult CheckHandler (ControlAction action, object parameter, MmsValue ctlVal, bool test, bool interlockCheck)
 

Enumeration Type Documentation

◆ AccessPolicy

enum IEC61850.Server.AccessPolicy
Enumerator
ACCESS_POLICY_ALLOW 0 
ACCESS_POLICY_DENY 1 

◆ CheckHandlerResult

enum IEC61850.Server.CheckHandlerResult
Enumerator
ACCEPTED -1 

check passed

HARDWARE_FAULT 1 

check failed due to hardware fault

TEMPORARILY_UNAVAILABLE 2 

control is already selected or operated

OBJECT_ACCESS_DENIED 3 

check failed due to access control reason - access denied for this client or state

OBJECT_UNDEFINED 4 

object not visible in this security context ???

◆ ControlBlockAccessType

enum IEC61850.Server.ControlBlockAccessType
Enumerator
IEC61850_CB_ACCESS_TYPE_READ 
IEC61850_CB_ACCESS_TYPE_WRITE 

◆ ControlHandlerResult

enum IEC61850.Server.ControlHandlerResult

Return type of ControlHandler and ControlWaitForExecutionHandler.

Enumerator
FAILED 0 

check or operation failed

OK 1 

check or operation was successful

WAITING 2 

check or operation is in progress

◆ DataAttributeType

enum IEC61850.Server.DataAttributeType
Enumerator
BOOLEAN 0 
INT8 1 
INT16 2 
INT32 3 
INT64 4 
INT128 5 
INT8U 6 
INT16U 7 
INT24U 8 
INT32U 9 
FLOAT32 10 
FLOAT64 11 
ENUMERATED 12 
OCTET_STRING_64 13 
OCTET_STRING_6 14 
OCTET_STRING_8 15 
VISIBLE_STRING_32 16 
VISIBLE_STRING_64 17 
VISIBLE_STRING_65 18 
VISIBLE_STRING_129 19 
VISIBLE_STRING_255 20 
UNICODE_STRING_255 21 
TIMESTAMP 22 
QUALITY 23 
CHECK 24 
CODEDENUM 25 
GENERIC_BITSTRING 26 
CONSTRUCTED 27 
ENTRY_TIME 28 
PHYCOMADDR 29 
CURRENCY 30 

◆ DataSetOperation

enum IEC61850.Server.DataSetOperation
Enumerator
DATASET_CREATE 
DATASET_DELETE 
DATASET_READ 
DATASET_WRITE 
DATASET_GET_DIRECTORY 

◆ HealthValues

enum IEC61850.Server.HealthValues
Enumerator
OK 1 
WARNING 2 
ALARM 3 

◆ ModeValues

enum IEC61850.Server.ModeValues
Enumerator
ON 1 
BLOCKED 2 
TEST 3 
TEST_BLOCKED 4 
OFF 5 

◆ RCBEventType

enum IEC61850.Server.RCBEventType

Report control block event types.

Enumerator
GET_PARAMETER 0 

parameter read by client (not implemented).

SET_PARAMETER 1 

parameter set by client.

UNRESERVED 2 

reservation canceled.

RESERVED 3 

reservation

ENABLED 4 

RCB enabled.

DISABLED 5 

RCB disabled.

GI 6 

GI report triggered.

PURGEBUF 7 

Purge buffer procedure executed.

OVERFLOW 8 

Report buffer overflow.

REPORT_CREATED 9 

A new report was created and inserted into the buffer.

◆ ReportSettings

enum IEC61850.Server.ReportSettings

RCB properties that are configurable to be writable or read-only.

Enumerator
RPT_ID 1 
BUF_TIME 2 
DATSET 4 
TRG_OPS 8 
OPT_FIELDS 16 
INTG_PD 32 

◆ SelectStateChangedReason

enum IEC61850.Server.SelectStateChangedReason

Reason for the select state change.

Enumerator
SELECT_STATE_REASON_SELECTED 0 

Control has been selected.

SELECT_STATE_REASON_CANCELED 1 

Cancel received for the control.

SELECT_STATE_REASON_TIMEOUT 2 

Unselected due to timeout (sboTimeout)

SELECT_STATE_REASON_OPERATED 3 

Unselected due to successful operate.

SELECT_STATE_REASON_OPERATE_FAILED 4 

Unselected due to failed operate.

SELECT_STATE_REASON_DISCONNECTED 5 

Unselected due to disconnection of selecting client.

Function Documentation

◆ CheckHandler()

delegate CheckHandlerResult IEC61850.Server.CheckHandler ( ControlAction action,
object parameter,
MmsValue ctlVal,
bool test,
bool interlockCheck )

◆ ControlHandler()

delegate ControlHandlerResult IEC61850.Server.ControlHandler ( ControlAction action,
object parameter,
MmsValue ctlVal,
bool test )

◆ ControlSelectStateChangedHandler()

delegate void IEC61850.Server.ControlSelectStateChangedHandler ( ControlAction action,
object parameter,
bool isSelected,
SelectStateChangedReason reason )

◆ ControlWaitForExecutionHandler()

delegate ControlHandlerResult IEC61850.Server.ControlWaitForExecutionHandler ( ControlAction action,
object parameter,
MmsValue ctlVal,
bool test,
bool synchroCheck )

◆ GoCBEventHandler()

delegate void IEC61850.Server.GoCBEventHandler ( MmsGooseControlBlock goCB,
int cbEvent,
object parameter )

◆ RCBEventHandler()

delegate void IEC61850.Server.RCBEventHandler ( object parameter,
ReportControlBlock rcb,
ClientConnection con,
RCBEventType eventType,
string parameterName,
MmsDataAccessError serviceError )

◆ WriteAccessHandler()

delegate MmsDataAccessError IEC61850.Server.WriteAccessHandler ( DataAttribute dataAttr,
MmsValue value,
ClientConnection connection,
object parameter )