adtf::streaming::wolverine::ISampleStreamStatistics Class Reference

Samplestream statistics Interface. This interface describes statistical information of an ISampleStream. More...

#include <samplestream_statistics_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::streaming::sample_stream<>, adtf::streaming::sample_stream< IStreamingPort, IStreamingInPort, ISampleStreamInPort >, adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >, and adtf::streaming::sample_stream< INTERFACES >.

Public Types
using	tSampleStreamStatistic = adtf::services::wolverine::ISampleStreamTracer::tTraceData
	structure containing the current samplestream statistics for samplestream input and output

Public Member Functions
	ADTF_IID (ISampleStreamStatistics, "samplestream_statistics.wolverine.streaming.adtf.iid")
	definition of interface identifier
virtual tSampleStreamStatistic	GetStatistics ()=0
virtual void	EnableSampleSizeStatistics (bool bEnable)=0
virtual void	ResetStatistics ()=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~ISampleStreamStatistics ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Samplestream statistics Interface. This interface describes statistical information of an ISampleStream.

Member Function Documentation

EnableSampleSizeStatistics()

virtual void adtf::streaming::wolverine::ISampleStreamStatistics::EnableSampleSizeStatistics ( bool bEnable )

pure virtual

Enables/disables the tracking of sample size statistics. For better performance this can be turned off.

Parameters

[in]

bEnable

Whether to enable sample size statistics.

Implemented in adtf::streaming::sample_stream< INTERFACES >, adtf::streaming::sample_stream< IStreamingPort, IStreamingInPort, ISampleStreamInPort >, adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >, and adtf::streaming::sample_stream<>.

GetStatistics()

virtual tSampleStreamStatistic adtf::streaming::wolverine::ISampleStreamStatistics::GetStatistics ( )

pure virtual

Calculates and retrieves the statistical information.

Returns

Statistic information object.

Implemented in adtf::streaming::sample_stream< INTERFACES >, adtf::streaming::sample_stream< IStreamingPort, IStreamingInPort, ISampleStreamInPort >, adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >, and adtf::streaming::sample_stream<>.

ResetStatistics()

virtual void adtf::streaming::wolverine::ISampleStreamStatistics::ResetStatistics ( )

pure virtual

Resets statistical information.

Implemented in adtf::streaming::sample_stream< INTERFACES >, adtf::streaming::sample_stream< IStreamingPort, IStreamingInPort, ISampleStreamInPort >, adtf::streaming::sample_stream< IStreamingPort, IStreamingOutPort, ISampleStreamOutPort >, and adtf::streaming::sample_stream<>.

---

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

• src/libraries/streaming3/include/adtfstreaming3/samplestream_statistics_intf.h