VariableIndex.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_VARIABLEINDEX_H
#define NIDAS_CORE_VARIABLEINDEX_H

namespace nidas { namespace core {

class Variable;

class VariableIndex
{
public:

    VariableIndex() :
        _variable(0),
        _index(-1)
    {}

    VariableIndex(Variable* var, int index) :
        _variable(var),
        _index(index)
    {}

    VariableIndex(const VariableIndex& rhs) :
        _variable(rhs._variable),
        _index(rhs._index)
    {}
        
    VariableIndex& operator=(const VariableIndex& rhs)
    {
        _variable = rhs._variable;
        _index = rhs._index;
        return *this;
    }

    bool operator==(const VariableIndex& rhs) const
    {
        return (_variable == rhs._variable) && (_index == rhs._index);
    }

    Variable*
    variable()
    {
        return _variable;
    }

    int
    index()
    {
        return _index;
    }

    float
    get(float* fdata, float dflt)
    {
        if (_index >= 0)
            return fdata[_index];
        return dflt;
    }

    void
    set(float* fdata, float value)
    {
        if (_index >= 0)
            fdata[_index] = value;
    }

    bool
    operator!() const
    {
        return _index < 0 || !_variable;
    }

    bool
    valid() const
    {
        return _index >= 0 && _variable;
    }

private:

    Variable* _variable;
    int _index;
};

}}  // namespace nidas namespace core

#endif