lib/kernel_ManagerContour_NDimensions/NameWrapper.h

   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 __NAME_WRAPPER__
  27 #define __NAME_WRAPPER__
  28
  29
  30
  31 //------------------------------------------------------------------------------------------------------------
  32 // Includes
  33 //------------------------------------------------------------------------------------------------------------
  34 #include <iostream>
  35
  36 class NameWrapper{
  37
  38 //------------------------------------------------------------------------------------------------------------
  39 // Constructors & Destructors
  40 //------------------------------------------------------------------------------------------------------------
  41 public:
  42
  43         /*
  44         * Creates the NameWrapper
  45         * @param thekeyName The key name
  46         * @param theRealName  The real name
  47         * @return Returns the created NameWrapper
  48         */
  49         NameWrapper(std::string thekeyName, std::string theRealName);
  50
  51         /*
  52         * Destroys the NameWrapper
  53         */
  54         ~NameWrapper();
  55 //------------------------------------------------------------------------------------------------------------
  56 // Methods
  57 //------------------------------------------------------------------------------------------------------------
  58
  59         /*
  60         * Sets the names pair to wrapp
  61         * @param thekeyName The key name
  62         * @param theRealName  The real name
  63         */
  64         void setWrappingPair(std::string thekeyName, std::string theRealName );
  65
  66         /*
  67         * Gets the wrapped key name
  68         * @param keyName The key name
  69         */
  70         std::string getKeyName();
  71
  72         /*
  73         * Gets the wrapped real name
  74         * @param realName The real name
  75         */
  76         std::string getRealName();
  77
  78 //------------------------------------------------------------------------------------------------------------
  79 // Constants
  80 //------------------------------------------------------------------------------------------------------------
  81
  82 private:
  83 //------------------------------------------------------------------------------------------------------------
  84 // Attributes
  85 //------------------------------------------------------------------------------------------------------------
  86
  87         /*
  88         * The wrapped key name
  89         */
  90         std::string keyName;
  91
  92         /*
  93         * The wrapped real name
  94         */
  95         std::string realName;
  96
  97 };
  98 #endif