nidas::dynld::SampleInputStream Class Reference

An implementation of a SampleInput. More...

#include <SampleInputStream.h>

Inheritance diagram for nidas::dynld::SampleInputStream:

Classes
struct	ReadResult
	Tuple for all the possible results of iostream reads. More...

Public Types
typedef nidas::core::dsm_time_t	dsm_time_t

Public Member Functions
	SampleInputStream (bool raw=false)
	Constructor.
	SampleInputStream (nidas::core::IOChannel *iochannel, bool raw=false)
	Constructor.
virtual SampleInputStream *	clone (nidas::core::IOChannel *iochannel)
	Create a clone, with a new, connected IOChannel.
virtual	~SampleInputStream ()
std::string	getName () const
int	getFd () const
virtual void	setIOChannel (nidas::core::IOChannel *val)
	Set the IOChannel for this SampleInputStream.h.
void	readInputHeader ()
	Read archive information at beginning of input stream or file.
bool	parseInputHeader ()
const nidas::core::SampleInputHeader &	getInputHeader () const
void	requestConnection (nidas::core::DSMService *)
virtual nidas::core::SampleInput *	getOriginal () const
nidas::core::SampleInput *	connected (nidas::core::IOChannel *iochan) throw ()
	Implementation of IOChannelRequester::connected.
void	setNonBlocking (bool val)
bool	isNonBlocking () const
const nidas::core::DSMConfig *	getDSMConfig () const
	What DSM am I connnected to? May be NULL if it cannot be determined.
void	setKeepStats (bool val)
void	addSampleTag (const nidas::core::SampleTag *tag) throw ()
	Implementation of SampleInput::addSampleTag().
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.
nidas::core::SampleSource *	getProcessedSampleSource ()
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.
std::list< const nidas::core::SampleTag * >	getSampleTags () const
	Get the output SampleTags.
nidas::core::SampleTagIterator	getSampleTagIterator () const
	Implementation of SampleSource::getSampleTagIterator().
void	addSampleClient (nidas::core::SampleClient *client) throw ()
	Implementation of SampleSource::addSampleClient().
void	removeSampleClient (nidas::core::SampleClient *client) throw ()
	Remove a SampleClient from this SampleSource.
void	addSampleClientForTag (nidas::core::SampleClient *client, const nidas::core::SampleTag *tag) throw ()
	Add a Client for a given SampleTag.
void	removeSampleClientForTag (nidas::core::SampleClient *client, const nidas::core::SampleTag *tag) throw ()
	Remove a SampleClient for a given SampleTag from this SampleSource.
int	getClientCount () const throw ()
	How many SampleClients are currently in my list.
void	flush () throw ()
	Implementation of SampleSource::flush(), unpacks and distributes any samples currently in the read buffer.
const nidas::core::SampleStats &	getSampleStats () const
bool	readSamples ()
	Read a buffer of data, serialize the data into samples, and distribute() samples to the receive() method of my SampleClients and DSMSensors.
void	search (const nidas::util::UTime &tt)
	Search forward until a sample header is read whose time is greater than or equal to tt.
nidas::core::Sample *	readSample ()
	Read the next sample from the InputStream.
void	distribute (const nidas::core::Sample *s) throw ()
	Distribute a sample to my clients.
size_t	getBadSamples () const
void	close ()
void	setBadSampleFilter (const nidas::core::BadSampleFilter &bsf)
	Replace the bad sample filter rules for this stream with bsf.
void	setFilterBadSamples (bool val)
	See BadSampleFilter.
void	setMinDsmId (int val)
	See BadSampleFilter.
void	setMaxDsmId (int val)
	See BadSampleFilter.
void	setMinSampleLength (unsigned int val)
	See BadSampleFilter.
void	setMaxSampleLength (unsigned int val)
	See BadSampleFilter.
void	setMinSampleTime (const nidas::util::UTime &val)
	See BadSampleFilter.
void	setMaxSampleTime (const nidas::util::UTime &val)
	See BadSampleFilter.
void	fromDOMElement (const xercesc::DOMElement *node)
void	setExpectHeader (bool val)
bool	getExpectHeader () const
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 ()

Protected Member Functions
	SampleInputStream (SampleInputStream &x, nidas::core::IOChannel *iochannel)
	Copy constructor, with a new, connected IOChannel.

