Control object. More...

Inheritance diagram for IEC61850.Client.ControlObject:

Collaboration diagram for IEC61850.Client.ControlObject:

Public Member Functions
delegate void	ControlActionHandler (UInt32 invokeId, Object parameter, IedClientError error, ControlActionType type, bool success)
	Handler for asynchronous control actions (select, operate, cancel) More...

delegate void	CommandTerminationHandler (Object parameter, ControlObject controlObject)

ControlModel	GetControlModel ()
	Gets the control model. More...

MmsType	GetCtlValType ()
	Get the type of ctlVal. More...

void	SetOrigin (string originator, OrCat originatorCategory)
	Sets the origin parameter used by control commands. More...

bool	Operate (bool ctlVal)
	Operate the control with the specified control value. More...

bool	Operate (bool ctlVal, UInt64 operTime)
	Operate the control with the specified control value (time activated control). More...

bool	Operate (float ctlVal)
	Operate the control with the specified control value. More...

bool	Operate (float ctlVal, UInt64 operTime)
	Operate the control with the specified control value (time activated control). More...

bool	Operate (int ctlVal)
	Operate the control with the specified control value. More...

bool	Operate (int ctlVal, UInt64 operTime)
	Operate the control with the specified control value (time activated control). More...

bool	Operate (MmsValue ctlVal)
	Operate the control with the specified control value. More...

bool	Operate (MmsValue ctlVal, UInt64 operTime)
	Operate the control with the specified control value (time activated control). More...

