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

#include <SampleSource.h>

Inheritance diagram for nidas::core::SampleSource:

Public Member Functions
virtual	~SampleSource ()

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

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

virtual void	addSampleTag (const SampleTag *)=0 throw (nidas::util::InvalidParameterException)
	Add a SampleTag to this SampleSource. More...

virtual void	removeSampleTag (const SampleTag *)=0 throw ()

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

virtual SampleTagIterator	getSampleTagIterator () const =0

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

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

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

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

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

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

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

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

inlinevirtual

Member Function Documentation

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

pure virtual

Add a SampleClient of all Samples to this SampleSource.

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

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

Referenced by nidas::dynld::SampleProcessor::connect(), nidas::core::SampleArchiver::connect(), nidas::core::SamplePipeline::connect(), nidas::dynld::SampleProcessor::connectSource(), nidas::core::SampleArchiver::connectSource(), DataDump::run(), and DataStats::run().

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

pure virtual

Add a SampleClient to this SampleSource.

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

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

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

pure virtual

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

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.

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

Referenced by nidas::core::DSMEngine::disconnectProcessors().

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

pure virtual

How many SampleClients are currently in my list.

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

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

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::dynld::SampleInputStream, nidas::dynld::raf::SyncRecordSource, nidas::core::NearestResamplerAtRate, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::dynld::StatisticsCruncher, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::NearestResampler, and nidas::core::SampleSourceSupport.

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

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::dynld::SampleInputStream, nidas::dynld::raf::SyncRecordSource, nidas::core::NearestResamplerAtRate, nidas::core::SampleIOProcessor, nidas::core::SamplePipeline, nidas::core::SampleSorter, nidas::dynld::StatisticsCruncher, nidas::core::SampleAverager, nidas::core::NearestResampler, nidas::core::SampleBuffer, and nidas::core::SampleSourceSupport.