Protected Attributes
nidas::core::IOChannel *	_iochan
nidas::core::SampleSourceSupport	_source

Private Member Functions
nidas::core::Sample *	nextSample ()
	Unpack the next sample from the InputStream.
nidas::core::Sample *	nextSample (bool keepreading, bool searching=false, dsm_time_t search_time=LONG_LONG_MIN)
	Unpack the next sample from the InputStream buffer or by reading more data if keepreading is true.
void	checkUnexpectedEOF ()
ReadResult	readBlock (bool keepreading, char *&ptr, size_t &lentoread)
	Read a block into memory, updating the given block pointer and length counter accordingly.
ReadResult	read (bool keepreading, char *ptr, size_t lentoread)
	All reads of the iostream go through here.
void	handleNewInput ()
	Whenever we are at the start of a new input, we need to start over with parsing the input header.
nidas::core::Sample *	handleEOF (bool keepreading)
	When EOF has been caught, then either we need to return the last pending sample, or else we need to throw the exception.
void	closeBlocks ()
nidas::core::Sample *	sampleFromHeader () throw ()
	Check the current header for validity and generate a sample for it.
	SampleInputStream (const SampleInputStream &x)
	No regular copy.
SampleInputStream &	operator= (const SampleInputStream &x)
	No assignment.

Private Attributes
nidas::core::DSMService *	_service
	Service that has requested my input.
nidas::core::IOStream *	_iostream
const nidas::core::DSMConfig *	_dsm
bool	_expectHeader
bool	_inputHeaderParsed
nidas::core::SampleHeader	_sheader
size_t	_headerToRead
char *	_hptr
nidas::core::Sample *	_samp
	Will be non-null if we have previously read part of a sample from the stream.
nidas::core::Sample *	_sampPending
	The currently pending sample.
size_t	_dataToRead
	How many bytes left to read from the stream into the data portion of samp.
char *	_dptr
	Pointer into the data portion of samp where we will read next.
bool	_skipSample
	This is set if the data for the current sample header should be read but skipped, because the sample is the first after a block of bad samples and thus the time at the front of the sample might still be corrupt.
BlockStats	_block
	Information about the current block of samples, good or bad.
size_t	_badSamples
	Number of bad samples in the stream so far, which is to say number of bytes checked which did not contain a reasonable sample header.
size_t	_goodSamples
	Number of good samples in the stream so far.
nidas::core::SampleInputHeader	_inputHeader
nidas::core::BadSampleFilter	_bsf
SampleInputStream *	_original
bool	_raw
std::string	_last_name
	Keep the current name of the input stream so it can be referenced even after the input stream has advanced to a new input name.
nidas::util::EOFException	_eofx
bool	_ateof

Static Private Attributes
static XMLCh *	namespaceURI = 0

Detailed Description

An implementation of a SampleInput.

The readSamples method converts raw bytes from the iochannel into Samples.

If a SampleClient has requested processed Samples via addProcessedSampleClient, then SampleInputStream will pass Samples to the respective DSMSensor for processing, and then the DSMSensor passes the processed Samples to the SampleClient:

iochannel -> readSamples method -> DSMSensor -> SampleClient

If a SampleClient has requested non-processed Samples, via the simple addSampleClient method, then SampleInput stream passes the Samples straight to the SampleClient:

iochannel -> readSamples method -> SampleClient

Member Typedef Documentation

dsm_time_t

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

Constructor & Destructor Documentation

SampleInputStream() [1/4]

SampleInputStream::SampleInputStream

(

bool

raw = false

)

Constructor.

Parameters

raw	Whether the input samples are raw.

Referenced by clone().

SampleInputStream() [2/4]

SampleInputStream::SampleInputStream	(	nidas::core::IOChannel *	iochannel,
		bool	raw = false )

Constructor.

Parameters

iochannel

The IOChannel that we use for data input. SampleInputStream will own the pointer to the IOChannel, and will delete it in ~SampleInputStream(). If it is a null pointer, then it must be set within the fromDOMElement method.

References _iochan, _iostream, nidas::core::IOChannel::getBufferSize(), and setIOChannel().

~SampleInputStream()

