Class describing a group of variables that are sampled and handled together. More...

#include <SampleTag.h>

Inheritance diagram for nidas::core::SampleTag:

Public Member Functions
	SampleTag ()
	Constructor.

	SampleTag (const DSMSensor *sensor)
	Constructor of a sample for a given sensor.

	SampleTag (const SampleTag &)
	Copy constructor.

virtual	~SampleTag ()

SampleTag &	operator= (const SampleTag &rhs)

void	setSampleId (unsigned int val)
	Set the sample portion of the shortId.

unsigned int	getSampleId () const
	Get the sample portion of the shortId.

void	setSensorId (unsigned int val)
	Set the sensor portion of the shortId.

unsigned int	getSensorId () const
	Get the sensor portion of the shortId.

void	setDSMId (unsigned int val)
	Set the DSM portion of the id.

unsigned int	getDSMId () const
	Get the DSM portion of the id.

dsm_sample_id_t	getId () const
	Get the 26 bit id, containing the DSM id and the sensor+sample id.

unsigned int	getSpSId () const
	Get the sensor+sample portion of the id.

const std::string &	getSuffix () const
	Suffix, which is appended to variable names.

void	setSuffix (const std::string &val)

const DSMConfig *	getDSMConfig () const

void	setDSMConfig (const DSMConfig *val)

const DSMSensor *	getDSMSensor () const

void	setDSMSensor (const DSMSensor *val)

int	getStation () const
	Station number, which is also known as the Site number.

void	setStation (int val)

const Site *	getSite () const
	Get the Site of this SampleTag, which will be non-NULL only if getDSMConfig() returns non-NULL.

virtual void	setRate (double val)
	Set sampling rate in samples/sec.

virtual double	getRate () const
	Get sampling rate in samples/sec.

virtual void	setPeriod (double val)
	Set sampling period (1/rate) in sec.

virtual double	getPeriod () const
	Get sampling period (1/rate) in sec.

void	setProcessed (bool val)
	Set if this sample is going to be post processed.

bool	isProcessed () const
	Test to see if this sample is to be post processed.

void	setScanfFormat (const std::string &val)

const std::string &	getScanfFormat () const

void	setPromptString (const std::string &val)

const std::string &	getPromptString () const

void	setPromptOffset (double val)

double	getPromptOffset () const

virtual void	addVariable (Variable *var)
	Add a variable to this SampleTag.

const std::vector< const Variable * > &	getVariables () const

const std::vector< Variable * > &	getVariables ()

void	removeVariable (const Variable *var)

Variable &	getVariable (int i)
	Provide a reference to a variable - allowing one to modify it.

void	addParameter (Parameter *val)
	Add a parameter to this SampleTag.

const std::list< const Parameter * > &	getParameters () const

const Parameter *	getParameter (const std::string &name) const

void	setEnabled (bool val)

bool	isEnabled () const

unsigned int	getDataIndex (const Variable *var) const
	What is the index of a Variable into the data of a sample from this SampleTag.

float	getTimetagAdjust () const
	Whether to enable TimetagAdjuster for this sample.

void	setTimetagAdjust (float val)

VariableIterator	getVariableIterator () const

void	fromDOMElement (const xercesc::DOMElement *)

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

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

Static Public Member Functions
static const XMLCh *	getNamespaceURI ()

Protected Member Functions
void	setId (dsm_sample_id_t val)
	Set the full id.

void	setSpSId (unsigned int val)
	Set the sensor + sample portions of the id.

Private Attributes
dsm_sample_id_t	_id

unsigned int	_sampleId

unsigned int	_sensorId

std::string	_suffix

int	_station

double	_rate

bool	_processed

const DSMConfig *	_dsm

const DSMSensor *	_sensor

std::vector< const Variable * >	_constVariables

std::vector< Variable * >	_variables

std::vector< std::string >	_variableNames

std::string	_scanfFormat

std::string	_promptString

double	_promptOffset

std::list< Parameter * >	_parameters
	List of pointers to Parameters.

std::list< const Parameter * >	_constParameters
	List of const pointers to Parameters for providing via getParameters().

bool	_enabled

float	_ttAdjustVal
	If positive, enable TimetagAdjustor for these samples.

Static Private Attributes
static XMLCh *	namespaceURI = 0

Detailed Description

Class describing a group of variables that are sampled and handled together.

A SampleTag has an integer ID. This is the same ID that is associated with Sample objects, allowing software to map between a data sample and the meta-data associated with it.

A SampleTag/Sample ID is a 32-bit value comprised of four parts: 6-bit type_id, 10-bit DSM_id, 16-bit sensor+sample id.

The type id specifies the data type (float, int, double, etc), The type_id is only meaningful in an actual data Sample, and is not accessible in the SampleTag class.

