A SampleScanner for reading samples that have been pre-formatted by a device driver - they already have a header consisting of a timetag, and a data length. More...

#include <SampleScanner.h>

Inheritance diagram for nidas::core::DriverSampleScanner:

[legend]

Public Member Functions
	DriverSampleScanner (int bufsize=8192)

void	setMessageParameters (unsigned int, const std::string &, bool)
	setMessageSeparator is not implemented in DriverSampleScanner.

Sample *	nextSample (DSMSensor *sensor)
	Extract the next sample from the buffer.

virtual void	init ()
	Initialize the scanner.

virtual const std::string &	getMessageSeparator () const
	Returns an empty string.

virtual const std::string	getBackslashedMessageSeparator () const
	Returns an empty string.

virtual bool	getMessageSeparatorAtEOM () const

virtual unsigned int	getMessageLength () const
	Returns 0.

virtual bool	getNullTerminate () const
	Should the SampleScanner append a null character, '\0', to the messages.

void	setUsecsPerByte (int val)

int	getUsecsPerByte () const

virtual size_t	readBuffer (DSMSensor *sensor, bool &exhausted)
	Read from the sensor into the internal buffer of this SampleScanner.

virtual size_t	readBuffer (DSMSensor *sensor, bool &exhausted, int msecTimeout)
	Read from the sensor into the internal buffer of this SampleScanner, providing a timeout in milliseconds.

virtual void	clearBuffer ()

unsigned int	getBytesInBuffer () const

virtual void	resetStatistics ()

virtual void	calcStatistics (unsigned int periodUsec)
	Update the sensor sampling statistics: samples/sec, bytes/sec, min/max sample size, that can be accessed via getObservedSamplingRate(), getObservedDataRate() etc.

unsigned int	getMaxSampleLength () const

unsigned int	getMinSampleLength () const

unsigned int	getBadTimeTagCount () const

float	getObservedSamplingRate () const

float	getObservedDataRate () const

void	addNumBytesToStats (size_t val)

void	addSampleToStats (unsigned int val)

void	incrementBadTimeTags ()

Protected Attributes
const unsigned int	BUFSIZE
	Buffer size for reading from sensor.

char *	_buffer

unsigned int	_bufhead

unsigned int	_buftail

Sample *	_osamp

struct dsm_sample	_header

unsigned int	_outSampRead

unsigned int	_outSampToRead

char *	_outSampDataPtr

std::string	_messageSeparator

int	_messageLength

bool	_separatorAtEOM

char *	_separator
	messageSeparator in a C string.

int	_separatorLen
	Length of messageSeparator.

Private Attributes
std::string	_emptyString

time_t	_initialTimeSecs

unsigned int	_minSampleLength [2]

unsigned int	_maxSampleLength [2]

int	_currentIndex

int	_reportIndex

size_t	_nsamples

size_t	_nbytes

unsigned int	_badTimeTags

float	_sampleRateObs
	Observed number of samples per second.

float	_dataRateObs

int	_usecsPerByte

Detailed Description

A SampleScanner for reading samples that have been pre-formatted by a device driver - they already have a header consisting of a timetag, and a data length.

This can be used, for example, to read samples from a driver supporting an A/D converter.

Constructor & Destructor Documentation

◆ DriverSampleScanner()

DriverSampleScanner::DriverSampleScanner ( int bufsize = 8192 )

Member Function Documentation

◆ addNumBytesToStats()

void nidas::core::SampleScanner::addNumBytesToStats ( size_t val )

inlineinherited

References nidas::core::SampleScanner::_nbytes, and nidas::core::getSample().

Referenced by nidas::core::SampleScanner::readBuffer(), and nidas::core::DatagramSampleScanner::readBuffer().

◆ addSampleToStats()

void nidas::core::SampleScanner::addSampleToStats ( unsigned int val )

inlineinherited

References nidas::core::SampleScanner::_currentIndex, nidas::core::SampleScanner::_maxSampleLength, nidas::core::SampleScanner::_minSampleLength, and nidas::core::SampleScanner::_nsamples.

Referenced by nextSample(), nidas::core::DatagramSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), and nidas::core::MessageStreamScanner::requestBiggerSample().

◆ calcStatistics()

void SampleScanner::calcStatistics ( unsigned int periodUsec )

virtualinherited

Update the sensor sampling statistics: samples/sec, bytes/sec, min/max sample size, that can be accessed via getObservedSamplingRate(), getObservedDataRate() etc.