SampleInputStream::~SampleInputStream ( )

virtual

References _iochan, _samp, _sampPending, close(), and nidas::core::Sample::freeReference().

SampleInputStream() [3/4]

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

protected

Copy constructor, with a new, connected IOChannel.

References _iochan, _iostream, nidas::core::IOChannel::getBufferSize(), and setIOChannel().

SampleInputStream() [4/4]

nidas::dynld::SampleInputStream::SampleInputStream ( const SampleInputStream & x )

private

No regular copy.

Member Function Documentation

addSampleClient()

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

inlinevirtual

Implementation of SampleSource::addSampleClient().

Implements nidas::core::SampleSource.

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

addSampleClientForTag()

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

inlinevirtual

Add a Client for a given SampleTag.

Implementation of SampleSource::addSampleClient().

Implements nidas::core::SampleSource.

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

addSampleTag()

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

inlinevirtual

Implementation of SampleInput::addSampleTag().

Implements nidas::core::SampleSource.

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

checkUnexpectedEOF()

void SampleInputStream::checkUnexpectedEOF ( )

private

References _dataToRead, _headerToRead, _last_name, _samp, _sheader, CNAME, nidas::core::Sample::getDataByteLength(), nidas::core::SampleHeader::getSizeOf(), and WLOG.

Referenced by read().

clone()

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

virtual

Create a clone, with a new, connected IOChannel.

Reimplemented in nidas::dynld::RawSampleInputStream.

References SampleInputStream().

close()

void SampleInputStream::close ( )

virtual

Exceptions

nidas::util::IOException

Implements nidas::core::SampleInput.

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

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

closeBlocks()

void SampleInputStream::closeBlocks ( )

private

References _badSamples, _block, _bsf, _goodSamples, _last_name, nidas::dynld::BlockStats::block_start, CNAME, DLOG, nidas::core::BadSampleFilter::filterBadSamples(), nidas::core::getSample(), nidas::util::LogContextState::log(), LOG_DEBUG, LOG_WARNING, and nidas::dynld::BlockStats::nbytes.

Referenced by close(), and handleNewInput().

connected()

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

virtual

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.

References nidas::core::getSample().

distribute()

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

inline

Distribute a sample to my clients.

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

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

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

flush()

void SampleInputStream::flush ( ) throw (  )

virtual

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

Implements nidas::core::SampleSource.

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

fromDOMElement()

void SampleInputStream::fromDOMElement ( const xercesc::DOMElement * node )

virtual

Exceptions

nidas::util::InvalidParameterException

Implements nidas::core::DOMable.

References _iochan, nidas::core::IOChannel::createIOChannel(), nidas::core::getSample(), setIOChannel(), and WLOG.

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

getBadSamples()

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

inline

References _badSamples.

getClientCount()

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

inlinevirtual

How many SampleClients are currently in my list.

Exceptions

)

Implements nidas::core::SampleSource.

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

getDSMConfig()

const DSMConfig * SampleInputStream::getDSMConfig ( ) const

virtual

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

Implements nidas::core::SampleInput.

References _dsm.

getExpectHeader()

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

inline

References _expectHeader.

getFd()

int SampleInputStream::getFd ( ) const

virtual

Implements nidas::core::SampleInput.

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

getInputHeader()

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

inline

References _inputHeader.

Referenced by nidas::dynld::raf::SyncRecordReader::init().

getName()

string SampleInputStream::getName ( ) const

virtual

Implements nidas::core::SampleInput.

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

Referenced by parseInputHeader(), readInputHeader(), and sampleFromHeader().

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

inlinevirtual

Implements nidas::core::SampleInput.

References _original.

getProcessedSampleSource()

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

inlinevirtual

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 _source, and nidas::core::SampleSourceSupport::getProcessedSampleSource().

getRawSampleSource()

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

inlinevirtual

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 _source, and nidas::core::SampleSourceSupport::getRawSampleSource().

getSampleStats()

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

inlinevirtual

Implements nidas::core::SampleSource.

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

getSampleTagIterator()

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

inlinevirtual

Implementation of SampleSource::getSampleTagIterator().

Implements nidas::core::SampleSource.

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

getSampleTags()

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

inlinevirtual

Get the output SampleTags.