The 26 bits of DSM_id and sensor+sample are known simply as the Id (or full id), and is accessible with the getId() method.

The DSM_id contains the id of the data acquisition system that collected the data, and can be accessed separately from the other fields with getDSMId() and setDSMId().

The 16-bit sensor+sample id is also known as the shortId. To maintain flexibility, the shortId has not been divided further into bit fields of sensor and sample id, but is a sum of the two. This means that you cannot set the shortId without losing track of the sensor and sample ids. For this reason, methods to set the shortId and fullId are protected.

To access the portions of the shortId, use getSensorId(), setSensorId(), getSampleId() and setSampleId().

Example: a DSMSensor has an id of 200, and four associated SampleTags with sample ids of 1,2,3 and 4. Therefore one should do a setSensorId(200) on each of the SampleTags, so that their shortIds become 201,202,203, and 204. The convention is that processed samples have sample ids >= 1. Raw, unprocessed Samples from this sensor have a sample id of 0, and therefore a shortId of 200.

A SampleTag also has a rate attribute, indicating the requested sampling rate for the variables.

Constructor & Destructor Documentation

◆ SampleTag() [1/3]

SampleTag::SampleTag ( )

Constructor.

◆ SampleTag() [2/3]

SampleTag::SampleTag ( const DSMSensor * sensor )

Constructor of a sample for a given sensor.

References _dsm, _sensor, setDSMId(), and setSensorId().

◆ SampleTag() [3/3]

SampleTag::SampleTag ( const SampleTag & x )

Copy constructor.

References addParameter(), addVariable(), nidas::core::Parameter::clone(), and nidas::core::getSample().

◆ ~SampleTag()

SampleTag::~SampleTag ( )

virtual

References _parameters, _variables, and nidas::core::getSample().

Member Function Documentation

◆ addParameter()

void SampleTag::addParameter ( Parameter * val )

Add a parameter to this SampleTag.

SampleTag will then own the pointer and will delete it in its destructor. If a Parameter already exists with the same name, that Parameter will be removed and deleted.

References _constParameters, _parameters, and nidas::core::getSample().

Referenced by fromDOMElement(), operator=(), and SampleTag().

◆ addVariable()

void SampleTag::addVariable ( Variable * var )

virtual

Add a variable to this SampleTag.

SampleTag will own the Variable, and will delete it in its destructor.

Exceptions

nidas::util::InvalidParameterException

References _constVariables, and _variables.

◆ fromDOMElement()

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

virtual

◆ getDataIndex()

unsigned int SampleTag::getDataIndex ( const Variable * var ) const

What is the index of a Variable into the data of a sample from this SampleTag.

Returns: UINT_MAX: 'tain't here

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

◆ getDSMConfig()

const DSMConfig * nidas::core::SampleTag::getDSMConfig ( ) const

inline

References _dsm.

◆ getDSMId()

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

inline

Get the DSM portion of the id.

References _id, and GET_DSM_ID.

Referenced by nidas::dynld::isff::WisardMote::addMoteSampleTag(), nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::StatisticsCruncher::attach(), nidas::dynld::StatisticsProcessor::connectSource(), nidas::dynld::isff::WisardMote::createSampleTags(), nidas::core::DSMSensor::fromDOMElement(), fromDOMElement(), nidas::dynld::raf::DSMMesaSensor::fromDOMElement(), and nidas::dynld::StatisticsCruncher::StatisticsCruncher().

◆ getDSMSensor()

const DSMSensor * nidas::core::SampleTag::getDSMSensor ( ) const

inline

References _sensor.

Referenced by nidas::core::SamplePipeline::addSampleClient(), nidas::core::SamplePipeline::connect(), SampleToDatabase::defaultMeasurementName(), nidas::core::SamplePipeline::disconnect(), fromDOMElement(), nidas::core::VariableConverter::getDSMSensor(), and nidas::core::SamplePipeline::removeSampleClient().

◆ getId()

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

inline

Get the 26 bit id, containing the DSM id and the sensor+sample id.

References _id, and GET_FULL_ID.

◆ getNamespaceURI()

static const XMLCh * nidas::core::DOMable::getNamespaceURI ( )

inlinestaticinherited

References nidas::core::DOMable::namespaceURI.

◆ getParameter()

const Parameter * SampleTag::getParameter ( const std::string & name ) const

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

Referenced by nidas::dynld::isff::WisardMote::createSampleTags(), nidas::dynld::isff::WisardMote::unpackTsoil(), and nidas::dynld::raf::DSMAnalogSensor::validate().

◆ getParameters()

const std::list< const Parameter * > & nidas::core::SampleTag::getParameters ( ) const

inline

References _constParameters.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::A2DSensor::validate(), nidas::dynld::DSC_FreqCounter::validate(), and nidas::dynld::raf::A2D_Serial::validate().

