nidas v1.2.3
Public Member Functions | Static Public Member Functions | Static Private Attributes | List of all members
nidas::core::SampleInput Class Referenceabstract

Interface of an input SampleSource. More...

#include <SampleInput.h>

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

Public Member Functions

virtual ~SampleInput ()
 
virtual std::string getName () const =0
 
virtual void setKeepStats (bool val)=0
 
virtual const DSMConfig * getDSMConfig () const =0
 
virtual void requestConnection (DSMService *)=0
 
virtual SampleInput * getOriginal () const =0
 
virtual bool readSamples ()=0
 Read a buffer of data, serialize the data into samples, and distribute() samples to the receive() method of my SampleClients.
 
virtual Sample * readSample ()=0
 Blocking read of the next sample from the buffer.
 
virtual void close ()=0
 
virtual void setNonBlocking (bool val)=0
 
virtual bool isNonBlocking () const =0
 
virtual int getFd () const =0
 
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
 
virtual IOChannelRequester * connected (IOChannel *)=0
 
virtual void fromDOMElement (const xercesc::DOMElement *)=0
 Initialize myself from a xercesc::DOMElement.
 
virtual xercesc::DOMElement * toDOMParent (xercesc::DOMElement *parent, bool complete) const
 Create a DOMElement and append it to the parent.
 
virtual xercesc::DOMElement * toDOMElement (xercesc::DOMElement *node, bool complete) const
 Add my content into a DOMElement.
 

Static Public Member Functions

static const XMLCh * getNamespaceURI ()
 

Static Private Attributes

static XMLCh * namespaceURI = 0
 

Detailed Description

Interface of an input SampleSource.

Typically a SampleInput is reading serialized samples from a socket or file, and then sending them on.

Constructor & Destructor Documentation

◆ ~SampleInput()

virtual nidas::core::SampleInput::~SampleInput ( )
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().

◆ close()

virtual void nidas::core::SampleInput::close ( )
pure virtual
Exceptions
nidas::util::IOException

Implemented in nidas::dynld::SampleInputStream.

◆ connected()

virtual IOChannelRequester * nidas::core::IOChannelRequester::connected ( IOChannel * )
pure virtualinherited

Implemented in nidas::dynld::XMLConfigAllService, nidas::dynld::XMLConfigService, nidas::core::SampleOutputBase, nidas::dynld::SampleOutputStream, nidas::dynld::UDPSampleOutput, and nidas::dynld::SampleInputStream.

Referenced by nidas::core::McSocketUDP::connected(), nidas::core::McSocket::connected(), nidas::core::FileSet::mounted(), and nidas::core::DatagramSocket::requestConnection().

◆ flush()

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

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.

◆ fromDOMElement()

virtual void nidas::core::DOMable::fromDOMElement ( const xercesc::DOMElement * )
pure virtualinherited

Initialize myself from a xercesc::DOMElement.

Exceptions
nidas::util::InvalidParameterException

Implemented in nidas::core::CharacterSensor, nidas::core::DatagramSocket, nidas::core::DSMCatalog, nidas::core::DSMConfig, nidas::core::DSMSensor, nidas::core::DSMServer, nidas::core::McSocket, nidas::core::McSocketUDP, nidas::core::MultipleUDPSockets, nidas::core::Project, nidas::core::SampleTag, nidas::core::SensorCatalog, nidas::core::ServiceCatalog, nidas::core::Site, nidas::core::Socket, nidas::core::ServerSocket, nidas::core::UnixIOChannel, nidas::core::Variable, nidas::core::VariableConverter, nidas::core::Linear, nidas::core::Polynomial, nidas::dynld::isff::CS_Krypton, nidas::dynld::raf::Arinc_IRS, nidas::dynld::raf::DSMArincSensor, nidas::dynld::raf::DSMMesaSensor, nidas::dynld::raf::IRIGSensor, nidas::core::CalFile, nidas::core::DSMService, nidas::core::FileSet, nidas::core::FsMount, nidas::core::SampleIOProcessor, nidas::core::SampleOutputBase, nidas::core::SerialSensor, nidas::dynld::isff::DAUSensor, nidas::dynld::isff::Wind2D, nidas::dynld::iss::TiltSensor, nidas::dynld::raf::CVIProcessor, nidas::dynld::raf::LamsSensor, nidas::dynld::RawSampleInputStream, nidas::dynld::RawSampleOutputStream, nidas::dynld::RawSampleService, nidas::dynld::SampleInputStream, and nidas::dynld::UDPSampleOutput.

Referenced by nidas::core::DSMConfig::fromDOMElement(), nidas::core::SampleIOProcessor::fromDOMElement(), and nidas::dynld::RawSampleOutputStream::fromDOMElement().

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

