idl/SUPERV.idl

   1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20 //
  21 //
  22 //  File   : SUPERV.idl
  23 //  Author : Jean Rahuel
  24 //  $Header:
  25
  26 /*! \file SUPERV.idl This file contains a set of interfaces of the %SUPERVISION module
  27 */
  28
  29 #ifndef __SUPERV_IDL__
  30 #define __SUPERV_IDL__
  31
  32 #include "SALOME_ModuleCatalog.idl"
  33 #include "SALOME_Component.idl"
  34 #include "SALOMEDS.idl"
  35 /*!
  36  The main package of interfaces of %SUPERVISION module
  37 */
  38 module SUPERV {
  39
  40 /*!
  41 This enumeration contains a set of elements defining the type of the port.
  42 \note  <BR>In general, ports represent <STRONG>input or output parameters</STRONG> of the functions,
  43 implemented in different kinds of nodes of the graph.
  44 */
  45   enum KindOfPort { UndefinedParameter ,
  46                     ServiceParameter ,
  47                     GateParameter ,
  48                     InLineParameter ,
  49                     LoopParameter ,
  50                     SwitchParameter ,
  51                     EndSwitchParameter ,
  52                     GOTOParameter ,
  53                     DataStreamParameter } ;
  54
  55 /*!
  56 This enumeration contains a set of dependencies of InPorts and OutPorts.
  57 */
  58 //  enum KindOfDependency { UndefinedDependency , TimeDependency , IterationDependency } ;
  59
  60 /*!
  61 This enumeration contains a set of schemas of InPorts.
  62 */
  63   enum KindOfSchema { SCHENULL , TI , TF , DELTA } ;
  64
  65 /*!
  66 This enumeration contains a set of interpolations of InPorts.
  67 */
  68   enum KindOfInterpolation { INTERNULL , L0 , L1 } ;
  69
  70 /*!
  71 This enumeration contains a set of extrapolations of InPorts.
  72 */
  73   enum KindOfExtrapolation { EXTRANULL , E0 , E1 } ;
  74
  75 /*!
  76 This enumeration contains a set of dependencies of Ports.
  77 */
  78   enum KindOfDataStreamTrace { WithoutTrace , SummaryTrace , DetailedTrace } ;
  79
  80 /*!
  81 This enumeration contains a set of elements defining the type of the node.
  82 */
  83   enum KindOfNode { FactoryNode ,
  84                     DataFlowGraph ,
  85                     ComputingNode ,
  86                     InLineNode ,
  87                     LoopNode ,
  88                     EndLoopNode ,
  89                     SwitchNode ,
  90                     EndSwitchNode ,
  91                     GOTONode ,
  92                     DataStreamGraph ,
  93                     MacroNode ,
  94                     UnknownNode };
  95
  96 /*!
  97 This struct contains fields defining the date.
  98 */
  99   struct SDate {
 100     short Second;
 101     short Minute;
 102     short Hour;
 103     short Day;
 104     short Month;
 105     short Year;
 106   };
 107 /*!
 108 This enumeration contains a set of elements defining the type of operation, which has been performed
 109 on this node(graph).
 110 */
 111
 112   enum GraphEvent { UndefinedEvent ,
 113                     NoEvent ,
 114                     NewThreadEvent ,
 115                     WaitingEvent ,
 116                     ReadyEvent ,
 117                     RunningEvent ,
 118                     DoneEvent ,
 119                     ErroredEvent ,
 120                     SuspendEvent ,
 121                     ResumeEvent ,
 122                     KillEvent ,
 123                     StopEvent } ;
 124
 125   // UndefinedState : Non existing Node, Port etc...
 126 /*!
 127 This enumeration contains a set of elements defining the current state of the node(graph).
 128 */
 129
 130   enum GraphState { UndefinedState ,
 131                     NoState ,
 132                     EditingState ,
 133                     SuspendState ,
 134                     WaitingState ,
 135                     ReadyState ,
 136                     SuspendReadyState ,
 137                     RunningState ,
 138                     DoneState ,
 139                     ErrorState ,
 140                     SuspendDoneState ,
 141                     SuspendErroredState ,
 142                     KillState ,
 143                     StopState ,
 144                     LoadingState,
 145                     NumberOfGraphStates } ;
 146
 147 /*! A sequence of string values.
 148 */
 149   typedef sequence<string> ListOfStrings ;
 150
 151   interface Value ;
 152
 153   interface Link ;
 154   interface StreamLink ;
 155
 156   typedef sequence<Link> ListOfLinks ;
 157   typedef sequence<StreamLink> ListOfStreamLinks ;
 158
 159   interface Port ;
 160   interface StreamPort ;
 161
 162   typedef sequence<Port> ListOfPorts ;
 163   typedef sequence<StreamPort> ListOfStreamPorts ;
 164
 165   interface CNode ;
 166   interface FNode ;
 167   interface INode ;
 168   interface GNode ;
 169   interface LNode ;
 170   interface ELNode ;
 171   interface SNode ;
 172   interface ESNode ;
 173   interface Graph ;
 174   interface StreamGraph ;
 175
 176   typedef sequence<CNode>  ListOfCNodes ;
 177   typedef sequence<FNode>  ListOfFNodes ;
 178   typedef sequence<INode>  ListOfINodes ;
 179   typedef sequence<GNode>  ListOfGNodes ;
 180   typedef sequence<LNode>  ListOfLNodes ;
 181   typedef sequence<ELNode> ListOfELNodes ;
 182   typedef sequence<SNode>  ListOfSNodes ;
 183   typedef sequence<ESNode> ListOfESNodes ;
 184   typedef sequence<Graph>  ListOfGraphs ;
 185
 186 /*!
 187 This struct contains fields defining different types of nodes.
 188 */
 189
 190   struct ListOfNodes {
 191     ListOfCNodes  CNodes ;
 192     ListOfFNodes  FNodes ;
 193     ListOfINodes  INodes ;
 194     ListOfGNodes  GNodes ;
 195     ListOfLNodes  LNodes ;
 196     ListOfELNodes ELNodes ;
 197     ListOfSNodes  SNodes ;
 198     ListOfESNodes ESNodes ;
 199     ListOfGraphs  Graphs ;
 200   } ;
 201
 202   // ToSuspendState : will be Suspended before running if waiting or
 203   //                  will be Suspended while running or
 204   //                  will be Suspended after run
 205   // ToSuspendStartState : will be Suspended at the beginning of execution
 206   // ToSuspendDoneState : will be Suspended after run
 207 /*!
 208 This enumeration contains a set of elements defining the %ControlState of the node.
 209 The %ControlState gives a possibility to determine the "control actions" which have been done by
 210 the user (Suspend, SuspendDone, Kill, etc...).
 211 */
 212   enum ControlState { VoidState ,
 213                       ToSuspendStartState ,
 214                       ToSuspendState ,
 215                       ToSuspendDoneState ,
 216                       ToKillState ,
 217                       ToKillDoneState ,
 218                       ToStopState ,
 219                       NumberOfControlStates } ;
 220
 221
 222
 223   ////////////////
 224 /*! \brief interface %SuperG
 225
 226 This interface contains a set of methods necessary for management of a %graph.
 227 */
 228   interface SuperG : Engines::Component, SALOMEDS::Driver {
 229   ////////////////
 230
 231 //DumpPython is defined in SALOME_Component.idl (SALOMEDS::Driver)
 232 //    SALOMEDS::TMPFile DumpPython( in SALOMEDS::Study theStudy ,
 233 //                                  in boolean isPublished ,
 234 //                                  out boolean isValisScript ) ;
 235
 236 /*!
 237   Constructs a graph with possibility to read/edit it
 238   \param aGraph  %aGraphName or %aGraphXmlFile
 239 */
 240     SUPERV::Graph Graph(in string aGraph ) ; // aGraphName or aGraphXmlFile
 241
 242 /*!
 243   Constructs a read Only graph ( for execution ).
 244  \note <BR>In this graph there is also a possibility to update nodes, coordinates of the links,
 245   of container names and input data.
 246   \param aGraph  %aGraphName or %aGraphXmlFile
 247 */
 248     SUPERV::Graph GraphE(in string aGraph ) ; // aGraphName or aGraphXmlFile
 249
 250 /*!
 251   Constructs a StreamGraph with possibility to read/edit it
 252   \param aGraph  %aGraphName or %aGraphXmlFile
 253 */
 254     SUPERV::StreamGraph StreamGraph(in string aGraph ) ; // aGraphName or aGraphXmlFile
 255
 256 /*!
 257   Constructs a read Only StreamGraph ( for execution ).
 258  \note <BR>In this graph there is also a possibility to update nodes, coordinates of the links,
 259   of container names and input data.
 260   \param aGraph  %aGraphName or %aGraphXmlFile
 261 */
 262     SUPERV::StreamGraph StreamGraphE(in string aGraph ) ; // aGraphName or aGraphXmlFile
 263
 264 /*!
 265 Creates a value of <b>string</b> type which will be used for <VAR>Input</VAR> method in the interface %Node.
 266 \param aString Input value of string type.
 267 */
 268     SUPERV::Value StringValue( in string aString ) ;
 269 /*!
 270 Creates a value of <b>any</b> type which will be used for <VAR>Input</VAR> method in the interface %Node.
 271 \param anAny Input value of any type.
 272 */
 273     SUPERV::Value AnyValue( in any anAny ) ;
 274 /*!
 275  Gets a graph with a definite %IOR
 276 \param ior String parameter defining %IOR of the graph.
 277 */
 278     SUPERV::Graph getGraph(in string ior); // get Graph from is IOR
 279
 280 /*!
 281  Gets a graph with a definite %IOR
 282 \param ior String parameter defining %IOR of the graph.
 283 */
 284     SUPERV::StreamGraph getStreamGraph(in string ior); // get Graph from is IOR
 285
 286   };
 287
 288 /*! \brief %CNode interface
 289
 290 This is a base class of the SUPERVISION module. It contains a set of methods allowing:
 291 <ul>
 292     <li>creating a <b>Computation</b> node and setting its parameters (Name, Author, Comments etc.)
 293     <li>checking the current state of the node in the data flow
 294     <li>node execution follow-up
 295     <li>management of the components, which can be initialized for execution of calculations in the data flow. (For that purpose %CNode class inherits the methods of the %Engines:Component class)
 296 </ul>
 297 */
 298
 299   //////////////
 300   interface CNode : Engines::Component {
 301   //////////////
 302
 303
 304 /*!
 305 Returns the name of the node(graph).
 306 */
 307     string Name() ;
 308 /*!
 309 Returns the service of this node .
 310 */
 311     SALOME_ModuleCatalog::Service Service() ;
 312 /*!
 313 Returns the type of the node.
 314 */
 315     SUPERV::KindOfNode Kind() ;
 316 /*!
 317 Returns the date of creation of the node(graph).
 318 */
 319     SUPERV::SDate CreationDate() ;
 320 /*!
 321 Returns the date of last update of the node(graph).
 322 */
 323     SUPERV::SDate LastUpdateDate() ;
 324 /*!
 325 Returns the name of the version of the node(graph).
 326 */
 327     string Version() ;
 328 /*!
 329 Returns the name of the author of the node(graph).
 330 */
 331     string Author() ;
 332 /*!
 333 Returns the string containing comments about this node(graph).
 334 */
 335     string Comment() ;
 336
 337
 338 /*!
 339 Sets the name of the node(graph).
 340 \param aNewName String value defining the name of the node(graph).
 341 \return True if the name has been updated.
 342 */
 343     boolean SetName(in string aNewName ) ;
 344 /*!
 345 Sets the name of the author. Returns True if it is updated.
 346 \param anAuthor String value defining the name of the author.
 347 \return True if the name has been updated.
 348 */
 349     boolean SetAuthor(in string anAuthor ) ;
 350 /*!
 351 Allows to update the comments about this node(graph).
 352 \param aComment String value containing a comment to this node(graph).
 353 \return True if the old comment has been updated.
 354 */
 355     boolean SetComment(in string aComment ) ;
 356
 357 /*!
 358  Gets a port of the node (for compatibility : see GetInPort - GetOutPort).
 359 */
 360     SUPERV::Port Port( in string aParameterName ) ;
 361
 362 /*! Gets an Input port in a node.
 363 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 364 */
 365     SUPERV::Port GetInPort( in string aParameterName ) ;
 366
 367 /*! Gets an Output port in a node.
 368 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 369 */
 370     SUPERV::Port GetOutPort( in string aParameterName ) ;
 371
 372 /*! Gets an Input StreamPort in a node.
 373 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 374 */
 375     SUPERV::StreamPort GetInStreamPort( in string aParameterName ) ;
 376
 377 /*! Gets an Output StreamPort in a node.
 378 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 379 */
 380     SUPERV::StreamPort GetOutStreamPort( in string aParameterName ) ;
 381
 382 /*!
 383  Returns true if a Node (or Graph) has StreamPorts
 384 */
 385     boolean HasStreamPort() ;
 386
 387 /*!
 388  Enters a value into an Input %Port
 389 */
 390     SUPERV::Port Input( in string InputParameterName ,
 391                         in Value aValue ) ;
 392
 393 /*!
 394   Gets a list of ports of the node(graph)
 395 */
 396     SUPERV::ListOfPorts Ports() ;
 397
 398 /*!
 399   Gets a list of ports of the node(graph)
 400 */
 401     SUPERV::ListOfStreamPorts StreamPorts() ;
 402
 403 /*! Gets a list of links of a node(graph)
 404 */
 405     SUPERV::ListOfLinks Links() ;
 406
 407 /*! Gets a list of StreamLinks of a node(graph)
 408 */
 409     SUPERV::ListOfStreamLinks StreamLinks() ;
 410
 411 /*!
 412 Returns True if this node is a graph.
 413 */
 414     boolean IsStreamGraph() ;
 415 /*!
 416 Returns True if this node is a graph.
 417 */
 418     boolean IsGraph() ;
 419
 420 /*!
 421 Returns True if this node is a MacroNode of a DataFlowGraph or a DataStreamGraph.
 422 */
 423     boolean IsMacro() ;
 424 /*!
 425 Returns True if this node is a MacroNode of a DataFlowGraph.
 426 */
 427     boolean IsFlowMacro() ;
 428 /*!
 429 Returns True if this node is a MacroNode of a DataStreamGraph.
 430 */
 431     boolean IsStreamMacro() ;
 432
 433 /*!
 434 Returns True if this node is a Head Graph .
 435 */
 436     boolean IsHeadGraph() ;
 437 /*!
 438 Returns the MacroNode Level of this node.
 439 */
 440     long GraphLevel() ;
 441
 442 /*!
 443 Returns True if the node appears to be a %computing node.
 444 */
 445     boolean IsComputing() ;
 446 /*!
 447 Returns True if the node appears to be a %factory node.
 448 */
 449     boolean IsFactory() ;
 450 /*!
 451 Returns True if the node appears to be an %inline node.
 452 */
 453     boolean IsInLine() ;
 454 /*!
 455 Returns True if the node appears to be a %GOTO node.
 456 */
 457     boolean IsGOTO() ;
 458 /*!
 459 Returns True if the node appears to be a %loop node.
 460 */
 461     boolean IsLoop() ;
 462 /*!
 463 Returns True if the node appears to be an %endloop node.
 464 */
 465     boolean IsEndLoop() ;
 466 /*!
 467 Returns True if the node appears to be a %switch node.
 468 */
 469     boolean IsSwitch() ;
 470 /*!
 471 Returns True if the node appears to be a %endswitch node.
 472 */
 473     boolean IsEndSwitch() ;
 474
 475 /*!
 476  Returns the numero of subgraph of a node.
 477 */
 478     long SubGraph() ;
 479 /*!
 480  Returns the numero of substreamgraph of a node.
 481 */
 482     long SubStreamGraph() ;
 483
 484 /*!
 485 Returns the number of threads of the graph.
 486 */
 487     long Thread() ;
 488
 489 /*!
 490  Returns True if the node(graph) is waiting for Data input
 491 */
 492     boolean IsWaiting() ;
 493
 494 /*!
 495  Returns True if the node(graph) is ready for execution
 496 */
 497      boolean IsReady() ;
 498
 499 /*!
 500  Returns True if the node(graph) is currently running
 501 */
 502     boolean IsRunning() ;
 503
 504 /*!
 505  Returns True if execution is finished
 506 */
 507
 508     boolean IsDone() ;
 509 /*!
 510  Returns True if execution is suspended
 511 */
 512
 513     boolean IsSuspended() ;
 514 /*!
 515 Returns the current state of the graph.
 516 */
 517     SUPERV::GraphState State() ;
 518
 519 /*!
 520  Waits for ready_to_run state, Suspend and return.
 521 */
 522     boolean ReadyW() ;
 523
 524 /*! Waits for running state, Suspend and return.
 525 */
 526     boolean RunningW() ;
 527
 528 /*! Waits for done state, Suspend and return.
 529 */
 530     boolean DoneW() ;
 531
 532 /*! Waits for Suspend state and return.
 533 */
 534     boolean SuspendedW() ;
 535
 536     //    boolean Ping();
 537
 538 /*! Kills execution.
 539 <br>
 540 If not running : will be killed when ready to run.
 541 If running : kills immediatly.
 542 */
 543     boolean Kill();
 544
 545 /*! Kills execution.
 546 <br>
 547 Execution will be killed only just after running (only for nodes).
 548 */
 549     boolean KillDone();
 550
 551 /*! Stops execution.
 552 <br>
 553 If not running : will be stopped when ready to run.
 554 If running : stops immediatly
 555 */
 556     boolean Stop();
 557 /*! Suspends execution.
 558 <br>
 559 If not running : will be Suspended when ready to run. It is used in step-by-step execution.
 560 If running : suspends immediatly
 561 */
 562     boolean Suspend();
 563 /*! Suspends execution only just after running.
 564 */
 565     boolean SuspendDone();
 566
 567 /*! Resumes execution.
 568 <br>
 569 If Suspended : running will be continued.
 570 If not Suspended : cancels the current ControlState ( Suspend, Kill, ...)
 571 */
 572     boolean Resume();
 573
 574
 575 // Control state required : Kill, Suspend, Stop
 576 /*!
 577  Returns control state of the node(graph).
 578 */
 579     SUPERV::ControlState Control() ;
 580 /*!
 581 Clears the control state of the node(graph).
 582 */
 583     void ControlClear() ;
 584
 585     boolean ContainerKill();
 586
 587 /*!
 588 Sets the position of the node in the window.
 589 */
 590     void Coords( in long X , in long Y ) ;
 591 /*!
 592 Returns the position of the node along X-axis.
 593 */
 594     long X() ;
 595 /*!
 596 Returns the position of the node along Y-axis.
 597 */
 598     long Y() ;
 599 /*!
 600 Returns the Cpu used by a node for execution of calculations in seconds.
 601 */
 602     long CpuUsed() ;
 603
 604   } ;
 605 /*! \brief %FNode class
 606
 607 This class is necessary for management of factory nodes in a data flow. Besides the inherited methods it contains some methods allowing to define
 608 the component from the container, which will be called for execution of the calculation.
 609 */
 610   //////////////
 611   interface FNode : CNode {
 612   //////////////
 613 /*! Gets the name of the component, which will be called for execution of the calculation.
 614 */
 615     string GetComponentName() ;
 616 /*! Gets the name of the interface of the component.
 617 */
 618     string GetInterfaceName() ;
 619 /*! Gets the container containing the component, which will be called for execution of the calculation.
 620 */
 621     string GetContainer() ;
 622 /*! Sets the name of the component, which will be called for execution of the calculation.
 623 \param aComponentName Name of the component.
 624 */
 625     boolean SetComponentName(in string aComponentName ) ;
 626 /*! Sets the name of the interface of the component.
 627 \param anInterfaceName Name of the interface.
 628 */
 629     boolean SetInterfaceName(in string anInterfaceName ) ;
 630 /*! Gets the container containing the component, which will be called for execution of the calculation.
 631 \param aContainer Container containing the component.
 632 */
 633     boolean SetContainer(in string aContainer ) ;
 634 /*! Method to define if %FNode gets from a component, which is implemented in C++ or Python.
 635   Returns True if it's a C++ component node
 636 */
 637     boolean IsCimpl() ;
 638
 639   } ;
 640 /*! \brief %INode class
 641
 642 This class is necessary for management of inline nodes in a data flow. Besides the inherited methods it contains some methods allowing to set a Python function, which will be
 643 executed for performing calculations, as well as input and output parameters for the node.
 644 */
 645   // InLine Nodes
 646   //////////////
 647   interface INode : CNode {
 648   //////////////
 649
 650 /*! Sets Python function for the InLine Node.
 651 \param FuncName Name of the function
 652 \param aPyInitFunction Python initialization function of the InLine Node
 653 */
 654     void SetPyFunction( in string FuncName ,
 655                         in SUPERV::ListOfStrings aPyInitFunction ) ;
 656 /*! Returns Python function of the InLine Node.
 657 */
 658     SUPERV::ListOfStrings PyFunction() ;
 659 /*! Returns the name of the Python function of the InLine Node.
 660 */
 661     string PyFuncName() ;
 662
 663 /*! Creates an Input port in a node.
 664 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 665 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 666 */
 667     SUPERV::Port InPort( in string aParameterName , in string aParameterType ) ;
 668 /*! Creates an Output port in an Inline node.
 669 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 670 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 671 */
 672     SUPERV::Port OutPort( in string aParameterName , in string aParameterType ) ;
 673
 674 /*! Creates an Input DataStreamPort in an Inline node.
 675 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 676 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 677 */
 678     SUPERV::StreamPort InStreamPort( in string aParameterName , in SALOME_ModuleCatalog::DataStreamType aParameterType , in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
 679
 680 /*! Creates an Output DataStreamPort in an Inline node.
 681 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 682 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 683 */
 684     SUPERV::StreamPort OutStreamPort( in string aParameterName , in SALOME_ModuleCatalog::DataStreamType aParameterType , in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
 685
 686   } ;
 687 /*! \brief %GNode class
 688
 689 This class is necessary for management of GOTO/EndLoop/EndSwitch nodes in the dataflow.
 690 Besides the inherited methods it contains some methods allowing to define the couple node, which will be linked to this one.
 691 */
 692   // GOTO/EndLoop/EndSwitch Nodes
 693   ///////////////
 694   interface GNode : INode {
 695   ///////////////
 696 /*! Sets the coupled InLine Node to this GOTO/EndLoop/EndSwitch Node.
 697 */
 698     boolean SetCoupled( in string anInLineNode ) ;
 699 /*! Returns the coupled InLine Node to this GOTO/EndLoop/EndSwitch Node.
 700 */
 701     SUPERV::INode Coupled() ;
 702   } ;
 703 /*! %Loop Nodes class
 704 */
 705   // Loop Nodes
 706   ///////////////
 707   interface LNode : GNode {
 708   ///////////////
 709 /*! Sets Python Init function of the Loop Node.
 710 \param InitName Name of the Init function
 711 \param aPyInitFunction Python Init function
 712 */
 713     void SetPyInit( in string InitName ,
 714                             in SUPERV::ListOfStrings aPyInitFunction ) ;
 715 /*! Returns Python Init function of the Loop Node.
 716 */
 717     SUPERV::ListOfStrings PyInit() ;
 718 /*! Returns the name of the Python Init function of the Loop  Node.
 719 */
 720     string PyInitName() ;
 721
 722 /*! Sets Python More function of the Loop Node.
 723 \param MoreName Name of the More function
 724 \param aPyMoreFunction Python More function
 725 */
 726     void SetPyMore( in string MoreName ,
 727                             in SUPERV::ListOfStrings aPyMoreFunction ) ;
 728 /*! Returns Python More function of the Loop Node.
 729 */
 730     SUPERV::ListOfStrings PyMore() ;
 731 /*! Returns the name of the Python More function of the Loop Node.
 732 */
 733     string PyMoreName() ;
 734
 735 /*! Sets Python Next function of the Loop Node.
 736 \param  NextName Name of the  Next function
 737 \param aPy NextFunction Python  Next function
 738 */
 739     void SetPyNext( in string NextName ,
 740                             in SUPERV::ListOfStrings aPyNextFunction ) ;
 741
 742 /*! Returns Python Next function of the Loop Node.
 743 */
 744     SUPERV::ListOfStrings PyNext() ;
 745 /*! Returns the name of the Python Next function of the Loop Node.
 746 */
 747     string PyNextName() ;
 748
 749   } ;
 750
 751   // EndOfLoop Nodes
 752   ////////////////
 753   interface ELNode : GNode {
 754   ////////////////
 755   } ;
 756
 757   // Switch Nodes
 758   ///////////////
 759   interface SNode : GNode {
 760   ///////////////
 761   } ;
 762
 763   // EndOfSwitch Nodes
 764   ////////////////
 765   interface ESNode : GNode {
 766   ////////////////
 767   } ;
 768
 769 /*! \brief Interface of a graph
 770
 771 This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
 772 */
 773
 774   ///////////////
 775   interface Graph : GNode {
 776   ///////////////
 777
 778     /*! Creates a Computing Node in a Graph.
 779     */
 780     SUPERV::CNode CNode( in SALOME_ModuleCatalog::Service aService ) ;
 781
 782     /*! Creates a Factory Node in a Graph.
 783     */
 784     SUPERV::FNode FNode( in string aComponentName ,
 785                          in string anInterfaceName ,
 786                          in SALOME_ModuleCatalog::Service aService ,
 787                          in boolean isCimpl ) ;
 788
 789     /*! Creates an InLine Node in a Graph.
 790     */
 791     SUPERV::INode INode( in string FuncName , in ListOfStrings aPythonFunction ) ;
 792
 793     /*! Creates a GOTO Node and links it to the corresponding InLine node.
 794     */
 795     SUPERV::GNode GNode( in string FuncName , in ListOfStrings aPythonFunction ,
 796                          in string anINode ) ;
 797
 798     /*! Creates a Loop Node ("for" or "while" loop) and links it to the corresponding end of loop node.
 799     */
 800     SUPERV::LNode LNode( in string InitName , in ListOfStrings InitFunction ,
 801                          in string MoreName , in ListOfStrings MoreFunction ,
 802                          in string NextName , in ListOfStrings NextFunction ,
 803                          out SUPERV::INode anEndOfLoop ) ;
 804
 805     /*! Creates a conditional "if/elseif/else" or "switch" node and the corresponding end node
 806     */
 807     SUPERV::SNode SNode( in string FuncName , in ListOfStrings aPythonFunction ,
 808                          out SUPERV::INode anEndOfSwitch ) ;
 809
 810     /*! Creates a "MacroNode" node which corresponds to a Graph with a xml file
 811     */
 812     SUPERV::Graph MNode( in string aXmlFileName ) ;
 813
 814     /*! Creates a "MacroNode" node which corresponds to a Graph with a Graph
 815     */
 816     SUPERV::Graph GraphMNode( in Graph aGraph ) ;
 817
 818     /*! Returns a Graph of a "MacroNode" or a "MacroNode" of a Graph
 819     */
 820     SUPERV::Graph FlowObjRef() ;
 821
 822     /*! Returns a StreamGraph of a "MacroNode"  or a "MacroNode" of a StreamGraph
 823     */
 824     SUPERV::StreamGraph StreamObjRef() ;
 825
 826     /*! Returns an existing node with a definite name.
 827     \param aNodeName Name of the Node.
 828     */
 829     SUPERV::CNode Node( in string aNodeName ) ;
 830
 831     /*! Creates a CORBA Component Object Reference
 832     */
 833     Engines::Component ComponentRef( in string aComputerContainer ,
 834                                      in string aComponentName ) ;
 835
 836     /*! Creates a link  connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
 837      */
 838     SUPERV::Link Link( in SUPERV::Port OutputPort ,
 839                        in SUPERV::Port InputPort ) ;
 840
 841     /*!
 842       Give the last error[s] message[s]
 843       \return string[s] corresponding to last error[s].
 844     */
 845     string Messages() ;
 846
 847     /*!
 848       Imports a graph into a file with XML format
 849       \param anXmlFile String parameter defining the name of the XML file.
 850       \return True, if the graph has been successfully imported.
 851     */
 852     boolean Import( in string anXmlFile ) ;
 853
 854     /*!
 855       Exports a graph to a file with XML format
 856       \param anXmlFile String parameter defining the name of the XML file.
 857       \return True, if the graph has been successfully exported.
 858     */
 859     boolean Export( in string anXmlFile ) ;
 860
 861     /*!
 862       Exports a graph to a string in python format
 863     */
 864     string SavePY( in boolean importSuperV ) ;
 865
 866     /*!
 867       Returns True if the graph is read Only.
 868     */
 869     boolean IsReadOnly() ;
 870
 871     /*!
 872       Starts asynchronous execution of the graph.
 873     */
 874     boolean Run() ;
 875
 876     /*!
 877       Assigns to the %Node an %Event and a %State of the %Node, if the Event is
 878       available. And returns immediately Nil, NoEvent and NoState if not.
 879       Returns false if the graph is finished, suspended, killed or stopped.
 880       \param aNode  %Node for which this method is called
 881       \param anEvent  An operation, which has been performed on this node(graph).
 882       \param aState   Current state of the graph
 883     */
 884     boolean EventNoW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
 885                       out SUPERV::GraphState aState ) ;
 886
 887     /*!
 888       Assigns to the %Node an %Event and a %State of the %Node, if the Event is
 889       available. Waits if it is not available at the current moment.
 890       Returns false if the graph is finished, suspended, killed or stopped.
 891       \param aNode  %Node for which this method is called
 892       \param anEvent  An operation, which has been performed on this node(graph).
 893       \param aState   Current state of the graph
 894     */
 895     boolean Event( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
 896                    out SUPERV::GraphState aState ) ;
 897
 898     // Same as Event but execution of the thread is suspended between the
 899     // return of EventW and the next call to EventW
 900     /*!
 901       Assigns to the %Node an %Event and a %State of the %Node, if the Event is
 902       available. And returns immediately Nil, NoEvent and NoState if not.
 903       Returns false if the graph is finished, suspended, killed or stopped.
 904       \note <BR>Execution of the thread is suspended between the return of this
 905       method and its next usage.
 906       \param aNode  %Node for which this method is called
 907       \param anEvent  An operation, which has been performed on this node(graph).
 908       \param aState   Current state of the graph
 909     */
 910     boolean EventW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
 911                     out SUPERV::GraphState aState ) ;
 912     /*! \name Methods used for inner debugging purposes of threads management :
 913      */
 914     /*@{*/
 915
 916     long EventQSize() ;
 917     long LevelMax() ;
 918     SUPERV::ListOfNodes LevelNodes( in long aLevel ) ;
 919     long ThreadsMax() ;
 920
 921     /*@}*/
 922
 923     /*!
 924       Returns the number of currently running threads.
 925     */
 926     long Threads();
 927     /*!
 928       Returns the number of suspended threads.
 929     */
 930     long SuspendedThreads();
 931     /*!
 932       Returns True if the graph is valid.
 933     */
 934     boolean IsValid() ;
 935     /*!
 936       Returns True if the graph can be executed.
 937     */
 938     boolean IsExecutable() ;
 939     /*!
 940       Returns True if the graph is being currently edited.
 941     */
 942     boolean IsEditing() ;
 943     /*!
 944       Returns True if the graph is being currently executed.
 945     */
 946     boolean IsExecuting() ;
 947
 948     long LastLevelDone() ;
 949
 950     /*!
 951       Launches step-by-step execution of the graph.
 952       \note  The execution is suspended immediatly after performance of operations of the first node and
 953       user can specify the nodes, where execution will be again suspended after its resuming.
 954     */
 955     boolean Start() ;
 956     /*!
 957       Allows to copy one graph into another.
 958     */
 959     SUPERV::Graph Copy() ;
 960     /*!
 961       Convert a FlowGraph to a StreamGraph.
 962     */
 963     SUPERV::StreamGraph ToStreamGraph() ;
 964     /*!
 965       Merges two graphs
 966     */
 967     boolean Merge( in Graph aGraph ) ;
 968     /*!
 969       Returns a list of nodes of the graph.
 970     */
 971     SUPERV::ListOfNodes Nodes() ;
 972     /*!
 973       Returns a list of links of the graph.
 974     */
 975     SUPERV::ListOfLinks GLinks() ;
 976     /*!
 977       Gets IOR of the garph.
 978     */
 979     string getIOR();
 980
 981     /*!
 982       Returns the number of independent subgraphs
 983     */
 984     long SubGraphsNumber() ;
 985     /*!
 986       Returns a list of Nodes of a SubGraph.
 987     */
 988     SUPERV::ListOfNodes SubGraphsNodes( in long SubGraphNumber ) ;
 989
 990     /*! Forces use of Editor's data model and destroy of Executor
 991      */
 992     void Editing();
 993
 994   } ;
 995
 996
 997
 998
 999
1000 /*! \brief Interface of a StreamGraph
1001
1002 This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
1003 */
1004
1005   /////////////////////
1006   interface StreamGraph : Graph {
1007   /////////////////////
1008
1009 /*!
1010 Allows to copy one graph into another.
1011 */
1012     SUPERV::StreamGraph StreamCopy() ;
1013     /*! Creates a "MacroNode" node which corresponds to a StreamGraph with a xml file
1014     */
1015     SUPERV::StreamGraph StreamMNode( in string aXmlFileName ) ;
1016
1017     /*! Creates a "MacroNode" node which corresponds to a StreamGraph with a Graph
1018     */
1019     SUPERV::StreamGraph StreamGraphMNode( in StreamGraph aStreamGraph ) ;
1020
1021 /*!
1022  Creates a link  connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
1023 */
1024     SUPERV::StreamLink StreamLink( in SUPERV::StreamPort OutputPort ,
1025                                    in SUPERV::StreamPort InputPort ) ;
1026
1027 /*!
1028 Returns a list of links of the graph.
1029 */
1030     SUPERV::ListOfStreamLinks GStreamLinks() ;
1031     boolean SetStreamParams( in long Timeout ,
1032                              in SUPERV::KindOfDataStreamTrace DataStreamTrace ,
1033                              in double DeltaTime ) ;
1034     void StreamParams( out long Timeout ,
1035                        out SUPERV::KindOfDataStreamTrace DataStreamTrace ,
1036                        out double DeltaTime ) ;
1037
1038 /*!
1039 Returns the number of independent subStreamgraphs
1040 */
1041     long SubStreamGraphsNumber() ;
1042 /*!
1043 Returns a list of Nodes of a SubStreamGraph.
1044 */
1045     SUPERV::ListOfNodes SubStreamGraphsNodes( in long SubStreamGraphNumber ) ;
1046
1047 /*!
1048 Convert a StreamGraph to a FlowGraph.
1049 */
1050     SUPERV::Graph ToFlowGraph() ;
1051
1052 /*!
1053 Merge a StreamGraph.
1054 */
1055     boolean StreamMerge( in StreamGraph aStreamGraph ) ;
1056
1057   } ;
1058
1059
1060
1061
1062
1063
1064 /*! \brief Interface of the %link
1065
1066 This interface contains a set of methods used for representation and management of the links
1067 connecting nodes in a %graph.
1068 */
1069
1070   //////////////
1071   interface Link : Engines::Component {
1072   //////////////
1073 /*!
1074 Returns the %Output %Port of the Link
1075 */
1076     SUPERV::Port OutPort() ;
1077
1078 /*!
1079 Returns the %Input %Port of the Link
1080 */
1081     SUPERV::Port InPort() ;
1082
1083     // For GUI :
1084 /*! \name Methods used for representation of links in GUI of %SALOME application :
1085 */
1086 /*@{*/
1087 /*!
1088 Returns the number of coordinate points which are included in the link.
1089 \note  <BR>Every link can contain a set of coordinate points which constitute it. These points have
1090 index numbers (beginning from 1) and coordinates defining their position in the window. Indexing of
1091 the points starts from input port to output port of the corresponding link.
1092 */
1093     long CoordsSize() ;
1094 /*!
1095 Adds a coordinate point to the link.
1096 \param index  Index of the point.
1097 \param X  Coordinates of the point.
1098 \param Y  Coordinates of the point.
1099 */
1100     boolean AddCoord( in long index , in long X , in long Y ) ;
1101 /*!
1102 Changes the location of a definite coordinate point of the link.
1103 \param index  Index of the point.
1104 \param X  Coordinates of the point.
1105 \param Y  Coordinates of the point.
1106 */
1107
1108     boolean ChangeCoord( in long index , in long X , in long Y ) ;
1109 /*!
1110 Removes a coordinate point of the link.
1111 \param index  Index of the point.
1112 */
1113
1114     boolean RemoveCoord( in long index ) ;
1115
1116 /*!
1117 Sets the location of a coordinate point of the link.
1118 \param index  Index of the point.
1119 \param X  Coordinates of the point.
1120 \param Y  Coordinates of the point.
1121 */
1122
1123     boolean Coords( in long index , out long X , out long Y ) ;
1124 /*@}*/
1125
1126     //    void Destroy() ;
1127
1128     /*! Checks if the types of Ports that it connects are compatible
1129      */
1130     boolean IsValid();
1131
1132     /*! Check if the Link equals to the another given Link
1133      */
1134     boolean IsEqual( in SUPERV::Link aLink );
1135
1136   } ;
1137
1138
1139
1140
1141
1142
1143 /*! \brief Interface of the %link
1144
1145 This interface contains a set of methods used for representation and management of the links
1146 connecting nodes in a %graph.
1147 */
1148
1149   ////////////////////
1150   interface StreamLink : Link {
1151   ////////////////////
1152 /*!
1153 Returns the %Output %StreamPort of the StreamLink
1154 */
1155     SUPERV::StreamPort OutStreamPort() ;
1156
1157 /*!
1158 Returns the %Input %StreamPort of the StreamLink
1159 */
1160     SUPERV::StreamPort InStreamPort() ;
1161
1162
1163   } ;
1164
1165
1166
1167
1168
1169 /*! \brief  %Value interface
1170
1171 This interface contains a set of methods used for setting initial parameters of the ports
1172 */
1173
1174   ///////////////
1175   interface Value : Engines::Component {
1176   ///////////////
1177 /*!
1178 Converts the given value into a value of string type.
1179 */
1180     string ToString() ;
1181 /*!
1182 Converts the given value into a value of independant data type.
1183 */
1184     any ToAny() ;
1185 /*!
1186 Returns True if the value represents an IOR.
1187 */
1188     boolean IsIOR() ;
1189 /*!
1190 Gets data type of the component.
1191 */
1192     string ComponentDataType() ;
1193
1194     //    void Destroy() ;
1195
1196   } ;
1197 /*! \brief  %Port interface
1198
1199 This interface contains a set of methods used for management of the ports.
1200 */
1201
1202   //////////////
1203   interface Port : Value {
1204   //////////////
1205
1206 /*!
1207   Gives a value to an Input %Port
1208 \param aValue This parameter defines the input value
1209 */
1210     boolean Input( in SUPERV::Value aValue ) ;
1211
1212 /*!
1213 Returns the node of the port
1214 */
1215     SUPERV::CNode Node() ;
1216 /*!
1217 Sets the name of the port.
1218 */
1219     string Name() ;
1220
1221 /* Gets the type of a port.
1222 \return A string defining the type of a port
1223 */
1224
1225     string Type() ;
1226
1227     // Link of an Input Port
1228 /*!
1229 Returns the link of an %Input %Port
1230 */
1231     SUPERV::Link Link() ;
1232
1233 /*!
1234 Returns a list of links of an Input %Port of an EndSwitchNode
1235 */
1236     SUPERV::ListOfLinks Links() ;
1237
1238 /*!
1239 Returns True if this port appears to be an %Input %Port of a Node
1240 */
1241     boolean IsInput() ;
1242
1243 /*!
1244 Returns True if an %Input %Value exists for that %Input %Port (without link)
1245 */
1246     boolean HasInput() ;
1247
1248 /*!
1249 Returns True if the %Port is linked (without value)
1250 */
1251 // Port with link (without Value)
1252     boolean IsLinked() ;
1253
1254     // Kind of a Port
1255 /*! Returns the type of this port.
1256 */
1257     SUPERV::KindOfPort Kind() ;
1258
1259     // Port from the service of the node
1260 /*!
1261 Returns True if the %Port is a parameter of a service
1262 */
1263     boolean IsParam() ;
1264     // Port is a Gate of the node
1265 /*!
1266 Returns True if the %Port appears to be a Gate Port of the Node
1267 */
1268     boolean IsGate() ;
1269     // Port is a parameter of an InLineNode
1270 /*!
1271 Returns True if the %Port appears to be a parameter of an InLine Node.
1272 */
1273     boolean IsInLine() ;
1274
1275     // Port is a LoopParameter (InitLoop or DoLoop) of an LoopNode
1276 /*!
1277 Returns True if the %Port appears to be a Loop Parameter (InitLoop or DoLoop) of a Loop Node
1278 */
1279     boolean IsLoop() ;
1280     // Port is an output parameter of a SwitchNode connected to an InGate
1281 /*!
1282 Returns True if the %Port appears to be a parameter of a switch node
1283 */
1284     // Port is a parameter of a switch node
1285     boolean IsSwitch() ;
1286     // Port is an Input parameter of a EndSwitchNode connected to several output ports
1287 /*!
1288 Returns True if the %Port appears to be an EndSwitch Node connected to several output ports.
1289 */
1290     boolean IsEndSwitch() ;
1291
1292     boolean IsDataStream() ;
1293
1294 /*! Returns the current state of the port.
1295 */
1296     SUPERV::GraphState State() ;
1297 /*! Returns True if computation is finished.
1298 */
1299     boolean IsDone() ;
1300
1301 /*! deactivate the objref of a Port when its node is destroyed
1302 */
1303     void Remove() ;
1304
1305   } ;
1306
1307   ////////////////////
1308   interface StreamPort : Port {
1309   ////////////////////
1310
1311     // Link of a StreamPort
1312 /*!
1313 Returns the link of a %StreamPort
1314 */
1315     SUPERV::StreamLink StreamLink() ;
1316
1317 /*! Returns the current Dependency of the DataStreamPort : TimeDependency or IterationDependency
1318 */
1319     SALOME_ModuleCatalog::DataStreamDependency Dependency() ;
1320     boolean SetDependency( in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
1321
1322 /*! Sets or Returns the current kinds of Schema, Interpolation and Extrapolation of the InDataStreamPort
1323 */
1324     boolean SetParams( in KindOfSchema aKindOfSchema ,
1325                        in KindOfInterpolation aKindOfInterpolation ,
1326                        in KindOfExtrapolation aKindOfExtrapolation ) ;
1327     boolean Params( out KindOfSchema aKindOfSchema ,
1328                     out KindOfInterpolation aKindOfInterpolation ,
1329                     out KindOfExtrapolation aKindOfExtrapolation ) ;
1330
1331 /*! Sets or Returns the current number of values ("NIVEAU") of the OutDataStreamPort
1332 */
1333     boolean SetNumberOfValues( in long aNumberOfValues ) ;
1334     long NumberOfValues() ;
1335
1336   } ;
1337
1338 };
1339 #endif