kernel/src/bbtkBlackBoxInputDescriptor.h

   1 /*
   2  # ---------------------------------------------------------------------
   3  #
   4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5  #                        pour la SantÈ)
   6  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9  #
  10  #  This software is governed by the CeCILL-B license under French law and
  11  #  abiding by the rules of distribution of free software. You can  use,
  12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13  #  license as circulated by CEA, CNRS and INRIA at the following URL
  14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15  #  or in the file LICENSE.txt.
  16  #
  17  #  As a counterpart to the access to the source code and  rights to copy,
  18  #  modify and redistribute granted by the license, users are provided only
  19  #  with a limited warranty  and the software's author,  the holder of the
  20  #  economic rights,  and the successive licensors  have only  limited
  21  #  liability.
  22  #
  23  #  The fact that you are presently reading this means that you have had
  24  #  knowledge of the CeCILL-B license and that you accept its terms.
  25  # ------------------------------------------------------------------------ */
  26
  27
  28 /*=========================================================================
  29   Program:   bbtk
  30   Module:    $RCSfile: bbtkBlackBoxInputDescriptor.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:49:01 $
  33   Version:   $Revision: 1.6 $
  34 =========================================================================*/
  35
  36
  37 /**
  38  *  \file
  39  *  \brief Class bbtk::BlackBoxInputDescriptor : abstract descriptor of an input of a black box
  40  */
  41 /**
  42  * \class bbtk::BlackBoxInputDescriptor
  43  * \brief Abstract descriptor of an input of a black box
  44  */
  45
  46 #ifndef __bbtkBlackBoxInputDescriptor_h__
  47 #define __bbtkBlackBoxInputDescriptor_h__
  48
  49 #include "bbtkBlackBoxInputOutputDescriptor.h"
  50
  51 namespace bbtk
  52 {
  53   class BBTK_EXPORT BlackBoxInputDescriptor
  54     : public BlackBoxInputOutputDescriptor
  55   {
  56   public:
  57     typedef enum {
  58       MANDATORY,
  59       OPTIONAL
  60     } OptionType;
  61
  62
  63     /// Ctor with name and description
  64     BlackBoxInputDescriptor(TypeInfo creator_type_info,
  65                             const std::string& name,
  66                             const std::string& description,
  67                             const std::string& nature,
  68                             bool copy_construct = true,
  69                             OptionType option = MANDATORY
  70                             )
  71       : BlackBoxInputOutputDescriptor(creator_type_info,name,
  72                                       description,nature,
  73                                       copy_construct),
  74         mOption(option)
  75     {}
  76     /// Returns the option of the input
  77     OptionType GetOption() const { return mOption; }
  78
  79   protected:
  80     /// Default ctor is reserved to children
  81     BlackBoxInputDescriptor() : BlackBoxInputOutputDescriptor(),
  82                                 mOption(OPTIONAL) {}
  83
  84   private:
  85     /// The option of the input
  86     OptionType mOption;
  87   };
  88
  89 }
  90 // namespace bbtk
  91 #endif