Pure virtual interface for a source of Samples. More...

#include <SampleSource.h>

Inheritance diagram for nidas::core::SampleSource:

[legend]

Public Member Functions
virtual	~SampleSource ()

virtual SampleSource *	getRawSampleSource ()=0
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

virtual SampleSource *	getProcessedSampleSource ()=0
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

virtual void	addSampleTag (const SampleTag *)=0
	Add a SampleTag to this SampleSource.

virtual void	removeSampleTag (const SampleTag *)=0

virtual std::list< const SampleTag * >	getSampleTags () const =0
	What SampleTags am I a SampleSource for?

virtual SampleTagIterator	getSampleTagIterator () const =0

virtual void	addSampleClient (SampleClient *c)=0
	Add a SampleClient of all Samples to this SampleSource.

virtual void	removeSampleClient (SampleClient *c)=0
	Remove a SampleClient from this SampleSource.

virtual void	addSampleClientForTag (SampleClient c, const SampleTag )=0
	Add a SampleClient to this SampleSource.

virtual void	removeSampleClientForTag (SampleClient c, const SampleTag )=0
	Remove a SampleClient for a given SampleTag from this SampleSource.

virtual int	getClientCount () const =0
	How many SampleClients are currently in my list.

virtual void	flush ()=0
	Request that this SampleSource flush it's samples.

virtual const SampleStats &	getSampleStats () const =0

Detailed Description

Pure virtual interface for a source of Samples.

Implementations of SampleSource typically maintain a list of SampleClients. When a SampleSource has a Sample ready, it will call the receive method of all its SampleClients. SampleClients register/unregister with a SampleSource via the addSampleClient/removeSampleClient methods.

Constructor & Destructor Documentation

◆ ~SampleSource()

virtual nidas::core::SampleSource::~SampleSource ( )

inlinevirtual

Member Function Documentation

◆ addSampleClient()

virtual void nidas::core::SampleSource::addSampleClient ( SampleClient * c )

pure virtual

Add a SampleClient of all Samples to this SampleSource.

The pointer to the SampleClient must remain valid, until after it is removed.

Exceptions

)

Implemented in nidas::dynld::SampleInputStream, nidas::core::DSMSensor, nidas::core::SampleSourceSupport, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::dynld::raf::SyncRecordGenerator, nidas::dynld::raf::SyncRecordSource, and nidas::dynld::StatisticsCruncher.

Referenced by nidas::dynld::AsciiOutput::connect(), nidas::core::SampleArchiver::connect(), nidas::dynld::SampleProcessor::connect(), nidas::core::SampleArchiver::connectSource(), and nidas::dynld::SampleProcessor::connectSource().

◆ addSampleClientForTag()

virtual void nidas::core::SampleSource::addSampleClientForTag	(	SampleClient *	c,
		const SampleTag *	)

pure virtual

Add a SampleClient to this SampleSource.

The pointer to the SampleClient must remain valid, until after it is removed.

Exceptions

)

Implemented in nidas::dynld::SampleInputStream, nidas::core::SamplePipeline, nidas::core::SampleSourceSupport, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::dynld::raf::SyncRecordSource, nidas::dynld::StatisticsCruncher, nidas::core::DSMSensor, nidas::core::SampleBuffer, nidas::core::SampleIOProcessor, nidas::core::SampleSorter, and nidas::dynld::raf::SyncRecordGenerator.

Referenced by nidas::dynld::StatisticsCruncher::attach(), nidas::dynld::raf::CVIProcessor::attachLVInput(), nidas::core::NearestResamplerAtRate::connect(), nidas::core::SampleAverager::connect(), and nidas::core::NearestResampler::connect().

◆ addSampleTag()

virtual void nidas::core::SampleSource::addSampleTag ( const SampleTag * )

pure virtual

Add a SampleTag to this SampleSource.

This SampleSource does not own the SampleTag.

Exceptions

nidas::util::InvalidParameterException

Implemented in nidas::dynld::SampleInputStream, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::core::SampleSourceSupport, nidas::dynld::raf::SyncRecordSource, nidas::dynld::StatisticsCruncher, and nidas::core::DSMSensor.

Referenced by nidas::core::SamplePipeline::addSampleTag(), and nidas::dynld::RawSampleService::schedule().

◆ flush()

virtual void nidas::core::SampleSource::flush ( )

pure virtual

Request that this SampleSource flush it's samples.

One must think about whether to call flush() on SampleClients of this SampleSource. A SampleClient may have multiple SampleSources and a flush() of it when one SampleSource() is done may not be what is wanted.

Exceptions

)

Implemented in nidas::core::DSMSensor, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleArchiver, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::core::SampleSourceSupport, nidas::dynld::raf::CVIProcessor, nidas::dynld::raf::SyncRecordGenerator, nidas::dynld::raf::SyncRecordSource, nidas::dynld::SampleInputStream, nidas::dynld::SampleProcessor, nidas::dynld::StatisticsCruncher, nidas::dynld::StatisticsProcessor, nidas::core::Resampler, and nidas::core::SampleThread.

◆ getClientCount()

virtual int nidas::core::SampleSource::getClientCount ( ) const

pure virtual

How many SampleClients are currently in my list.

Exceptions

)

Implemented in nidas::core::DSMSensor, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::core::SampleSourceSupport, nidas::dynld::raf::SyncRecordGenerator, nidas::dynld::raf::SyncRecordSource, nidas::dynld::SampleInputStream, and nidas::dynld::StatisticsCruncher.

Referenced by nidas::core::SamplePipeline::getClientCount().

◆ getProcessedSampleSource()

virtual SampleSource * nidas::core::SampleSource::getProcessedSampleSource ( )

pure virtual

Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

SampleClients use this method to get a pointer to whatever sample source they are interested in. Derived classes can return NULL if they are not a SampleSource of processed samples.

Implemented in nidas::core::DSMSensor, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::core::SampleSourceSupport, nidas::dynld::raf::SyncRecordSource, nidas::dynld::SampleInputStream, and nidas::dynld::StatisticsCruncher.

Referenced by nidas::core::SampleArchiver::connectSource(), nidas::dynld::raf::CVIProcessor::connectSource(), nidas::dynld::SampleProcessor::connectSource(), nidas::dynld::StatisticsProcessor::connectSource(), and nidas::core::SampleArchiver::disconnectSource().

◆ getRawSampleSource()

virtual SampleSource * nidas::core::SampleSource::getRawSampleSource ( )

pure virtual

Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

SampleClients use this method to get a pointer to whatever sample source they are interested in. Derived classes can return NULL if they are not a SampleSource of raw samples.

Implemented in nidas::core::DSMSensor, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::core::SampleSourceSupport, nidas::dynld::raf::SyncRecordSource, nidas::dynld::SampleInputStream, and nidas::dynld::StatisticsCruncher.