Dynamic information required by the outstation from the user application. More...

#include <dnp3.hpp>

Public Member Functions
virtual uint16_t	get_processing_delay_ms ()=0
	Returns the DELAY_MEASUREMENT delay. More...

virtual WriteTimeResult	write_absolute_time (uint64_t time)=0
	Handle a write of the absolute time during time synchronization procedures. More...

virtual ApplicationIin	get_application_iin ()=0
	Returns the application-controlled IIN bits. More...

virtual RestartDelay	cold_restart ()=0
	Request that the outstation perform a cold restart (IEEE-1815 2012, p. 58) More...

virtual RestartDelay	warm_restart ()=0
	Request that the outstation perform a warm restart (IEEE-1815 2012, p. 58) More...

virtual FreezeResult	freeze_counters_all (FreezeType freeze_type, DatabaseHandle &database_handle)
	Freeze all the counters. More...

virtual FreezeResult	freeze_counters_all_at_time (DatabaseHandle &database_handle, uint64_t time, uint32_t interval)
	Freeze all the counters at a requested time and interval. More...

virtual FreezeResult	freeze_counters_range (uint16_t start, uint16_t stop, FreezeType freeze_type, DatabaseHandle &database_handle)
	Freeze a range of counters. More...

virtual FreezeResult	freeze_counters_range_at_time (uint16_t start, uint16_t stop, DatabaseHandle &database_handle, uint64_t time, uint32_t interval)
	Freeze a range of counters at a requested time and interval. More...

virtual bool	support_write_analog_dead_bands ()
	Controls outstation support for writing group 34, analog input dead-bands. More...

virtual void	begin_write_analog_dead_bands ()
	Called when the outstation begins processing a header to write analog dead-bands. More...

virtual void	write_analog_dead_band (uint16_t index, double dead_band)
	Called when the outstation begins processing a header to write analog dead-bands. More...

virtual void	end_write_analog_dead_bands ()
	Called when the outstation completes processing a header to write analog dead-bands. More...

virtual bool	write_string_attr (uint8_t set, uint8_t variation, StringAttr attr_type, const char *value)
	Write a string attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_float_attr (uint8_t set, uint8_t variation, FloatAttr attr_type, float value)
	Write a 32-bit floating point attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_double_attr (uint8_t set, uint8_t variation, FloatAttr attr_type, double value)
	Write a 64-bit floating point attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_uint_attr (uint8_t set, uint8_t variation, UintAttr attr_type, uint32_t value)
	Write an unsigned integer attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_int_attr (uint8_t set, uint8_t variation, IntAttr attr_type, int32_t value)
	Write a signed integer attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_octet_string_attr (uint8_t set, uint8_t variation, OctetStringAttr attr_type, ByteIterator &value)
	Write an octet-string attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_bit_string_attr (uint8_t set, uint8_t variation, BitStringAttr attr_type, ByteIterator &value)
	Write a bit-string attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual bool	write_time_attr (uint8_t set, uint8_t variation, TimeAttr attr_type, uint64_t value)
	Write a DNP3 time attribute. This method is only called if the corresponding attribute has been configured as writable. More...

virtual void	begin_confirm ()
	Called when a CONFIRM is received to a response or unsolicited response, but before any previously transmitted events are cleared from the buffer. More...

virtual void	event_cleared (uint64_t id)
	Called when an event is cleared from the buffer due to master acknowledgement. More...

virtual void	end_confirm (const BufferState &state)
	Called when all relevant events have been cleared. More...

Detailed Description

Dynamic information required by the outstation from the user application.

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

Member Function Documentation

◆ begin_confirm()

virtual void dnp3::OutstationApplication::begin_confirm ( )

inlinevirtual

Called when a CONFIRM is received to a response or unsolicited response, but before any previously transmitted events are cleared from the buffer.

Note: This method has a default implementation that does nothing

◆ begin_write_analog_dead_bands()

virtual void dnp3::OutstationApplication::begin_write_analog_dead_bands ( )

inlinevirtual

Called when the outstation begins processing a header to write analog dead-bands.

Note: This method has a default implementation that does nothing

◆ cold_restart()

virtual RestartDelay dnp3::OutstationApplication::cold_restart ( )

pure virtual

Request that the outstation perform a cold restart (IEEE-1815 2012, p. 58)

The outstation will not automatically restart. It is the responsibility of the user application to handle this request and take the appropriate action.

Returns: The restart delay

◆ end_confirm()

virtual void dnp3::OutstationApplication::end_confirm ( const BufferState & state )

inlinevirtual

Called when all relevant events have been cleared.

Parameters

state information about the post-CONFIRM state of the buffer

Note: This method has a default implementation that does nothing

