Interface to a data sample. More...

#include <Sample.h>

Inheritance diagram for nidas::core::Sample:

[legend]

Public Member Functions
	Sample (sampleType t=CHAR_ST)

virtual	~Sample ()

void	setTimeTag (dsm_time_t val)

dsm_time_t	getTimeTag () const
	Time-tag in non-leap microseconds since Jan 1, 1970 00:00 GMT.

void	setId (dsm_sample_id_t val)
	Set the id portion of the sample header.

dsm_sample_id_t	getId () const
	Get the id portion of the sample header.

void	setRawId (dsm_sample_id_t val)
	Set the full, raw id portion of the sample header.

dsm_sample_id_t	getRawId () const

void	setSpSId (unsigned int val)
	Set the short id portion of the sample header, containing the sensor + sample ids.

unsigned int	getSpSId () const
	Get the short id portion of the sample header.

void	setDSMId (unsigned int val)
	Set the DSM (data system) id portion of the sample header.

unsigned int	getDSMId () const
	Get the DSM (data system) id portion of the sample header.

unsigned int	getDataByteLength () const
	Get the number of bytes in data portion of sample.

virtual void	setDataLength (unsigned int val)=0
	Set the number of elements in data portion of sample.

virtual unsigned int	getDataLength () const =0
	Get the number of elements in data portion of sample.

virtual sampleType	getType () const =0
	Get the type of the sample.

unsigned int	getHeaderLength () const
	Number of bytes in header.

const void *	getHeaderPtr () const
	Get a pointer to the header portion of the sample.

virtual void *	getVoidDataPtr ()=0
	Get a void* pointer to the data portion of the sample.

virtual const void *	getConstVoidDataPtr () const =0
	Get a const void* pointer to the data portion of the sample.

virtual double	getDataValue (unsigned int i) const =0
	Get the numeric value of data element i.

virtual void	setDataValue (unsigned int i, double val)=0
	Set the value of data element i to a double.

virtual void	setDataValue (unsigned int i, float val)=0
	Set the value of data element i to a float.

virtual unsigned int	getAllocLength () const =0
	Get number of elements allocated in data portion of sample.

virtual unsigned int	getAllocByteLength () const =0
	Get number of bytes allocated in data portion of sample.

virtual void	allocateData (unsigned int val)=0
	Allocate a number of bytes of data.

virtual void	reallocateData (unsigned int val)=0
	Re-allocate a number of bytes of data, saving old contents.

void	holdReference () const
	Increment the reference count for this sample.

virtual void	freeReference () const =0
	Decrement the reference count for this sample.

Protected Attributes
SampleHeader	_header

int	_refCount
	The reference count.

nidas::util::Mutex	_refLock

Static Protected Attributes
static int	_nsamps
	Global count of the number of samples in use by a process.

Detailed Description

Interface to a data sample.

A Sample contains a SampleHeader and some data.

Constructor & Destructor Documentation

◆ Sample()

nidas::core::Sample::Sample ( sampleType t = CHAR_ST )

inline

References _nsamps.

◆ ~Sample()

virtual nidas::core::Sample::~Sample ( )

inlinevirtual

References _nsamps.

Member Function Documentation

◆ allocateData()

virtual void nidas::core::Sample::allocateData ( unsigned int val )

pure virtual

Allocate a number of bytes of data.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::core::SamplePool< SampleType >::getSample().

◆ freeReference()

virtual void nidas::core::Sample::freeReference ( ) const

pure virtual

Decrement the reference count for this sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by DataStats::clearSampleQueue(), nidas::dynld::SampleInputStream::nextSample(), nidas::core::DriverSampleScanner::nextSample(), nidas::dynld::SampleInputStream::parseInputHeader(), nidas::dynld::raf::CVI_LV_Input::process(), nidas::core::MessageStreamScanner::requestBiggerSample(), DmdA2dCk::run(), MergeVerifier::run(), nidas::core::SampleBuffer::run(), nidas::core::SampleSorter::run(), nidas::dynld::SampleInputStream::~SampleInputStream(), nidas::core::SampleScanner::~SampleScanner(), nidas::dynld::raf::SyncRecordReader::~SyncRecordReader(), and nidas::dynld::raf::SyncServer::~SyncServer().

◆ getAllocByteLength()

virtual unsigned int nidas::core::Sample::getAllocByteLength ( ) const

pure virtual

Get number of bytes allocated in data portion of sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

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

◆ getAllocLength()

virtual unsigned int nidas::core::Sample::getAllocLength ( ) const

pure virtual

Get number of elements allocated in data portion of sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

◆ getConstVoidDataPtr()

virtual const void * nidas::core::Sample::getConstVoidDataPtr ( ) const

pure virtual

Get a const void* pointer to the data portion of the sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::dynld::raf::LamsNetSensor::process(), nidas::dynld::raf::LamsSensor::process(), nidas::dynld::raf::UHSAS_Serial::process(), and nidas::dynld::AsciiOutput::receive().

◆ getDataByteLength()

unsigned int nidas::core::Sample::getDataByteLength ( ) const

