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

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

Enumeration Type Documentation

AcseAuthenticationMechanism

enum IEC61850.Client.AcseAuthenticationMechanism

strong

Enumerator
ACSE_AUTH_NONE	don't use authentication
ACSE_AUTH_PASSWORD	use password authentication

IedClientError

enum IEC61850.Client.IedClientError

strong

Error codes for client side functions

Enumerator
IED_ERROR_OK	No error occurred - service request has been successful
IED_ERROR_NOT_CONNECTED	The service request can not be executed because the client is not yet connected
IED_ERROR_ALREADY_CONNECTED	Connect service not execute because the client is already connected
IED_ERROR_CONNECTION_LOST	The service request can not be executed caused by a loss of connection
IED_ERROR_SERVICE_NOT_SUPPORTED	The service or some given parameters are not supported by the client stack or by the server
IED_ERROR_CONNECTION_REJECTED	Connection rejected by server
IED_ERROR_USER_PROVIDED_INVALID_ARGUMENT	API function has been called with an invalid argument
IED_ERROR_OBJECT_REFERENCE_INVALID	The object provided object reference is invalid (there is a syntactical error).
IED_ERROR_UNEXPECTED_VALUE_RECEIVED	Received object is of unexpected type
IED_ERROR_TIMEOUT	The communication to the server failed with a timeout
IED_ERROR_ACCESS_DENIED	The server rejected the access to the requested object/service due to access control
IED_ERROR_OBJECT_DOES_NOT_EXIST	The server reported that the requested object does not exist
IED_ERROR_OBJECT_EXISTS	The server reported that the requested object already exists
IED_ERROR_OBJECT_ACCESS_UNSUPPORTED	The server does not support the requested access method
IED_ERROR_TYPE_INCONSISTENT	The server expected an object of another type
IED_ERROR_TEMPORARILY_UNAVAILABLE	The object or service is temporarily unavailable
IED_ERROR_OBJECT_UNDEFINED	The specified object is not defined in the server (returned by server)
IED_ERROR_INVALID_ADDRESS	The specified address is invalid (returned by server)
IED_ERROR_HARDWARE_FAULT	Service failed due to a hardware fault (returned by server)
IED_ERROR_TYPE_UNSUPPORTED	The requested data type is not supported by the server (returned by server)
IED_ERROR_OBJECT_ATTRIBUTE_INCONSISTENT	The provided attributes are inconsistent (returned by server)
IED_ERROR_OBJECT_VALUE_INVALID	The provided object value is invalid (returned by server)
IED_ERROR_OBJECT_INVALIDATED	The object is invalidated (returned by server)
IED_ERROR_MALFORMED_MESSAGE	Received an invalid response message from the server
IED_ERROR_SERVICE_NOT_IMPLEMENTED	Service not implemented

IedConnectionState

enum IEC61850.Client.IedConnectionState

strong

Connection state of an IedConnection instance

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

ReasonForInclusion

enum IEC61850.Client.ReasonForInclusion

strong

Enumerator
REASON_NOT_INCLUDED	the element is not included in the received report
REASON_DATA_CHANGE	the element is included due to a change of the data value
REASON_QUALITY_CHANGE	the element is included due to a change in the quality of data
REASON_DATA_UPDATE	the element is included due to an update of the data value
REASON_INTEGRITY	the element is included due to a periodic integrity report task
REASON_GI	the element is included due to a general interrogation by the client
REASON_UNKNOWN	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