bbtkVirtualExec.h

Go to the documentation of this file.

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

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

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

#include "bbtkSystem.h"
#include "bbtkComplexBlackBoxDescriptor.h"
#include "bbtkFactory.h"

namespace bbtk
{

  class Interpreter;
  BBTK_FORWARD_DECLARE_POINTER(Interpreter);

  class BBTK_EXPORT VirtualExec : public Object
  {
    BBTK_ABSTRACT_OBJECT_INTERFACE(VirtualExec);
  public:
    typedef enum
    {
       NoDialog,
       TextDialog,
       GraphicalDialog
    }
    DialogModeType;


    void SetInterpreter(InterpreterPointer i) { mInterpreter = i; }
    InterpreterPointer GetInterpreter(); // { return mInterpreter.lock(); }
    //    const Interpreter::Pointer GetInterpreter() const { return mInterpreter; }

    virtual Factory::Pointer GetFactory() { return Factory::Pointer(); }
    // virtual const Factory* GetFactory() const { return 0; }
    
    virtual void SetInputs(const std::map<std::string,std::string>& m) = 0;

    virtual void SetNoExecMode(bool b) = 0;

    virtual bool GetNoExecMode() const = 0;

    virtual void SetDialogMode(DialogModeType t) = 0;

    virtual void SetNoErrorMode(bool b) = 0;
    virtual bool GetNoErrorMode() const = 0;
    //=================================================================
    virtual void LoadPackage(const std::string &name ) = 0;

    virtual void UnLoadPackage(const std::string &name ) = 0;

    virtual void BeginPackage (const std::string &name ) = 0;

    virtual void EndPackage () = 0;

    virtual void Define (const std::string &name,
                 const std::string& pack,
                 const std::string &scriptfilename) = 0;
 
    virtual void SetCurrentFileName (const std::string &name ) = 0;

    virtual void EndDefine () = 0;

    virtual void Kind(const std::string& kind) = 0;

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

    virtual void Destroy (const std::string &boxName) = 0;

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

    virtual void Execute (const std::string &box) = 0;

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

    virtual void DefineOutput (const std::string &name,
                       const std::string &box,
                       const std::string &output,
                       const std::string &help) = 0;     
  
    virtual void Set (const std::string &box, 
              const std::string &input, 
              const std::string &value) = 0;

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

    virtual void SetWorkspaceName( const std::string& n ) = 0;

    virtual void Author(const std::string &authorName) = 0;

    virtual void Category(const std::string &categories) = 0;

    virtual void Description(const std::string &d) = 0;

    virtual void PrintBoxes() = 0;

    virtual 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) = 0;

    virtual std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true) = 0;

    virtual void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr) = 0;
    
    virtual void Reset() = 0;
    
    virtual void SetMessageLevel(const std::string &kind, int level) = 0;
    
    virtual void HelpMessages() = 0;

    virtual void Print(const std::string & message) = 0;

    virtual ComplexBlackBoxDescriptor::Pointer GetWorkspace() 
    { return  ComplexBlackBoxDescriptor::Pointer(); }
  
  //  static const std::string& GetObjectDescription() = 0;
  //  { static std::string s("VirtualExec"); return s; }
  protected:

  private:

    InterpreterWeakPointer mInterpreter;

  };
}
#endif