Updated class availabilty and documentation

This commit is contained in:
2018-05-05 16:03:25 -04:00
parent bd9e66f176
commit 2ec207a194

View File

@@ -13,22 +13,22 @@
class Caesar{
private:
std::string inputString;
std::string outputString;
int shift;
std::string inputString; //The string that needs encoded/decoded
std::string outputString; //The encoded/decoded string
int shift; //The amount that you need to shift each letter
void setShift(int shiftAmount); //Sets shift and makes sure it is within the propper bounds
void setInputString(std::string inputString); //Sets the input string
std::string encode(); //Encodes the inputString and stores the result in outputString
std::string decode(); //Decodes the inputString and stores the result in outputString
public:
Caesar();
~Caesar();
void setInputString(std::string inputString);
std::string getInputString() const;
void setShift(int shiftAmount);
int getShift() const;
std::string getOutputString() const;
std::string encode();
std::string encode(int shiftAmount, std::string inputString);
std::string decode();
std::string decode(int shiftAmount, std::string inputString);
void reset();
std::string getInputString() const; //Returns the inputString
int getShift() const; //Returns shift
std::string getOutputString() const; //Returns the outputString
std::string encode(int shiftAmount, std::string input); //Sets the shift and inputString and encodes the message
std::string decode(int shiftAmount, std::string input); //Sets the shift and inputString and decodes the message
void reset(); //Makes sure all of the variables are empty
};