nidas  v1.2-1520
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
nidas::dynld::isff::CS_Krypton Class Reference

A data converter from voltage to water vapor density in gm/m^3 for a Campbell Scientfic krypton hygrometer. More...

#include <CS_Krypton.h>

Inheritance diagram for nidas::dynld::isff::CS_Krypton:
Inheritance graph
[legend]

Public Member Functions

 CS_Krypton ()
 
CS_Kryptonclone () const
 
void setKw (float val)
 
float getKw () const
 
void setV0 (float val)
 
float getV0 () const
 
void setPathLength (float val)
 
float getPathLength () const
 
void setBias (float val)
 
float getBias () const
 
void reset ()
 Reset the converter to invalid or default settings, such as after an error occurs parsing a CalFile. More...
 
double convert (dsm_time_t t, double volts)
 Convert a voltage to water vapor density in g/m^3. More...
 
std::string toString () const
 Generate a string description of this VariableConverter. More...
 
void fromString (const std::string &) throw (nidas::util::InvalidParameterException)
 
void fromDOMElement (const xercesc::DOMElement *) throw (nidas::util::InvalidParameterException)
 Initialize myself from a xercesc::DOMElement. More...
 
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. More...
 
void setCalFileHandler (CalFileHandler *)
 Set the instance of CalFileHandler which will be called and given first option to handle new CalFile records. More...
 
void setUnits (const std::string &val)
 
virtual const std::string & getUnits () const
 
void setVariable (const Variable *val)
 
const VariablegetVariable () const
 
const DSMSensorgetDSMSensor () const
 
const DSMConfiggetDSMConfig () const
 
void addParameter (Parameter *val)
 Add a parameter to this VariableConverter. More...
 
const std::list< const
Parameter * > & 
getParameters () const
 Get list of parameters. More...
 
const ParametergetParameter (const std::string &name) const
 Fetch a parameter by name. More...
 
void setCalFile (CalFile *)
 
CalFilegetCalFile ()
 
const CalFilegetCalFile () const
 
virtual xercesc::DOMElement * toDOMParent (xercesc::DOMElement *parent, bool complete) const throw (xercesc::DOMException)
 Create a DOMElement and append it to the parent. More...
 
virtual xercesc::DOMElement * toDOMElement (xercesc::DOMElement *node, bool complete) const throw (xercesc::DOMException)
 Add my content into a DOMElement. More...
 

Static Public Member Functions

static VariableConvertercreateVariableConverter (XDOMElement &child)
 
static VariableConvertercreateFromString (const std::string &) throw (nidas::util::InvalidParameterException)
 
static const XMLCh * getNamespaceURI ()
 

Protected Member Functions

void parseFields (CalFile *cf)
 Parse the fields in the current CalFile record for the particular settings and coefficients needed by this converter. More...
 
void abortCalFile (const std::string &what)
 

Protected Attributes

CalFile_calFile
 
CalFileHandler_handler
 

Private Attributes

float _Kw
 
float _V0
 
float _logV0
 
float _pathLength
 
float _bias
 
float _pathLengthKw
 

Detailed Description

A data converter from voltage to water vapor density in gm/m^3 for a Campbell Scientfic krypton hygrometer.

Constructor & Destructor Documentation

CS_Krypton::CS_Krypton ( )

Member Function Documentation

void VariableConverter::abortCalFile ( const std::string &  what)
protectedinherited
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::Parameter::getName().

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

CS_Krypton * CS_Krypton::clone ( ) const
virtual
double CS_Krypton::convert ( dsm_time_t  t,
double  volts 
)
virtual

Convert a voltage to water vapor density in g/m^3.

Implements nidas::core::VariableConverter.

VariableConverter * VariableConverter::createFromString ( const std::string &  str)
throw (nidas::util::InvalidParameterException
)
staticinherited
VariableConverter * VariableConverter::createVariableConverter ( XDOMElement child)
staticinherited
void CS_Krypton::fromDOMElement ( const xercesc::DOMElement *  )
throw (nidas::util::InvalidParameterException
)
virtual
void CS_Krypton::fromString ( const std::string &  )
throw (nidas::util::InvalidParameterException
)
virtual

