dnp3::ControlCode Struct Reference

CROB (Group12Var1) control code. More...

#include <dnp3.hpp>

Public Member Functions
	ControlCode (TripCloseCode tcc, bool clear, OpType op_type)
	Initialize a ControlCode instance. More...

Static Public Member Functions
static ControlCode	from_op_type (OpType op_type)
	Initialize a ControlCode instance from a OpType More...
static ControlCode	from_tcc_and_op_type (TripCloseCode tcc, OpType op_type)
	Initialize a ControlCode instance from a TripCloseCode and a OpType. More...

Public Attributes
TripCloseCode	tcc
	This field is used in conjunction with ControlCode::op_type 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	op_type
	This field is used in conjunction with the ControlCode::tcc field to specify a control operation. More...

Friends
class	CppControlCodeFriend

Detailed Description

CROB (Group12Var1) control code.

Constructor & Destructor Documentation

ControlCode()

dnp3::ControlCode::ControlCode	(	TripCloseCode	tcc,
		bool	clear,
		OpType	op_type
	)

Initialize a ControlCode instance.

Note

Values are initialized to:

• ControlCode::queue : false

Parameters

tcc	This field is used in conjunction with ControlCode::op_type 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.
op_type	This field is used in conjunction with the ControlCode::tcc field to specify a control operation

Returns

New instance of ControlCode

Member Function Documentation

from_op_type()

static ControlCode dnp3::ControlCode::from_op_type ( OpType  op_type )

static

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.

Note

Values are initialized to:

• ControlCode::tcc : TripCloseCode::nul
• ControlCode::clear : false
• ControlCode::queue : false

Parameters

op_type

This field is used in conjunction with the ControlCode::tcc field to specify a control operation

Returns

New instance of ControlCode

from_tcc_and_op_type()

static ControlCode dnp3::ControlCode::from_tcc_and_op_type ( TripCloseCode  tcc, OpType  op_type  )

static

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.

Note

Values are initialized to:

• ControlCode::clear : false
• ControlCode::queue : false

Parameters

tcc	This field is used in conjunction with ControlCode::op_type to specify a control operation
op_type	This field is used in conjunction with the ControlCode::tcc field to specify a control operation

Returns

New instance of ControlCode

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.

op_type

OpType dnp3::ControlCode::op_type

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::op_type to specify a control operation.

---

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

• dnp3.hpp