/*
 * Project: MoleCuilder
 * Description: creates and alters molecular systems
 * Copyright (C)  2010 University of Bonn. All rights reserved.
 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
 */

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

#include "Actions/ActionTraits.hpp"

#include <string>

/** Constructor for base class ActionTraits.
 *
 */
ActionTraits::ActionTraits()
{}

/** Constructor for base class ActionTraits.
 *
 */
ActionTraits::~ActionTraits()
{}

/** Returns Current Value for this ActionTrait.
 * \return ActionTraits::CurrentValue as std::string
 */
const std::string ActionTraits::getCurrentValue() const
{
 return CurrentValue;
}

/** Returns Description for this ActionTrait.
 * \return ActionTraits::Description as std::string
 */
const std::string ActionTraits::getDescription() const
{
  return Description;
}

/** Returns menu title for this ActionTrait.
 * \return ActionTraits::MenuTitle as std::string
 */
const std::string ActionTraits::getMenuName() const
{
  return MenuTitle;
}

/** Returns menu title for this ActionTrait.
 * \return ActionTraits::MenuPosition as std::string
 */
const int ActionTraits::getMenuPosition() const
{
  return MenuPosition;
}

/** Returns Description for the given option of this ActionTrait.
 * \param token of option
 * \return ActionTraits::OptionDescription as std::string
 */
const std::string ActionTraits::getOptionDescription(const std::string descr) const
{
  if (OptionDescription.find(descr) != OptionDescription.end())
    return OptionDescription.find(descr)->second;
  else
    return std::string();
}

/** Returns ShortForm for this ActionTrait.
 * \return ActionTraits::ShortForm as std::string
 */
const std::string ActionTraits::getShortForm() const
{
  return ShortForm;
}

/** Returns Type for this ActionTrait.
 * \return ActionTraits::InternalType as std::type_info reference
 */
const std::type_info * ActionTraits::getType() const
{
  return InternalType;
}

/** Forward iterator from beginning of list of options.
 * \return iterator
 */
ActionTraits::options_iterator ActionTraits::getBeginIter()
{
  return OptionDescription.begin();
}

/** Forward iterator at end of list of options.
 * \return iterator
 */
ActionTraits::options_iterator ActionTraits::getEndIter()
{
  return OptionDescription.end();
}

/** Constant forward iterator from beginning of list of options.
 * \return constant iterator
 */
ActionTraits::options_const_iterator ActionTraits::getBeginIter() const
{
  return OptionDescription.begin();
}

/** Constant forward iterator at end of list of options.
 * \return constant iterator
 */
ActionTraits::options_const_iterator ActionTraits::getEndIter() const
{
  return OptionDescription.end();
}