ExportMap.h

Go to the documentation of this file.

/*
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * ExportMap.h
 * Interface the ExportMap and ExportedVariables
 * Copyright (C) 2005 Simon Newton
 */

#ifndef INCLUDE_OLA_EXPORTMAP_H_
#define INCLUDE_OLA_EXPORTMAP_H_

#include <ola/base/Macro.h>
#include <stdlib.h>

#include <functional>
#include <map>
#include <sstream>
#include <string>
#include <vector>

namespace ola {

class BaseVariable {
 public:
 explicit BaseVariable(const std::string &name): m_name(name) {}

 virtual ~BaseVariable() {}

 const std::string Name() const { return m_name; }

 virtual const std::string Value() const = 0;

 private:
 std::string m_name;
};

struct VariableLessThan: public std::binary_function<BaseVariable*,
 BaseVariable*, bool> {
 bool operator()(BaseVariable *x, BaseVariable *y) {
 return x->Name() < y->Name();
 }
};


class BoolVariable: public BaseVariable {
 public:
 explicit BoolVariable(const std::string &name)
 : BaseVariable(name),
 m_value(false) {}
 ~BoolVariable() {}

 void Set(bool value) { m_value = value; }

 bool Get() const { return m_value; }

 const std::string Value() const { return m_value ? "1" : "0"; }

 private:
 bool m_value;
};


/*
 * Represents a string variable
 */
class StringVariable: public BaseVariable {
 public:
 explicit StringVariable(const std::string &name)
 : BaseVariable(name),
 m_value("") {}
 ~StringVariable() {}

 void Set(const std::string &value) { m_value = value; }
 const std::string Get() const { return m_value; }
 const std::string Value() const { return m_value; }

 private:
 std::string m_value;
};


/*
 * Represents a integer variable
 */
class IntegerVariable: public BaseVariable {
 public:
 explicit IntegerVariable(const std::string &name)
 : BaseVariable(name),
 m_value(0) {}
 ~IntegerVariable() {}

 void Set(int value) { m_value = value; }
 void operator++(int) { m_value++; }
 void operator--(int) { m_value--; }
 void Reset() { m_value = 0; }
 int Get() const { return m_value; }
 const std::string Value() const {
 std::ostringstream out;
 out << m_value;
 return out.str();
 }

 private:
 int m_value;
};


/*
 * Represents a counter which can only be added to.
 */
class CounterVariable: public BaseVariable {
 public:
 explicit CounterVariable(const std::string &name)
 : BaseVariable(name),
 m_value(0) {}
 ~CounterVariable() {}

 void operator++(int) { m_value++; }
 void operator+=(unsigned int value) { m_value += value; }
 void Reset() { m_value = 0; }
 unsigned int Get() const { return m_value; }
 const std::string Value() const {
 std::ostringstream out;
 out << m_value;
 return out.str();
 }

 private:
 unsigned int m_value;
};


/*
 * A Map variable holds string -> type mappings
 */
template<typename Type>
class MapVariable: public BaseVariable {
 public:
 MapVariable(const std::string &name, const std::string &label)
 : BaseVariable(name),
 m_label(label) {}
 ~MapVariable() {}

 void Remove(const std::string &key);
 void Set(const std::string &key, Type value);
 Type &operator[](const std::string &key);
 const std::string Value() const;
 const std::string Label() const { return m_label; }

 protected:
 std::map<std::string, Type> m_variables;

 private:
 std::string m_label;
};

typedef MapVariable<std::string> StringMap;


class IntMap: public MapVariable<int> {
 public:
 IntMap(const std::string &name, const std::string &label)
 : MapVariable<int>(name, label) {}

 void Increment(const std::string &key) {
 m_variables[key]++;
 }
};


class UIntMap: public MapVariable<unsigned int> {
 public:
 UIntMap(const std::string &name, const std::string &label)
 : MapVariable<unsigned int>(name, label) {}

 void Increment(const std::string &key) {
 m_variables[key]++;
 }
};


/*
 * Return a value from the Map Variable, this will create an entry in the map
 * if the variable doesn't exist.
 */
template<typename Type>
Type &MapVariable<Type>::operator[](const std::string &key) {
 return m_variables[key];
}


/*
 * Set a value in the Map variable.
 */
template<typename Type>
void MapVariable<Type>::Set(const std::string &key, Type value) {
 m_variables[key] = value;
}


template<typename Type>
void MapVariable<Type>::Remove(const std::string &key) {
 typename std::map<std::string, Type>::iterator iter = m_variables.find(key);

 if (iter != m_variables.end())
 m_variables.erase(iter);
}


class ExportMap {
 public:
 ExportMap() {}
 ~ExportMap();

 BoolVariable *GetBoolVar(const std::string &name);

 IntegerVariable *GetIntegerVar(const std::string &name);

 CounterVariable *GetCounterVar(const std::string &name);

 StringVariable *GetStringVar(const std::string &name);

 StringMap *GetStringMapVar(const std::string &name,
 const std::string &label="");
 IntMap *GetIntMapVar(const std::string &name, const std::string &label="");
 UIntMap *GetUIntMapVar(const std::string &name,
 const std::string &label="");

 std::vector<BaseVariable*> AllVariables() const;

 private :
 template<typename Type>
 Type *GetVar(std::map<std::string, Type*> *var_map,
 const std::string &name);

 template<typename Type>
 Type *GetMapVar(std::map<std::string, Type*> *var_map,
 const std::string &name,
 const std::string &label);

 std::map<std::string, BoolVariable*> m_bool_variables;
 std::map<std::string, CounterVariable*> m_counter_variables;
 std::map<std::string, IntegerVariable*> m_int_variables;
 std::map<std::string, StringVariable*> m_string_variables;

 std::map<std::string, StringMap*> m_str_map_variables;
 std::map<std::string, IntMap*> m_int_map_variables;
 std::map<std::string, UIntMap*> m_uint_map_variables;

 DISALLOW_COPY_AND_ASSIGN(ExportMap);
};
} // namespace ola
#endif // INCLUDE_OLA_EXPORTMAP_H_