inline

Get the number of bytes in data portion of sample.

References _header, and nidas::core::SampleHeader::getDataByteLength().

Referenced by SampleCounter::accumulateSample(), nidas::dynld::SampleInputStream::checkUnexpectedEOF(), nidas::core::SampleT< DataT >::getDataLength(), nidas::dynld::SampleInputStream::nextSample(), nidas::core::DriverSampleScanner::nextSample(), nidas::dynld::AsciiOutput::receive(), nidas::core::SampleBuffer::run(), and nidas::core::SampleSorter::run().

◆ getDataLength()

virtual unsigned int nidas::core::Sample::getDataLength ( ) const

pure virtual

Get the number of elements in data portion of sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::dynld::isff::NCAR_TRH::ifanFilter(), nidas::dynld::isff::Licor7500::process(), nidas::dynld::isff::Wind2D::process(), nidas::dynld::isff::Wind3D::process(), nidas::dynld::WxtSensor::process(), and nidas::dynld::raf::CVIProcessor::receive().

◆ getDataValue()

virtual double nidas::core::Sample::getDataValue ( unsigned int i ) const

pure virtual

Get the numeric value of data element i.

No range checking of i is done.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::dynld::isff::Wind2D::process(), nidas::dynld::StatisticsCruncher::receive(), and nidas::dynld::AsciiOutput::receive().

◆ getDSMId()

unsigned int nidas::core::Sample::getDSMId ( ) const

inline

Get the DSM (data system) id portion of the sample header.

References _header, and nidas::core::SampleHeader::getDSMId().

Referenced by nidas::core::NearestResamplerAtRate::connect().

◆ getHeaderLength()

unsigned int nidas::core::Sample::getHeaderLength ( ) const

inline

Number of bytes in header.

References nidas::core::SampleHeader::getSizeOf().

◆ getHeaderPtr()

const void * nidas::core::Sample::getHeaderPtr ( ) const

inline

Get a pointer to the header portion of the sample.

References _header.

Referenced by nidas::core::operator<<().

◆ getId()

dsm_sample_id_t nidas::core::Sample::getId ( ) const

inline

Get the id portion of the sample header.

References _header, and nidas::core::SampleHeader::getId().

Referenced by nidas::dynld::StatisticsCruncher::attach(), nidas::core::NearestResamplerAtRate::connect(), nidas::core::SampleAverager::connect(), nidas::core::NearestResampler::connect(), nidas::core::NearestResampler::ctorCommon(), nidas::core::Site::fromDOMElement(), nidas::core::NearestResamplerAtRate::NearestResamplerAtRate(), nidas::core::MessageStreamScanner::requestBiggerSample(), ExtractFast2D::run(), ExtractDMT::run(), SensorExtract::run(), and nidas::core::Site::validate().

◆ getRawId()

dsm_sample_id_t nidas::core::Sample::getRawId ( ) const

inline

References _header, and nidas::core::SampleHeader::getRawId().

◆ getSpSId()

unsigned int nidas::core::Sample::getSpSId ( ) const

inline

Get the short id portion of the sample header.

This is the portion of the id without the DSM id.

References _header, and nidas::core::SampleHeader::getSpSId().

◆ getTimeTag()

dsm_time_t nidas::core::Sample::getTimeTag ( ) const

inline

Time-tag in non-leap microseconds since Jan 1, 1970 00:00 GMT.

References _header, and nidas::core::SampleHeader::getTimeTag().

Referenced by nidas::core::SampleSorter::flush(), nidas::dynld::SampleInputStream::nextSample(), nidas::dynld::raf::SyncServer::openStream(), nidas::dynld::isff::WisardMote::process(), nidas::dynld::raf::PSI9116_Sensor::process(), nidas::dynld::raf::SidsNetSensor::process(), nidas::core::MessageStreamScanner::requestBiggerSample(), DataStats::restartStats(), NidsMerge::run(), nidas::core::SampleSorter::run(), nidas::dynld::raf::SyncRecordSource::sendSyncRecord(), nidas::dynld::raf::Extract2D::setTimeStamp(), nidas::dynld::raf::Extract2D::setTimeStamp(), and nidas::dynld::isff::WisardMote::unpackTsoil().

◆ getType()

virtual sampleType nidas::core::Sample::getType ( ) const

pure virtual

Get the type of the sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::dynld::raf::SyncRecordSource::selectVariablesFromSensor(), and nidas::dynld::IEEE_Float::validate().

◆ getVoidDataPtr()

virtual void * nidas::core::Sample::getVoidDataPtr ( )

pure virtual

Get a void* pointer to the data portion of the sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::dynld::SampleInputStream::nextSample(), nidas::core::DriverSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::dynld::raf::A2D_Serial::process(), and nidas::core::MessageStreamScanner::requestBiggerSample().

◆ holdReference()

void nidas::core::Sample::holdReference ( ) const

inline

Increment the reference count for this sample.

Sample supports a form of reference counting. See freeReference. We have to use a hack-like cast of the this pointer to a const so that holdReference can be used on a const Sample. The SamplePool class supports Sample reference counting.

