---

Die.h

/*
 * Die.h -- class interface for polyhedral die
 * Copyright (C) 2002  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: Die.h,v 1.2 2003/03/23 22:14:36 elemings Exp $
 */

#ifdef __cplusplus

#  ifndef OGS_CORE_DIE_H
#    define OGS_CORE_DIE_H

#    include <ogs/support/Object.h>
#    include <ogs/core/Namespace.h>

OGS_BEGIN_CORE_NAMESPACE

class Die: public ogs::support::Object {
  public:
    typedef unsigned short Sides;

    typedef unsigned short Count;

    typedef short Modifier;

    typedef short Value;

    static const Sides d4 = 4;
    static const Sides d6 = 6;
    static const Sides d8 = 8;
    static const Sides d10 = 10;
    static const Sides d12 = 12;
    static const Sides d20 = 20;

    static const Sides d2 = 2;

    static const Sides d3 = 3;

    static const Sides d5 = 5;

    static const Sides d100 = 100;

    static Value
    roll (Sides sides = d20, Count count = 1, Modifier modifier = 0);

    Die (Sides sides = d20, Count count = 1, Modifier modifier = 0);

    Sides getSides () const;
    void setSides (Sides sides);
    Count getCount () const;
    void setCount (Count count);
    Modifier getModifier () const;
    void setModifier (Modifier modifier);
    Value getValue () const;
    void setValue () const;
    Value rollValue () const;
    Value getMaximumValue () const;
    Value getMinimumValue () const;

    //std::string formatNotation () const;
    //void parseNotation (const std::string& string);

  private:
    Sides sides;
    Count count;
    Modifier modifier;
    // The value can be rerolled even if the die is const.
    mutable Value value;
};

inline Die::Sides Die::getSides () const {
  return (this->sides);
}

inline Die::Count Die::getCount () const {
  return (this->count);
}

inline Die::Modifier Die::getModifier () const {
  return (this->modifier);
}

inline Die::Value Die::getValue () const {
  return (this->value);
}

inline Die::Value Die::rollValue () const {
  setValue ();
  return (getValue ());
}

inline Die::Value Die::getMinimumValue () const {
  return (this->count + this->modifier);
}

inline Die::Value Die::getMaximumValue () const {
  return ((this->count * this->sides) + this->modifier);
}

OGS_END_CORE_NAMESPACE

#  endif /* !defined OGS_CORE_DIE_H */

#endif /* defined __cplusplus */

---