Reimplemented from nidas::core::VariableConverter.

float nidas::dynld::isff::CS_Krypton::getBias ( ) const
inline
CalFile* nidas::core::VariableConverter::getCalFile ( )
inlineinherited
const CalFile* nidas::core::VariableConverter::getCalFile ( ) const
inlineinherited
const DSMConfig * VariableConverter::getDSMConfig ( ) const
inherited
const DSMSensor * VariableConverter::getDSMSensor ( ) const
inherited
float nidas::dynld::isff::CS_Krypton::getKw ( ) const
inline
static const XMLCh* nidas::core::DOMable::getNamespaceURI ( )
inlinestaticinherited
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.

const std::list<const Parameter*>& nidas::core::VariableConverter::getParameters ( ) const
inlineinherited
float nidas::dynld::isff::CS_Krypton::getPathLength ( ) const
inline
virtual const std::string& nidas::core::VariableConverter::getUnits ( ) const
inlinevirtualinherited
float nidas::dynld::isff::CS_Krypton::getV0 ( ) const
inline
const Variable* nidas::core::VariableConverter::getVariable ( ) const
inlineinherited
void CS_Krypton::parseFields ( CalFile cf)
protectedvirtual

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

Implements nidas::core::VariableConverter.

References nidas::core::CalFile::getFields().

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::util::Exception::what().

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

void CS_Krypton::reset ( )
virtual

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

Implements nidas::core::VariableConverter.

References nidas::core::floatNAN.

void nidas::dynld::isff::CS_Krypton::setBias ( float  val)
inline
Parameters
valBias (g/m^3) to be removed from data values.

Referenced by fromDOMElement().

void VariableConverter::setCalFile ( CalFile val)
inherited
void VariableConverter::setCalFileHandler ( CalFileHandler cfh)
inherited

Set the instance of CalFileHandler which will be called and given first option to handle new CalFile records.

Pass null to disable the callbacks.

References nidas::core::VariableConverter::_handler.

Referenced by nidas::dynld::isff::NCAR_TRH::validate().

void nidas::dynld::isff::CS_Krypton::setKw ( float  val)
inline
Parameters
valKw parameter from sensor calibration.

Referenced by fromDOMElement().

void nidas::dynld::isff::CS_Krypton::setPathLength ( float  val)
inline
Parameters
valPathlength of sensor, in cm.

Referenced by fromDOMElement().

void nidas::core::VariableConverter::setUnits ( const std::string &  val)
inlineinherited
void nidas::dynld::isff::CS_Krypton::setV0 ( float  val)
inline
Parameters
valV0 value in millivolts.

Referenced by fromDOMElement().

void nidas::core::VariableConverter::setVariable ( const Variable val)
inlineinherited
xercesc::DOMElement * DOMable::toDOMElement ( xercesc::DOMElement *  node,
bool  complete 
) const
throw (xercesc::DOMException
)
virtualinherited
xercesc::DOMElement * DOMable::toDOMParent ( xercesc::DOMElement *  parent,
bool  complete 
) const
throw (xercesc::DOMException
)
virtualinherited
std::string CS_Krypton::toString ( ) const
virtual

Generate a string description of this VariableConverter.

May be used in meta-data, for example Netcdf comment.

Implements nidas::core::VariableConverter.

Member Data Documentation

float nidas::dynld::isff::CS_Krypton::_bias
private
CalFile* nidas::core::VariableConverter::_calFile
protectedinherited
CalFileHandler* nidas::core::VariableConverter::_handler
protectedinherited
float nidas::dynld::isff::CS_Krypton::_Kw
private
float nidas::dynld::isff::CS_Krypton::_logV0
private
float nidas::dynld::isff::CS_Krypton::_pathLength
private
float nidas::dynld::isff::CS_Krypton::_pathLengthKw
private
float nidas::dynld::isff::CS_Krypton::_V0
private

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