References _refCount, _refLock, nidas::core::getSample(), nidas::util::Mutex::lock(), and nidas::util::Mutex::unlock().

Referenced by nidas::core::SamplePool< SampleType >::getSample(), and nidas::dynld::raf::LamsNetSensor::process().

◆ reallocateData()

virtual void nidas::core::Sample::reallocateData ( unsigned int val )

pure virtual

Re-allocate a number of bytes of data, saving old contents.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

◆ setDataLength()

virtual void nidas::core::Sample::setDataLength ( unsigned int val )

pure virtual

Set the number of elements in data portion of sample.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

Referenced by nidas::core::DriverSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::dynld::isff::MOSMote::process(), nidas::dynld::raf::PPT_Serial::process(), and nidas::core::MessageStreamScanner::requestBiggerSample().

◆ setDataValue() [1/2]

virtual void nidas::core::Sample::setDataValue	(	unsigned int	i,
		double	val )

pure virtual

Set the value of data element i to a double.

No range checking of i is done.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

◆ setDataValue() [2/2]

virtual void nidas::core::Sample::setDataValue	(	unsigned int	i,
		float	val )

pure virtual

Set the value of data element i to a float.

No range checking is of i done.

Implemented in nidas::core::SampleT< DataT >, nidas::core::SampleT< char >, nidas::core::SampleT< double >, and nidas::core::SampleT< float >.

◆ setDSMId()

void nidas::core::Sample::setDSMId ( unsigned int val )

inline

Set the DSM (data system) id portion of the sample header.

References _header, and nidas::core::SampleHeader::setDSMId().

◆ setId()

void nidas::core::Sample::setId ( dsm_sample_id_t val )

inline

Set the id portion of the sample header.

The id typically identifies the data system and sensor of origin of the sample.

References _header, and nidas::core::SampleHeader::setId().

Referenced by nidas::core::DriverSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::dynld::raf::DSMArincSensor::process(), and nidas::dynld::raf::DSMArincSensor::processAlta().

◆ setRawId()

void nidas::core::Sample::setRawId ( dsm_sample_id_t val )

inline

Set the full, raw id portion of the sample header.

This method is not typically used except when doing raw IO on a sample. The raw id contains an enumeration of the sample type, along with the fields returned by getId().

References _header, and nidas::core::SampleHeader::setRawId().

◆ setSpSId()

void nidas::core::Sample::setSpSId ( unsigned int val )

inline

Set the short id portion of the sample header, containing the sensor + sample ids.

This is the portion of the id without the DSM id.

References _header, and nidas::core::SampleHeader::setSpSId().

◆ setTimeTag()

void nidas::core::Sample::setTimeTag ( dsm_time_t val )

inline

References _header, and nidas::core::SampleHeader::setTimeTag().

Referenced by nidas::core::DriverSampleScanner::nextSample(), nidas::core::MessageStreamScanner::nextSampleByLength(), nidas::core::MessageStreamScanner::nextSampleSepBOM(), nidas::core::MessageStreamScanner::nextSampleSepEOM(), nidas::dynld::raf::CVI_LV_Input::process(), nidas::dynld::raf::UHSAS_Serial::process(), and nidas::core::SampleSorter::run().

Member Data Documentation

◆ _header

SampleHeader nidas::core::Sample::_header

protected

Referenced by getDataByteLength(), getDSMId(), getHeaderPtr(), getId(), getRawId(), getSpSId(), getTimeTag(), nidas::core::SampleT< DataT >::setDataLength(), setDSMId(), setId(), setRawId(), setSpSId(), and setTimeTag().

◆ _nsamps

int Sample::_nsamps

staticprotected

Global count of the number of samples in use by a process.

Incremented in the constructor, decremented in the destructor. Useful for development debugging to track leaks.

Referenced by Sample(), and ~Sample().

◆ _refCount

int nidas::core::Sample::_refCount

mutableprotected

The reference count.

Referenced by holdReference().

◆ _refLock

nidas::util::Mutex nidas::core::Sample::_refLock

mutableprotected

Referenced by holdReference().

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

nidas/core/Sample.h
nidas/core/Sample.cc

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Sample()

◆ ~Sample()

Member Function Documentation

◆ allocateData()

◆ freeReference()

◆ getAllocByteLength()

◆ getAllocLength()

◆ getConstVoidDataPtr()

◆ getDataByteLength()

◆ getDataLength()

◆ getDataValue()

◆ getDSMId()

◆ getHeaderLength()

◆ getHeaderPtr()

◆ getId()

◆ getRawId()

◆ getSpSId()

◆ getTimeTag()

◆ getType()

◆ getVoidDataPtr()

◆ holdReference()

◆ reallocateData()

◆ setDataLength()

◆ setDataValue() [1/2]

◆ setDataValue() [2/2]

◆ setDSMId()

◆ setId()

◆ setRawId()

◆ setSpSId()

◆ setTimeTag()

Member Data Documentation

◆ _header

◆ _nsamps

◆ _refCount

◆ _refLock