Should be called every periodUsec by a user of this sensor.

Parameters

periodUsec Statistics period.

References nidas::core::SampleScanner::_currentIndex, nidas::core::SampleScanner::_dataRateObs, nidas::core::SampleScanner::_maxSampleLength, nidas::core::SampleScanner::_minSampleLength, nidas::core::SampleScanner::_nbytes, nidas::core::SampleScanner::_nsamples, nidas::core::SampleScanner::_reportIndex, nidas::core::SampleScanner::_sampleRateObs, nidas::core::getSample(), and USECS_PER_SEC.

Referenced by nidas::core::DSMSensor::calcStatistics().

◆ clearBuffer()

void SampleScanner::clearBuffer ( )

virtualinherited

References nidas::core::SampleScanner::_bufhead, and nidas::core::SampleScanner::_buftail.

Referenced by nidas::core::DSMSensor::clearBuffer().

◆ getBackslashedMessageSeparator()

virtual const std::string nidas::core::SampleScanner::getBackslashedMessageSeparator ( ) const

inlinevirtualinherited

Returns an empty string.

Reimplemented in nidas::core::MessageSampleScanner, and nidas::core::MessageStreamScanner.

References nidas::core::SampleScanner::_emptyString.

◆ getBadTimeTagCount()

unsigned int nidas::core::SampleScanner::getBadTimeTagCount ( ) const

inlineinherited

References nidas::core::SampleScanner::_badTimeTags.

Referenced by nidas::core::DSMSensor::getBadTimeTagCount().

◆ getBytesInBuffer()

unsigned int nidas::core::SampleScanner::getBytesInBuffer ( ) const

inlineinherited

References nidas::core::SampleScanner::_bufhead, and nidas::core::SampleScanner::_buftail.

◆ getMaxSampleLength()

unsigned int nidas::core::SampleScanner::getMaxSampleLength ( ) const

inlineinherited

References nidas::core::SampleScanner::_maxSampleLength, and nidas::core::SampleScanner::_reportIndex.

Referenced by nidas::core::DSMSensor::getMaxSampleLength().

◆ getMessageLength()

virtual unsigned int nidas::core::SampleScanner::getMessageLength ( ) const

inlinevirtualinherited

Returns 0.

Reimplemented in nidas::core::MessageSampleScanner, and nidas::core::MessageStreamScanner.

◆ getMessageSeparator()

virtual const std::string & nidas::core::SampleScanner::getMessageSeparator ( ) const

inlinevirtualinherited

Returns an empty string.

Reimplemented in nidas::core::MessageSampleScanner, and nidas::core::MessageStreamScanner.

References nidas::core::SampleScanner::_emptyString.

◆ getMessageSeparatorAtEOM()

virtual bool nidas::core::SampleScanner::getMessageSeparatorAtEOM ( ) const

inlinevirtualinherited

Reimplemented in nidas::core::MessageSampleScanner, and nidas::core::MessageStreamScanner.

◆ getMinSampleLength()

unsigned int nidas::core::SampleScanner::getMinSampleLength ( ) const

inlineinherited

References nidas::core::SampleScanner::_maxSampleLength, nidas::core::SampleScanner::_minSampleLength, and nidas::core::SampleScanner::_reportIndex.

Referenced by nidas::core::DSMSensor::getMinSampleLength().

◆ getNullTerminate()

virtual bool nidas::core::SampleScanner::getNullTerminate ( ) const

inlinevirtualinherited

Should the SampleScanner append a null character, '\0', to the messages.

Reimplemented in nidas::core::MessageStreamScanner, and nidas::core::DatagramSampleScanner.

Referenced by nidas::core::CharacterSensor::getNullTerminated().

◆ getObservedDataRate()

float SampleScanner::getObservedDataRate ( ) const

inherited

References nidas::core::SampleScanner::_currentIndex, nidas::core::SampleScanner::_dataRateObs, nidas::core::SampleScanner::_initialTimeSecs, nidas::core::SampleScanner::_nbytes, and nidas::core::SampleScanner::_reportIndex.

Referenced by nidas::core::DSMSensor::getObservedDataRate().

◆ getObservedSamplingRate()

float SampleScanner::getObservedSamplingRate ( ) const

inherited

