src/engine/InlineNode.hxx

   1 // Copyright (C) 2006-2014  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef __INLINENODE_HXX__
  21 #define __INLINENODE_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24 #include "ElementaryNode.hxx"
  25 #include <string>
  26
  27 namespace YACS
  28 {
  29   namespace ENGINE
  30   {
  31     class Container;
  32
  33 /*! \brief Class for calculation node (script) inlined (and executed) in the schema
  34  *
  35  * \ingroup Nodes
  36  *
  37  * This node is like a script. It has no state if it is executed several times.
  38  * Each execution the string _script is executed within a clean context.
  39  *
  40  * \see ServiceNode
  41  * \see ElementaryNode
  42  */
  43     class YACSLIBENGINE_EXPORT InlineNode : public ElementaryNode
  44     {
  45     protected:
  46       InlineNode(const InlineNode& other, ComposedNode *father)
  47         :ElementaryNode(other,father),_script(other._script),_mode(other._mode),_container(0) { }
  48       InlineNode(const std::string& name):ElementaryNode(name),_mode("local"),_container(0) { }
  49     public:
  50       virtual void setScript(const std::string& script);
  51       virtual std::string getScript(){return _script;}
  52
  53 //! Return a new InlineNode node by making a copy of this node
  54 /*!
  55  * \param name: name of the new node
  56  * \return the new node built by cloning.
  57  */
  58       virtual InlineNode* cloneNode(const std::string& name)
  59       { throw Exception("Not implemented");};
  60       virtual void accept(Visitor *visitor);
  61       virtual ~InlineNode();
  62       virtual std::string typeName() {return "YACS__ENGINE__InlineNode";}
  63       virtual void setExecutionMode(const std::string& mode);
  64       virtual std::string getExecutionMode();
  65       virtual void setContainer(Container* container);
  66       virtual Container* getContainer();
  67       void performDuplicationOfPlacement(const Node& other);
  68       bool isDeployable() const;
  69     protected:
  70       std::string _script;
  71       std::string _mode;
  72       Container* _container;
  73     };
  74
  75 /*! \brief Class for calculation node (function) inlined (and executed) in the schema
  76  *
  77  * \ingroup Nodes
  78  *
  79  * This node is like a function. It can have a state. The first time the node
  80  * is executed, the string _script is executed in a clean context followed by the
  81  * execution of the function _fname. Next times, the function _fname is executed
  82  * within the preserved context.
  83  *
  84  * \see ServiceNode
  85  * \see ElementaryNode
  86  */
  87     class YACSLIBENGINE_EXPORT InlineFuncNode : public InlineNode
  88     {
  89     protected:
  90       InlineFuncNode(const InlineFuncNode& other, ComposedNode *father)
  91         :InlineNode(other,father),_fname(other._fname) { }
  92       InlineFuncNode(const std::string& name):InlineNode(name) { }
  93     public:
  94 //! Set the function name to use in node execution
  95 /*!
  96  * \param fname: name of the function contained in the script to execute
  97  */
  98       virtual void setFname(const std::string& fname);
  99       virtual std::string getFname() { return _fname; }
 100       void accept(Visitor *visitor);
 101       virtual ~InlineFuncNode();
 102       virtual std::string typeName() {return "YACS__ENGINE__InlineFuncNode";}
 103       virtual void checkBasicConsistency() const throw(Exception);
 104     protected:
 105       std::string _fname;
 106     };
 107   }
 108 }
 109
 110 #endif