kernel/src/bbtkAtomicBlackBoxOutputDescriptor.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkAtomicBlackBoxOutputDescriptor.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/10/17 08:18:12 $
   6   Version:   $Revision: 1.3 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31
  32 /**
  33  *  \file
  34  *  \brief Class bbtk::AtomicBlackBoxOutputDescriptor : structure containing the description of a AtomicBlackBox output (name, description, type, functor)
  35  */
  36 /**
  37  * \class bbtk::AtomicBlackBoxOutputDescriptor
  38  * \brief Structure containing the description of a AtomicBlackBox output (name, description, type, functor)
  39  */
  40
  41 #ifndef __bbtkAtomicBlackBoxOutputDescriptor_h__
  42 #define __bbtkAtomicBlackBoxOutputDescriptor_h__
  43
  44 #include "bbtkBlackBoxOutputDescriptor.h"
  45 #include "bbtkAtomicBlackBoxGetSetFunctor.h"
  46 #include "bbtkMessageManager.h"
  47
  48 namespace bbtk
  49 {
  50
  51
  52   class BBTK_EXPORT AtomicBlackBoxOutputDescriptor :
  53     public bbtk::BlackBoxOutputDescriptor
  54   {
  55   public:
  56
  57     AtomicBlackBoxOutputDescriptor( TypeInfo creator_type_info,
  58                                     const std::string& name,
  59                                     const std::string& description,
  60                                     const std::string& nature,
  61                                     AtomicBlackBoxGetFunctor* getfunctor,
  62                                     AtomicBlackBoxSetFunctor* setfunctor,
  63                                     bool copy_construct = true);
  64     ~AtomicBlackBoxOutputDescriptor();
  65
  66     /// Returns the type of the input
  67     TypeInfo GetTypeInfo() const { return mGetFunctor->GetTypeInfo(); }
  68     /// Returns the name of the type of the input
  69     std::string GetTypeName() const { return mGetFunctor->GetTypeName(); }
  70    /// Returns the name of the type of the input
  71     std::string GetHumanTypeName() const { return mGetFunctor->GetHumanTypeName(); }
  72     /// Returns true iff the type is a pointer to class
  73     virtual bool IsPointerType() const { return mGetFunctor->IsPointerType(); }   /// Returns the functor on the Get method
  74     AtomicBlackBoxGetFunctor* GetGetFunctor() { return mGetFunctor; }
  75     /// Returns the functor on the Set method
  76     AtomicBlackBoxSetFunctor* GetSetFunctor() { return mSetFunctor; }
  77
  78
  79   private:
  80     /// Default ctor is private
  81     AtomicBlackBoxOutputDescriptor() :
  82       BlackBoxOutputDescriptor(typeid(void),"","","") {}
  83     /// The functor on the Get method
  84     AtomicBlackBoxGetFunctor* mGetFunctor;
  85     /// The functor on the Set method
  86     AtomicBlackBoxSetFunctor* mSetFunctor;
  87   };
  88
  89
  90 }
  91 // namespace bbtk
  92 #endif