ValueList.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  ValueList.h
//
//  Represents a list of items
//
//  Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
//
//  SOFTWARE NOTICE AND LICENSE
//
//  This file is part of OpenZWave.
//
//  OpenZWave is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  OpenZWave 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------

#ifndef _ValueList_H
#define _ValueList_H

#include <string>
#include <vector>
#include "Defs.h"
#include "value_classes/Value.h"

class TiXmlElement;

namespace OpenZWave
{
    namespace Internal
    {
        namespace VC
        {

            class ValueList: public Value
            {
                public:
                    struct Item
                    {
                            string m_label;
                            int32 m_value;
                    };

                    ValueList(uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, vector<Item> const& _items, int32 const _valueIdx, uint8 const _pollIntensity, uint8 const _size = 4);
                    ValueList();
                    virtual ~ValueList()
                    {
                    }

                    bool SetByLabel(string const& _label);
                    bool SetByValue(int32 const _value);

                    void OnValueRefreshed(int32 const _valueIdx);

                    // From Value
                    virtual string const GetAsString() const
                    {
                        return GetItem()->m_label;
                    }
                    virtual bool SetFromString(string const& _value)
                    {
                        return SetByLabel(_value);
                    }
                    virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement);
                    virtual void WriteXML(TiXmlElement* _valueElement);

                    Item const* GetItem() const;

                    int32 GetItemIdxByLabel(string const& _label) const;
                    int32 GetItemIdxByValue(int32 const _value) const;

                    bool GetItemLabels(vector<string>* o_items);
                    bool GetItemValues(vector<int32>* o_values);

                    uint8 GetSize() const
                    {
                        return m_size;
                    }

                private:
                    vector<Item> m_items;
                    int32 m_valueIdx;                   // the current index in the m_items vector
                    int32 m_valueIdxCheck;          // the previous index in the m_items vector (used for double-checking spurious value reads)
                    uint8 m_size;
            };
        } // namespace VC
    } // namespace Internal
} // namespace OpenZWave

#endif