Implements nidas::core::SampleSource.

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

handleEOF()

Sample * SampleInputStream::handleEOF ( bool keepreading )

private

When EOF has been caught, then either we need to return the last pending sample, or else we need to throw the exception.

HOWEVER, because nextSample() is not allowed to throw an IOException when keepreading is false, since in general it does not make sense to trigger EOF when nothing is being read, this handler only throws the exception when keepreading is true.

References _eofx, _sampPending, CNAME, DLOG, and nidas::core::getSample().

Referenced by nextSample(), and readSamples().

handleNewInput()

void SampleInputStream::handleNewInput ( )

private

Whenever we are at the start of a new input, we need to start over with parsing the input header.

This method sets up the right state to start over on a new file.

References _inputHeaderParsed, _iostream, nidas::core::IOStream::backup(), closeBlocks(), CNAME, DLOG, nidas::core::IOStream::getNumInputBytes(), and VLOG.

Referenced by read().

isNonBlocking()

bool SampleInputStream::isNonBlocking ( ) const

virtual

Exceptions

nidas::util::IOException

Implements nidas::core::SampleInput.

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

nextSample() [1/2]

Sample * SampleInputStream::nextSample ( )

private

Unpack the next sample from the InputStream.

This method does not perform any physical reads, so it should not throw EOFException or IOException.

Returns

pointer to a sample if there is one available in the buffer, else NULL.

References nextSample().

Referenced by flush(), nextSample(), readSample(), readSamples(), and search().

nextSample() [2/2]

Sample * SampleInputStream::nextSample ( bool keepreading, bool searching = false, dsm_time_t search_time = LONG_LONG_MIN )

private

Unpack the next sample from the InputStream buffer or by reading more data if keepreading is true.

If searching is set, then reading stops after the first sample header found whose time tag is after search_time, as described in the search() method.

Exceptions

nidas::util::IOException

References _ateof, _bsf, _dataToRead, _dptr, _headerToRead, _hptr, _inputHeaderParsed, _samp, _sampPending, _sheader, _skipSample, CNAME, DLOG, nidas::core::BadSampleFilter::filterBadSamples(), nidas::util::UTime::format(), nidas::core::Sample::freeReference(), nidas::core::SampleHeader::getDataByteLength(), nidas::core::Sample::getDataByteLength(), nidas::core::SampleHeader::getRawId(), nidas::core::getSample(), nidas::core::SampleHeader::getSizeOf(), nidas::core::SampleHeader::getTimeTag(), nidas::core::Sample::getTimeTag(), nidas::core::Sample::getVoidDataPtr(), handleEOF(), readBlock(), readInputHeader(), sampleFromHeader(), nidas::core::SampleHeader::setDataByteLength(), nidas::core::SampleHeader::setRawId(), nidas::core::SampleHeader::setTimeTag(), VLOG, and WLOG.

operator=()

SampleInputStream & nidas::dynld::SampleInputStream::operator= ( const SampleInputStream & x )

private

No assignment.

parseInputHeader()

bool SampleInputStream::parseInputHeader

(

)

Exceptions

nidas::util::IOException

References _bsf, _dataToRead, _expectHeader, _headerToRead, _hptr, _inputHeader, _inputHeaderParsed, _iostream, _samp, _sheader, nidas::core::IOStream::backup(), CNAME, DLOG, nidas::core::Sample::freeReference(), getName(), nidas::core::IOStream::getNumInputBytes(), nidas::core::SampleHeader::getSizeOf(), nidas::core::SampleInputHeader::parse(), PLOG, and nidas::core::BadSampleFilter::skipNidasHeader().

Referenced by readInputHeader().

read()

SampleInputStream::ReadResult SampleInputStream::read ( bool keepreading, char * ptr, size_t lentoread )

private

All reads of the iostream go through here.

There are three kinds of reads needed:

• Read to fill the iostream buffer but not a local block. (ptr==0 and keepreading=true)
• Read from the iostream buffer into a local block (keepreading==false).
• Read from the iostream to fill a local block, filling the buffer as needed (keepreading=true)