References nidas::core::SampleScanner::_currentIndex, nidas::core::SampleScanner::_initialTimeSecs, nidas::core::SampleScanner::_nsamples, nidas::core::SampleScanner::_reportIndex, and nidas::core::SampleScanner::_sampleRateObs.

Referenced by nidas::core::DSMSensor::getObservedSamplingRate().

◆ getUsecsPerByte()

int nidas::core::SampleScanner::getUsecsPerByte ( ) const

inlineinherited

References nidas::core::SampleScanner::_usecsPerByte.

Referenced by nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::MessageStreamScanner::readBuffer(), and nidas::core::MessageStreamScanner::readBuffer().

◆ incrementBadTimeTags()

void nidas::core::SampleScanner::incrementBadTimeTags ( )

inlineinherited

References nidas::core::SampleScanner::_badTimeTags.

Referenced by nextSample().

◆ init()

void SampleScanner::init ( )

virtualinherited

Initialize the scanner.

Must be called by a user of SampleScanner prior to calling readSamples().

References nidas::core::SampleScanner::resetStatistics().

Referenced by nidas::core::DSMSensor::open().

◆ nextSample()

Sample * DriverSampleScanner::nextSample ( DSMSensor * sensor )

virtual

Extract the next sample from the buffer.

Returns NULL if there are no more samples in the buffer.

Implements nidas::core::SampleScanner.

◆ readBuffer() [1/2]

size_t SampleScanner::readBuffer	(	DSMSensor *	sensor,
		bool &	exhausted )

virtualinherited

Read from the sensor into the internal buffer of this SampleScanner.

Exceptions

nidas::util::IOException

Reimplemented in nidas::core::MessageStreamScanner, and nidas::core::DatagramSampleScanner.

References nidas::core::SampleScanner::_buffer, nidas::core::SampleScanner::_bufhead, nidas::core::SampleScanner::_buftail, nidas::core::SampleScanner::addNumBytesToStats(), nidas::core::SampleScanner::BUFSIZE, DLOG, nidas::core::DSMSensor::getDSMId(), nidas::core::Project::getInstance(), nidas::core::DSMSensor::getName(), nidas::core::getSample(), nidas::core::DSMSensor::getSensorId(), len, and nidas::core::DSMSensor::read().

Referenced by nidas::core::DSMSensor::readBuffer(), nidas::core::MessageStreamScanner::readBuffer(), nidas::core::SampleScanner::readBuffer(), nidas::core::MessageStreamScanner::readBuffer(), and nidas::core::DSMSensor::readBuffer().

◆ readBuffer() [2/2]

size_t SampleScanner::readBuffer	(	DSMSensor *	sensor,
		bool &	exhausted,
		int	msecTimeout )

virtualinherited

Read from the sensor into the internal buffer of this SampleScanner, providing a timeout in milliseconds.

This will throw nidas::util::IOTimeoutException if the read fails due to a timeout.

Exceptions

nidas::util::IOException

Reimplemented in nidas::core::MessageStreamScanner.

References nidas::core::DSMSensor::getName(), nidas::core::DSMSensor::getReadFd(), nidas::core::getSample(), MSECS_PER_SEC, NLOG, NSECS_PER_MSEC, and nidas::core::SampleScanner::readBuffer().

◆ resetStatistics()

void SampleScanner::resetStatistics ( )

virtualinherited

References nidas::core::SampleScanner::_badTimeTags, nidas::core::SampleScanner::_currentIndex, nidas::core::SampleScanner::_dataRateObs, nidas::core::SampleScanner::_initialTimeSecs, nidas::core::SampleScanner::_maxSampleLength, nidas::core::SampleScanner::_minSampleLength, nidas::core::SampleScanner::_nbytes, nidas::core::SampleScanner::_nsamples, nidas::core::SampleScanner::_reportIndex, nidas::core::SampleScanner::_sampleRateObs, and nidas::core::getSample().

Referenced by nidas::core::SampleScanner::init(), and nidas::core::SampleScanner::SampleScanner().

◆ setMessageParameters()

void nidas::core::DriverSampleScanner::setMessageParameters	(	unsigned int	,
		const std::string &	,
		bool	)

inlinevirtual

setMessageSeparator is not implemented in DriverSampleScanner.

Throws nidas::util::InvalidParameterException.

Exceptions

nidas::util::InvalidParameterException

Implements nidas::core::SampleScanner.

Reimplemented in nidas::core::MessageSampleScanner.

