bbtkExecuter.h

Go to the documentation of this file.

/*=========================================================================                                                                               
  Program:   bbtk
  Module:    $RCSfile: bbtkExecuter.h,v $
  Language:  C++
  Date:      $Date: 2008/10/17 08:18:13 $
  Version:   $Revision: 1.16 $
=========================================================================*/

/* ---------------------------------------------------------------------

* 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 __bbtkExecuter_h__
#define __bbtkExecuter_h__

#include "bbtkVirtualExec.h"

#include "bbtkSystem.h"
#include "bbtkComplexBlackBox.h"
#include "bbtkFactory.h"
#include <string>
#include <deque>

namespace bbtk
{

  class Interpreter;


  class /*BBTK_EXPORT*/ Executer : public VirtualExec
  {
    BBTK_OBJECT_INTERFACE(Executer);
    typedef VirtualExec Superclass;
  public:
    static Pointer New();
    

    Factory::Pointer GetFactory() { return mFactory; }
    //    const Factory::Pointer GetFactory() const { return mFactory; }


    void SetInputs(const std::map<std::string,std::string>& m) { mInputs = m; }

    void SetNoExecMode(bool b) { mNoExecMode = b; }

    bool GetNoExecMode() const { return mNoExecMode; }

    void SetDialogMode(DialogModeType t) { mDialogMode = t; }

    void SetNoErrorMode(bool b) { mNoErrorMode = b; }

    bool GetNoErrorMode() const { return mNoErrorMode; }


    //=================================================================
    void LoadPackage(const std::string &name );

    void UnLoadPackage(const std::string &name );

    void BeginPackage (const std::string &name );

    void EndPackage ();

    void Define (const std::string &name,
                 const std::string& pack,
                 const std::string &scriptfilename);

    void SetCurrentFileName (const std::string &name );

    void EndDefine ();

    void Kind(const std::string& kind);

    void Create ( const std::string& boxType, const std::string& boxName);

    void Destroy (const std::string &boxName);

    void Connect (const std::string &boxfrom,
                  const std::string &output,
                  const std::string &boxto,
                  const std::string &input);

    void Execute (const std::string &box);

    void DefineInput (const std::string &name,
                      const std::string &box,
                      const std::string &input,
                      const std::string &help);

    void DefineOutput (const std::string &name,
                       const std::string &box,
                       const std::string &output,
                       const std::string &help);     

    void Set (const std::string &box, 
              const std::string &input, 
              const std::string &value);

    std::string Get (const std::string &box, 
                     const std::string &output);

    void SetWorkspaceName( const std::string& n );

    void Author(const std::string &authorName);

    void Category(const std::string &category);

    void Description(const std::string & d);

    void PrintBoxes();

    std::string ShowGraph(const std::string &nameblackbox, 
                          const std::string &detailStr, 
                          const std::string &levelStr,
                          const std::string &output_file,
                          const std::string &custom_header,
                          const std::string &custom_title,
                          bool system_display = true);

    std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true);
    
    void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr);
    
    void Reset();

    void SetMessageLevel(const std::string &kind,
                         int level);

    void HelpMessages();
    

    void Print(const std::string & message);

  //  static const std::string& GetObjectDescription();
  //  { static std::string s("Executer"); return s; }


    ComplexBlackBoxDescriptor::Pointer GetWorkspace() 
    { return mRootCBB.lock(); }
    Package::Pointer GetUserPackage() 
    { return mRootPackage.lock(); }

    ComplexBlackBoxDescriptor::Pointer GetCurrentDescriptor() 
    { return mOpenDefinition.back().box; }
    

  protected:

  private:

    
    //    bool InDefinitionBlock() { return (mOpenDefinition.size()>1); }

    //==================================================================
    // ATTRIBUTES
     
    Factory::Pointer mFactory;
    
 
    Package::WeakPointer mRootPackage;
    
    ComplexBlackBoxDescriptor::WeakPointer mRootCBB;

    struct CBBDefinition
    {
      ComplexBlackBoxDescriptor::Pointer box;
      std::string package;
      CBBDefinition(ComplexBlackBoxDescriptor::Pointer d, 
                    const std::string& p )
        : box(d), package(p) {}
    };

    std::deque<CBBDefinition> mOpenDefinition;

    std::deque<Package::WeakPointer> mOpenPackage;

    std::map<std::string,std::string> mInputs;
    
    bool mNoExecMode;


    DialogModeType mDialogMode;

    bool mNoErrorMode;

  };
}
#endif