In all these cases, we need to catch if we hit the end of a file to know if the file ended unexpectedly. Also, if we hit the end of a file and a sample is still pending (because filtering is enabled and a sample is not good until it passes the filter and is succeeded by eof or another good sample), then we also need to return that sample. This method records the eof exception but does not pass it on, waiting instead for it to be thrown after any pending sample has been returned by nextSample(). Callers can test ReadResult members for which cases have occurred.

References _ateof, _eofx, _iostream, nidas::core::IOStream::available(), checkUnexpectedEOF(), CNAME, DLOG, nidas::core::getSample(), handleNewInput(), nidas::core::IOStream::isNewInput(), nidas::core::IOStream::read(), nidas::core::IOStream::readBuf(), and VLOG.

Referenced by readBlock(), and readSamples().

readBlock()

SampleInputStream::ReadResult SampleInputStream::readBlock ( bool keepreading, char *& ptr, size_t & lentoread )

private

Read a block into memory, updating the given block pointer and length counter accordingly.

If keepreading is false, only read into the block what is available from the iostream buffer. Return the ReadResult of the last read. Always return if the current input ends or eof is reached.

References nidas::core::getSample(), and read().

Referenced by nextSample().

readInputHeader()

void SampleInputStream::readInputHeader

(

)

Read archive information at beginning of input stream or file.

Exceptions

nidas::util::IOException

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

Referenced by nidas::dynld::raf::SyncRecordReader::init(), and nextSample().

readSample()

Sample * SampleInputStream::readSample ( )

virtual

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.

Exceptions

nidas::util::IOException

Implements nidas::core::SampleInput.

References nextSample().

Referenced by nidas::dynld::raf::SyncRecordReader::init(), and nidas::dynld::raf::SyncRecordReader::read().

readSamples()

bool SampleInputStream::readSamples ( )

virtual

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.

Exceptions

nidas::util::IOException

Implements nidas::core::SampleInput.

References _ateof, _iostream, _source, nidas::core::IOStream::available(), CNAME, nidas::core::SampleSourceSupport::distribute(), handleEOF(), nextSample(), read(), and VLOG.

removeSampleClient()

void nidas::dynld::SampleInputStream::removeSampleClient ( nidas::core::SampleClient * c ) throw (  )

inlinevirtual

Remove a SampleClient from this SampleSource.

Exceptions

)

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::removeSampleClient().

removeSampleClientForTag()

void nidas::dynld::SampleInputStream::removeSampleClientForTag ( nidas::core::SampleClient * c, const nidas::core::SampleTag *  ) throw (  )

inlinevirtual

Remove a SampleClient for a given SampleTag from this SampleSource.

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

Exceptions

)

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::removeSampleClientForTag().

removeSampleTag()

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

inlinevirtual

Exceptions

)

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::removeSampleTag().

requestConnection()

void SampleInputStream::requestConnection ( nidas::core::DSMService * requester )

virtual

Exceptions

nidas::util::IOException

Implements nidas::core::SampleInput.

References _iochan, _service, nidas::core::getSample(), and nidas::core::IOChannel::requestConnection().

sampleFromHeader()

Sample * SampleInputStream::sampleFromHeader ( ) throw (  )

private

Check the current header for validity and generate a sample for it.

References _badSamples, _block, _bsf, _goodSamples, _headerToRead, _hptr, _iostream, _sheader, _skipSample, nidas::util::LogContextState::active(), nidas::dynld::BlockStats::addGoodSample(), CNAME, nidas::dynld::BlockStats::endBadBlock(), nidas::core::BadSampleFilter::filterBadSamples(), ftime(), nidas::core::SampleHeader::getDataByteLength(), nidas::core::SampleHeader::getId(), getName(), nidas::core::IOStream::getNumInputBytes(), nidas::core::getSample(), nidas::core::SampleHeader::getSizeOf(), nidas::core::SampleHeader::getTimeTag(), nidas::core::SampleHeader::getType(), nidas::dynld::BlockStats::good, nidas::core::BadSampleFilter::invalidSampleHeader(), nidas::util::LogContextState::log(), LOG_DEBUG, LOG_WARNING, nidas::dynld::BlockStats::nbytes, nidas::dynld::BlockStats::start_time, nidas::dynld::BlockStats::startBadBlock(), and WLOG.

Referenced by nextSample().

search()

void SampleInputStream::search

(

const nidas::util::UTime &

tt

)

