An interface used to update measurement values. More...

#include <opendnp3/outstation/IUpdateHandler.h>

Public Member Functions
virtual	~IUpdateHandler ()

virtual bool	FreezeCounter (uint16_t index, bool clear=false, EventMode mode=EventMode::Detect)=0
	Freeze a Counter measurement. More...

virtual bool	Modify (FlagsType type, uint16_t start, uint16_t stop, uint8_t flags)=0
	Update the flags of a measurement without changing it's value. More...

virtual bool	Update (const Analog &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update an Analog measurement. More...

virtual bool	Update (const AnalogOutputStatus &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update a AnalogOutputStatus measurement. More...

virtual bool	Update (const Binary &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update a Binary measurement. More...

virtual bool	Update (const BinaryOutputStatus &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update a BinaryOutputStatus measurement. More...

virtual bool	Update (const Counter &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update a Counter measurement. More...

virtual bool	Update (const DoubleBitBinary &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update a DoubleBitBinary measurement. More...

virtual bool	Update (const OctetString &meas, uint16_t index, EventMode mode=EventMode::Detect)=0
	Update an octet string value. More...

virtual bool	Update (const TimeAndInterval &meas, uint16_t index)=0
	Update a TimeAndInterval valueindex. More...

Detailed Description

An interface used to update measurement values.

Definition at line 34 of file IUpdateHandler.h.

Constructor & Destructor Documentation

◆ ~IUpdateHandler()

virtual opendnp3::IUpdateHandler::~IUpdateHandler ( )

inlinevirtual

Definition at line 37 of file IUpdateHandler.h.

Member Function Documentation

◆ FreezeCounter()

virtual bool opendnp3::IUpdateHandler::FreezeCounter	(	uint16_t	index,
		bool	clear = `false`,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Freeze a Counter measurement.

Parameters

index	index of the measurement
clear	clear the original counter
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Modify()

virtual bool opendnp3::IUpdateHandler::Modify	(	FlagsType	type,
		uint16_t	start,
		uint16_t	stop,
		uint8_t	flags
	)

pure virtual

Update the flags of a measurement without changing it's value.

Parameters

type	enumeration specifiy the type to change
start	the start index at which to begin changing flags
stop	the stop index at which to end changing flags
flags	the new value of the flags

Implemented in opendnp3::UpdateBuilder.

◆ Update() [1/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const Analog &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update an Analog measurement.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [2/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const AnalogOutputStatus &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update a AnalogOutputStatus measurement.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [3/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const Binary &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update a Binary measurement.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [4/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const BinaryOutputStatus &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update a BinaryOutputStatus measurement.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [5/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const Counter &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update a Counter measurement.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [6/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const DoubleBitBinary &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update a DoubleBitBinary measurement.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [7/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const OctetString &	meas,
		uint16_t	index,
		EventMode	mode = `EventMode::Detect`
	)

pure virtual

Update an octet string value.

Parameters

meas	measurement to be processed
index	index of the measurement
mode	Describes how event generation is handled for this method

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

◆ Update() [8/8]

virtual bool opendnp3::IUpdateHandler::Update	(	const TimeAndInterval &	meas,
		uint16_t	index
	)

pure virtual

Update a TimeAndInterval valueindex.

Parameters

meas	measurement to be processed
index	index of the measurement

Returns: true if the value exists and it was updated

Implemented in opendnp3::UpdateBuilder.

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

opendnp3/outstation/IUpdateHandler.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IUpdateHandler()

Member Function Documentation

◆ FreezeCounter()

◆ Modify()

◆ Update() [1/8]

◆ Update() [2/8]

◆ Update() [3/8]

◆ Update() [4/8]

◆ Update() [5/8]

◆ Update() [6/8]

◆ Update() [7/8]

◆ Update() [8/8]