Rotor.h

/**************************************************************************
 * Copyright (c) 2007 Clifford Conley Owens III                           *
 *                                                                        *
 * This file is part of Biorithm.                                         *
 *                                                                        *
 * Biorithm 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 3 of the License, or      *
 * (at your option) any later version.                                    *
 *                                                                        *
 * Biorithm 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 Biorithm.  If not, see <http://www.gnu.org/licenses/>.      *
 *                                                                        *
 **************************************************************************/

#ifndef ROTOR_H
#define ROTOR_H

// ---------------------------- External Headers ---------------------------- //

#include <vector>

using namespace std;

class Rotor
{
    private:
        // This is the vector of digits
        vector<unsigned int> digits;

        // The number of different values a digit can have
        unsigned int values;

        // This lets us know whether or not the digits must be unique
        bool unique;

        // Helper methods

        void rotateUnique(unsigned int pos);
        void start(unsigned int pos);
        void rotateNonunique(unsigned int pos);

    public:
        Rotor(unsigned int digitSize = 0, unsigned int valuesSize = 0,
            bool unique = false);
        Rotor(const Rotor& src);
        ~Rotor();
        Rotor& operator =(const Rotor& rhs);
        unsigned int getValue(unsigned int index) const;
        bool isValid() const;
        void rotate();
        void setUnique();
        void reset();
        void reset(const vector<unsigned int>& startPos);
        void resizeDigits(unsigned int size);
        void resizeValues(unsigned int size);
        unsigned int getSize() const;
        unsigned int getDigit(unsigned int index) const;
        bool isEmpty() const;
};

#endif