◆ getDSMConfig()

virtual const DSMConfig * nidas::core::SampleInput::getDSMConfig ( ) const
pure virtual

Implemented in nidas::dynld::SampleInputStream.

◆ getFd()

virtual int nidas::core::SampleInput::getFd ( ) const
pure virtual

Implemented in nidas::dynld::SampleInputStream.

◆ getName()

virtual std::string nidas::core::SampleInput::getName ( ) const
pure virtual

Implemented in nidas::dynld::SampleInputStream.

◆ getNamespaceURI()

static const XMLCh * nidas::core::DOMable::getNamespaceURI ( )
inlinestaticinherited

References nidas::core::DOMable::namespaceURI.

Referenced by nidas::dynld::UDPSampleOutput::getProjectDOM(), nidas::core::Dataset::toDOMElement(), nidas::core::ProjectConfig::toDOMElement(), nidas::core::Dataset::toDOMParent(), nidas::core::Datasets::toDOMParent(), nidas::core::ProjectConfig::toDOMParent(), nidas::core::ProjectConfigs::toDOMParent(), nidas::core::DSMConfig::toDOMParent(), nidas::core::DSMSensor::toDOMParent(), nidas::core::Project::toDOMParent(), nidas::core::SampleTag::toDOMParent(), nidas::core::Site::toDOMParent(), nidas::core::ServerSocket::toDOMParent(), nidas::core::Variable::toDOMParent(), nidas::core::Datasets::writeXML(), and nidas::core::ProjectConfigs::writeXML().

◆ getOriginal()

virtual SampleInput * nidas::core::SampleInput::getOriginal ( ) const
pure virtual

Implemented in nidas::dynld::SampleInputStream.

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

◆ isNonBlocking()

virtual bool nidas::core::SampleInput::isNonBlocking ( ) const
pure virtual
Exceptions
nidas::util::IOException

Implemented in nidas::dynld::SampleInputStream.

◆ readSample()

virtual Sample * nidas::core::SampleInput::readSample ( )
pure virtual

Blocking read of the next sample from the buffer.

The caller must call freeReference on the sample when they're done with it.

Exceptions
nidas::util::IOException

Implemented in nidas::dynld::SampleInputStream.

◆ readSamples()

virtual bool nidas::core::SampleInput::readSamples ( )
pure virtual

Read a buffer of data, serialize the data into samples, and distribute() samples to the receive() method of my SampleClients.

This will perform only one physical read of the underlying device and so is appropriate to use when a select() has determined that there is data availabe on our file descriptor.

Returns
false: no data available for physical read, likely the result of doing a non-blocking read on an empty file descriptor. true: physical read did not necessarily consume all available data.
Exceptions
nidas::util::IOException

Implemented in nidas::dynld::SampleInputStream.

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

◆ requestConnection()

virtual void nidas::core::SampleInput::requestConnection ( DSMService * )
pure virtual
Exceptions
nidas::util::IOException

Implemented in nidas::dynld::SampleInputStream.

◆ setKeepStats()

virtual void nidas::core::SampleInput::setKeepStats ( bool val)
pure virtual

Implemented in nidas::dynld::SampleInputStream.

◆ setNonBlocking()

virtual void nidas::core::SampleInput::setNonBlocking ( bool val)
pure virtual
Exceptions
nidas::util::IOException

Implemented in nidas::dynld::SampleInputStream.

◆ toDOMElement()

xercesc::DOMElement * DOMable::toDOMElement ( xercesc::DOMElement * node,
bool complete ) const
virtualinherited

Add my content into a DOMElement.

Exceptions
xercesc::DOMException

Reimplemented in nidas::core::DSMConfig, nidas::core::DSMSensor, nidas::core::Project, nidas::core::SampleTag, nidas::core::Site, nidas::core::ServerSocket, and nidas::core::Variable.

Referenced by nidas::core::ServerSocket::toDOMParent().

◆ toDOMParent()

xercesc::DOMElement * DOMable::toDOMParent ( xercesc::DOMElement * parent,
bool complete ) const
virtualinherited

Create a DOMElement and append it to the parent.

Exceptions
xercesc::DOMException

Reimplemented in nidas::core::DSMConfig, nidas::core::DSMSensor, nidas::core::Project, nidas::core::SampleTag, nidas::core::Site, nidas::core::ServerSocket, and nidas::core::Variable.

Member Data Documentation

◆ namespaceURI

XMLCh * DOMable::namespaceURI = 0
staticprivateinherited

Referenced by nidas::core::DOMable::getNamespaceURI().

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