Callbacks for handling controls. More...

#include <dnp3.hpp>

Public Member Functions
virtual void	begin_fragment ()=0
	Notifies the start of a command fragment. More...

virtual void	end_fragment (DatabaseHandle &database)=0
	Notifies the end of a command fragment. More...

virtual CommandStatus	select_g12v1 (const Group12Var1 &value, uint16_t index, DatabaseHandle &database_handle)=0
	Select a CROB, but do not operate. More...

virtual CommandStatus	operate_g12v1 (const Group12Var1 &value, uint16_t index, OperateType op_type, DatabaseHandle &database_handle)=0
	Operate a control point. More...

virtual CommandStatus	select_g41v1 (int32_t value, uint16_t index, DatabaseHandle &database_handle)=0
	Select an analog output, but do not operate. More...

virtual CommandStatus	operate_g41v1 (int32_t value, uint16_t index, OperateType op_type, DatabaseHandle &database_handle)=0
	Operate a control point. More...

virtual CommandStatus	select_g41v2 (int16_t value, uint16_t index, DatabaseHandle &database_handle)=0
	Select an analog output, but do not operate. More...

virtual CommandStatus	operate_g41v2 (int16_t value, uint16_t index, OperateType op_type, DatabaseHandle &database_handle)=0
	Operate a control point. More...

virtual CommandStatus	select_g41v3 (float value, uint16_t index, DatabaseHandle &database_handle)=0
	Select an analog output, but do not operate. More...

virtual CommandStatus	operate_g41v3 (float value, uint16_t index, OperateType op_type, DatabaseHandle &database_handle)=0
	Operate a control point. More...

virtual CommandStatus	select_g41v4 (double value, uint16_t index, DatabaseHandle &database_handle)=0
	Select an analog output, but do not operate. More...

virtual CommandStatus	operate_g41v4 (double value, uint16_t index, OperateType op_type, DatabaseHandle &database_handle)=0
	Operate a control point. More...

Detailed Description

Callbacks for handling controls.

Return CommandStatus::not_supported for an index that doesn't exist. When it's the first control in the request that fails, the response also sets IIN2.2 (parameter error).

The outstation answers a g41v3 or g41v4 control whose value is NaN or infinite with CommandStatus::not_supported itself, without calling this interface.

Note: this class is an "interface" and only has virtual methods, some of which may have default implementations.

Member Function Documentation

◆ begin_fragment()

virtual void dnp3::ControlHandler::begin_fragment ( )

pure virtual

Notifies the start of a command fragment.

◆ end_fragment()

virtual void dnp3::ControlHandler::end_fragment ( DatabaseHandle & database )

pure virtual

Notifies the end of a command fragment.

Parameters

database Database handle

◆ operate_g12v1()

virtual CommandStatus dnp3::ControlHandler::operate_g12v1	(	const Group12Var1 &	value,
		uint16_t	index,
		OperateType	op_type,
		DatabaseHandle &	database_handle
	)

pure virtual

Operate a control point.

Parameters

value	Received CROB
index	Index of the point
op_type	Operate type
database_handle	Database handle

Returns: Command status

◆ operate_g41v1()

virtual CommandStatus dnp3::ControlHandler::operate_g41v1	(	int32_t	value,
		uint16_t	index,
		OperateType	op_type,
		DatabaseHandle &	database_handle
	)

pure virtual

Operate a control point.

Parameters

value	Received analog output value
index	Index of the point
op_type	Operate type
database_handle	Database handle

Returns: Command status

◆ operate_g41v2()

virtual CommandStatus dnp3::ControlHandler::operate_g41v2	(	int16_t	value,
		uint16_t	index,
		OperateType	op_type,
		DatabaseHandle &	database_handle
	)

pure virtual

Operate a control point.

Parameters

value	Received analog output value
index	Index of the point
op_type	Operate type
database_handle	Database handle

Returns: Command status

◆ operate_g41v3()

virtual CommandStatus dnp3::ControlHandler::operate_g41v3	(	float	value,
		uint16_t	index,
		OperateType	op_type,
		DatabaseHandle &	database_handle
	)

pure virtual

Operate a control point.

Parameters

value	Received analog output value
index	Index of the point
op_type	Operate type
database_handle	Database handle

Returns: Command status

◆ operate_g41v4()

virtual CommandStatus dnp3::ControlHandler::operate_g41v4	(	double	value,
		uint16_t	index,
		OperateType	op_type,
		DatabaseHandle &	database_handle
	)

pure virtual

Operate a control point.

Parameters

value	Received analog output value
index	Index of the point
op_type	Operate type
database_handle	Database handle

Returns: Command status

◆ select_g12v1()

virtual CommandStatus dnp3::ControlHandler::select_g12v1	(	const Group12Var1 &	value,
		uint16_t	index,
		DatabaseHandle &	database_handle
	)

pure virtual

Select a CROB, but do not operate.

Implementors can think of this function as asking the question "is this control supported"?

Most implementations should not alter the database in this method. It is only provided in the event that some event counters reflected via the API get updated on SELECT, but this would be highly abnormal.

Parameters

value	Received CROB
index	Index of the point
database_handle	Database handle

Returns: Command status

◆ select_g41v1()

virtual CommandStatus dnp3::ControlHandler::select_g41v1	(	int32_t	value,
		uint16_t	index,
		DatabaseHandle &	database_handle
	)

pure virtual

Select an analog output, but do not operate.

Implementors can think of this function as asking the question "is this control supported"?

Most implementations should not alter the database in this method. It is only provided in the event that some event counters reflected via the API get updated on SELECT, but this would be highly abnormal.

Parameters

value	Received analog output value
index	Index of the point
database_handle	Database handle

Returns: Command status

◆ select_g41v2()

virtual CommandStatus dnp3::ControlHandler::select_g41v2	(	int16_t	value,
		uint16_t	index,
		DatabaseHandle &	database_handle
	)

pure virtual

Select an analog output, but do not operate.

Implementors can think of this function as asking the question "is this control supported"?

Most implementations should not alter the database in this method. It is only provided in the event that some event counters reflected via the API get updated on SELECT, but this would be highly abnormal.

Parameters

value	Received analog output value
index	Index of the point
database_handle	Database handle

Returns: Command status

◆ select_g41v3()

virtual CommandStatus dnp3::ControlHandler::select_g41v3	(	float	value,
		uint16_t	index,
		DatabaseHandle &	database_handle
	)

pure virtual

Select an analog output, but do not operate.

Implementors can think of this function as asking the question "is this control supported"?

Most implementations should not alter the database in this method. It is only provided in the event that some event counters reflected via the API get updated on SELECT, but this would be highly abnormal.

Parameters

value	Received analog output value
index	Index of the point
database_handle	Database handle

Returns: Command status

◆ select_g41v4()

virtual CommandStatus dnp3::ControlHandler::select_g41v4	(	double	value,
		uint16_t	index,
		DatabaseHandle &	database_handle
	)

pure virtual

Select an analog output, but do not operate.

Implementors can think of this function as asking the question "is this control supported"?

Most implementations should not alter the database in this method. It is only provided in the event that some event counters reflected via the API get updated on SELECT, but this would be highly abnormal.

Parameters

value	Received analog output value
index	Index of the point
database_handle	Database handle

Returns: Command status

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

dnp3.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ begin_fragment()

◆ end_fragment()

◆ operate_g12v1()

◆ operate_g41v1()

◆ operate_g41v2()

◆ operate_g41v3()

◆ operate_g41v4()

◆ select_g12v1()

◆ select_g41v1()

◆ select_g41v2()

◆ select_g41v3()

◆ select_g41v4()