UInt32	OperateAsync (bool ctlVal, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value. More...

UInt32	OperateAsync (bool ctlVal, UInt64 operTime, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value (time activated control). More...

UInt32	OperateAsync (float ctlVal, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value. More...

UInt32	OperateAsync (float ctlVal, UInt64 operTime, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value (time activated control). More...

UInt32	OperateAsync (int ctlVal, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value. More...

UInt32	OperateAsync (int ctlVal, UInt64 operTime, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value (time activated control). More...

UInt32	OperateAsync (MmsValue ctlVal, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value. More...

UInt32	OperateAsync (MmsValue ctlVal, UInt64 operTime, ControlActionHandler handler, object parameter)
	Operate the control with the specified control value (time activated control). More...

bool	Select ()
	Select the control object. More...

UInt32	SelectAsync (ControlActionHandler handler, object parameter)
	Select the control object. More...

bool	SelectWithValue (MmsValue ctlVal)
	Send a select with value command for generic MmsValue instances More...

bool	SelectWithValue (bool ctlVal)
	Send a select with value command for boolean controls More...

bool	SelectWithValue (int ctlVal)
	Send a select with value command for integer controls More...

bool	SelectWithValue (float ctlVal)
	Send a select with value command for float controls More...

UInt32	SelectWithValueAsync (bool ctlVal, ControlActionHandler handler, object parameter)
	Send a select with value command for boolean controls - asynchronous version More...

UInt32	SelectWithValueAsync (int ctlVal, ControlActionHandler handler, object parameter)
	Send a select with value command for integer controls - asynchronous version More...

UInt32	SelectWithValueAsync (float ctlVal, ControlActionHandler handler, object parameter)
	Send a select with value command for float controls - asynchronous version More...

UInt32	SelectWithValueAsync (MmsValue ctlVal, ControlActionHandler handler, object parameter)
	Send a select with value command for generic MmsValue instances - asynchronous version More...

bool	Cancel ()
	Cancel a selection or time activated operation More...

UInt32	CancelAsync (ControlActionHandler handler, object parameter)
	Cancel a selection or time activated operation More...

void	EnableSynchroCheck ()
	Enables the synchro check for operate commands More...

void	EnableInterlockCheck ()
	Enables the interlock check for operate and select commands More...

void	SetInterlockCheck (bool value)
	Sets the value of the interlock check flag for operate and select commands More...

void	SetSynchroCheck (bool value)
	Sets the value of the synchro check flag for operate command More...

void	SetTestMode (bool value)
	Sets the value of the test flag for the operate command More...

LastApplError	GetLastApplError ()
	Gets the last received LastApplError (Additional Cause Diagnostics) value. More...

void	SetCommandTerminationHandler (CommandTerminationHandler handler, Object parameter)
	Sets the command termination handler. More...

void	Dispose ()

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
IedClientError	LastError `[get]`
	Gets the error code of the last synchronous control action (operate, select, select-with-value, cancel) More...

Detailed Description

Control object.

Member Function Documentation

◆ Cancel()

bool IEC61850.Client.ControlObject.Cancel ( )

Cancel a selection or time activated operation

Returns: true when the cancelation has been successful, false otherwise

Parameters

handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ CancelAsync()

UInt32 IEC61850.Client.ControlObject.CancelAsync	(	ControlActionHandler	handler,
		object	parameter
	)

Cancel a selection or time activated operation

◆ ControlActionHandler()

delegate void IEC61850.Client.ControlObject.ControlActionHandler	(	UInt32	invokeId,
		Object	parameter,
		IedClientError	error,
		ControlActionType	type,
		bool	success
	)

Handler for asynchronous control actions (select, operate, cancel)

◆ EnableInterlockCheck()

void IEC61850.Client.ControlObject.EnableInterlockCheck ( )

Enables the interlock check for operate and select commands

◆ EnableSynchroCheck()

void IEC61850.Client.ControlObject.EnableSynchroCheck ( )

Enables the synchro check for operate commands

◆ GetControlModel()

ControlModel IEC61850.Client.ControlObject.GetControlModel ( )

Gets the control model.

Returns: The control model.

◆ GetCtlValType()

MmsType IEC61850.Client.ControlObject.GetCtlValType ( )

Get the type of ctlVal.

Returns: MmsType required for the ctlVal value.

◆ GetLastApplError()

LastApplError IEC61850.Client.ControlObject.GetLastApplError ( )

Gets the last received LastApplError (Additional Cause Diagnostics) value.

Returns: The last appl error.

◆ Operate() [1/8]

bool IEC61850.Client.ControlObject.Operate ( bool ctlVal )

Operate the control with the specified control value.

Parameters

ctlVal the new value of the control

Returns: true when the operation has been successful, false otherwise

◆ Operate() [2/8]

bool IEC61850.Client.ControlObject.Operate	(	bool	ctlVal,
		UInt64	operTime
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed

Returns: true when the operation has been successful, false otherwise

◆ Operate() [3/8]

bool IEC61850.Client.ControlObject.Operate ( float ctlVal )

Operate the control with the specified control value.

Parameters

ctlVal the new value of the control

Returns: true when the operation has been successful, false otherwise

◆ Operate() [4/8]

bool IEC61850.Client.ControlObject.Operate	(	float	ctlVal,
		UInt64	operTime
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed

Returns: true when the operation has been successful, false otherwise

◆ Operate() [5/8]

bool IEC61850.Client.ControlObject.Operate ( int ctlVal )

Operate the control with the specified control value.

Parameters

ctlVal the new value of the control

Returns: true when the operation has been successful, false otherwise

◆ Operate() [6/8]

bool IEC61850.Client.ControlObject.Operate	(	int	ctlVal,
		UInt64	operTime
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed

Returns: true when the operation has been successful, false otherwise

◆ Operate() [7/8]

bool IEC61850.Client.ControlObject.Operate ( MmsValue ctlVal )

Operate the control with the specified control value.

Parameters

ctlVal the new value of the control

Returns: true when the operation has been successful, false otherwise

◆ Operate() [8/8]

bool IEC61850.Client.ControlObject.Operate	(	MmsValue	ctlVal,
		UInt64	operTime
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed

Returns: true when the operation has been successful, false otherwise

◆ OperateAsync() [1/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	bool	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value.

Parameters

ctlVal	the new value of the control
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [2/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	bool	ctlVal,
		UInt64	operTime,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [3/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	float	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value.

Parameters

ctlVal	the new value of the control
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [4/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	float	ctlVal,
		UInt64	operTime,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [5/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	int	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value.

Parameters

ctlVal	the new value of the control
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [6/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	int	ctlVal,
		UInt64	operTime,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [7/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	MmsValue	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value.

Parameters

ctlVal	the new value of the control
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ OperateAsync() [8/8]

UInt32 IEC61850.Client.ControlObject.OperateAsync	(	MmsValue	ctlVal,
		UInt64	operTime,
		ControlActionHandler	handler,
		object	parameter
	)

Operate the control with the specified control value (time activated control).

Parameters

ctlVal	the new value of the control
operTime	the time when the operation will be executed
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ Select()

bool IEC61850.Client.ControlObject.Select ( )

Select the control object.

Returns: true when the selection has been successful, false otherwise

◆ SelectAsync()

UInt32 IEC61850.Client.ControlObject.SelectAsync	(	ControlActionHandler	handler,
		object	parameter
	)

Select the control object.

Parameters

handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ SelectWithValue() [1/4]

bool IEC61850.Client.ControlObject.SelectWithValue ( MmsValue ctlVal )

Send a select with value command for generic MmsValue instances

Parameters

ctlVal the value to be checked.

Returns: true when the selection has been successful, false otherwise

◆ SelectWithValue() [2/4]

bool IEC61850.Client.ControlObject.SelectWithValue ( bool ctlVal )

Send a select with value command for boolean controls

Parameters

ctlVal the value to be checked.

Returns: true when the selection has been successful, false otherwise

◆ SelectWithValue() [3/4]

bool IEC61850.Client.ControlObject.SelectWithValue ( int ctlVal )

Send a select with value command for integer controls

Parameters

ctlVal the value to be checked.

Returns: true when the selection has been successful, false otherwise

◆ SelectWithValue() [4/4]

bool IEC61850.Client.ControlObject.SelectWithValue ( float ctlVal )

Send a select with value command for float controls

Parameters

ctlVal the value to be checked.

Returns: true when the selection has been successful, false otherwise

◆ SelectWithValueAsync() [1/4]

UInt32 IEC61850.Client.ControlObject.SelectWithValueAsync	(	bool	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Send a select with value command for boolean controls - asynchronous version

Parameters

ctlVal	the value to be checked.
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ SelectWithValueAsync() [2/4]

UInt32 IEC61850.Client.ControlObject.SelectWithValueAsync	(	int	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Send a select with value command for integer controls - asynchronous version

Parameters

ctlVal	the value to be checked.
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ SelectWithValueAsync() [3/4]

UInt32 IEC61850.Client.ControlObject.SelectWithValueAsync	(	float	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Send a select with value command for float controls - asynchronous version

Parameters

ctlVal	the value to be checked.
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ SelectWithValueAsync() [4/4]

UInt32 IEC61850.Client.ControlObject.SelectWithValueAsync	(	MmsValue	ctlVal,
		ControlActionHandler	handler,
		object	parameter
	)

Send a select with value command for generic MmsValue instances - asynchronous version

Parameters

ctlVal	the value to be checked.
handler	Callback function to handle the received response or service timeout
parameter	User provided callback parameter. Will be passed to the callback function

Returns: the invoke ID of the sent request

Exceptions

IedConnectionException This exception is thrown if there is a connection or service error

◆ SetCommandTerminationHandler()

void IEC61850.Client.ControlObject.SetCommandTerminationHandler	(	CommandTerminationHandler	handler,
		Object	parameter
	)

Sets the command termination handler.

Parameters

handler	the handler (delegate) that is invoked when a CommandTerminationMessage is received.
parameter	Parameter.

◆ SetInterlockCheck()

void IEC61850.Client.ControlObject.SetInterlockCheck ( bool value )

Sets the value of the interlock check flag for operate and select commands

◆ SetOrigin()

void IEC61850.Client.ControlObject.SetOrigin	(	string	originator,
		OrCat	originatorCategory
	)

Sets the origin parameter used by control commands.

Parameters

originator	Originator. An arbitrary string identifying the controlling client.
originatorCategory	Originator category.

◆ SetSynchroCheck()

void IEC61850.Client.ControlObject.SetSynchroCheck ( bool value )

Sets the value of the synchro check flag for operate command

◆ SetTestMode()

void IEC61850.Client.ControlObject.SetTestMode ( bool value )

Sets the value of the test flag for the operate command

Property Documentation

◆ LastError

IedClientError IEC61850.Client.ControlObject.LastError

get

Gets the error code of the last synchronous control action (operate, select, select-with-value, cancel)

error code.

The documentation for this class was generated from the following file:

/home/mzillgit/workspace-git/bitbucket/mz-automation/libiec61850/dotnet/IEC61850forCSharp/Control.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Cancel()

◆ CancelAsync()

◆ ControlActionHandler()

◆ EnableInterlockCheck()

◆ EnableSynchroCheck()

◆ GetControlModel()

◆ GetCtlValType()

◆ GetLastApplError()

◆ Operate() [1/8]

◆ Operate() [2/8]

◆ Operate() [3/8]

◆ Operate() [4/8]

◆ Operate() [5/8]

◆ Operate() [6/8]

◆ Operate() [7/8]

◆ Operate() [8/8]

◆ OperateAsync() [1/8]

◆ OperateAsync() [2/8]

◆ OperateAsync() [3/8]

◆ OperateAsync() [4/8]

◆ OperateAsync() [5/8]

◆ OperateAsync() [6/8]

◆ OperateAsync() [7/8]

◆ OperateAsync() [8/8]

◆ Select()

◆ SelectAsync()

◆ SelectWithValue() [1/4]

◆ SelectWithValue() [2/4]

◆ SelectWithValue() [3/4]

◆ SelectWithValue() [4/4]

◆ SelectWithValueAsync() [1/4]

◆ SelectWithValueAsync() [2/4]

◆ SelectWithValueAsync() [3/4]

◆ SelectWithValueAsync() [4/4]

◆ SetCommandTerminationHandler()

◆ SetInterlockCheck()

◆ SetOrigin()

◆ SetSynchroCheck()

◆ SetTestMode()

Property Documentation

◆ LastError