Represents additional context information of the control action that caused the callback invokation More...

Public Member Functions
void	SetError (ControlLastApplError error)
	Sets the error code for the next command termination or application error message. More...

void	SetAddCause (ControlAddCause addCause)
	Sets the add cause for the next command termination or application error message More...

OrCat	GetOrCat ()
	Gets the originator category provided by the client More...

byte []	GetOrIdent ()
	Get the originator identifier provided by the client More...

int	GetCtlNum ()
	Gets the ctlNum attribute of the control action More...

DataObject	GetControlObject ()
	Gets the control object that is subject to this action More...

UInt64	GetControlTime ()
	Gets the time of control execution, if it's a time activated control More...

DateTimeOffset	GetControlTimeAsDataTimeOffset ()
	Gets the tome of control execution as data time offset. More...

ClientConnection	GetClientConnection ()
	Gets the client object associated with the client that caused the control action More...

bool	IsSelect ()
	Cehck if the control callback is called by a select or operate command More...

Detailed Description

Represents additional context information of the control action that caused the callback invokation

Member Function Documentation

◆ GetClientConnection()

ClientConnection IEC61850.Server.ControlAction.GetClientConnection ( )

Gets the client object associated with the client that caused the control action

Returns: The client connection.

◆ GetControlObject()

DataObject IEC61850.Server.ControlAction.GetControlObject ( )

Gets the control object that is subject to this action

Returns: the controllable data object instance

◆ GetControlTime()

UInt64 IEC61850.Server.ControlAction.GetControlTime ( )

Gets the time of control execution, if it's a time activated control

Returns: The time of control execution or 0 for immediate execution

◆ GetControlTimeAsDataTimeOffset()

DateTimeOffset IEC61850.Server.ControlAction.GetControlTimeAsDataTimeOffset ( )

Gets the tome of control execution as data time offset.

Returns: The control execution time as data time offset.

◆ GetCtlNum()

int IEC61850.Server.ControlAction.GetCtlNum ( )

Gets the ctlNum attribute of the control action

Returns: The ctlNum value. Valid values are restricted from 0 to 255, -1 means not present

◆ GetOrCat()

OrCat IEC61850.Server.ControlAction.GetOrCat ( )

Gets the originator category provided by the client

Returns: The or cat.

◆ GetOrIdent()

byte [] IEC61850.Server.ControlAction.GetOrIdent ( )

Get the originator identifier provided by the client

Returns: The or ident.

◆ IsSelect()

bool IEC61850.Server.ControlAction.IsSelect ( )

Cehck if the control callback is called by a select or operate command

Returns: true, if select, false otherwise.

◆ SetAddCause()

void IEC61850.Server.ControlAction.SetAddCause ( ControlAddCause addCause )

Sets the add cause for the next command termination or application error message

Parameters

addCause the additional cause code

◆ SetError()

void IEC61850.Server.ControlAction.SetError ( ControlLastApplError error )

Sets the error code for the next command termination or application error message.