◆ getPeriod()

virtual double nidas::core::SampleTag::getPeriod ( ) const

inlinevirtual

Get sampling period (1/rate) in sec.

A value of 0.0 means an unknown rate.

References _rate.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag().

◆ getPromptOffset()

double nidas::core::SampleTag::getPromptOffset ( ) const

inline

References _promptOffset.

◆ getPromptString()

const std::string & nidas::core::SampleTag::getPromptString ( ) const

inline

References _promptString.

◆ getRate()

virtual double nidas::core::SampleTag::getRate ( ) const

inlinevirtual

Get sampling rate in samples/sec.

A value of 0.0 means an unknown rate.

References _rate.

◆ getSampleId()

unsigned int nidas::core::SampleTag::getSampleId ( ) const

inline

Get the sample portion of the shortId.

References _sampleId.

Referenced by nidas::core::SamplePipeline::connect(), nidas::dynld::isff::WisardMote::createSampleTags(), SampleToDatabase::defaultMeasurementName(), nidas::core::DSMSensor::fromDOMElement(), nidas::dynld::raf::DSMMesaSensor::fromDOMElement(), nidas::core::SampleIOProcessor::fromDOMElement(), nidas::dynld::raf::DSMArincSensor::init(), nidas::dynld::raf::DSMArincSensor::open(), parseAnalog(), parseOther(), PConfig::showAll(), nidas::dynld::GPS_NMEA_Serial::validate(), nidas::dynld::GPS_Novatel_Serial::validate(), nidas::dynld::raf::A2D_Serial::validate(), and nidas::dynld::raf::TwoD64_USB_v3::validate().

◆ getScanfFormat()

const std::string & nidas::core::SampleTag::getScanfFormat ( ) const

inline

References _scanfFormat.

Referenced by nidas::core::CharacterSensor::doesAsciiSscanfs(), and nidas::core::CharacterSensor::init().

◆ getSensorId()

unsigned int nidas::core::SampleTag::getSensorId ( ) const

inline

Get the sensor portion of the shortId.

References _sensorId.

Referenced by nidas::dynld::isff::WisardMote::createSampleTags(), and nidas::dynld::raf::DSMMesaSensor::fromDOMElement().

◆ getSite()

const Site * SampleTag::getSite ( ) const

Get the Site of this SampleTag, which will be non-NULL only if getDSMConfig() returns non-NULL.

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

Referenced by SampleToDatabase::setSiteAndMeasurement().

◆ getSpSId()

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

inline

Get the sensor+sample portion of the id.

References _id, and GET_SPS_ID.

Referenced by nidas::dynld::isff::WisardMote::addMoteSampleTag(), nidas::dynld::StatisticsProcessor::addRequestedSampleTag(), nidas::dynld::StatisticsCruncher::attach(), nidas::dynld::StatisticsProcessor::connectSource(), nidas::core::DSMSensor::fromDOMElement(), fromDOMElement(), StatsProcess::listOutputSamples(), nidas::dynld::StatisticsProcessor::selectRequestedSampleTags(), and nidas::dynld::StatisticsCruncher::StatisticsCruncher().

◆ getStation()

int nidas::core::SampleTag::getStation ( ) const

inline

Station number, which is also known as the Site number.

A station number of 0 is the "non" station. Otherwise positive integers are used when a project consists of more than one similar station, where one can differentiate between the variables by a station number (which maps to a station dimension in a NetCDF file). Setting the station on a SampleTag will set the: the station on all its variables.

References _station.

Referenced by nidas::dynld::StatisticsCruncher::connect(), fromDOMElement(), and PConfig::loadVariables().

◆ getSuffix()

const std::string & nidas::core::SampleTag::getSuffix ( ) const

inline

Suffix, which is appended to variable names.

References _suffix.

Referenced by SampleToDatabase::setSiteAndMeasurement().

◆ getTimetagAdjust()

float nidas::core::SampleTag::getTimetagAdjust ( ) const

inline

Whether to enable TimetagAdjuster for this sample.

A value of 0 means no ttadjust. The default value of -1 means don't override the value set for the sensor.

References _ttAdjustVal.

Referenced by nidas::dynld::isff::ATIK_Sonic::checkSampleTags(), nidas::dynld::isff::CSAT3_Sonic::checkSampleTags(), nidas::dynld::isff::CSI_IRGA_Sonic::checkSampleTags(), nidas::core::CharacterSensor::init(), nidas::dynld::raf::DSMArincSensor::init(), and nidas::dynld::isff::CSI_CRX_Binary::validate().

◆ getVariable()

Variable & nidas::core::SampleTag::getVariable ( int i )

inline

Provide a reference to a variable - allowing one to modify it.

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

◆ getVariableIterator()

