nidas v1.2.3
Public Member Functions | List of all members
nidas::core::Resampler Class Referenceabstract

Interface for a resampler, simply a SampleClient and a SampleSource. More...

#include <Resampler.h>

Inheritance diagram for nidas::core::Resampler:
Inheritance graph
[legend]

Public Member Functions

virtual ~Resampler ()
 
virtual void flush () throw () =0
 Both SampleClient and SampleSource have a flush() method.
 
virtual void connect (SampleSource *source)=0
 Connect the resampler to a source.
 
virtual void disconnect (SampleSource *source) throw () =0
 
virtual bool receive (const Sample *s)=0
 Method called to pass a sample to this client.
 
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 const SampleStats & getSampleStats () const =0
 

Detailed Description

Interface for a resampler, simply a SampleClient and a SampleSource.

Constructor & Destructor Documentation

◆ ~Resampler()

virtual nidas::core::Resampler::~Resampler ( )
inlinevirtual

Member Function Documentation

◆ addSampleClient()

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

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 virtualinherited

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 virtualinherited

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().

◆ connect()

virtual void nidas::core::Resampler::connect ( SampleSource * source)
pure virtual

Connect the resampler to a source.

Exceptions
nidas::util::InvalidParameterException

Implemented in nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::dynld::raf::SyncRecordSource, nidas::dynld::StatisticsCruncher, and nidas::core::NearestResampler.

◆ disconnect()

virtual void nidas::core::Resampler::disconnect ( SampleSource * source)
throw ( )
pure virtual

Implemented in nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::dynld::raf::SyncRecordSource, nidas::dynld::StatisticsCruncher, and nidas::core::NearestResampler.

◆ flush()

virtual void nidas::core::Resampler::flush ( )
throw ( )
pure virtual

Both SampleClient and SampleSource have a flush() method.

Redeclaring it here as pure virtual removes the ambiguity.

Implements nidas::core::SampleClient.

Implemented in nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::SampleAverager, nidas::dynld::raf::SyncRecordSource, and nidas::dynld::StatisticsCruncher.

◆ getClientCount()

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

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 virtualinherited

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 virtualinherited

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.

Referenced by nidas::core::SamplePipeline::connect(), nidas::core::SampleArchiver::connectSource(), nidas::core::SamplePipeline::disconnect(), and nidas::core::SampleArchiver::disconnectSource().

◆ getSampleStats()

virtual const SampleStats & nidas::core::SampleSource::getSampleStats ( ) const
pure virtualinherited

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::getSampleStats(), nidas::core::SampleArchiver::printStatus(), nidas::dynld::raf::SyncRecordGenerator::printStatus(), and nidas::dynld::RawSampleService::printStatus().

◆ getSampleTagIterator()

virtual SampleTagIterator nidas::core::SampleSource::getSampleTagIterator ( ) const
pure virtualinherited

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::dynld::StatisticsCruncher::connect(), nidas::dynld::raf::CVIProcessor::connectSource(), and nidas::core::SamplePipeline::getSampleTagIterator().

◆ getSampleTags()

virtual std::list< const SampleTag * > nidas::core::SampleSource::getSampleTags ( ) const
pure virtualinherited

What SampleTags am I a SampleSource for?

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::dynld::StatisticsCruncher::attach(), nidas::core::NearestResamplerAtRate::connect(), nidas::core::SampleAverager::connect(), nidas::core::NearestResampler::connect(), nidas::core::SampleArchiver::connectSource(), nidas::dynld::SampleProcessor::connectSource(), nidas::dynld::StatisticsProcessor::connectSource(), nidas::core::SamplePipeline::getSampleTags(), and nidas::dynld::RawSampleService::schedule().

◆ receive()

virtual bool nidas::core::SampleClient::receive ( const Sample * s)
pure virtualinherited

Method called to pass a sample to this client.

This method is typically called by a SampleSource for each of its SampleClients when it has a sample ready. Returns true: success false: sample rejected. This is meant to signal a warning-type situation - like a socket not being available temporarily. True errors will be thrown as an IOException.

Exceptions

)

Implemented in nidas::dynld::UDPSampleOutput, nidas::dynld::raf::SyncRecordSource, TestClient, nidas::core::DSMSensor, nidas::core::NearestResampler, nidas::core::NearestResamplerAtRate, nidas::core::RemoteSerialConnection, nidas::core::SampleAverager, nidas::core::SampleBuffer, nidas::core::SampleOutputBase, nidas::core::SampleSorter, nidas::dynld::raf::CVIProcessor, nidas::dynld::raf::SyncRecordReader, nidas::dynld::SampleOutputStream, nidas::dynld::StatisticsCruncher, DumpClient, SampleDispatcher, DataStats, DumpClient, nidas::dynld::AsciiOutput, and nidas::dynld::raf::CVIOutput.

◆ removeSampleClient()

virtual void nidas::core::SampleSource::removeSampleClient ( SampleClient * c)
pure virtualinherited

Remove a SampleClient from this SampleSource.

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::core::RemoteSerialConnection::close(), nidas::core::DSMEngine::closeOutputs(), nidas::core::SampleArchiver::disconnect(), nidas::dynld::SampleProcessor::disconnect(), nidas::core::SampleArchiver::~SampleArchiver(), and nidas::dynld::SampleProcessor::~SampleProcessor().

◆ removeSampleClientForTag()

virtual void nidas::core::SampleSource::removeSampleClientForTag ( SampleClient * c,
const SampleTag *  )
pure virtualinherited

Remove a SampleClient for a given SampleTag from 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.

◆ removeSampleTag()

virtual void nidas::core::SampleSource::removeSampleTag ( const SampleTag * )
pure virtualinherited
Exceptions

)

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::removeSampleTag().

The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0