Search forward until a sample header is read whose time is greater than or equal to tt.

Leaves the InputStream positioned so that the next call to readSample() or readSamples() will read the rest of the sample.

Exceptions

nidas::util::IOException

References CNAME, DLOG, and nextSample().

setBadSampleFilter()

void nidas::dynld::SampleInputStream::setBadSampleFilter ( const nidas::core::BadSampleFilter & bsf )

inline

Replace the bad sample filter rules for this stream with bsf.

References _bsf, and nidas::core::getSample().

setExpectHeader()

void nidas::dynld::SampleInputStream::setExpectHeader ( bool val )

inline

References _expectHeader, and nidas::core::getSample().

Referenced by setIOChannel().

setFilterBadSamples()

void nidas::dynld::SampleInputStream::setFilterBadSamples ( bool val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setFilterBadSamples().

setIOChannel()

void SampleInputStream::setIOChannel ( nidas::core::IOChannel * val )

virtual

Set the IOChannel for this SampleInputStream.h.

References _dsm, _iochan, nidas::core::IOChannel::close(), nidas::core::IOChannel::getConnectionInfo(), nidas::core::Project::getInstance(), nidas::core::getSample(), setExpectHeader(), and nidas::core::IOChannel::writeNidasHeader().

Referenced by fromDOMElement(), SampleInputStream(), and SampleInputStream().

setKeepStats()

void nidas::dynld::SampleInputStream::setKeepStats ( bool val )

inlinevirtual

Implements nidas::core::SampleInput.

References _source, and nidas::core::SampleSourceSupport::setKeepStats().

setMaxDsmId()

void nidas::dynld::SampleInputStream::setMaxDsmId ( int val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setMaxDsmId().

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

setMaxSampleLength()

void nidas::dynld::SampleInputStream::setMaxSampleLength ( unsigned int val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setMaxSampleLength().

setMaxSampleTime()

void nidas::dynld::SampleInputStream::setMaxSampleTime ( const nidas::util::UTime & val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setMaxSampleTime().

setMinDsmId()

void nidas::dynld::SampleInputStream::setMinDsmId ( int val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setMinDsmId().

setMinSampleLength()

void nidas::dynld::SampleInputStream::setMinSampleLength ( unsigned int val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setMinSampleLength().

setMinSampleTime()

void nidas::dynld::SampleInputStream::setMinSampleTime ( const nidas::util::UTime & val )

inline

See BadSampleFilter.

References _bsf, and nidas::core::BadSampleFilter::setMinSampleTime().

setNonBlocking()

void SampleInputStream::setNonBlocking ( bool val )

virtual

Exceptions

nidas::util::IOException

Implements nidas::core::SampleInput.

References _iochan, and nidas::core::IOChannel::setNonBlocking().

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

_ateof

bool nidas::dynld::SampleInputStream::_ateof

private

Referenced by nextSample(), read(), and readSamples().

_badSamples

size_t nidas::dynld::SampleInputStream::_badSamples

private

Number of bad samples in the stream so far, which is to say number of bytes checked which did not contain a reasonable sample header.

Referenced by closeBlocks(), getBadSamples(), and sampleFromHeader().

_block

BlockStats nidas::dynld::SampleInputStream::_block

private

Information about the current block of samples, good or bad.

Referenced by closeBlocks(), and sampleFromHeader().

_bsf

nidas::core::BadSampleFilter nidas::dynld::SampleInputStream::_bsf

private

Referenced by closeBlocks(), nextSample(), parseInputHeader(), sampleFromHeader(), setBadSampleFilter(), setFilterBadSamples(), setMaxDsmId(), setMaxSampleLength(), setMaxSampleTime(), setMinDsmId(), setMinSampleLength(), and setMinSampleTime().

_dataToRead

size_t nidas::dynld::SampleInputStream::_dataToRead

private

How many bytes left to read from the stream into the data portion of samp.

Referenced by checkUnexpectedEOF(), nextSample(), and parseInputHeader().

_dptr

char* nidas::dynld::SampleInputStream::_dptr

private

Pointer into the data portion of samp where we will read next.

Referenced by nextSample().

_dsm

const nidas::core::DSMConfig* nidas::dynld::SampleInputStream::_dsm

private

Referenced by getDSMConfig(), and setIOChannel().

_eofx

nidas::util::EOFException nidas::dynld::SampleInputStream::_eofx

private

Referenced by handleEOF(), and read().

_expectHeader

bool nidas::dynld::SampleInputStream::_expectHeader

private

Referenced by getExpectHeader(), parseInputHeader(), and setExpectHeader().

_goodSamples

size_t nidas::dynld::SampleInputStream::_goodSamples

private

Number of good samples in the stream so far.

Referenced by closeBlocks(), and sampleFromHeader().

_headerToRead

size_t nidas::dynld::SampleInputStream::_headerToRead

private

Referenced by checkUnexpectedEOF(), nextSample(), parseInputHeader(), and sampleFromHeader().

_hptr

char* nidas::dynld::SampleInputStream::_hptr

private

Referenced by nextSample(), parseInputHeader(), and sampleFromHeader().

_inputHeader

nidas::core::SampleInputHeader nidas::dynld::SampleInputStream::_inputHeader

private

Referenced by getInputHeader(), and parseInputHeader().

_inputHeaderParsed

bool nidas::dynld::SampleInputStream::_inputHeaderParsed

private

Referenced by handleNewInput(), nextSample(), parseInputHeader(), and readInputHeader().

_iochan

nidas::core::IOChannel* nidas::dynld::SampleInputStream::_iochan

protected

Referenced by close(), nidas::dynld::RawSampleInputStream::fromDOMElement(), fromDOMElement(), getFd(), getName(), isNonBlocking(), requestConnection(), SampleInputStream(), SampleInputStream(), setIOChannel(), setNonBlocking(), and ~SampleInputStream().

_iostream

nidas::core::IOStream* nidas::dynld::SampleInputStream::_iostream

private

Referenced by close(), handleNewInput(), parseInputHeader(), read(), readInputHeader(), readSamples(), sampleFromHeader(), SampleInputStream(), and SampleInputStream().

_last_name

std::string nidas::dynld::SampleInputStream::_last_name

private

Keep the current name of the input stream so it can be
referenced even after the input stream has advanced to a new input name.

Referenced by checkUnexpectedEOF(), closeBlocks(), and readInputHeader().

_original

SampleInputStream* nidas::dynld::SampleInputStream::_original

private

Referenced by getOriginal().

_raw

bool nidas::dynld::SampleInputStream::_raw

private

_samp

nidas::core::Sample* nidas::dynld::SampleInputStream::_samp

private

Will be non-null if we have previously read part of a sample from the stream.

Referenced by checkUnexpectedEOF(), nextSample(), parseInputHeader(), and ~SampleInputStream().

_sampPending

nidas::core::Sample* nidas::dynld::SampleInputStream::_sampPending

private

The currently pending sample.

When filtering is active, the pending sample is held until the succeeding sample header is confirmed to be good.

Referenced by handleEOF(), nextSample(), and ~SampleInputStream().

_service

nidas::core::DSMService* nidas::dynld::SampleInputStream::_service

private

Service that has requested my input.

Referenced by requestConnection().

_sheader

nidas::core::SampleHeader nidas::dynld::SampleInputStream::_sheader

private

Referenced by checkUnexpectedEOF(), nextSample(), parseInputHeader(), and sampleFromHeader().

_skipSample

bool nidas::dynld::SampleInputStream::_skipSample

private

This is set if the data for the current sample header should be read but skipped, because the sample is the first after a block of bad samples and thus the time at the front of the sample might still be corrupt.

Referenced by nextSample(), and sampleFromHeader().

_source

nidas::core::SampleSourceSupport nidas::dynld::SampleInputStream::_source

protected

Referenced by addSampleClient(), addSampleClientForTag(), addSampleTag(), distribute(), flush(), getClientCount(), getProcessedSampleSource(), getRawSampleSource(), getSampleStats(), getSampleTagIterator(), getSampleTags(), readSamples(), removeSampleClient(), removeSampleClientForTag(), removeSampleTag(), and setKeepStats().

namespaceURI

XMLCh * DOMable::namespaceURI = 0

staticprivateinherited

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

---

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

• nidas/dynld/SampleInputStream.h
• nidas/dynld/SampleInputStream.cc