dnp3.IControlHandler Interface Reference

Callbacks for handling controls More...

Public Member Functions
void	BeginFragment ()
	Notifies the start of a command fragment More...
void	EndFragment ()
	Notifies the end of a command fragment More...
CommandStatus	SelectG12v1 (G12v1 control, ushort index, Database database)
	Select a CROB, but do not operate More...
CommandStatus	OperateG12v1 (G12v1 control, ushort index, OperateType opType, Database database)
	Operate a control point More...
CommandStatus	SelectG41v1 (int control, ushort index, Database database)
	Select an analog output, but do not operate More...
CommandStatus	OperateG41v1 (int control, ushort index, OperateType opType, Database database)
	Operate a control point More...
CommandStatus	SelectG41v2 (short value, ushort index, Database database)
	Select an analog output, but do not operate More...
CommandStatus	OperateG41v2 (short value, ushort index, OperateType opType, Database database)
	Operate a control point More...
CommandStatus	SelectG41v3 (float value, ushort index, Database database)
	Select an analog output, but do not operate More...
CommandStatus	OperateG41v3 (float value, ushort index, OperateType opType, Database database)
	Operate a control point More...
CommandStatus	SelectG41v4 (double value, ushort index, Database database)
	Select an analog output, but do not operate More...
CommandStatus	OperateG41v4 (double value, ushort index, OperateType opType, Database database)
	Operate a control point More...

Detailed Description

Callbacks for handling controls

Member Function Documentation

BeginFragment()

void dnp3.IControlHandler.BeginFragment

(

)

Notifies the start of a command fragment

EndFragment()

void dnp3.IControlHandler.EndFragment

(

)

Notifies the end of a command fragment

OperateG12v1()

CommandStatus dnp3.IControlHandler.OperateG12v1	(	G12v1	control,
		ushort	index,
		OperateType	opType,
		Database	database
	)

Operate a control point

Parameters

control	Received CROB
index	Index of the point
opType	Operate type
database	Database

Returns

Command status

OperateG41v1()

CommandStatus dnp3.IControlHandler.OperateG41v1	(	int	control,
		ushort	index,
		OperateType	opType,
		Database	database
	)

Operate a control point

Parameters

control	Received analog output value
index	Index of the point
opType	Operate type
database	Database

Returns

Command status

OperateG41v2()

CommandStatus dnp3.IControlHandler.OperateG41v2	(	short	value,
		ushort	index,
		OperateType	opType,
		Database	database
	)

Operate a control point

Parameters

value	Received analog output value
index	Index of the point
opType	Operate type
database	Database

Returns

Command status

OperateG41v3()

CommandStatus dnp3.IControlHandler.OperateG41v3	(	float	value,
		ushort	index,
		OperateType	opType,
		Database	database
	)

Operate a control point

Parameters

value	Received analog output value
index	Index of the point
opType	Operate type
database	Database

Returns

Command status

OperateG41v4()

CommandStatus dnp3.IControlHandler.OperateG41v4	(	double	value,
		ushort	index,
		OperateType	opType,
		Database	database
	)

Operate a control point

Parameters

value	Received analog output value
index	Index of the point
opType	Operate type
database	Database

Returns

Command status

SelectG12v1()

CommandStatus dnp3.IControlHandler.SelectG12v1	(	G12v1	control,
		ushort	index,
		Database	database
	)

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

control	Received CROB
index	Index of the point
database	Database

Returns

Command status

SelectG41v1()

CommandStatus dnp3.IControlHandler.SelectG41v1	(	int	control,
		ushort	index,
		Database	database
	)

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

control	Received analog output value
index	Index of the point
database	Database

Returns

Command status

SelectG41v2()

CommandStatus dnp3.IControlHandler.SelectG41v2	(	short	value,
		ushort	index,
		Database	database
	)

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	Database

Returns

Command status

SelectG41v3()

CommandStatus dnp3.IControlHandler.SelectG41v3	(	float	value,
		ushort	index,
		Database	database
	)

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	Database

Returns

Command status

SelectG41v4()

CommandStatus dnp3.IControlHandler.SelectG41v4	(	double	value,
		ushort	index,
		Database	database
	)

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	Database

Returns

Command status

---

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

• IControlHandler.cs