lib/kernel_ManagerContour_NDimensions/KeyThing.h

   1 #ifndef __KEY_THING__
   2 #define __KEY_THING__
   3
   4
   5 //------------------------------------------------------------------------------------------------------------
   6 // Includes
   7 //------------------------------------------------------------------------------------------------------------
   8 #include <iostream>
   9 #include <string>
  10
  11 class KeyThing{
  12
  13
  14 //------------------------------------------------------------------------------------------------------------
  15 // Constructors & Destructors
  16 //------------------------------------------------------------------------------------------------------------
  17 public:
  18
  19         /*
  20         * Creates the key thing
  21         * @param thePrefix Is the prefix of the new keyThing for the key generation correponding to the new keyThing
  22         * @param theValue Is the value of the intial key generation correponding to the new keyThing
  23         */
  24         KeyThing(std::string thePrefix, int theValue);
  25
  26         /*
  27         * Destroys the key thing
  28         */
  29         ~KeyThing();
  30
  31
  32 //------------------------------------------------------------------------------------------------------------
  33 // Public Methods
  34 //------------------------------------------------------------------------------------------------------------
  35
  36         /*
  37         * Sets the prefix of the keyThing
  38         */
  39         void setPrefix( std::string aPrefix);
  40
  41         /*
  42         * Sets the value value of the keyThing
  43         * @param aValue The valueimum to set
  44         */
  45         void setValue (int aValue);
  46
  47         /*
  48         * Gets the prefix of the keyThing
  49         * @return prefix The setted prefix
  50         */
  51         std::string getPrefix();
  52
  53         /*
  54         * Gets the value value of the keyThing
  55         * @return value The setted valueimum
  56         */
  57         int getValue();
  58
  59 //------------------------------------------------------------------------------------------------------------
  60 // Constants
  61 //------------------------------------------------------------------------------------------------------------
  62
  63 //------------------------------------------------------------------------------------------------------------
  64 // Attributes
  65 //------------------------------------------------------------------------------------------------------------
  66
  67 private:
  68
  69         /*
  70         * Represents the prefix of the keyThing
  71         */
  72         std::string prefix;
  73
  74         /*
  75         * Represents the value value of the keyThing
  76         */
  77         int value;
  78 };
  79 #endif
  80