IEC61850.Client Namespace Reference

Classes
class	ControlObject
	Control object. More...
class	DataSet
	This class is used to represent a data set. It is used to store the values of a data set. More...
class	FileDirectoryEntry
class	GooseControlBlock
class	IedClientErrorExtension
class	IedConnection
	This class acts as the entry point for the IEC 61850 client API. It represents a single (MMS) connection to a server. More...
class	IedConnectionException
class	IsoConnectionParameters
	Connection parameters associated with the ISO protocol layers (transport, session, presentation, ACSE) More...
class	LastApplError
struct	LastApplErrorInternal
class	MmsConnection
	Represents an MmsConnection object (a single connection to an MMS server) More...
class	MmsJournalEntry
	Represents an entry of a log. More...
class	MmsJournalVariable
	Represents a variable in a log entry. More...
class	MmsServerIdentity
class	Report
	A class to hold the contents of a received report. More...
class	ReportControlBlock
	Report control block (RCB) representation. More...
class	SampledValuesControlBlock
	Sampled values control bloc (SvCB) representation. More...

Enumerations
enum	ControlActionType { SELECT = 0 , OPERATE = 1 , CANCEL = 2 }
enum	IedConnectionState { IED_STATE_CLOSED = 0 , IED_STATE_CONNECTING = 1 , IED_STATE_CONNECTED = 2 , IED_STATE_CLOSING = 3 }
	Connection state of an IedConnection instance. More...
enum	IedClientError {   IED_ERROR_OK = 0 , IED_ERROR_NOT_CONNECTED = 1 , IED_ERROR_ALREADY_CONNECTED = 2 , IED_ERROR_CONNECTION_LOST = 3 ,   IED_ERROR_SERVICE_NOT_SUPPORTED = 4 , IED_ERROR_CONNECTION_REJECTED = 5 , IED_ERROR_USER_PROVIDED_INVALID_ARGUMENT = 10 , IED_ERROR_ENABLE_REPORT_FAILED_DATASET_MISMATCH = 11 ,   IED_ERROR_OBJECT_REFERENCE_INVALID = 12 , IED_ERROR_UNEXPECTED_VALUE_RECEIVED = 13 , IED_ERROR_TIMEOUT = 20 , IED_ERROR_ACCESS_DENIED = 21 ,   IED_ERROR_OBJECT_DOES_NOT_EXIST = 22 , IED_ERROR_OBJECT_EXISTS = 23 , IED_ERROR_OBJECT_ACCESS_UNSUPPORTED = 24 , IED_ERROR_TYPE_INCONSISTENT = 25 ,   IED_ERROR_TEMPORARILY_UNAVAILABLE = 26 , IED_ERROR_OBJECT_UNDEFINED = 27 , IED_ERROR_INVALID_ADDRESS = 28 , IED_ERROR_HARDWARE_FAULT = 29 ,   IED_ERROR_TYPE_UNSUPPORTED = 30 , IED_ERROR_OBJECT_ATTRIBUTE_INCONSISTENT = 31 , IED_ERROR_OBJECT_VALUE_INVALID = 32 , IED_ERROR_OBJECT_INVALIDATED = 33 ,   IED_ERROR_MALFORMED_MESSAGE = 34 , IED_ERROR_OBJECT_CONSTRAINT_CONFLICT = 35 , IED_ERROR_SERVICE_NOT_IMPLEMENTED = 98 , IED_ERROR_UNKNOWN = 99 }
	Error codes for client side functions. More...
enum	AcseAuthenticationMechanism { ACSE_AUTH_NONE = 0 , ACSE_AUTH_PASSWORD = 1 }
enum	ReasonForInclusion {   REASON_NOT_INCLUDED = 0 , REASON_DATA_CHANGE = 1 , REASON_QUALITY_CHANGE = 2 , REASON_DATA_UPDATE = 4 ,   REASON_INTEGRITY = 8 , REASON_GI = 16 , REASON_UNKNOWN = 32 }

Functions
delegate void	GetRCBValuesHandler (UInt32 invokeId, object parameter, IedClientError err, ReportControlBlock rcb)
	Asynchonous service handler for the get RCB values service.
delegate void	SetRCBValuesHandler (UInt32 invokeId, object parameter, IedClientError err, ReportControlBlock rcb)
	Asynchonous service handler for the set RCB values service.
delegate void	GenericServiceHandler (UInt32 invokeId, object parameter, IedClientError err)
	Generic asynchonous service handler - used by simple services that have only success or error result.
delegate void	ReportHandler (Report report, object parameter)
	Report handler.

Enumeration Type Documentation

AcseAuthenticationMechanism

enum IEC61850.Client.AcseAuthenticationMechanism

Enumerator
ACSE_AUTH_NONE	0	don't use authentication
ACSE_AUTH_PASSWORD	1	use password authentication

ControlActionType

enum IEC61850.Client.ControlActionType

Enumerator
SELECT	0
OPERATE	1
CANCEL	2

IedClientError

enum IEC61850.Client.IedClientError

Error codes for client side functions.

Enumerator
IED_ERROR_OK	0	No error occurred - service request has been successful
IED_ERROR_NOT_CONNECTED	1	The service request can not be executed because the client is not yet connected
IED_ERROR_ALREADY_CONNECTED	2	Connect service not execute because the client is already connected
IED_ERROR_CONNECTION_LOST	3	The service request can not be executed caused by a loss of connection
IED_ERROR_SERVICE_NOT_SUPPORTED	4	The service or some given parameters are not supported by the client stack or by the server
IED_ERROR_CONNECTION_REJECTED	5	Connection rejected by server
IED_ERROR_USER_PROVIDED_INVALID_ARGUMENT	10	API function has been called with an invalid argument
IED_ERROR_ENABLE_REPORT_FAILED_DATASET_MISMATCH	11
IED_ERROR_OBJECT_REFERENCE_INVALID	12	The object provided object reference is invalid (there is a syntactical error).
IED_ERROR_UNEXPECTED_VALUE_RECEIVED	13	Received object is of unexpected type
IED_ERROR_TIMEOUT	20	The communication to the server failed with a timeout
IED_ERROR_ACCESS_DENIED	21	The server rejected the access to the requested object/service due to access control
IED_ERROR_OBJECT_DOES_NOT_EXIST	22	The server reported that the requested object does not exist
IED_ERROR_OBJECT_EXISTS	23	The server reported that the requested object already exists
IED_ERROR_OBJECT_ACCESS_UNSUPPORTED	24	The server does not support the requested access method
IED_ERROR_TYPE_INCONSISTENT	25	The server expected an object of another type
IED_ERROR_TEMPORARILY_UNAVAILABLE	26	The object or service is temporarily unavailable
IED_ERROR_OBJECT_UNDEFINED	27	The specified object is not defined in the server (returned by server)
IED_ERROR_INVALID_ADDRESS	28	The specified address is invalid (returned by server)
IED_ERROR_HARDWARE_FAULT	29	Service failed due to a hardware fault (returned by server)
IED_ERROR_TYPE_UNSUPPORTED	30	The requested data type is not supported by the server (returned by server)
IED_ERROR_OBJECT_ATTRIBUTE_INCONSISTENT	31	The provided attributes are inconsistent (returned by server)
IED_ERROR_OBJECT_VALUE_INVALID	32	The provided object value is invalid (returned by server)
IED_ERROR_OBJECT_INVALIDATED	33	The object is invalidated (returned by server)
IED_ERROR_MALFORMED_MESSAGE	34	Received an invalid response message from the server
IED_ERROR_OBJECT_CONSTRAINT_CONFLICT	35	Service was not executed because required resource is still in use
IED_ERROR_SERVICE_NOT_IMPLEMENTED	98	Service not implemented
IED_ERROR_UNKNOWN	99

IedConnectionState

enum IEC61850.Client.IedConnectionState

Connection state of an IedConnection instance.

Enumerator
IED_STATE_CLOSED	0	The connection is closed. Requests cannot be sent.
IED_STATE_CONNECTING	1	The connection is connecting. Requests cannot be sent yet.
IED_STATE_CONNECTED	2	The connection is up. Requests can be sent.
IED_STATE_CLOSING	3	The connection is closing. Requests connect be sent.

ReasonForInclusion

enum IEC61850.Client.ReasonForInclusion

Enumerator
REASON_NOT_INCLUDED	0	the element is not included in the received report
REASON_DATA_CHANGE	1	the element is included due to a change of the data value
REASON_QUALITY_CHANGE	2	the element is included due to a change in the quality of data
REASON_DATA_UPDATE	4	the element is included due to an update of the data value
REASON_INTEGRITY	8	the element is included due to a periodic integrity report task
REASON_GI	16	the element is included due to a general interrogation by the client
REASON_UNKNOWN	32	the reason for inclusion is unknown

Function Documentation

GenericServiceHandler()

delegate void IEC61850.Client.GenericServiceHandler	(	UInt32	invokeId,
		object	parameter,
		IedClientError	err )

Generic asynchonous service handler - used by simple services that have only success or error result.

Parameters

invokeId	The invoke ID of the request triggering this callback
parameter	user provided callback parameter
err	Error code of response or timeout error in case of a response timeout

GetRCBValuesHandler()

delegate void IEC61850.Client.GetRCBValuesHandler	(	UInt32	invokeId,
		object	parameter,
		IedClientError	err,
		ReportControlBlock	rcb )

Asynchonous service handler for the get RCB values service.

Parameters

invokeId	The invoke ID of the request triggering this callback
parameter	user provided callback parameter
err	Error code of response or timeout error in case of a response timeout
rcb	the report control block instance

ReportHandler()

delegate void IEC61850.Client.ReportHandler	(	Report	report,
		object	parameter )

Report handler.

Parameters

report

represents the received report. DON'T use this object outside the scope of the report handler!

SetRCBValuesHandler()

delegate void IEC61850.Client.SetRCBValuesHandler	(	UInt32	invokeId,
		object	parameter,
		IedClientError	err,
		ReportControlBlock	rcb )

Asynchonous service handler for the set RCB values service.

Parameters

invokeId	The invoke ID of the request triggering this callback
parameter	user provided callback parameter
err	Error code of response or timeout error in case of a response timeout
rcb	the report control block instance