-/*=========================================================================
-
+/*=========================================================================
Program: bbtk
Module: $RCSfile: bbtkBlackBoxDescriptor.h,v $
Language: C++
- Date: $Date: 2008/02/05 11:07:42 $
- Version: $Revision: 1.3 $
-
- Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
- l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-
- This software is distributed WITHOUT ANY WARRANTY; without even
- the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
- PURPOSE. See the above copyright notices for more information.
-
+ Date: $Date: 2008/10/17 08:18:12 $
+ Version: $Revision: 1.11 $
=========================================================================*/
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+* This software is governed by the CeCILL-B license under French law and
+* abiding by the rules of distribution of free software. You can use,
+* modify and/ or redistribute the software under the terms of the CeCILL-B
+* license as circulated by CEA, CNRS and INRIA at the following URL
+* http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+* or in the file LICENSE.txt.
+*
+* As a counterpart to the access to the source code and rights to copy,
+* modify and redistribute granted by the license, users are provided only
+* with a limited warranty and the software's author, the holder of the
+* economic rights, and the successive licensors have only limited
+* liability.
+*
+* The fact that you are presently reading this means that you have had
+* knowledge of the CeCILL-B license and that you accept its terms.
+* ------------------------------------------------------------------------ */
+
+
/**
* \file
* \brief Class bbtk::BlackBoxDescriptor : (abstract) describes of a BlackBox (name, description, author) and is able to create an instance of it.
#ifndef __bbtkBlackBoxDescriptor_h__
#define __bbtkBlackBoxDescriptor_h__
+#include "bbtkObject.h"
#include "bbtkBlackBoxInputDescriptor.h"
#include "bbtkBlackBoxOutputDescriptor.h"
#include <map>
class BlackBox;
class Package;
+ BBTK_FORWARD_DECLARE_POINTER(BlackBox);
+ BBTK_FORWARD_DECLARE_POINTER(Package);
//==========================================================================
- class BBTK_EXPORT BlackBoxDescriptor
+ class BBTK_EXPORT BlackBoxDescriptor : public Object
{
+ BBTK_ABSTRACT_OBJECT_INTERFACE(BlackBoxDescriptor);
public:
/// The type of descriptor of inputs
typedef BlackBoxInputDescriptor InputDescriptor;
/// The kinds of black box
typedef enum
{
- STANDARD,
- ADAPTOR,
- DEFAULT_ADAPTOR
+ STANDARD=0,
+ ADAPTOR=1,
+ DEFAULT_ADAPTOR=2,
+ GUI=3,
+ DEFAULT_GUI=4
}
Kind;
- /// Default ctor
- BlackBoxDescriptor();
- /// Default dtor
- virtual ~BlackBoxDescriptor();
- /// Creates an instance with name boxname of the BlackBox
+ /// Releases a descriptor
+ // static void Release(BlackBoxDescriptor::WeakPointer);
+
+ /// Creates an instance with name boxname of the BlackBox
/// of which this is the descriptor
- virtual BlackBox* CreateInstance(const std::string& boxname) = 0;
+ virtual BlackBoxPointer NewBlackBox(const std::string& boxname) = 0;
/// Returns the name of the **TYPE** of the black box
const std::string& GetTypeName() const { return mTypeName; }
+ /// Returns the full name of the **TYPE** of the black box (+package name)
+ std::string GetFullTypeName() const;
+
/// Returns the description of the BlackBox
const std::string& GetDescription() const { return mDescription; }
/// Returns the author(s) of the BlackBox
const std::string& GetAuthor() const { return mAuthor; }
- /// Returns the keyword(s) of the BlackBox
- const std::string& GetKeyword() const { return mKeyword; }
+ /// Returns the category(s) of the BlackBox
+ const std::string& GetCategory() const { return mCategory; }
- /// Returns the Package to which the box belongs
- Package* GetPackage() { return mPackage; }
-
- /// Returns the Package to which the box belongs
- const Package* GetPackage() const { return mPackage; }
+ /// Returns the Package to which the box belongs (const pointer)
+ PackagePointer GetPackage() const { return mPackage; }
/// Returns the kind of box
Kind GetKind() const { return mKind; }
{ return mOutput; }
/// Returns a const pointer on the descriptor of the input of name <name>
- const InputDescriptor* GetInputDescriptor(const std::string & name) const;
+ const InputDescriptor* GetInputDescriptor(const std::string &name) const;
/// Returns a const pointer on the descriptor of the output of name <name>
- const OutputDescriptor* GetOutputDescriptor(const std::string & name) const;
+ const OutputDescriptor* GetOutputDescriptor(const std::string &name) const;
/// Sets the name of the **TYPE** of BlackBox
void SetTypeName( const std::string& name ) { mTypeName=name; }
/// Adds the string to the BlackBox author list
void AddToAuthor( const std::string&, bool clear = false );
- /// Adds the string to the BlackBox keyword list
- void AddToKeyword( const std::string&, bool clear = false );
+ /// Adds the string to the BlackBox category list
+ void AddToCategory( const std::string&, bool clear = false );
/// Sets the Package to which the box belongs
- void SetPackage(Package *package) { mPackage = package; }
+ void SetPackage(PackagePointer package) { mPackage = package; }
/// Sets the kind of box
void SetKind(Kind kind) { mKind = kind; }
int detail, int level,
const std::string& output_dir = "",
bool relative_link = false );
+ ///
+ virtual void Check(bool recursive=true) const;
protected:
/// Adds an input descriptor
- void AddInputDescriptor( BlackBoxInputDescriptor* d )
+ void AddInputDescriptor( BlackBoxInputDescriptor *d )
{ mInput[d->GetName()] = d; }
/// Adds an output descriptor
- void AddOutputDescriptor( BlackBoxOutputDescriptor* d )
+ void AddOutputDescriptor( BlackBoxOutputDescriptor *d )
{ mOutput[d->GetName()] = d; }
// private:
std::string mDescription;
/// The author of the black box
std::string mAuthor;
- /// The keyword of the black box
- std::string mKeyword;
- /// The kind of box
+ /// The category of the black box
+ std::string mCategory;
+ /// The kind of box (standard / adaptor)
Kind mKind;
/// The Package to which the box belongs
- Package *mPackage;
+ PackagePointer mPackage;
/// The inputs
InputDescriptorMapType mInput;
/// The outputs
OutputDescriptorMapType mOutput;
-
+
};
// class BlackBoxDescriptor
//==========================================================================
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff