#include <RawSampleInputStream.h>

Inheritance diagram for nidas::dynld::RawSampleInputStream:

Public Types
typedef nidas::core::dsm_time_t	dsm_time_t

Public Member Functions
	RawSampleInputStream ()
	Default constructor. More...

	RawSampleInputStream (nidas::core::IOChannel *iochannel)
	Constructor with a connected IOChannel. More...

RawSampleInputStream *	clone (nidas::core::IOChannel *)
	Create a copy with a different, connected IOChannel. More...

virtual	~RawSampleInputStream ()

void	fromDOMElement (const xercesc::DOMElement *node) throw (nidas::util::InvalidParameterException)
	Initialize myself from a xercesc::DOMElement. More...

std::string	getName () const

int	getFd () const

virtual void	setIOChannel (nidas::core::IOChannel *val)
	Set the IOChannel for this SampleInputStream.h. More...

void	readInputHeader () throw (nidas::util::IOException)
	Read archive information at beginning of input stream or file. More...

bool	parseInputHeader () throw (nidas::util::IOException)

const nidas::core::SampleInputHeader &	getInputHeader () const

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

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

nidas::core::SampleInput *	connected (nidas::core::IOChannel *iochan) throw ()
	Implementation of IOChannelRequester::connected. More...

void	setNonBlocking (bool val) throw (nidas::util::IOException)

bool	isNonBlocking () const throw (nidas::util::IOException)

const nidas::core::DSMConfig *	getDSMConfig () const
	What DSM am I connnected to? May be NULL if it cannot be determined. More...

void	setKeepStats (bool val)

void	addSampleTag (const nidas::core::SampleTag *tag) throw ()
	Implementation of SampleInput::addSampleTag(). More...

void	removeSampleTag (const nidas::core::SampleTag *tag) throw ()

nidas::core::SampleSource *	getRawSampleSource ()
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples. More...

nidas::core::SampleSource *	getProcessedSampleSource ()
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples. More...

std::list< const nidas::core::SampleTag * >	getSampleTags () const
	Get the output SampleTags. More...

nidas::core::SampleTagIterator	getSampleTagIterator () const
	Implementation of SampleSource::getSampleTagIterator(). More...

void	addSampleClient (nidas::core::SampleClient *client) throw ()
	Implementation of SampleSource::addSampleClient(). More...

void	removeSampleClient (nidas::core::SampleClient *client) throw ()
	Remove a SampleClient from this SampleSource. More...

void	addSampleClientForTag (nidas::core::SampleClient client, const nidas::core::SampleTag tag) throw ()
	Add a Client for a given SampleTag. More...

void	removeSampleClientForTag (nidas::core::SampleClient client, const nidas::core::SampleTag tag) throw ()
	Remove a SampleClient for a given SampleTag from this SampleSource. More...

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

void	flush () throw ()
	Implementation of SampleSource::flush(), unpacks and distributes any samples currently in the read buffer. More...

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

bool	readSamples () throw (nidas::util::IOException)
	Read a buffer of data, serialize the data into samples, and distribute() samples to the receive() method of my SampleClients and DSMSensors. More...

void	search (const nidas::util::UTime &tt) throw (nidas::util::IOException)
	Search forward until a sample header is read whose time is greater than or equal to tt. More...

nidas::core::Sample *	readSample () throw (nidas::util::IOException)
	Read the next sample from the InputStream. More...

void	distribute (const nidas::core::Sample *s) throw ()
	Distribute a sample to my clients. More...

size_t	getBadSamples () const

void	close () throw (nidas::util::IOException)

void	setBadSampleFilter (const nidas::core::BadSampleFilter &bsf)
	Replace the bad sample filter rules for this stream with `bsf`. More...

void	setFilterBadSamples (bool val)
	See BadSampleFilter. More...

void	setMinDsmId (int val)
	See BadSampleFilter. More...

void	setMaxDsmId (int val)
	See BadSampleFilter. More...

void	setMinSampleLength (unsigned int val)
	See BadSampleFilter. More...

void	setMaxSampleLength (unsigned int val)
	See BadSampleFilter. More...

void	setMinSampleTime (const nidas::util::UTime &val)
	See BadSampleFilter. More...

void	setMaxSampleTime (const nidas::util::UTime &val)
	See BadSampleFilter. More...

void	setExpectHeader (bool val)

bool	getExpectHeader () const

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

Protected Member Functions
	RawSampleInputStream (RawSampleInputStream &x, nidas::core::IOChannel *)
	Create a copy, but with a new IOChannel. More...

Protected Attributes
nidas::core::IOChannel *	_iochan

nidas::core::SampleSourceSupport	_source

Member Typedef Documentation

typedef nidas::core::dsm_time_t nidas::dynld::SampleInputStream::dsm_time_t

inherited

Constructor & Destructor Documentation

RawSampleInputStream::RawSampleInputStream ( )

Default constructor.

Referenced by clone().

RawSampleInputStream::RawSampleInputStream ( nidas::core::IOChannel * iochannel )

Constructor with a connected IOChannel.

Parameters

iochannel The IOChannel that we use for data input. RawSampleInputStream will own the pointer to the IOChannel, and will delete it in ~RawSampleInputStream().

RawSampleInputStream::~RawSampleInputStream ( )

virtual

RawSampleInputStream::RawSampleInputStream	(	RawSampleInputStream &	x,
		nidas::core::IOChannel *	iochannel
	)

protected

Create a copy, but with a new IOChannel.

Member Function Documentation

void nidas::dynld::SampleInputStream::addSampleClient	(	nidas::core::SampleClient *	client	)
throw	(
	)

inlinevirtualinherited

Implementation of SampleSource::addSampleClient().

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::addSampleClient().

void nidas::dynld::SampleInputStream::addSampleClientForTag	(	nidas::core::SampleClient *	client,
		const nidas::core::SampleTag *	tag
	)
throw	(
	)

inlinevirtualinherited

Add a Client for a given SampleTag.

Implementation of SampleSource::addSampleClient().

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::addSampleClientForTag().

void nidas::dynld::SampleInputStream::addSampleTag	(	const nidas::core::SampleTag *	tag	)
throw	(
	)

inlinevirtualinherited

Implementation of SampleInput::addSampleTag().

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::addSampleTag().

Referenced by nidas::dynld::raf::SyncServer::initSensors(), StatsProcess::run(), and DataPrep::run().

RawSampleInputStream * RawSampleInputStream::clone ( nidas::core::IOChannel * iochannel )

virtual

Create a copy with a different, connected IOChannel.

Create a clone, with a new, connected IOChannel.

Reimplemented from nidas::dynld::SampleInputStream.

References RawSampleInputStream().

void SampleInputStream::close	(		)
throw	(	nidas::util::IOException
	)

virtualinherited

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::_iochan, nidas::dynld::SampleInputStream::_iostream, nidas::core::IOChannel::close(), and nidas::dynld::SampleInputStream::closeBlocks().

Referenced by NidsMerge::run(), StatsProcess::run(), DataPrep::run(), nidas::dynld::raf::SyncServer::stop(), and nidas::dynld::SampleInputStream::~SampleInputStream().

SampleInput * SampleInputStream::connected	(	nidas::core::IOChannel *	iochan	)
throw	(
	)

virtualinherited

Implementation of IOChannelRequester::connected.

One can use this method to notify SampleInputStream that the IOChannel is connected, which will cause SampleInputStream to open the IOStream.

Implements nidas::core::IOChannelRequester.

void nidas::dynld::SampleInputStream::distribute	(	const nidas::core::Sample *	s	)
throw	(
	)

inlineinherited

Distribute a sample to my clients.

One could use this to insert a sample into the stream.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::distribute().

Referenced by nidas::dynld::raf::SyncServer::handleSample().

void SampleInputStream::flush	(	)
throw	(
	)

virtualinherited

Implementation of SampleSource::flush(), unpacks and distributes any samples currently in the read buffer.

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, CNAME, nidas::core::SampleSourceSupport::distribute(), nidas::core::SampleSourceSupport::getClientCount(), nidas::dynld::SampleInputStream::nextSample(), and VLOG.

void RawSampleInputStream::fromDOMElement	(	const xercesc::DOMElement *	)
throw	(	nidas::util::InvalidParameterException
	)

virtual

Initialize myself from a xercesc::DOMElement.

Implements nidas::core::DOMable.

References nidas::dynld::SampleInputStream::fromDOMElement(), and nidas::core::RAW_SAMPLE.

size_t nidas::dynld::SampleInputStream::getBadSamples ( ) const

inlineinherited

References nidas::dynld::SampleInputStream::_badSamples.

int nidas::dynld::SampleInputStream::getClientCount	(	)	const
throw	(
	)

inlinevirtualinherited

How many SampleClients are currently in my list.

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::getClientCount().

const DSMConfig * SampleInputStream::getDSMConfig ( ) const

virtualinherited

What DSM am I connnected to? May be NULL if it cannot be determined.

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::_dsm.

bool nidas::dynld::SampleInputStream::getExpectHeader ( ) const

inlineinherited

References nidas::dynld::SampleInputStream::_expectHeader.

int SampleInputStream::getFd ( ) const

