]> Creatis software - bbtk.git/blob - kernel/src/bbtkAtomicBlackBoxInputDescriptor.h
no message
[bbtk.git] / kernel / src / bbtkAtomicBlackBoxInputDescriptor.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbtkAtomicBlackBoxInputDescriptor.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::AtomicBlackBoxInputDescriptor : structure containing the description of a AtomicBlackBox input (name, description, type, functor)
35  */
36 /**
37  * \class bbtk::AtomicBlackBoxInputDescriptor
38  * \brief Structure containing the description of a AtomicBlackBox input (name, description, type, functor)
39  */
40  
41 #ifndef __bbtkAtomicBlackBoxInputDescriptor_h__
42 #define __bbtkAtomicBlackBoxInputDescriptor_h__
43
44 #include "bbtkBlackBoxInputDescriptor.h"
45 #include "bbtkAtomicBlackBoxGetSetFunctor.h"
46 #include <typeinfo>
47
48 namespace bbtk
49 {
50
51
52   class BBTK_EXPORT AtomicBlackBoxInputDescriptor : 
53     public bbtk::BlackBoxInputDescriptor
54   {
55   public:
56     //typedef enum {
57     //  MANDATORY,
58     //  OPTIONAL
59     //} InputType;
60
61       
62     AtomicBlackBoxInputDescriptor( TypeInfo creator_type_info,
63                                    const std::string& name,
64                                    const std::string& description,
65                                    const std::string& nature,
66                                    AtomicBlackBoxGetFunctor* getfunctor,
67                                    AtomicBlackBoxSetFunctor* setfunctor,
68                                    bool copy_construct = true);
69     
70     ~AtomicBlackBoxInputDescriptor();  
71     /// Returns the type of the input
72     TypeInfo GetTypeInfo() const { return mGetFunctor->GetTypeInfo(); }
73     /// Returns the name of the type of the input
74     std::string GetTypeName() const { return mGetFunctor->GetTypeName(); }
75     /// Returns the name of the type of the input
76     std::string GetHumanTypeName() const { return mGetFunctor->GetHumanTypeName(); }    
77     /// Returns true iff the type is a pointer to class 
78     virtual bool IsPointerType() const { return mGetFunctor->IsPointerType(); }    
79     /// Returns the functor on the Get method
80     AtomicBlackBoxGetFunctor* GetGetFunctor() { return mGetFunctor; }
81     /// Returns the functor on the Set method
82     AtomicBlackBoxSetFunctor* GetSetFunctor() { return mSetFunctor; }
83     
84     
85   private:
86     /// Default ctor is private 
87     AtomicBlackBoxInputDescriptor() : 
88       BlackBoxInputDescriptor(typeid(void),"","","") {}
89     /// The functor on the Get method
90     AtomicBlackBoxGetFunctor* mGetFunctor;
91     /// The functor on the Set method
92     AtomicBlackBoxSetFunctor* mSetFunctor;
93   };
94   
95 }
96 // namespace bbtk
97 #endif