An interface that captures the original active API of the AggregateCalculator class required to integrate with the subscription code. More...

#include <aggregatecalculatorinterface.h>

Public Member Functions
virtual UaNodeId	GetAggregateId ()=0
	The aggregate function applied by the calculator. More...

virtual bool	QueueRawValue (UaDataValue value)=0
	Pushes the next raw value into the stream. More...

virtual UaDataValue	GetProcessedValue (bool returnPartial)=0
	Returns the next processed value. More...

virtual bool	UsesInterpolatedBounds ()=0
	Indicates whether this aggregate uses Interpolated Bounding Values. More...

virtual bool	HasEndTimePassed (UaDateTime currentTime)=0
	Returns true if the specified time is later than the end time of the current interval. More...

Detailed Description

An interface that captures the original active API of the AggregateCalculator class required to integrate with the subscription code.

Member Function Documentation

virtual UaNodeId AggregateCalculatorInterface::GetAggregateId ( )

pure virtual

The aggregate function applied by the calculator.

virtual UaDataValue AggregateCalculatorInterface::GetProcessedValue ( bool returnPartial )

pure virtual

Returns the next processed value.

Parameters

returnPartial If true, a partial interval should be processed.

Returns: The processed value. Returns an empty UaDataValue if nothing available and returnPartial is false.

virtual bool AggregateCalculatorInterface::HasEndTimePassed ( UaDateTime currentTime )

pure virtual

Returns true if the specified time is later than the end time of the current interval.

Returns: true if time flows forward and the time is later than the end time.

virtual bool AggregateCalculatorInterface::QueueRawValue ( UaDataValue value )

pure virtual

Pushes the next raw value into the stream.

Parameters

value The data value to append to the stream.

Returns: True if successful, false if the source timestamp has been superseded by values already in the stream.

virtual bool AggregateCalculatorInterface::UsesInterpolatedBounds ( )

pure virtual

Indicates whether this aggregate uses Interpolated Bounding Values.

Returns: True is this aggregate uses Interpolated Bounding Values and false if it uses Simple Bounding Values.

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

C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/aggregatecalculatorinterface.h