◆ setUsecsPerByte()

void nidas::core::SampleScanner::setUsecsPerByte ( int val )

inlineinherited

References nidas::core::SampleScanner::_usecsPerByte, and nidas::core::getSample().

Referenced by nidas::dynld::ModbusRTU::open().

Member Data Documentation

◆ _badTimeTags

unsigned int nidas::core::SampleScanner::_badTimeTags

privateinherited

Referenced by nidas::core::SampleScanner::getBadTimeTagCount(), nidas::core::SampleScanner::incrementBadTimeTags(), and nidas::core::SampleScanner::resetStatistics().

◆ _buffer

char* nidas::core::SampleScanner::_buffer

protectedinherited

Referenced by nextSample(), nidas::core::DatagramSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::SampleScanner::readBuffer(), nidas::core::DatagramSampleScanner::readBuffer(), and nidas::core::SampleScanner::~SampleScanner().

◆ _bufhead

unsigned int nidas::core::SampleScanner::_bufhead

protectedinherited

Referenced by nidas::core::SampleScanner::clearBuffer(), nidas::core::SampleScanner::getBytesInBuffer(), nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::SampleScanner::readBuffer(), and nidas::core::DatagramSampleScanner::readBuffer().

◆ _buftail

unsigned int nidas::core::SampleScanner::_buftail

protectedinherited

Referenced by nidas::core::SampleScanner::clearBuffer(), nidas::core::SampleScanner::getBytesInBuffer(), nextSample(), nidas::core::DatagramSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::SampleScanner::readBuffer(), and nidas::core::DatagramSampleScanner::readBuffer().

◆ _currentIndex

int nidas::core::SampleScanner::_currentIndex

privateinherited

Referenced by nidas::core::SampleScanner::addSampleToStats(), nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getObservedDataRate(), nidas::core::SampleScanner::getObservedSamplingRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _dataRateObs

float nidas::core::SampleScanner::_dataRateObs

privateinherited

Referenced by nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getObservedDataRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _emptyString

std::string nidas::core::SampleScanner::_emptyString

privateinherited

Referenced by nidas::core::SampleScanner::getBackslashedMessageSeparator(), and nidas::core::SampleScanner::getMessageSeparator().

◆ _header

struct dsm_sample nidas::core::SampleScanner::_header

protectedinherited

Referenced by nextSample().

◆ _initialTimeSecs

time_t nidas::core::SampleScanner::_initialTimeSecs

privateinherited

Referenced by nidas::core::SampleScanner::getObservedDataRate(), nidas::core::SampleScanner::getObservedSamplingRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _maxSampleLength

unsigned int nidas::core::SampleScanner::_maxSampleLength[2]

privateinherited

Referenced by nidas::core::SampleScanner::addSampleToStats(), nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getMaxSampleLength(), nidas::core::SampleScanner::getMinSampleLength(), and nidas::core::SampleScanner::resetStatistics().

◆ _messageLength

int nidas::core::SampleScanner::_messageLength

protectedinherited

Referenced by nidas::core::MessageSampleScanner::getMessageLength(), nidas::core::MessageStreamScanner::getMessageLength(), and nidas::core::MessageStreamScanner::setMessageParameters().

◆ _messageSeparator

std::string nidas::core::SampleScanner::_messageSeparator

protectedinherited

Referenced by nidas::core::MessageSampleScanner::getBackslashedMessageSeparator(), nidas::core::MessageStreamScanner::getBackslashedMessageSeparator(), nidas::core::MessageSampleScanner::getMessageSeparator(), nidas::core::MessageStreamScanner::getMessageSeparator(), nidas::core::MessageSampleScanner::setMessageParameters(), and nidas::core::MessageStreamScanner::setMessageParameters().

◆ _minSampleLength

unsigned int nidas::core::SampleScanner::_minSampleLength[2]

privateinherited

Referenced by nidas::core::SampleScanner::addSampleToStats(), nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getMinSampleLength(), and nidas::core::SampleScanner::resetStatistics().

◆ _nbytes

size_t nidas::core::SampleScanner::_nbytes

privateinherited

Referenced by nidas::core::SampleScanner::addNumBytesToStats(), nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getObservedDataRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _nsamples

size_t nidas::core::SampleScanner::_nsamples

privateinherited

Referenced by nidas::core::SampleScanner::addSampleToStats(), nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getObservedSamplingRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _osamp

