bbtkBlackBoxDescriptor.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkBlackBoxDescriptor.h,v $
  Language:  C++
  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.
* ------------------------------------------------------------------------ */                                                                         


#ifndef __bbtkBlackBoxDescriptor_h__
#define __bbtkBlackBoxDescriptor_h__

#include "bbtkObject.h"
#include "bbtkBlackBoxInputDescriptor.h"
#include "bbtkBlackBoxOutputDescriptor.h"
#include <map>
#include <fstream>

namespace bbtk
{

  class BlackBox;
  class Package;
  BBTK_FORWARD_DECLARE_POINTER(BlackBox);
  BBTK_FORWARD_DECLARE_POINTER(Package);

  //==========================================================================
  class BBTK_EXPORT BlackBoxDescriptor : public Object
  {
    BBTK_ABSTRACT_OBJECT_INTERFACE(BlackBoxDescriptor);
  public:
    typedef BlackBoxInputDescriptor InputDescriptor;
    typedef BlackBoxOutputDescriptor OutputDescriptor;
    typedef std::map<std::string, InputDescriptor*> InputDescriptorMapType;
    typedef std::map<std::string, OutputDescriptor*> OutputDescriptorMapType;
    typedef enum
    {
      STANDARD=0,
      ADAPTOR=1,
      DEFAULT_ADAPTOR=2,
      GUI=3,
      DEFAULT_GUI=4
    }
    Kind;

    //    static void Release(BlackBoxDescriptor::WeakPointer);

    virtual BlackBoxPointer NewBlackBox(const std::string& boxname) = 0;

    const std::string& GetTypeName() const { return mTypeName; }
    
    std::string GetFullTypeName() const;
    
    const std::string& GetDescription() const { return mDescription; }
    
    const std::string& GetAuthor() const { return mAuthor; }
    
    const std::string& GetCategory() const { return mCategory; }
    
    PackagePointer GetPackage() const { return mPackage; }
    
    Kind GetKind() const { return mKind; }

    virtual void GetHelp(bool full=true) const;

    const InputDescriptorMapType& GetInputDescriptorMap() const 
      { return mInput; }
      
    const OutputDescriptorMapType& GetOutputDescriptorMap() const 
      { return mOutput; }
      
    const InputDescriptor* GetInputDescriptor(const std::string &name) const;

    const OutputDescriptor* GetOutputDescriptor(const std::string &name) const;

    void SetTypeName( const std::string& name ) { mTypeName=name; }

    void AddToDescription( const std::string&, bool clear = false );
    
    void AddToAuthor( const std::string&, bool clear = false );
    
    void AddToCategory( const std::string&, bool clear = false );
    
    void SetPackage(PackagePointer package) { mPackage = package; }
    
    void SetKind(Kind kind) { mKind = kind; }

    /* 
   virtual void InsertHTMLGraph( std::ofstream& s, int detail, int level, 
                                  const std::string& output_dir = "" ) { }
    */
    virtual void InsertHtmlHelp ( std::ofstream& s, 
                                  int detail, int level,
                                  const std::string& output_dir = "",
                                  bool relative_link = false );
    virtual void Check(bool recursive=true) const;

  protected:
    void AddInputDescriptor( BlackBoxInputDescriptor *d ) 
    { mInput[d->GetName()] = d; }
    void AddOutputDescriptor( BlackBoxOutputDescriptor *d ) 
    { mOutput[d->GetName()] = d; }

    //  private:
    std::string mTypeName;
    std::string mDescription;
    std::string mAuthor;
    std::string mCategory;    
    Kind mKind;
    PackagePointer mPackage;
    InputDescriptorMapType mInput;
    OutputDescriptorMapType mOutput;

  };
  // class BlackBoxDescriptor
  //==========================================================================


 
}
// namespace bbtk
#endif