A non-templated interface to a TimeSeriesProperty. More...

#include <ITimeSeriesProperty.h>

Inheritance diagram for Mantid::Kernel::ITimeSeriesProperty:

Public Member Functions
virtual std::pair< double, double >	averageAndStdDevInFilter (const std::vector< SplittingInterval > &filter) const =0
	Calculate the time-weighted average and standard deviation of a property in a filtered range. More...

virtual double	averageValueInFilter (const std::vector< SplittingInterval > &filter) const =0
	Calculate the time-weighted average of a property in a filtered range. More...

virtual void	clear ()=0
	Deletes the series of values in the property. More...

virtual void	clearOutdated ()=0
	Deletes all but the 'last entry' in the property. More...

virtual Property *	cloneWithTimeShift (const double timeShift) const =0

virtual void	expandFilterToRange (std::vector< SplittingInterval > &split, double min, double max, const TimeInterval &range) const =0
	Make sure an existing filter covers the full time range given. More...

virtual void	makeFilterByValue (std::vector< SplittingInterval > &split, double min, double max, double TimeTolerance, bool centre=true) const =0
	Fill a TimeSplitterType that will filter the events by matching. More...

virtual int	realSize () const =0
	Returns the real size of the time series property map: More...

virtual double	timeAverageValue () const =0
	Returns the calculated time weighted average value. More...

virtual std::vector< Types::Core::DateAndTime >	timesAsVector () const =0
	Return the time series's times as a vector<DateAndTime> More...

virtual	~ITimeSeriesProperty ()=default
	Virtual destructor. More...

Detailed Description

A non-templated interface to a TimeSeriesProperty.

Definition at line 26 of file ITimeSeriesProperty.h.

Constructor & Destructor Documentation

◆ ~ITimeSeriesProperty()

virtual Mantid::Kernel::ITimeSeriesProperty::~ITimeSeriesProperty ( )

virtualdefault

Virtual destructor.

Member Function Documentation

◆ averageAndStdDevInFilter()

virtual std::pair< double, double > Mantid::Kernel::ITimeSeriesProperty::averageAndStdDevInFilter ( const std::vector< SplittingInterval > & filter ) const

pure virtual

Calculate the time-weighted average and standard deviation of a property in a filtered range.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ averageValueInFilter()

virtual double Mantid::Kernel::ITimeSeriesProperty::averageValueInFilter ( const std::vector< SplittingInterval > & filter ) const

pure virtual

Calculate the time-weighted average of a property in a filtered range.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ clear()

virtual void Mantid::Kernel::ITimeSeriesProperty::clear ( )

pure virtual

Deletes the series of values in the property.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ clearOutdated()

virtual void Mantid::Kernel::ITimeSeriesProperty::clearOutdated ( )

pure virtual

Deletes all but the 'last entry' in the property.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ cloneWithTimeShift()

virtual Property * Mantid::Kernel::ITimeSeriesProperty::cloneWithTimeShift ( const double timeShift ) const

pure virtual

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ expandFilterToRange()

virtual void Mantid::Kernel::ITimeSeriesProperty::expandFilterToRange	(	std::vector< SplittingInterval > &	split,
		double	min,
		double	max,
		const TimeInterval &	range
	)		const

pure virtual

Make sure an existing filter covers the full time range given.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ makeFilterByValue()

virtual void Mantid::Kernel::ITimeSeriesProperty::makeFilterByValue	(	std::vector< SplittingInterval > &	split,
		double	min,
		double	max,
		double	TimeTolerance,
		bool	centre = `true`
	)		const

pure virtual

Fill a TimeSplitterType that will filter the events by matching.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, Mantid::Kernel::TimeSeriesProperty< bool >, Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ realSize()

virtual int Mantid::Kernel::ITimeSeriesProperty::realSize ( ) const

pure virtual

Returns the real size of the time series property map:

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ timeAverageValue()

virtual double Mantid::Kernel::ITimeSeriesProperty::timeAverageValue ( ) const

pure virtual

Returns the calculated time weighted average value.

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

◆ timesAsVector()

virtual std::vector< Types::Core::DateAndTime > Mantid::Kernel::ITimeSeriesProperty::timesAsVector ( ) const

pure virtual

Return the time series's times as a vector<DateAndTime>

Implemented in Mantid::Kernel::TimeSeriesProperty< TYPE >, Mantid::Kernel::TimeSeriesProperty< HeldType >, Mantid::Kernel::TimeSeriesProperty< double >, Mantid::Kernel::TimeSeriesProperty< int >, and Mantid::Kernel::TimeSeriesProperty< bool >.

Referenced by Mantid::Algorithms::FilterByLogValue::exec().

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

Framework/Kernel/inc/MantidKernel/ITimeSeriesProperty.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ITimeSeriesProperty()

Member Function Documentation

◆ averageAndStdDevInFilter()

◆ averageValueInFilter()

◆ clear()

◆ clearOutdated()

◆ cloneWithTimeShift()

◆ expandFilterToRange()

◆ makeFilterByValue()

◆ realSize()

◆ timeAverageValue()

◆ timesAsVector()