Why isn't this a sublcass of Polynomial which sets MAX_NUM_COEFFS to 2? More...

#include <VariableConverter.h>

Inheritance diagram for nidas::core::Linear:

[legend]

Public Member Functions
	Linear ()

Linear *	clone () const

void	setSlope (float val)

float	getSlope () const

void	setIntercept (float val)

float	getIntercept () const

double	convert (dsm_time_t t, double val)

void	reset ()
	Reset the converter to invalid or default settings, such as after an error occurs parsing a CalFile.

void	parseFields (CalFile *cf)
	Parse the fields in the current CalFile record for the particular settings and coefficients needed by this converter.

virtual std::string	toString () const override
	Generate a string description of this VariableConverter.

void	fromString (const std::string &)

void	fromDOMElement (const xercesc::DOMElement *)

virtual void	readCalFile (dsm_time_t) throw ()
	Before a VariableConverter can be used for a conversion, the converter's CalFile, if it exists, needs to be advanced to the right record for the current sample time.

void	setCalFileHandler (CalFileHandler *)
	Set the instance of CalFileHandler which will be called and given first option to handle new CalFile records.

void	setUnits (const std::string &val)

virtual const std::string &	getUnits () const

void	setVariable (const Variable *val)

const Variable *	getVariable () const

const DSMSensor *	getDSMSensor () const

const DSMConfig *	getDSMConfig () const

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

const std::list< const Parameter * > &	getParameters () const
	Get list of parameters.

const Parameter *	getParameter (const std::string &name) const
	Fetch a parameter by name.

void	setCalFile (CalFile *)

CalFile *	getCalFile ()

const CalFile *	getCalFile () 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 VariableConverter *	createVariableConverter (XDOMElement &child)

static VariableConverter *	createFromString (const std::string &)

static const XMLCh *	getNamespaceURI ()

Protected Member Functions
void	abortCalFile (const std::string &what)

Protected Attributes
CalFile *	_calFile

CalFileHandler *	_handler

Private Attributes
float	_slope

float	_intercept

std::string	_units

std::map< std::string, Parameter * >	_parameters
	Map of parameters by name.

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

const Variable *	_variable

Static Private Attributes
static XMLCh *	namespaceURI = 0

Detailed Description

Why isn't this a sublcass of Polynomial which sets MAX_NUM_COEFFS to 2?

Constructor & Destructor Documentation

◆ Linear()

Linear::Linear ( )

Referenced by clone().

Member Function Documentation

◆ abortCalFile()

void VariableConverter::abortCalFile ( const std::string & what )

protectedinherited

References nidas::core::VariableConverter::_calFile, nidas::core::CalFile::getCurrentFileName(), nidas::core::VariableConverter::reset(), and WLOG.

◆ addParameter()

void VariableConverter::addParameter ( Parameter * val )

inherited

Add a parameter to this VariableConverter.

VariableConverter will then own the pointer and will delete it in its destructor. If a Parameter exists with the same name, it will be replaced with the new Parameter.

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

Referenced by nidas::core::VariableConverter::fromDOMElement(), nidas::core::VariableConverter::operator=(), and nidas::core::VariableConverter::VariableConverter().

◆ clone()

Linear * Linear::clone ( ) const

virtual

Implements nidas::core::VariableConverter.

References Linear().

◆ convert()

double Linear::convert	(	dsm_time_t	t,
		double	val )

virtual

Implements nidas::core::VariableConverter.

References _intercept, _slope, and nidas::core::VariableConverter::readCalFile().

◆ createFromString()

VariableConverter * VariableConverter::createFromString ( const std::string & str )

staticinherited

Exceptions

nidas::util::InvalidParameterException

References nidas::core::getSample().

◆ createVariableConverter()

VariableConverter * VariableConverter::createVariableConverter ( XDOMElement & child )

staticinherited

References nidas::core::DOMObjectFactory::createObject(), and nidas::core::getSample().

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

