nidas::core::SampleInput Class Reference

Interface of an input SampleSource. More...

#include <SampleInput.h>

Inheritance diagram for nidas::core::SampleInput:

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

Static Public Member Functions
static const XMLCh *	getNamespaceURI ()

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

virtual nidas::core::SampleInput::~SampleInput ( )

inlinevirtual

Member Function Documentation

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

pure virtualinherited

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 virtualinherited

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 virtualinherited

Add a SampleTag to this SampleSource.

This SampleSource does not own the SampleTag.

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

Referenced by nidas::core::SamplePipeline::addSampleTag(), nidas::dynld::RawSampleService::fromDOMElement(), StatsProcess::run(), and DataPrep::run().

virtual void nidas::core::SampleInput::close ( ) throw ( nidas::util::IOException )

pure virtual

Implemented in nidas::dynld::SampleInputStream, and nidas::dynld::isff::PacketInputStream.

Referenced by nidas::core::DSMService::~DSMService().

virtual IOChannelRequester* nidas::core::IOChannelRequester::connected ( IOChannel *  ) throw ( )

pure virtualinherited

Implemented in nidas::dynld::SampleInputStream, nidas::core::SampleOutputBase, nidas::dynld::isff::GOESOutput, nidas::dynld::psql::PSQLSampleOutput, nidas::dynld::UDPSampleOutput, nidas::dynld::SampleOutputStream, nidas::dynld::XMLConfigService, and nidas::dynld::XMLConfigAllService.

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

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

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.

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 void nidas::core::DOMable::fromDOMElement ( const xercesc::DOMElement *  ) throw ( nidas::util::InvalidParameterException )

pure virtualinherited

Initialize myself from a xercesc::DOMElement.

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

Referenced by nidas::core::DSMService::fromDOMElement(), nidas::dynld::isff::GOESOutput::fromDOMElement(), nidas::core::DSMConfig::fromDOMElement(), nidas::core::SampleIOProcessor::fromDOMElement(), nidas::core::SampleOutputBase::fromDOMElement(), and nidas::dynld::SampleInputStream::fromDOMElement().

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

pure virtualinherited

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 const DSMConfig* nidas::core::SampleInput::getDSMConfig ( ) const

pure virtual

Implemented in nidas::dynld::SampleInputStream.

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

pure virtual

Implemented in nidas::dynld::SampleInputStream.

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

pure virtual

Implemented in nidas::dynld::SampleInputStream, and nidas::dynld::isff::PacketInputStream.

Referenced by nidas::dynld::RawSampleService::fromDOMElement().

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::ProjectConfig::toDOMParent(), nidas::core::Datasets::toDOMParent(), nidas::core::ProjectConfigs::toDOMParent(), nidas::core::DSMConfig::toDOMParent(), nidas::core::Project::toDOMParent(), nidas::core::Site::toDOMParent(), nidas::core::SampleTag::toDOMParent(), nidas::core::ServerSocket::toDOMParent(), nidas::core::Variable::toDOMParent(), nidas::core::DSMSensor::toDOMParent(), nidas::core::Datasets::writeXML(), and nidas::core::ProjectConfigs::writeXML().

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

pure virtual

Implemented in nidas::dynld::SampleInputStream.

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::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 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::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.

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

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

pure virtualinherited

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

Referenced by nidas::core::SamplePipeline::getSampleStats(), nidas::dynld::RawSampleService::printClock(), nidas::dynld::RawSampleService::printStatus(), nidas::core::SampleArchiver::printStatus(), and nidas::dynld::raf::SyncRecordGenerator::printStatus().

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

pure virtualinherited

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

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::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::SampleSourceSupport, nidas::dynld::isff::PacketInputStream, nidas::dynld::psql::PSQLProcessor, nidas::dynld::raf::SyncRecordGenerator, nidas::core::SampleAverager, and nidas::core::NearestResampler.

Referenced by nidas::core::DSMEngine::connectOutputs(), nidas::dynld::SampleProcessor::connectSource(), nidas::dynld::StatisticsProcessor::connectSource(), nidas::core::SampleArchiver::connectSource(), nidas::core::SamplePipeline::getSampleTags(), DataPrep::run(), and nidas::dynld::RawSampleService::schedule().

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

pure virtual

Implemented in nidas::dynld::SampleInputStream.

virtual Sample* nidas::core::SampleInput::readSample ( ) throw ( nidas::util::IOException )

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.

Implemented in nidas::dynld::SampleInputStream, and nidas::dynld::isff::PacketInputStream.

virtual bool nidas::core::SampleInput::readSamples ( ) throw ( nidas::util::IOException )

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.

Implemented in nidas::dynld::SampleInputStream, and nidas::dynld::isff::PacketInputStream.

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

pure virtualinherited

Remove a SampleClient from this SampleSource.

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

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

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.

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::removeSampleTag ( const SampleTag *  ) throw ( )

pure virtualinherited

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

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

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

pure virtual

Implemented in nidas::dynld::SampleInputStream.

Referenced by nidas::dynld::RawSampleService::schedule().

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

pure virtual

Implemented in nidas::dynld::SampleInputStream.

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

pure virtual

Implemented in nidas::dynld::SampleInputStream.

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

virtualinherited

Add my content into a DOMElement.

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

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

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

virtualinherited

Create a DOMElement and append it to the parent.

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

---

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

• nidas/core/SampleInput.h