]> Creatis software - bbtk.git/blob - kernel/src/bbtkComplexBlackBoxOutputDescriptor.h
no message
[bbtk.git] / kernel / src / bbtkComplexBlackBoxOutputDescriptor.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbtkComplexBlackBoxOutputDescriptor.h,v $
4   Language:  C++
5   Date:      $Date: 2008/10/17 08:18:12 $
6   Version:   $Revision: 1.4 $
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  *  \file 
33  *  \brief Class bbtk::ComplexBlackBoxOutputDescriptor : structure containing the description of a ComplexBlackBox output (name, description, type, mapping)
34  */
35 /**
36  * \class bbtk::ComplexBlackBoxOutputDescriptor
37  * \brief Structure containing the description of a ComplexBlackBox output (name, description, type, mapping)
38  */
39
40 #ifndef __bbtkComplexBlackBoxOutputDescriptor_h__
41 #define __bbtkComplexBlackBoxOutputDescriptor_h__
42
43 #include "bbtkBlackBoxOutputDescriptor.h"
44 #include "bbtkMessageManager.h"
45 //#include "bbtkSystem.h"
46
47 namespace bbtk
48 {
49
50
51   class BBTK_EXPORT ComplexBlackBoxOutputDescriptor : 
52     public bbtk::BlackBoxOutputDescriptor
53   {
54   public:
55       
56     ComplexBlackBoxOutputDescriptor( TypeInfo creator_type_info,
57                                      const std::string& name,
58                                      const std::string& description,
59                                      const std::string& nature,
60                                      const std::string& target,
61                                      const std::string& output,
62                                      TypeInfo type);
63     
64     ~ComplexBlackBoxOutputDescriptor();
65     
66     /// Returns the type of the output
67     TypeInfo GetTypeInfo() const { return mType; }
68     /// Returns the name of the type of the output    
69     std::string GetTypeName() const { return TypeName(mType); }
70     /// Returns the name of the type of the output    
71     std::string GetHumanTypeName() const { return HumanTypeName(mType); }
72     /// 
73     bool IsPointerType() const { return false; }
74     
75
76     /// Returns the target black box 
77     const std::string& GetTarget() const { return mTarget; }
78     /// Returns the output 
79     const std::string& GetOutput() const { return mOutput; }
80         
81   private:
82     /// Default ctor is private 
83     ComplexBlackBoxOutputDescriptor() : 
84       BlackBoxOutputDescriptor(typeid(void),"","",""), 
85       mType(typeid(void))  {}
86     std::string mTarget;
87     std::string mOutput;
88     TypeInfo mType;
89   };
90
91 }
92 // namespace bbtk
93 #endif