virtualinherited

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::_iochan, and nidas::core::IOChannel::getFd().

const nidas::core::SampleInputHeader& nidas::dynld::SampleInputStream::getInputHeader ( ) const

inlineinherited

References nidas::dynld::SampleInputStream::_inputHeader.

Referenced by nidas::dynld::raf::SyncRecordReader::init(), nidas::dynld::raf::SyncServer::openStream(), SensorExtract::run(), StatsProcess::run(), ExtractFast2D::run(), ExtractDMT::run(), and DataPrep::run().

string SampleInputStream::getName ( ) const

virtualinherited

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::_iochan, and nidas::core::IOChannel::getName().

Referenced by nidas::dynld::SampleInputStream::parseInputHeader(), nidas::dynld::SampleInputStream::readInputHeader(), MergeVerifier::reportBackward(), MergeVerifier::reportDuplicate(), MergeVerifier::reportMissing(), MergeVerifier::run(), and nidas::dynld::SampleInputStream::sampleFromHeader().

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 nidas::core::SampleInput* nidas::dynld::SampleInputStream::getOriginal ( ) const

inlinevirtualinherited

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::_original.

nidas::core::SampleSource* nidas::dynld::SampleInputStream::getProcessedSampleSource ( )

inlinevirtualinherited

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.

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::getProcessedSampleSource().

nidas::core::SampleSource* nidas::dynld::SampleInputStream::getRawSampleSource ( )

inlinevirtualinherited

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.

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::getRawSampleSource().

const nidas::core::SampleStats& nidas::dynld::SampleInputStream::getSampleStats ( ) const

inlinevirtualinherited

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::getSampleStats().

nidas::core::SampleTagIterator nidas::dynld::SampleInputStream::getSampleTagIterator ( ) const

inlinevirtualinherited

Implementation of SampleSource::getSampleTagIterator().

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::getSampleTagIterator().

std::list<const nidas::core::SampleTag*> nidas::dynld::SampleInputStream::getSampleTags ( ) const

inlinevirtualinherited

Get the output SampleTags.

Implements nidas::core::SampleSource.

References nidas::dynld::SampleInputStream::_source, and nidas::core::SampleSourceSupport::getSampleTags().

bool SampleInputStream::isNonBlocking	(		)	const
throw	(	nidas::util::IOException
	)

virtualinherited

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::_iochan, and nidas::core::IOChannel::isNonBlocking().

bool SampleInputStream::parseInputHeader	(		)
throw	(	nidas::util::IOException
	)

inherited

Referenced by nidas::dynld::SampleInputStream::readInputHeader().

void SampleInputStream::readInputHeader	(		)
throw	(	nidas::util::IOException
	)

inherited

Read archive information at beginning of input stream or file.

References nidas::dynld::SampleInputStream::_inputHeaderParsed, nidas::dynld::SampleInputStream::_iostream, nidas::dynld::SampleInputStream::_last_name, CNAME, DLOG, nidas::dynld::SampleInputStream::getName(), nidas::core::IOStream::getNumInputBytes(), nidas::dynld::SampleInputStream::parseInputHeader(), and nidas::core::IOStream::read().

Referenced by nidas::dynld::raf::SyncRecordReader::init(), nidas::dynld::raf::SyncServer::openStream(), DataStats::readHeader(), MergeVerifier::run(), SensorExtract::run(), StatsProcess::run(), ExtractFast2D::run(), ExtractDMT::run(), and DataPrep::run().

Sample * SampleInputStream::readSample	(		)
throw	(	nidas::util::IOException
	)

virtualinherited

Read the next sample from the InputStream.

The caller must call freeReference on the sample when they're done with it. This method may perform zero or more reads of the IOChannel.

Returns: pointer to a sample, never NULL.

Implements nidas::core::SampleInput.

References nidas::dynld::SampleInputStream::nextSample().

Referenced by nidas::dynld::raf::SyncRecordReader::init(), nidas::dynld::raf::SyncServer::openStream(), nidas::dynld::raf::SyncServer::read(), NidsMerge::run(), MergeVerifier::run(), SensorExtract::run(), ExtractFast2D::run(), and ExtractDMT::run().

bool SampleInputStream::readSamples	(		)
throw	(	nidas::util::IOException
	)

virtualinherited

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

This will perform only one physical read of the underlying IOChannel and so is appropriate to use when a select() or poll() has determined that there is data available on the file descriptor, or when the physical device is configured for non-blocking reads.

Returns: false: no data available for physical read, likely the result of an EAGAIN from a non-blocking read on a file descriptor. true: physical read did not necessarily consume all available data.

Implements nidas::core::SampleInput.