VariableIterator SampleTag::getVariableIterator ( ) const

Referenced by nidas::dynld::raf::CVIOutput::addRequestedSampleTag(), nidas::dynld::iss::WICORSensor::addSampleTag(), nidas::dynld::isff::Wind3D::checkSampleTags(), nidas::dynld::StatisticsCruncher::createCombinations(), nidas::dynld::raf::DSMMesaSensor::fromDOMElement(), nidas::dynld::WxtSensor::init(), PConfig::loadVariables(), parseAnalog(), parseOther(), DumpClient::setSensors(), PConfig::showAll(), and toDOMElement().

◆ getVariables() [1/2]

const std::vector< Variable * > & nidas::core::SampleTag::getVariables ( )

inline

References _variables.

◆ getVariables() [2/2]

const std::vector< const Variable * > & SampleTag::getVariables ( ) const

References _constVariables.

◆ isEnabled()

bool nidas::core::SampleTag::isEnabled ( ) const

inline

References _enabled.

Referenced by nidas::dynld::StatisticsProcessor::addRequestedSampleTag().

◆ isProcessed()

bool nidas::core::SampleTag::isProcessed ( ) const

inline

Test to see if this sample is to be post processed.

References _processed.

Referenced by nidas::dynld::raf::DSMArincSensor::init(), PConfig::loadVariables(), nidas::dynld::raf::DSMArincSensor::open(), parseAnalog(), parseOther(), nidas::dynld::raf::SyncRecordSource::selectVariablesFromSensor(), and PConfig::showAll().

◆ operator=()

SampleTag & SampleTag::operator= ( const SampleTag & rhs )

References _dsm, _enabled, _id, _processed, _promptOffset, _promptString, _rate, _sampleId, _scanfFormat, _sensor, _sensorId, _station, _suffix, addParameter(), addVariable(), nidas::core::Parameter::clone(), and nidas::core::getSample().

◆ removeVariable()

void SampleTag::removeVariable ( const Variable * var )

References _constVariables, _variables, and nidas::core::getSample().

◆ setDSMConfig()

void nidas::core::SampleTag::setDSMConfig ( const DSMConfig * val )

inline

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

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

◆ setDSMId()

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

inline

Set the DSM portion of the id.

References _id, and SET_DSM_ID.

Referenced by nidas::core::NearestResampler::ctorCommon(), nidas::core::DSMSensor::fromDOMElement(), nidas::core::NearestResamplerAtRate::NearestResamplerAtRate(), SampleTag(), nidas::dynld::StatisticsCruncher::StatisticsCruncher(), nidas::dynld::raf::SyncRecordSource::SyncRecordSource(), and TestSource::TestSource().

◆ setDSMSensor()

void SampleTag::setDSMSensor ( const DSMSensor * val )

References _dsm, _sensor, and nidas::core::getSample().

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

◆ setEnabled()

void nidas::core::SampleTag::setEnabled ( bool val )

inline

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

Referenced by fromDOMElement().

◆ setId()

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

inlineprotected

Set the full id.

We don't make this public, because when you use it you can't keep track of the sensor and sample portions of the shortID.

References _id, and SET_FULL_ID.

◆ setPeriod()

virtual void nidas::core::SampleTag::setPeriod ( double val )

inlinevirtual

Set sampling period (1/rate) in sec.

A value of 0.0 means an unknown period.

Exceptions

nidas::util::InvalidParameterException

References _rate.

Referenced by fromDOMElement().

◆ setProcessed()

void nidas::core::SampleTag::setProcessed ( bool val )

inline

Set if this sample is going to be post processed.

Exceptions

nidas::util::InvalidParameterException

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

Referenced by fromDOMElement().

◆ setPromptOffset()

void nidas::core::SampleTag::setPromptOffset ( double val )

inline

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

Referenced by fromDOMElement().

◆ setPromptString()

void nidas::core::SampleTag::setPromptString ( const std::string & val )

inline

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

Referenced by fromDOMElement().

◆ setRate()

virtual void nidas::core::SampleTag::setRate ( double val )

inlinevirtual

Set sampling rate in samples/sec.

Derived SampleTags can override this method and throw an InvalidParameterException if they can't support the rate value. Sometimes a rate of 0.0 may mean don't sample the variables in the SampleTag.

Exceptions

nidas::util::InvalidParameterException

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

Referenced by nidas::core::DSMSensor::fromDOMElement(), fromDOMElement(), nidas::dynld::raf::IRIGSensor::fromDOMElement(), DataPrep::run(), nidas::dynld::raf::SyncRecordReader::scanHeader(), nidas::core::SampleAverager::setAveragePeriodSecs(), nidas::dynld::StatisticsCruncher::StatisticsCruncher(), and nidas::dynld::raf::SyncRecordSource::SyncRecordSource().