IEC61850.Client.ControlObject Class Reference

Control object. More...

Inheritance diagram for IEC61850.Client.ControlObject:

Collaboration diagram for IEC61850.Client.ControlObject:

Public Member Functions
delegate void	CommandTerminationHandler (Object parameter, ControlObject controlObject)
ControlModel	GetControlModel ()
	Gets the control model. 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...
bool	Select ()
	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...
bool	Cancel ()
	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)

Package Functions
	ControlObject (string objectReference, IntPtr connection, IedConnection iedConnection)

Detailed Description

Control object.

Member Function Documentation

bool IEC61850.Client.ControlObject.Cancel

(

)

Cancel a selection or time activated operation

Returns

true when the cancelation has been successful, false otherwise

void IEC61850.Client.ControlObject.EnableInterlockCheck

(

)

Enables the interlock check for operate and select commands

void IEC61850.Client.ControlObject.EnableSynchroCheck

(

)

Enables the synchro check for operate commands

ControlModel IEC61850.Client.ControlObject.GetControlModel

(

)

Gets the control model.

Returns

The control model.

LastApplError IEC61850.Client.ControlObject.GetLastApplError

(

)

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

Returns

The last appl error.

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

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

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

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

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

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

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

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

bool IEC61850.Client.ControlObject.Select

(

)

Select the control object.

Returns

true when the selection has been successful, false otherwise

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

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

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

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

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.

void IEC61850.Client.ControlObject.SetInterlockCheck

(

bool

value

)

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

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.

void IEC61850.Client.ControlObject.SetSynchroCheck

(

bool

value

)

Sets the value of the synchro check flag for operate command

void IEC61850.Client.ControlObject.SetTestMode

(

bool

value

)

Sets the value of the test flag for the operate command

---

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

• IEC61850forCSharp/Control.cs