dnp3 (C++ API) 1.1.0
dnp3::ReadHandler Class Referenceabstract

General handler that will receive all values read from the outstation. More...

#include <dnp3.hpp>

Public Member Functions

virtual void begin_fragment (ReadType read_type, const ResponseHeader &header)=0
 Marks the beginning of a fragment. More...
 
virtual void end_fragment (ReadType read_type, const ResponseHeader &header)=0
 Marks the end of a fragment. More...
 
virtual void handle_binary_input (const HeaderInfo &info, BinaryInputIterator &it)=0
 Handle binary input data. More...
 
virtual void handle_double_bit_binary_input (const HeaderInfo &info, DoubleBitBinaryInputIterator &it)=0
 Handle double-bit binary input data. More...
 
virtual void handle_binary_output_status (const HeaderInfo &info, BinaryOutputStatusIterator &it)=0
 Handle binary output status data. More...
 
virtual void handle_counter (const HeaderInfo &info, CounterIterator &it)=0
 Handle counter data. More...
 
virtual void handle_frozen_counter (const HeaderInfo &info, FrozenCounterIterator &it)=0
 Handle frozen counter input data. More...
 
virtual void handle_analog_input (const HeaderInfo &info, AnalogInputIterator &it)=0
 Handle analog input data. More...
 
virtual void handle_analog_output_status (const HeaderInfo &info, AnalogOutputStatusIterator &it)=0
 Handle analog output status data. More...
 
virtual void handle_octet_string (const HeaderInfo &info, OctetStringIterator &it)=0
 Handle octet string data. More...
 

Detailed Description

General handler that will receive all values read from the outstation.

Note
this class is an "interface" and only has pure virtual methods

Member Function Documentation

◆ begin_fragment()

virtual void dnp3::ReadHandler::begin_fragment ( ReadType  read_type,
const ResponseHeader header 
)
pure virtual

Marks the beginning of a fragment.

Parameters
read_typeDescribes what triggered the read event
headerHeader of the fragment

◆ end_fragment()

virtual void dnp3::ReadHandler::end_fragment ( ReadType  read_type,
const ResponseHeader header 
)
pure virtual

Marks the end of a fragment.

Parameters
read_typeDescribes what triggered the read event
headerHeader of the fragment

◆ handle_analog_input()

virtual void dnp3::ReadHandler::handle_analog_input ( const HeaderInfo info,
AnalogInputIterator it 
)
pure virtual

Handle analog input data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_analog_output_status()

virtual void dnp3::ReadHandler::handle_analog_output_status ( const HeaderInfo info,
AnalogOutputStatusIterator it 
)
pure virtual

Handle analog output status data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_binary_input()

virtual void dnp3::ReadHandler::handle_binary_input ( const HeaderInfo info,
BinaryInputIterator it 
)
pure virtual

Handle binary input data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_binary_output_status()

virtual void dnp3::ReadHandler::handle_binary_output_status ( const HeaderInfo info,
BinaryOutputStatusIterator it 
)
pure virtual

Handle binary output status data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_counter()

virtual void dnp3::ReadHandler::handle_counter ( const HeaderInfo info,
CounterIterator it 
)
pure virtual

Handle counter data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_double_bit_binary_input()

virtual void dnp3::ReadHandler::handle_double_bit_binary_input ( const HeaderInfo info,
DoubleBitBinaryInputIterator it 
)
pure virtual

Handle double-bit binary input data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_frozen_counter()

virtual void dnp3::ReadHandler::handle_frozen_counter ( const HeaderInfo info,
FrozenCounterIterator it 
)
pure virtual

Handle frozen counter input data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

◆ handle_octet_string()

virtual void dnp3::ReadHandler::handle_octet_string ( const HeaderInfo info,
OctetStringIterator it 
)
pure virtual

Handle octet string data.

Parameters
infoGroup/variation and qualifier information
itIterator of point values in the response. This iterator is valid only within this call. Do not copy it.

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