◆ end_write_analog_dead_bands()

virtual void dnp3::OutstationApplication::end_write_analog_dead_bands ( )

inlinevirtual

Called when the outstation completes processing a header to write analog dead-bands.

Multiple dead-bands changes can be accumulated in calls to OutstationApplication::write_analog_dead_band() and then be processed as a batch in this method.

Note: This method has a default implementation that does nothing

◆ event_cleared()

virtual void dnp3::OutstationApplication::event_cleared ( uint64_t id )

inlinevirtual

Called when an event is cleared from the buffer due to master acknowledgement.

Parameters

id	Unique identifier previously assigned to the event by the database in an update method

Note: This method has a default implementation that does nothing

◆ freeze_counters_all()

virtual FreezeResult dnp3::OutstationApplication::freeze_counters_all	(	FreezeType	freeze_type,
		DatabaseHandle &	database_handle
	)

inlinevirtual

Freeze all the counters.

Parameters

freeze_type	Type of freeze operation
database_handle	Database handle

Returns: Result of the freeze operation

Note: This method has a default implementation that returns 'FreezeResult::not_supported'

◆ freeze_counters_all_at_time()

virtual FreezeResult dnp3::OutstationApplication::freeze_counters_all_at_time	(	DatabaseHandle &	database_handle,
		uint64_t	time,
		uint32_t	interval
	)

inlinevirtual

Freeze all the counters at a requested time and interval.

Refer to the table on page 57 of IEEE 1815-2012 to interpret the time and interval parameters correctly

Parameters

database_handle	Database handle
time	48-bit DNP3 timestamp in milliseconds since epoch UTC
interval	Count of milliseconds representing the interval between freezes relative to the timestamp

Returns: Result of the freeze operation

Note: This method has a default implementation that returns 'FreezeResult::not_supported'

◆ freeze_counters_range()

virtual FreezeResult dnp3::OutstationApplication::freeze_counters_range	(	uint16_t	start,
		uint16_t	stop,
		FreezeType	freeze_type,
		DatabaseHandle &	database_handle
	)

inlinevirtual

Freeze a range of counters.

Parameters

start	Start index to freeze (inclusive)
stop	Stop index to freeze (inclusive)
freeze_type	Type of freeze operation
database_handle	Database handle

Returns: Result of the freeze operation

Note: This method has a default implementation that returns 'FreezeResult::not_supported'

◆ freeze_counters_range_at_time()

virtual FreezeResult dnp3::OutstationApplication::freeze_counters_range_at_time	(	uint16_t	start,
		uint16_t	stop,
		DatabaseHandle &	database_handle,
		uint64_t	time,
		uint32_t	interval
	)

inlinevirtual

Freeze a range of counters at a requested time and interval.

Refer to the table on page 57 of IEEE 1815-2012 to interpret the time and interval parameters correctly

Parameters

start	Start index to freeze (inclusive)
stop	Stop index to freeze (inclusive)
database_handle	Database handle
time	48-bit DNP3 timestamp in milliseconds since epoch UTC
interval	Count of milliseconds representing the interval between freezes relative to the timestamp

Returns: Result of the freeze operation

Note: This method has a default implementation that returns 'FreezeResult::not_supported'

◆ get_application_iin()

virtual ApplicationIin dnp3::OutstationApplication::get_application_iin ( )

pure virtual

Returns the application-controlled IIN bits.

Returns: Application IIN bits

◆ get_processing_delay_ms()

virtual uint16_t dnp3::OutstationApplication::get_processing_delay_ms ( )

pure virtual

Returns the DELAY_MEASUREMENT delay.

The value returned by this method is used in conjunction with the DELAY_MEASUREMENT function code and returned in a g52v2 time delay object as part of a non-LAN time synchronization procedure.

It represents the processing delay from receiving the request to sending the response. This parameter should almost always use the default value of zero as only an RTOS or bare metal system would have access to this level of timing. Modern hardware can almost always respond in less than 1 millisecond anyway.

For more information, see IEEE-1815 2012, p. 64.

Returns: Processing delay, in milliseconds

◆ support_write_analog_dead_bands()

virtual bool dnp3::OutstationApplication::support_write_analog_dead_bands ( )

inlinevirtual

Controls outstation support for writing group 34, analog input dead-bands.

Returning false, indicates that the writes to group34 should not be processed and requests to do so should be rejected with IIN2.NO_FUNC_CODE_SUPPORT

Returning true will allow the request to process the actual values with a sequence of calls:

1) A single call to OutstationApplication::begin_write_analog_dead_bands()

2) Zero or more calls to OutstationApplication::write_analog_dead_band()

3) A single call to OutstationApplication::end_write_analog_dead_bands()

