---

Component.h

/*
 * Component.h -- class interface for spell components
 * Copyright (C) 2003  Eric Lemings <elemings@users.sourceforge.net>
 *
 * This software 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 software 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this software; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA
 *
 * RCS: $Id: Component.h,v 1.2 2003/02/27 22:42:17 elemings Exp $
 */

#ifdef __cplusplus

#  ifndef OGS_MAGIC_COMPONENT_H
#    define OGS_MAGIC_COMPONENT_H

#    include <string>

#    include <ogs/magic/Namespace.h>

OGS_BEGIN_MAGIC_NAMESPACE

class Component {
  public:
    enum Type {
      VERBAL = 1,

      SOMANTIC = 2,

      MATERIAL = 3,

      FOCUS = 4,

      DIVINE_FOCUS = 5,

      EXPERIENCE_COST = 6
    };

    static Component Verbal ();
    static Component Somantic ();
    static Component DivineFocus ();

    Type getType () const;
    std::string getAbbreviation () const;

  protected:
    Component (Type type);

  private:
    Type _type;

    static bool isValid (int value);
};

inline Component Component::Verbal () {
  return (Component (Component::VERBAL));
}

inline Component Component::Somantic () {
  return (Component (Component::SOMANTIC));
}

inline Component Component::DivineFocus () {
  return (Component (Component::DIVINE_FOCUS));
}

inline Component::Type Component::getType () const {
  return (this->_type);
}

inline std::string Component::getAbbreviation () const {
  return (this->_type == VERBAL? "V":
          this->_type == SOMANTIC? "S":
          this->_type == MATERIAL? "M":
          this->_type == FOCUS? "F":
          this->_type == DIVINE_FOCUS? "DF":
          this->_type == EXPERIENCE_COST? "XP": "");
}

inline bool Component::isValid (int value) {
  return (value == VERBAL ||
          value == SOMANTIC ||
          value == MATERIAL ||
          value == FOCUS ||
          value == DIVINE_FOCUS ||
          value == EXPERIENCE_COST);
}

OGS_END_MAGIC_NAMESPACE

#  endif /* !defined OGS_MAGIC_COMPONENT_H */

#endif /* defined __cplusplus */

---