CROB (Group12Var1) control code More...

Public Member Functions
ControlCode	WithTcc (TripCloseCode value)
	This field is used in conjunction with ControlCode.OpType to specify a control operation More...

ControlCode	WithClear (bool value)
	Support for this field is optional. When the clear bit is set, the device shall remove pending control commands for that index and stop any control operation that is in progress for that index. The indexed point shall go to the state that it would have if the command were allowed to complete normally. More...

ControlCode	WithQueue (bool value)
	This field is obsolete and should always be 0 More...

ControlCode	WithOpType (OpType value)
	This field is used in conjunction with the ControlCode.Tcc field to specify a control operation More...

	ControlCode (TripCloseCode tcc, bool clear, OpType opType)
	Initialize a ControlCode instance More...

Static Public Member Functions
static ControlCode	FromOpType (OpType opType)
	Initialize a ControlCode instance from a OpType More...

static ControlCode	FromTccAndOpType (TripCloseCode tcc, OpType opType)
	Initialize a ControlCode instance from a TripCloseCode and a OpType. More...

Public Attributes
TripCloseCode	Tcc
	This field is used in conjunction with ControlCode.OpType to specify a control operation More...

bool	Clear
	Support for this field is optional. When the clear bit is set, the device shall remove pending control commands for that index and stop any control operation that is in progress for that index. The indexed point shall go to the state that it would have if the command were allowed to complete normally. More...

bool	Queue
	This field is obsolete and should always be 0 More...

OpType	OpType
	This field is used in conjunction with the ControlCode.Tcc field to specify a control operation More...

Detailed Description

CROB (Group12Var1) control code

Constructor & Destructor Documentation

◆ ControlCode()

dnp3.ControlCode.ControlCode	(	TripCloseCode	tcc,
		bool	clear,
		OpType	opType
	)

inline

Initialize a ControlCode instance

Default values:

ControlCode.Queue: false

Parameters

tcc	This field is used in conjunction with ControlCode.OpType to specify a control operation
clear	Support for this field is optional. When the clear bit is set, the device shall remove pending control commands for that index and stop any control operation that is in progress for that index. The indexed point shall go to the state that it would have if the command were allowed to complete normally.
opType	This field is used in conjunction with the ControlCode.Tcc field to specify a control operation

Member Function Documentation

◆ FromOpType()

static ControlCode dnp3.ControlCode.FromOpType ( OpType opType )

inlinestatic

Initialize a ControlCode instance from a OpType

ControlCode.Tcc will be set to TripCloseCode.Nul, ControlCode.Clear will be set to false and ControlCode.Queue will be set to false.

Default values:

Parameters

opType This field is used in conjunction with the ControlCode.Tcc field to specify a control operation

Returns: Initialized ControlCode instance

◆ FromTccAndOpType()

static ControlCode dnp3.ControlCode.FromTccAndOpType	(	TripCloseCode	tcc,
		OpType	opType
	)

inlinestatic

Initialize a ControlCode instance from a TripCloseCode and a OpType.

ControlCode.Clear will be set to false and ControlCode.Queue will be set to false.

Default values:

ControlCode.Clear: false
ControlCode.Queue: false

Parameters

tcc	This field is used in conjunction with ControlCode.OpType to specify a control operation
opType	This field is used in conjunction with the ControlCode.Tcc field to specify a control operation

Returns: Initialized ControlCode instance

◆ WithClear()

ControlCode dnp3.ControlCode.WithClear ( bool value )

inline

Support for this field is optional. When the clear bit is set, the device shall remove pending control commands for that index and stop any control operation that is in progress for that index. The indexed point shall go to the state that it would have if the command were allowed to complete normally.

◆ WithOpType()

ControlCode dnp3.ControlCode.WithOpType ( OpType value )

inline

This field is used in conjunction with the ControlCode.Tcc field to specify a control operation

◆ WithQueue()

ControlCode dnp3.ControlCode.WithQueue ( bool value )

inline

This field is obsolete and should always be 0

◆ WithTcc()

ControlCode dnp3.ControlCode.WithTcc ( TripCloseCode value )

inline

This field is used in conjunction with ControlCode.OpType to specify a control operation

Member Data Documentation

◆ Clear

bool dnp3.ControlCode.Clear

Support for this field is optional. When the clear bit is set, the device shall remove pending control commands for that index and stop any control operation that is in progress for that index. The indexed point shall go to the state that it would have if the command were allowed to complete normally.

◆ OpType

OpType dnp3.ControlCode.OpType

This field is used in conjunction with the ControlCode.Tcc field to specify a control operation

◆ Queue

bool dnp3.ControlCode.Queue

This field is obsolete and should always be 0

◆ Tcc

TripCloseCode dnp3.ControlCode.Tcc

This field is used in conjunction with ControlCode.OpType to specify a control operation

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

ControlCode.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ControlCode()

Member Function Documentation

◆ FromOpType()

◆ FromTccAndOpType()

◆ WithClear()

◆ WithOpType()

◆ WithQueue()

◆ WithTcc()

Member Data Documentation

◆ Clear

◆ OpType

◆ Queue

◆ Tcc