Returns: True if the outstation should process the request

Note: This method has a default implementation that returns 'false'

◆ warm_restart()

virtual RestartDelay dnp3::OutstationApplication::warm_restart ( )

pure virtual

Request that the outstation perform a warm restart (IEEE-1815 2012, p. 58)

The outstation will not automatically restart. It is the responsibility of the user application to handle this request and take the appropriate action.

Returns: The restart delay

◆ write_absolute_time()

virtual WriteTimeResult dnp3::OutstationApplication::write_absolute_time ( uint64_t time )

pure virtual

Handle a write of the absolute time during time synchronization procedures.

Parameters

time	Received time in milliseconds since EPOCH (only 48 bits are used)

Returns: Result of the write time operation

◆ write_analog_dead_band()

virtual void dnp3::OutstationApplication::write_analog_dead_band	(	uint16_t	index,
		double	dead_band
	)

inlinevirtual

Called when the outstation begins processing a header to write analog dead-bands.

Called for each analog dead-band in the write request where an analog input is defined at the specified index.

The dead-band is automatically updated in the database. This callback allows application code to persist the modified value to non-volatile memory if desired

Parameters

index	Index of the analog input
dead_band	New dead-band value

Note: This method has a default implementation that does nothing

◆ write_bit_string_attr()

virtual bool dnp3::OutstationApplication::write_bit_string_attr	(	uint8_t	set,
		uint8_t	variation,
		BitStringAttr	attr_type,
		ByteIterator &	value
	)

inlinevirtual

Write a bit-string attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Iterator over bytes of the value

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_double_attr()

virtual bool dnp3::OutstationApplication::write_double_attr	(	uint8_t	set,
		uint8_t	variation,
		FloatAttr	attr_type,
		double	value
	)

inlinevirtual

Write a 64-bit floating point attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Value of the attribute

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_float_attr()

virtual bool dnp3::OutstationApplication::write_float_attr	(	uint8_t	set,
		uint8_t	variation,
		FloatAttr	attr_type,
		float	value
	)

inlinevirtual

Write a 32-bit floating point attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Value of the attribute

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_int_attr()

virtual bool dnp3::OutstationApplication::write_int_attr	(	uint8_t	set,
		uint8_t	variation,
		IntAttr	attr_type,
		int32_t	value
	)

inlinevirtual

Write a signed integer attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Value of the attribute

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_octet_string_attr()

virtual bool dnp3::OutstationApplication::write_octet_string_attr	(	uint8_t	set,
		uint8_t	variation,
		OctetStringAttr	attr_type,
		ByteIterator &	value
	)

inlinevirtual

Write an octet-string attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Iterator over bytes of the value

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_string_attr()

virtual bool dnp3::OutstationApplication::write_string_attr	(	uint8_t	set,
		uint8_t	variation,
		StringAttr	attr_type,
		const char *	value
	)

inlinevirtual

Write a string attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Value of the attribute

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_time_attr()

virtual bool dnp3::OutstationApplication::write_time_attr	(	uint8_t	set,
		uint8_t	variation,
		TimeAttr	attr_type,
		uint64_t	value
	)

inlinevirtual

Write a DNP3 time attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	48-bit DNP3 timestamp value

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

◆ write_uint_attr()

virtual bool dnp3::OutstationApplication::write_uint_attr	(	uint8_t	set,
		uint8_t	variation,
		UintAttr	attr_type,
		uint32_t	value
	)

inlinevirtual

Write an unsigned integer attribute. This method is only called if the corresponding attribute has been configured as writable.

Parameters

set	Set to which the attribute belongs
variation	Variation of the attribute
attr_type	Enumeration describing which attribute it is, possibly unknown
value	Value of the attribute

Returns: If true, the value will be modified in the in memory database and the outstation will return a successful response. If false, no change will be made and the outstation will return PARAM_ERROR

Note: This method has a default implementation that returns 'false'

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

dnp3.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ begin_confirm()

◆ begin_write_analog_dead_bands()

◆ cold_restart()

◆ end_confirm()

◆ end_write_analog_dead_bands()

◆ event_cleared()

◆ freeze_counters_all()

◆ freeze_counters_all_at_time()

◆ freeze_counters_range()

◆ freeze_counters_range_at_time()

◆ get_application_iin()

◆ get_processing_delay_ms()

◆ support_write_analog_dead_bands()

◆ warm_restart()

◆ write_absolute_time()

◆ write_analog_dead_band()

◆ write_bit_string_attr()

◆ write_double_attr()

◆ write_float_attr()

◆ write_int_attr()

◆ write_octet_string_attr()

◆ write_string_attr()

◆ write_time_attr()

◆ write_uint_attr()