creaContours_lib
KeyThing.h
Go to the documentation of this file.
1 /*# ---------------------------------------------------------------------
2 #
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
4 # pour la Sant�)
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
8 #
9 # This software is governed by the CeCILL-B license under French law and
10 # abiding by the rules of distribution of free software. You can use,
11 # modify and/ or redistribute the software under the terms of the CeCILL-B
12 # license as circulated by CEA, CNRS and INRIA at the following URL
13 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
14 # or in the file LICENSE.txt.
15 #
16 # As a counterpart to the access to the source code and rights to copy,
17 # modify and redistribute granted by the license, users are provided only
18 # with a limited warranty and the software's author, the holder of the
19 # economic rights, and the successive licensors have only limited
20 # liability.
21 #
22 # The fact that you are presently reading this means that you have had
23 # knowledge of the CeCILL-B license and that you accept its terms.
24 # ------------------------------------------------------------------------ */
25 
26 #ifndef __KEY_THING__
27 #define __KEY_THING__
28 
29 
30 //------------------------------------------------------------------------------------------------------------
31 // Includes
32 //------------------------------------------------------------------------------------------------------------
33 #include <iostream>
34 #include <string>
35 
36 class KeyThing{
37 
38 
39 //------------------------------------------------------------------------------------------------------------
40 // Constructors & Destructors
41 //------------------------------------------------------------------------------------------------------------
42 public:
43 
44  /*
45  * Creates the key thing
46  * @param thePrefix Is the prefix of the new keyThing for the key generation correponding to the new keyThing
47  * @param theValue Is the value of the intial key generation correponding to the new keyThing
48  */
49  KeyThing(std::string thePrefix, int theValue);
50 
51  /*
52  * Destroys the key thing
53  */
54  ~KeyThing();
55 
56 
57 //------------------------------------------------------------------------------------------------------------
58 // Public Methods
59 //------------------------------------------------------------------------------------------------------------
60 
61  /*
62  * Sets the prefix of the keyThing
63  */
64  void setPrefix( std::string aPrefix);
65 
66  /*
67  * Sets the value value of the keyThing
68  * @param aValue The valueimum to set
69  */
70  void setValue (int aValue);
71 
72  /*
73  * Gets the prefix of the keyThing
74  * @return prefix The setted prefix
75  */
76  std::string getPrefix();
77 
78  /*
79  * Gets the value value of the keyThing
80  * @return value The setted valueimum
81  */
82  int getValue();
83 
84 //------------------------------------------------------------------------------------------------------------
85 // Constants
86 //------------------------------------------------------------------------------------------------------------
87 
88 //------------------------------------------------------------------------------------------------------------
89 // Attributes
90 //------------------------------------------------------------------------------------------------------------
91 
92 private:
93 
94  /*
95  * Represents the prefix of the keyThing
96  */
97  std::string prefix;
98 
99  /*
100  * Represents the value value of the keyThing
101  */
102  int value;
103 };
104 #endif
105