Sample* nidas::core::SampleScanner::_osamp

protectedinherited

Referenced by nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::MessageStreamScanner::requestBiggerSample(), and nidas::core::SampleScanner::~SampleScanner().

◆ _outSampDataPtr

char* nidas::core::SampleScanner::_outSampDataPtr

protectedinherited

Referenced by nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), and nidas::core::MessageStreamScanner::requestBiggerSample().

◆ _outSampRead

unsigned int nidas::core::SampleScanner::_outSampRead

protectedinherited

Referenced by nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), and nidas::core::MessageStreamScanner::requestBiggerSample().

◆ _outSampToRead

unsigned int nidas::core::SampleScanner::_outSampToRead

protectedinherited

Referenced by nextSample().

◆ _reportIndex

int nidas::core::SampleScanner::_reportIndex

privateinherited

Referenced by nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getMaxSampleLength(), nidas::core::SampleScanner::getMinSampleLength(), nidas::core::SampleScanner::getObservedDataRate(), nidas::core::SampleScanner::getObservedSamplingRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _sampleRateObs

float nidas::core::SampleScanner::_sampleRateObs

privateinherited

Observed number of samples per second.

Referenced by nidas::core::SampleScanner::calcStatistics(), nidas::core::SampleScanner::getObservedSamplingRate(), and nidas::core::SampleScanner::resetStatistics().

◆ _separator

char* nidas::core::SampleScanner::_separator

protectedinherited

messageSeparator in a C string.

Referenced by nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::MessageStreamScanner::setMessageParameters(), and nidas::core::SampleScanner::~SampleScanner().

◆ _separatorAtEOM

bool nidas::core::SampleScanner::_separatorAtEOM

protectedinherited

Referenced by nidas::core::MessageSampleScanner::getMessageSeparatorAtEOM(), nidas::core::MessageStreamScanner::getMessageSeparatorAtEOM(), nidas::core::MessageSampleScanner::setMessageParameters(), and nidas::core::MessageStreamScanner::setMessageParameters().

◆ _separatorLen

int nidas::core::SampleScanner::_separatorLen

protectedinherited

Length of messageSeparator.

Referenced by nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::core::MessageSampleScanner::setMessageParameters(), and nidas::core::MessageStreamScanner::setMessageParameters().

◆ _usecsPerByte

int nidas::core::SampleScanner::_usecsPerByte

privateinherited

Referenced by nidas::core::SampleScanner::getUsecsPerByte(), and nidas::core::SampleScanner::setUsecsPerByte().

◆ BUFSIZE

const unsigned int nidas::core::SampleScanner::BUFSIZE

protectedinherited

Buffer size for reading from sensor.

Referenced by nidas::core::SampleScanner::readBuffer(), and nidas::core::DatagramSampleScanner::readBuffer().

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

nidas/core/SampleScanner.h
nidas/core/SampleScanner.cc

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DriverSampleScanner()

Member Function Documentation

◆ addNumBytesToStats()

◆ addSampleToStats()

◆ calcStatistics()

◆ clearBuffer()

◆ getBackslashedMessageSeparator()

◆ getBadTimeTagCount()

◆ getBytesInBuffer()

◆ getMaxSampleLength()

◆ getMessageLength()

◆ getMessageSeparator()

◆ getMessageSeparatorAtEOM()

◆ getMinSampleLength()

◆ getNullTerminate()

◆ getObservedDataRate()

◆ getObservedSamplingRate()

◆ getUsecsPerByte()

◆ incrementBadTimeTags()

◆ init()

◆ nextSample()

◆ readBuffer() [1/2]

◆ readBuffer() [2/2]

◆ resetStatistics()

◆ setMessageParameters()

◆ setUsecsPerByte()

Member Data Documentation

◆ _badTimeTags

◆ _buffer

◆ _bufhead

◆ _buftail

◆ _currentIndex

◆ _dataRateObs

◆ _emptyString

◆ _header

◆ _initialTimeSecs

◆ _maxSampleLength

◆ _messageLength

◆ _messageSeparator

◆ _minSampleLength

◆ _nbytes

◆ _nsamples

◆ _osamp

◆ _outSampDataPtr

◆ _outSampRead

◆ _outSampToRead

◆ _reportIndex

◆ _sampleRateObs

◆ _separator

◆ _separatorAtEOM

◆ _separatorLen

◆ _usecsPerByte

◆ BUFSIZE