/*========================================================================= Program: bbtk Module: $RCSfile: bbtkTranscriptor.h,v $ $ Language: C++ Date: $Date: 2008/04/18 12:59:16 $ Version: $Revision: 1.10 $ 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. =========================================================================*/ /** * \file * \brief class Transcriptor: level 0 of script C++ translation (header) */ /** * \class bbtk::Transcriptor * \brief class Transcriptor: level 0 of script C++ translation */ #ifndef __bbtkTranscriptor_h__ #define __bbtkTranscriptor_h__ #include "bbtkVirtualExec.h" #include "bbtkSystem.h" #include namespace bbtk { class /*BBTK_EXPORT*/ Transcriptor : public VirtualExec { BBTK_OBJECT_INTERFACE(Transcriptor); typedef VirtualExec Superclass; public: static Pointer New(const std::string& filename); /// Sets the inputs of the workspace : void SetInputs(const std::map& m) { mInputs = m; } /// Puts the executer in "no exec" mode, /// which creates but does not execute pipelines //void SetNoExecMode(bool b) { mNoExecMode = b; } void SetNoExecMode(bool b) { if (b) m_Fp << " e->SetNoExecMode(true);" << std::endl; else m_Fp << " e->SetNoExecMode(false);" << std::endl; } bool GetNoExecMode() const { return mNoExecMode; } /// Sets the mode of dialog of the executer for Root inputs void SetDialogMode(DialogModeType t) { mDialogMode = t; } /// Loads a package void LoadPackage(const std::string &name ); /// Unloads a package void UnLoadPackage(const std::string &name ); /// Starts a package block void BeginPackage (const std::string &name ); /// Ends a package block void EndPackage (); /// Starts the definition of a new ComplexBlackBox in package pack /// scriptfilename is the file from which the def is read void Define (const std::string &name, const std::string& pack, const std::string &scriptfilename); /// Sets the file name to use for the current definition /// (Used to set it after the Define command) void SetCurrentFileName (const std::string &name ); /// End the definition of a ComplexBlackBox void EndDefine (); /// Sets the kind of the currently defined ComplexBlackBox void Kind(const std::string& kind); /// Creates a new black box in current complex box void Create ( const std::string& boxType, const std::string& boxName); /// Destroys a black box void Destroy (const std::string &boxName); /// Connects the output boxOutput to the input boxInput void Connect (const std::string &boxfrom, const std::string &output, const std::string &boxto, const std::string &input); /// Updates the box void Execute(const std::string &box); /// Defines an input of the current complex box void DefineInput (const std::string &name, const std::string &box, const std::string &input, const std::string &help); /// Defines an output of the current complex box void DefineOutput (const std::string &name, const std::string &box, const std::string &output, const std::string &help); /// sets the input of the box with the value void Set (const std::string &box, const std::string &input, const std::string &value); /// gets the output of the box std::string Get (const std::string &box, const std::string &output); /// changes the workspace name void SetWorkspaceName( const std::string& n ); ///Adds the authorName to the Box author list void Author(const std::string &authorName); ///Adds the Categories to the Box category list void Category(const std::string &category); /// The description string which explains what does the ComplexBox void Description(const std::string & d); /// prints the list off the boxes of the current box void PrintBoxes(); /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path 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); /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true); /// Description of the actual pipeline void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); void Reset(); /// Sets the level of message for kind void SetMessageLevel(const std::string &kind, int level); /// Prints help on the messages void HelpMessages(); /// Prints the string ... MORE : TO EXPLAIN void Print(const std::string & message); // static const std::string& GetObjectDescription() // { static std::string s("Executer"); return s; } protected: private: /// Constructor Transcriptor(const std::string& filename); /// The input values of the Root ComplexBlackBox std::map mInputs; /// no exec mode flag bool mNoExecMode; /// Dialog mode DialogModeType mDialogMode; /// File Pointer, to hold generated C++ code. // std::ofstream *m_Fp; std::ofstream m_Fp; }; } #endif