◆ fromDOMElement()

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

virtual

Exceptions

nidas::util::InvalidParameterException

Implements nidas::core::DOMable.

References nidas::core::VariableConverter::fromDOMElement(), nidas::core::getSample(), setIntercept(), and setSlope().

◆ fromString()

void Linear::fromString ( const std::string & str )

virtual

Exceptions

nidas::util::InvalidParameterException

Reimplemented from nidas::core::VariableConverter.

References nidas::core::getSample(), setIntercept(), setSlope(), and nidas::core::VariableConverter::setUnits().

◆ getCalFile() [1/2]

CalFile * nidas::core::VariableConverter::getCalFile ( )

inlineinherited

References nidas::core::VariableConverter::_calFile.

Referenced by nidas::core::SampleTag::fromDOMElement(), and nidas::dynld::isff::RebsLinear::toString().

◆ getCalFile() [2/2]

const CalFile * nidas::core::VariableConverter::getCalFile ( ) const

inlineinherited

References nidas::core::VariableConverter::_calFile.

◆ getDSMConfig()

const DSMConfig * VariableConverter::getDSMConfig ( ) const

inherited

References nidas::core::VariableConverter::getDSMSensor(), and nidas::core::getSample().

◆ getDSMSensor()

const DSMSensor * VariableConverter::getDSMSensor ( ) const

inherited

References nidas::core::SampleTag::getDSMSensor(), nidas::core::getSample(), and nidas::core::VariableConverter::getVariable().

Referenced by nidas::core::VariableConverter::fromDOMElement(), and nidas::core::VariableConverter::getDSMConfig().

◆ getIntercept()

float nidas::core::Linear::getIntercept ( ) const

inline

References _intercept.

◆ getNamespaceURI()

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

inlinestaticinherited

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

◆ getParameter()

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

inherited

Fetch a parameter by name.

Returns a NULL pointer if no such parameter exists.

References nidas::core::VariableConverter::_parameters.

Referenced by nidas::dynld::isff::CS_Krypton::fromDOMElement().

◆ getParameters()

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

inlineinherited

Get list of parameters.

References nidas::core::VariableConverter::_constParameters.

◆ getSlope()

float nidas::core::Linear::getSlope ( ) const

inline

References _slope.

◆ getUnits()

virtual const std::string & nidas::core::VariableConverter::getUnits ( ) const

inlinevirtualinherited

References nidas::core::VariableConverter::_units.

Referenced by toString(), nidas::core::Polynomial::toString(), and nidas::dynld::isff::RebsLinear::toString().

◆ getVariable()

const Variable * nidas::core::VariableConverter::getVariable ( ) const

inlineinherited

References nidas::core::VariableConverter::_variable.

Referenced by nidas::core::VariableConverter::getDSMSensor().

◆ parseFields()

void Linear::parseFields ( CalFile * cf )

virtual

Parse the fields in the current CalFile record for the particular settings and coefficients needed by this converter.

Implements nidas::core::VariableConverter.

References setIntercept(), and setSlope().

◆ readCalFile()

void VariableConverter::readCalFile	(	dsm_time_t	t	)
throw	(	)

virtualinherited

Before a VariableConverter can be used for a conversion, the converter's CalFile, if it exists, needs to be advanced to the right record for the current sample time.

As records are read, this method calls parseFields() so the VariableConverter subclass can extract the particular information it needs from the CalFile fields, typically coefficients.

For sensors which need to extend the kind of conversions which can be specified by a CalFile, there is a callback function available. See setCalFileHandler().

References DLOG, nidas::util::UTime::format(), and nidas::core::getSample().

Referenced by convert(), nidas::core::Polynomial::convert(), nidas::dynld::isff::CS_Krypton::convert(), nidas::dynld::isff::RebsLinear::convert(), nidas::dynld::isff::NCAR_TRH::convertVariable(), and nidas::dynld::raf::SyncRecordSource::preLoadCalibrations().