]> Creatis software - bbtk.git/blob - kernel/src/bbtkComplexBlackBoxInputDescriptor.h
Allow user to always forget .bbs
[bbtk.git] / kernel / src / bbtkComplexBlackBoxInputDescriptor.h
1 /*=========================================================================
2                                                                                 
3   Program:   bbtk
4   Module:    $RCSfile: bbtkComplexBlackBoxInputDescriptor.h,v $
5   Language:  C++
6   Date:      $Date: 2008/01/22 15:02:00 $
7   Version:   $Revision: 1.1 $
8                                                                                 
9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10   l'Image). All rights reserved. See Doc/License.txt or
11   http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
12                                                                                 
13      This software is distributed WITHOUT ANY WARRANTY; without even
14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15      PURPOSE.  See the above copyright notices for more information.
16                                                                                 
17 =========================================================================*/
18
19 /**
20  *  \file 
21  *  \brief Class bbtk::ComplexBlackBoxInputDescriptor : structure containing the description of a ComplexBlackBox input (name, description, type, mapping)
22  */
23 /**
24  * \class bbtk::ComplexBlackBoxInputDescriptor
25  * \brief Structure containing the description of a ComplexBlackBox input (name, description, type, mapping)
26  */
27
28 #ifndef __bbtkComplexBlackBoxInputDescriptor_h__
29 #define __bbtkComplexBlackBoxInputDescriptor_h__
30
31 #include "bbtkBlackBoxInputDescriptor.h"
32 #include "bbtkMessageManager.h"
33
34 namespace bbtk
35 {
36
37
38   class BBTK_EXPORT ComplexBlackBoxInputDescriptor : public bbtk::BlackBoxInputDescriptor
39   {
40   public:
41       
42     ComplexBlackBoxInputDescriptor( const std::string& name,
43                                     const std::string& description,
44                                     const std::string& target,
45                                     const std::string& input,
46                                     TypeInfo type);
47     
48     ~ComplexBlackBoxInputDescriptor();
49     
50     /// Returns the type of the input
51     TypeInfo GetTypeInfo() const { return mType; }
52     /// Returns the name of the type of the input
53     std::string GetTypeName() const { return TypeName(mType); }
54     /// Returns the name of the type of the input
55     std::string GetHumanTypeName() const { return HumanTypeName(mType); }
56     /// Returns the target black box 
57     const std::string& GetTarget() const { return mTarget; }
58     /// Returns the input 
59     const std::string& GetInput() const { return mInput; }
60     /// 
61     bool IsPointerType() const { return false; }
62     
63     
64   private:
65     /// Default ctor is private 
66     ComplexBlackBoxInputDescriptor() : BlackBoxInputDescriptor("",""),
67                                        mType(typeid(void)) {}
68     std::string mTarget;
69     std::string mInput;
70     TypeInfo mType;
71   };
72
73   
74 }
75 // namespace bbtk
76 #endif