Variable.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2005, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
#ifndef NIDAS_CORE_VARIABLE_H
#define NIDAS_CORE_VARIABLE_H

#include "DOMable.h"
#include "Site.h"
#include "VariableConverter.h"
#include <nidas/util/InvalidParameterException.h>

#include <string>
#include <list>

namespace nidas { namespace core {

class SampleTag;
class Parameter;
class Site;

class Variable : public DOMable
{
public:

    typedef enum var_type { CONTINUOUS, COUNTER, CLOCK, OTHER, WEIGHT } type_t;

    Variable();

    Variable(const Variable&);

    Variable& operator=(const Variable&);

    virtual ~Variable();

    bool operator == (const Variable& x) const;

    bool operator != (const Variable& x) const;

    bool operator < (const Variable& x) const;

    bool closeMatch(const Variable& x) const;

    void setSite(const Site* val)
    {
        _site = val;
        if (_site && getStation() == 0) setSiteSuffix(_site->getSuffix());
        else setSiteSuffix("");
    }

    const Site* getSite() const
    {
        return _site;
    }

    int getStation() const { return _station; }

    void setStation(int val)
    {
        _station = val;
        if (_site && _station == 0) setSiteSuffix(_site->getSuffix());
        else setSiteSuffix("");
    }

    type_t getType() const { return _type; }

    void setType(type_t val) { _type = val; }

    const SampleTag* getSampleTag() const { return _sampleTag; }

    void setSampleTag(const SampleTag* val);

    float getSampleRate() const;

    void setPrefix(const std::string& val)
    {
        _prefix = val;
        _name = _prefix + _suffix + _siteSuffix;
        _nameWithoutSite = _prefix + _suffix;
    }

    const std::string& getPrefix() const { return _prefix; }

    const std::string& getSuffix() const { return _suffix; }

    void setSuffix(const std::string& val)
    {
        _suffix = val;
        _name = _prefix + _suffix + _siteSuffix;
        _nameWithoutSite = _prefix + _suffix;
    }

    const std::string& getSiteSuffix() const { return _siteSuffix; }

    void setName(const std::string& val)
    {
        _suffix.clear();
        _siteSuffix.clear();
        _prefix = val;
        _name = _prefix;
        _nameWithoutSite = _prefix;
    }

    const std::string& getName() const { return _name; }

    const std::string& getNameWithoutSite() const { return _nameWithoutSite; }

    void setLongName(const std::string& val) { _longname = val; }

    const std::string& getLongName() const { return _longname; }

    void setA2dChannel( int val ) { _A2dChannel = val; }

    int getA2dChannel() const { return _A2dChannel; }

    void setUnits(const std::string& val) { _units = val; }

    const std::string& getUnits() const { return _units; }

    unsigned int getLength() const { return _length; }

    void setLength(unsigned int val) { _length = val; }

    void setConverter(VariableConverter* val)
    {
        delete _converter;
        _converter = val;
    }

    const VariableConverter* getConverter() const { return _converter; }

    VariableConverter* getConverter() { return _converter; }

    float*
    convert(dsm_time_t ttag, float* values, int nvalues=0, float* results=0);

    void addParameter(Parameter* val)
    {
        _parameters.push_back(val);
        _constParameters.push_back(val);
    }

    const std::list<const Parameter*>& getParameters() const
    {
        return _constParameters;
    }

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

    void setMissingValue(float val)
    {
        _missingValue = val;
    }

    float getMissingValue() const
    {
        return _missingValue;
    }

    void setMinValue(float val)
    {
        _minValue = val;
        if (std::isnan(_plotRange[0])) _plotRange[0] = val;
    }

    float getMinValue() const
    {
        return _minValue;
    }

    void setMaxValue(float val)
    {
        _maxValue = val;
        if (std::isnan(_plotRange[1])) _plotRange[1] = val;
    }

    float getMaxValue() const
    {
        return _maxValue;
    }

    void setPlotRange(float minv,float maxv)
    {
        _plotRange[0] = minv;
        _plotRange[1] = maxv;
    }

    void getPlotRange(float& minv,float& maxv) const
    {
        minv = _plotRange[0];
        maxv = _plotRange[1];
    }

    void setDynamic(bool val) { _dynamic = val; }

    bool isDynamic() const { return _dynamic; }

    void fromDOMElement(const xercesc::DOMElement*)
        throw(nidas::util::InvalidParameterException);

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

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

private:

    void setSiteSuffix(const std::string& val);

    std::string _name;

    const Site* _site;

    int _station;

    std::string _nameWithoutSite;

    std::string _prefix;

    std::string _suffix;

    std::string _siteSuffix;

    std::string _longname;

    const SampleTag* _sampleTag;

    int _A2dChannel;

    std::string _units;

    type_t _type;

    unsigned int _length;

    VariableConverter *_converter;

    std::list<Parameter*> _parameters;

    std::list<const Parameter*> _constParameters;

    float _missingValue;

    float _minValue;

    float _maxValue;

    float _plotRange[2];

    bool _dynamic;

};

}} // namespace nidas namespace core

#endif