source: src/Actions/ActionTraits.hpp@ 23359f

/*
 * ActionTraits.hpp
 *
 *  Created on: Oct 26, 2010
 *      Author: heber
 */

#ifndef ACTIONTRAITS_HPP_
#define ACTIONTRAITS_HPP_

// include config.h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <map>
#include <string>

/** Interface for all ActionTraits.
 * This class defines the interface, i.e. the common set of information that
 * is stored in this traits for Action classes. It also defines a set of getter
 * functions.
 *
 * Note that there are no setters. This is because the information is to be
 * given in a specialized form of the templated class ActionTrait that derives
 * from this interface.
 *
 */
class ActionTraits {
public:
  explicit ActionTraits();
  virtual ~ActionTraits();

  typedef std::map<std::string, std::string>::iterator    options_iterator;
  typedef std::map<std::string, std::string>::const_iterator    options_const_iterator;

  const std::string getCurrentValue() const;
  const std::string getDescription() const;
  const std::string getMenuName() const;
  const int getMenuPosition() const;
  const std::string getOptionDescription(const std::string descr) const;
  const std::string getShortForm() const;
  const std::type_info * getType() const;

  options_iterator getBeginIter();
  options_iterator getEndIter();
  options_const_iterator getBeginIter() const;
  options_const_iterator getEndIter() const;

protected:

  // internal information this trait contains
  std::string CurrentValue;
  std::string Description;
  std::string MenuTitle;
  int MenuPosition;
  std::map<std::string, std::string> OptionDescription;
  std::string ShortForm;
  const std::type_info *InternalType;
};

/* Templated class for ActionTraits to specialize.
 * I.e. every action specializes its own ActionTrait and inherits the
 * ActionTraits class as interface , e.g. Action called SuperAction:

 * ActionTrait<SuperAction> : public ActionTraits
 *
 * within the constructor of said ActionTrait<SuperAction> the specific
 * information for this derived Action class is then given.
 */
template <class T>
class ActionTrait : public ActionTraits {
public:
  ActionTrait();
  ~ActionTrait();
};


#endif /* ACTIONTRAITS_HPP_ */