src/GraphExecutor/DataFlowExecutor_DataFlow.hxx

   1 //  SUPERV GraphExecutor : contains classes that permit execution of graphs and particularly the execution automaton
   2 //
   3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : DataFlowExecutor_DataFlow.hxx
  25 //  Module : SUPERV
  26
  27 #ifndef _DATAFLOWEXECUTOR_DATAFLOW_HXX
  28 #define _DATAFLOWEXECUTOR_DATAFLOW_HXX
  29
  30 #include "DataFlowExecutor_OutNode.hxx"
  31
  32 namespace GraphExecutor {
  33
  34   class DataFlow : public GraphExecutor::OutNode {
  35
  36     private :
  37
  38       SALOME_NamingService* _theNamingService ;
  39
  40     public:
  41
  42       DataFlow();
  43       DataFlow( CORBA::ORB_ptr ORB, SALOME_NamingService* ptrNamingService ,
  44                 const char * DataFlowName ,
  45                 const char * DebugFileName ,
  46                 const SUPERV::KindOfNode aKindOfNode );
  47       DataFlow( CORBA::ORB_ptr ORB, SALOME_NamingService* ptrNamingService ,
  48                 const SALOME_ModuleCatalog::Service& DataFlowService ,
  49                 const char *DataFlowComponentName ,
  50                 const char *DataFlowInterfaceName ,
  51                 const char *DataFlowName ,
  52                 const SUPERV::KindOfNode DataFlowkind = SUPERV::ComputingNode ,
  53                 const SUPERV::SDate DataFlowFirstCreation = SUPERV::SDate() ,
  54                 const SUPERV::SDate DataFlowLastModification = SUPERV::SDate() ,
  55                 const char * DataFlowEditorRelease = NULLSTRING ,
  56                 const char * DataFlowAuthor = NULLSTRING ,
  57                 const char * DataFlowComputer = NULLSTRING ,
  58                 const char * DataFlowComment = NULLSTRING ,
  59                 const char * DebugFileName = NULLSTRING ) ;
  60       virtual ~DataFlow();
  61
  62       bool LoadDataFlow( const GraphBase::SGraph &aDataFlow ) ;
  63       bool LoadXml( const char* myFileName ) ;
  64
  65       const SALOME_ModuleCatalog::Service * NodeService( const char * NodeName ) ;
  66
  67       bool ChangeInputData( const char* ToNodeName ,
  68                             const char* ToParameterName ,
  69                             const CORBA::Any aValue = CORBA::Any() ) ;
  70       bool AddInputSharedData( const char* ToNodeName1 ,
  71                                const char* ToParameterName1 ,
  72                                const char* ToNodeName2 ,
  73                                const char* ToParameterName2 ) ;
  74
  75       bool IsValid() ;
  76       bool IsExecutable() ;
  77
  78       bool Run( const bool AndSuspend ) ;
  79       bool Run( const char * aNodeName ,
  80                 const char * AtNodeName , const bool AndSuspend ) ;
  81
  82       long LastLevelDone() ;
  83
  84       SUPERV::GraphState State() ;
  85       SUPERV::GraphState State(const char * aNodeName ) ;
  86       SUPERV::GraphState State( const char * aNodeName ,
  87                                  const char * anOutServiceParameterName ) ;
  88
  89       long Thread() ;
  90       long Thread(const char * aNodeName ) ;
  91
  92       SUPERV::AutomatonState AutomatonState() ;
  93       SUPERV::AutomatonState AutomatonState(const char * aNodeName ) ;
  94
  95       SUPERV::ControlState ControlState() ;
  96       SUPERV::ControlState ControlState(const char * aNodeName ) ;
  97       void ControlClear() ;
  98       void ControlClear(const char * aNodeName ) ;
  99
 100       bool Event( char ** aNodeName ,
 101                   SUPERV::GraphEvent & anEvent ,
 102                   SUPERV::GraphState & aState ,
 103                   bool WithWait = true ) ;
 104       bool EventW( char ** aNodeName ,
 105                    SUPERV::GraphEvent & anEvent ,
 106                    SUPERV::GraphState & aState ) ;
 107       long EventQSize() ;
 108
 109       bool IsWaiting() ;
 110       bool IsReady() ;
 111       bool IsRunning() ;
 112       bool IsDone() ;
 113       bool IsSuspended() ;
 114       bool IsWaiting(const char * aNodeName ) ;
 115       bool IsReady(const char * aNodeName ) ;
 116       bool IsRunning(const char * aNodeName ) ;
 117       bool IsDone(const char * aNodeName ) ;
 118       bool IsSuspended(const char * aNodeName ) ;
 119       bool IsDone(const char * aNodeName ,
 120                   const char * anOutServiceParameterName ) ;
 121
 122       const CORBA::Any *GetInData( const char * ToNodeName ,
 123                                    const char * ToParameterName ) ;
 124       const CORBA::Any *GetOutData( const char * FromNodeName ,
 125                                     const char * FromParameterName ) ;
 126
 127       long Threads() ;
 128
 129       bool ReadyWait() ;
 130       bool RunningWait() ;
 131       bool DoneWait() ;
 132       bool SuspendedWait() ;
 133       bool ReadyWait(const char * aNodeName ) ;
 134       bool RunningWait(const char * aNodeName ) ;
 135       bool DoneWait(const char * aNodeName ) ;
 136       bool SuspendedWait(const char * aNodeName ) ;
 137
 138       bool Ping(const char * aNodeName ) ;
 139       bool ContainerKill() ;
 140       bool ContainerKill(const char * aNodeName ) ;
 141
 142       bool Kill() ;
 143       bool Kill(const char * aNodeName ) ;
 144       bool KillDone(const char * aNodeName ) ;
 145       bool Suspend() ;
 146       bool Suspend(const char * aNodeName ) ;
 147       bool SuspendDone() ;
 148       bool SuspendDone(const char * aNodeName ) ;
 149       bool Resume() ;
 150       bool Resume(const char * aNodeName ) ;
 151       bool Stop() ;
 152       bool Stop(const char * aNodeName ) ;
 153
 154   };
 155
 156 };
 157
 158 #include "DataFlowExecutor_DataFlow.lxx"
 159
 160 ostream & operator << (ostream &,const GraphExecutor::DataFlow & G);
 161 ostream & operator << (ostream &,const SUPERV::SDate &);
 162
 163 #endif
 164
 165
 166