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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  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   } ;
 635 /*! \brief %INode class
 636
 637 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
 638 executed for performing calculations, as well as input and output parameters for the node.
 639 */
 640   // InLine Nodes
 641   //////////////
 642   interface INode : CNode {
 643   //////////////
 644
 645 /*! Sets Python function for the InLine Node.
 646 \param FuncName Name of the function
 647 \param aPyInitFunction Python initialization function of the InLine Node
 648 */
 649     void SetPyFunction( in string FuncName ,
 650                         in SUPERV::ListOfStrings aPyInitFunction ) ;
 651 /*! Returns Python function of the InLine Node.
 652 */
 653     SUPERV::ListOfStrings PyFunction() ;
 654 /*! Returns the name of the Python function of the InLine Node.
 655 */
 656     string PyFuncName() ;
 657
 658 /*! Creates an Input port in a node.
 659 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 660 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 661 */
 662     SUPERV::Port InPort( in string aParameterName , in string aParameterType ) ;
 663 /*! Creates an Output port in an Inline 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 OutPort( in string aParameterName , in string aParameterType ) ;
 668
 669 /*! Creates an Input DataStreamPort in an Inline node.
 670 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 671 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 672 */
 673     SUPERV::StreamPort InStreamPort( in string aParameterName , in SALOME_ModuleCatalog::DataStreamType aParameterType , in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
 674
 675 /*! Creates an Output DataStreamPort in an Inline node.
 676 \param aParameterName This value sets the name of the parameter which will be defined in this port.
 677 \param aParameterType This value sets the type of the parameter which will be defined in this port.
 678 */
 679     SUPERV::StreamPort OutStreamPort( in string aParameterName , in SALOME_ModuleCatalog::DataStreamType aParameterType , in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
 680
 681   } ;
 682 /*! \brief %GNode class
 683
 684 This class is necessary for management of GOTO/EndLoop/EndSwitch nodes in the dataflow.
 685 Besides the inherited methods it contains some methods allowing to define the couple node, which will be linked to this one.
 686 */
 687   // GOTO/EndLoop/EndSwitch Nodes
 688   ///////////////
 689   interface GNode : INode {
 690   ///////////////
 691 /*! Sets the coupled InLine Node to this GOTO/EndLoop/EndSwitch Node.
 692 */
 693     boolean SetCoupled( in string anInLineNode ) ;
 694 /*! Returns the coupled InLine Node to this GOTO/EndLoop/EndSwitch Node.
 695 */
 696     SUPERV::INode Coupled() ;
 697   } ;
 698 /*! %Loop Nodes class
 699 */
 700   // Loop Nodes
 701   ///////////////
 702   interface LNode : GNode {
 703   ///////////////
 704 /*! Sets Python Init function of the Loop Node.
 705 \param InitName Name of the Init function
 706 \param aPyInitFunction Python Init function
 707 */
 708     void SetPyInit( in string InitName ,
 709                             in SUPERV::ListOfStrings aPyInitFunction ) ;
 710 /*! Returns Python Init function of the Loop Node.
 711 */
 712     SUPERV::ListOfStrings PyInit() ;
 713 /*! Returns the name of the Python Init function of the Loop  Node.
 714 */
 715     string PyInitName() ;
 716
 717 /*! Sets Python More function of the Loop Node.
 718 \param MoreName Name of the More function
 719 \param aPyMoreFunction Python More function
 720 */
 721     void SetPyMore( in string MoreName ,
 722                             in SUPERV::ListOfStrings aPyMoreFunction ) ;
 723 /*! Returns Python More function of the Loop Node.
 724 */
 725     SUPERV::ListOfStrings PyMore() ;
 726 /*! Returns the name of the Python More function of the Loop Node.
 727 */
 728     string PyMoreName() ;
 729
 730 /*! Sets Python Next function of the Loop Node.
 731 \param  NextName Name of the  Next function
 732 \param aPy NextFunction Python  Next function
 733 */
 734     void SetPyNext( in string NextName ,
 735                             in SUPERV::ListOfStrings aPyNextFunction ) ;
 736
 737 /*! Returns Python Next function of the Loop Node.
 738 */
 739     SUPERV::ListOfStrings PyNext() ;
 740 /*! Returns the name of the Python Next function of the Loop Node.
 741 */
 742     string PyNextName() ;
 743
 744   } ;
 745
 746   // EndOfLoop Nodes
 747   ////////////////
 748   interface ELNode : GNode {
 749   ////////////////
 750   } ;
 751
 752   // Switch Nodes
 753   ///////////////
 754   interface SNode : GNode {
 755   ///////////////
 756   } ;
 757
 758   // EndOfSwitch Nodes
 759   ////////////////
 760   interface ESNode : GNode {
 761   ////////////////
 762   } ;
 763
 764 /*! \brief Interface of a graph
 765
 766 This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
 767 */
 768
 769   ///////////////
 770   interface Graph : GNode {
 771   ///////////////
 772
 773     /*! Creates a Computing Node in a Graph.
 774     */
 775     SUPERV::CNode CNode( in SALOME_ModuleCatalog::Service aService ) ;
 776
 777     /*! Creates a Factory Node in a Graph.
 778     */
 779     SUPERV::FNode FNode( in string aComponentName ,
 780                          in string anInterfaceName ,
 781                          in SALOME_ModuleCatalog::Service aService ) ;
 782
 783     /*! Creates an InLine Node in a Graph.
 784     */
 785     SUPERV::INode INode( in string FuncName , in ListOfStrings aPythonFunction ) ;
 786
 787     /*! Creates a GOTO Node and links it to the corresponding InLine node.
 788     */
 789     SUPERV::GNode GNode( in string FuncName , in ListOfStrings aPythonFunction ,
 790                          in string anINode ) ;
 791
 792     /*! Creates a Loop Node ("for" or "while" loop) and links it to the corresponding end of loop node.
 793     */
 794     SUPERV::LNode LNode( in string InitName , in ListOfStrings InitFunction ,
 795                          in string MoreName , in ListOfStrings MoreFunction ,
 796                          in string NextName , in ListOfStrings NextFunction ,
 797                          out SUPERV::INode anEndOfLoop ) ;
 798
 799     /*! Creates a conditional "if/elseif/else" or "switch" node and the corresponding end node
 800     */
 801     SUPERV::SNode SNode( in string FuncName , in ListOfStrings aPythonFunction ,
 802                          out SUPERV::INode anEndOfSwitch ) ;
 803
 804     /*! Creates a "MacroNode" node which corresponds to a Graph with a xml file
 805     */
 806     SUPERV::Graph MNode( in string aXmlFileName ) ;
 807
 808     /*! Creates a "MacroNode" node which corresponds to a Graph with a Graph
 809     */
 810     SUPERV::Graph GraphMNode( in Graph aGraph ) ;
 811
 812     /*! Returns a Graph of a "MacroNode" or a "MacroNode" of a Graph
 813     */
 814     SUPERV::Graph FlowObjRef() ;
 815
 816     /*! Returns a StreamGraph of a "MacroNode"  or a "MacroNode" of a StreamGraph
 817     */
 818     SUPERV::StreamGraph StreamObjRef() ;
 819
 820     /*! Returns an existing node with a definite name.
 821     \param aNodeName Name of the Node.
 822     */
 823     SUPERV::CNode Node( in string aNodeName ) ;
 824
 825     /*! Creates a CORBA Component Object Reference
 826     */
 827     Engines::Component ComponentRef( in string aComputerContainer ,
 828                                      in string aComponentName ) ;
 829
 830     /*! Creates a link  connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
 831      */
 832     SUPERV::Link Link( in SUPERV::Port OutputPort ,
 833                        in SUPERV::Port InputPort ) ;
 834
 835     /*!
 836       Give the last error[s] message[s]
 837       \return string[s] corresponding to last error[s].
 838     */
 839     string Messages() ;
 840
 841     /*!
 842       Imports a graph into a file with XML format
 843       \param anXmlFile String parameter defining the name of the XML file.
 844       \return True, if the graph has been successfully imported.
 845     */
 846     boolean Import( in string anXmlFile ) ;
 847
 848     /*!
 849       Exports a graph to a file with XML format
 850       \param anXmlFile String parameter defining the name of the XML file.
 851       \return True, if the graph has been successfully exported.
 852     */
 853     boolean Export( in string anXmlFile ) ;
 854
 855     /*!
 856       Exports a graph to a string in python format
 857     */
 858     string SavePY( in boolean importSuperV ) ;
 859
 860     /*!
 861       Returns True if the graph is read Only.
 862     */
 863     boolean IsReadOnly() ;
 864
 865     /*!
 866       Starts asynchronous execution of the graph.
 867     */
 868     boolean Run() ;
 869
 870     /*!
 871       Assigns to the %Node an %Event and a %State of the %Node, if the Event is
 872       available. And returns immediately Nil, NoEvent and NoState if not.
 873       Returns false if the graph is finished, suspended, killed or stopped.
 874       \param aNode  %Node for which this method is called
 875       \param anEvent  An operation, which has been performed on this node(graph).
 876       \param aState   Current state of the graph
 877     */
 878     boolean EventNoW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
 879                       out SUPERV::GraphState aState ) ;
 880
 881     /*!
 882       Assigns to the %Node an %Event and a %State of the %Node, if the Event is
 883       available. Waits if it is not available at the current moment.
 884       Returns false if the graph is finished, suspended, killed or stopped.
 885       \param aNode  %Node for which this method is called
 886       \param anEvent  An operation, which has been performed on this node(graph).
 887       \param aState   Current state of the graph
 888     */
 889     boolean Event( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
 890                    out SUPERV::GraphState aState ) ;
 891
 892     // Same as Event but execution of the thread is suspended between the
 893     // return of EventW and the next call to EventW
 894     /*!
 895       Assigns to the %Node an %Event and a %State of the %Node, if the Event is
 896       available. And returns immediately Nil, NoEvent and NoState if not.
 897       Returns false if the graph is finished, suspended, killed or stopped.
 898       \note <BR>Execution of the thread is suspended between the return of this
 899       method and its next usage.
 900       \param aNode  %Node for which this method is called
 901       \param anEvent  An operation, which has been performed on this node(graph).
 902       \param aState   Current state of the graph
 903     */
 904     boolean EventW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
 905                     out SUPERV::GraphState aState ) ;
 906     /*! \name Methods used for inner debugging purposes of threads management :
 907      */
 908     /*@{*/
 909
 910     long EventQSize() ;
 911     long LevelMax() ;
 912     SUPERV::ListOfNodes LevelNodes( in long aLevel ) ;
 913     long ThreadsMax() ;
 914
 915     /*@}*/
 916
 917     /*!
 918       Returns the number of currently running threads.
 919     */
 920     long Threads();
 921     /*!
 922       Returns the number of suspended threads.
 923     */
 924     long SuspendedThreads();
 925     /*!
 926       Returns True if the graph is valid.
 927     */
 928     boolean IsValid() ;
 929     /*!
 930       Returns True if the graph can be executed.
 931     */
 932     boolean IsExecutable() ;
 933     /*!
 934       Returns True if the graph is being currently edited.
 935     */
 936     boolean IsEditing() ;
 937     /*!
 938       Returns True if the graph is being currently executed.
 939     */
 940     boolean IsExecuting() ;
 941
 942     long LastLevelDone() ;
 943
 944     /*!
 945       Launches step-by-step execution of the graph.
 946       \note  The execution is suspended immediatly after performance of operations of the first node and
 947       user can specify the nodes, where execution will be again suspended after its resuming.
 948     */
 949     boolean Start() ;
 950     /*!
 951       Allows to copy one graph into another.
 952     */
 953     SUPERV::Graph Copy() ;
 954     /*!
 955       Convert a FlowGraph to a StreamGraph.
 956     */
 957     SUPERV::StreamGraph ToStreamGraph() ;
 958     /*!
 959       Merges two graphs
 960     */
 961     boolean Merge( in Graph aGraph ) ;
 962     /*!
 963       Returns a list of nodes of the graph.
 964     */
 965     SUPERV::ListOfNodes Nodes() ;
 966     /*!
 967       Returns a list of links of the graph.
 968     */
 969     SUPERV::ListOfLinks GLinks() ;
 970     /*!
 971       Gets IOR of the garph.
 972     */
 973     string getIOR();
 974
 975     /*!
 976       Returns the number of independent subgraphs
 977     */
 978     long SubGraphsNumber() ;
 979     /*!
 980       Returns a list of Nodes of a SubGraph.
 981     */
 982     SUPERV::ListOfNodes SubGraphsNodes( in long SubGraphNumber ) ;
 983
 984     /*! Forces use of Editor's data model and destroy of Executor
 985      */
 986     void Editing();
 987
 988   } ;
 989
 990
 991
 992
 993
 994 /*! \brief Interface of a StreamGraph
 995
 996 This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
 997 */
 998
 999   /////////////////////
1000   interface StreamGraph : Graph {
1001   /////////////////////
1002
1003 /*!
1004 Allows to copy one graph into another.
1005 */
1006     SUPERV::StreamGraph StreamCopy() ;
1007     /*! Creates a "MacroNode" node which corresponds to a StreamGraph with a xml file
1008     */
1009     SUPERV::StreamGraph StreamMNode( in string aXmlFileName ) ;
1010
1011     /*! Creates a "MacroNode" node which corresponds to a StreamGraph with a Graph
1012     */
1013     SUPERV::StreamGraph StreamGraphMNode( in StreamGraph aStreamGraph ) ;
1014
1015 /*!
1016  Creates a link  connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
1017 */
1018     SUPERV::StreamLink StreamLink( in SUPERV::StreamPort OutputPort ,
1019                                    in SUPERV::StreamPort InputPort ) ;
1020
1021 /*!
1022 Returns a list of links of the graph.
1023 */
1024     SUPERV::ListOfStreamLinks GStreamLinks() ;
1025     boolean SetStreamParams( in long Timeout ,
1026                              in SUPERV::KindOfDataStreamTrace DataStreamTrace ,
1027                              in double DeltaTime ) ;
1028     void StreamParams( out long Timeout ,
1029                        out SUPERV::KindOfDataStreamTrace DataStreamTrace ,
1030                        out double DeltaTime ) ;
1031
1032 /*!
1033 Returns the number of independent subStreamgraphs
1034 */
1035     long SubStreamGraphsNumber() ;
1036 /*!
1037 Returns a list of Nodes of a SubStreamGraph.
1038 */
1039     SUPERV::ListOfNodes SubStreamGraphsNodes( in long SubStreamGraphNumber ) ;
1040
1041 /*!
1042 Convert a StreamGraph to a FlowGraph.
1043 */
1044     SUPERV::Graph ToFlowGraph() ;
1045
1046 /*!
1047 Merge a StreamGraph.
1048 */
1049     boolean StreamMerge( in StreamGraph aStreamGraph ) ;
1050
1051   } ;
1052
1053
1054
1055
1056
1057
1058 /*! \brief Interface of the %link
1059
1060 This interface contains a set of methods used for representation and management of the links
1061 connecting nodes in a %graph.
1062 */
1063
1064   //////////////
1065   interface Link : Engines::Component {
1066   //////////////
1067 /*!
1068 Returns the %Output %Port of the Link
1069 */
1070     SUPERV::Port OutPort() ;
1071
1072 /*!
1073 Returns the %Input %Port of the Link
1074 */
1075     SUPERV::Port InPort() ;
1076
1077     // For GUI :
1078 /*! \name Methods used for representation of links in GUI of %SALOME application :
1079 */
1080 /*@{*/
1081 /*!
1082 Returns the number of coordinate points which are included in the link.
1083 \note  <BR>Every link can contain a set of coordinate points which constitute it. These points have
1084 index numbers (beginning from 1) and coordinates defining their position in the window. Indexing of
1085 the points starts from input port to output port of the corresponding link.
1086 */
1087     long CoordsSize() ;
1088 /*!
1089 Adds a coordinate point to the link.
1090 \param index  Index of the point.
1091 \param X  Coordinates of the point.
1092 \param Y  Coordinates of the point.
1093 */
1094     boolean AddCoord( in long index , in long X , in long Y ) ;
1095 /*!
1096 Changes the location of a definite coordinate point of the link.
1097 \param index  Index of the point.
1098 \param X  Coordinates of the point.
1099 \param Y  Coordinates of the point.
1100 */
1101
1102     boolean ChangeCoord( in long index , in long X , in long Y ) ;
1103 /*!
1104 Removes a coordinate point of the link.
1105 \param index  Index of the point.
1106 */
1107
1108     boolean RemoveCoord( in long index ) ;
1109
1110 /*!
1111 Sets the location of a coordinate point of the link.
1112 \param index  Index of the point.
1113 \param X  Coordinates of the point.
1114 \param Y  Coordinates of the point.
1115 */
1116
1117     boolean Coords( in long index , out long X , out long Y ) ;
1118 /*@}*/
1119
1120     //    void Destroy() ;
1121
1122     /*! Checks if the types of Ports that it connects are compatible
1123      */
1124     boolean IsValid();
1125
1126     /*! Check if the Link equals to the another given Link
1127      */
1128     boolean IsEqual( in SUPERV::Link aLink );
1129
1130   } ;
1131
1132
1133
1134
1135
1136
1137 /*! \brief Interface of the %link
1138
1139 This interface contains a set of methods used for representation and management of the links
1140 connecting nodes in a %graph.
1141 */
1142
1143   ////////////////////
1144   interface StreamLink : Link {
1145   ////////////////////
1146 /*!
1147 Returns the %Output %StreamPort of the StreamLink
1148 */
1149     SUPERV::StreamPort OutStreamPort() ;
1150
1151 /*!
1152 Returns the %Input %StreamPort of the StreamLink
1153 */
1154     SUPERV::StreamPort InStreamPort() ;
1155
1156
1157   } ;
1158
1159
1160
1161
1162
1163 /*! \brief  %Value interface
1164
1165 This interface contains a set of methods used for setting initial parameters of the ports
1166 */
1167
1168   ///////////////
1169   interface Value : Engines::Component {
1170   ///////////////
1171 /*!
1172 Converts the given value into a value of string type.
1173 */
1174     string ToString() ;
1175 /*!
1176 Converts the given value into a value of independant data type.
1177 */
1178     any ToAny() ;
1179 /*!
1180 Returns True if the value represents an IOR.
1181 */
1182     boolean IsIOR() ;
1183 /*!
1184 Gets data type of the component.
1185 */
1186     string ComponentDataType() ;
1187
1188     //    void Destroy() ;
1189
1190   } ;
1191 /*! \brief  %Port interface
1192
1193 This interface contains a set of methods used for management of the ports.
1194 */
1195
1196   //////////////
1197   interface Port : Value {
1198   //////////////
1199
1200 /*!
1201   Gives a value to an Input %Port
1202 \param aValue This parameter defines the input value
1203 */
1204     boolean Input( in SUPERV::Value aValue ) ;
1205
1206 /*!
1207 Returns the node of the port
1208 */
1209     SUPERV::CNode Node() ;
1210 /*!
1211 Sets the name of the port.
1212 */
1213     string Name() ;
1214
1215 /* Gets the type of a port.
1216 \return A string defining the type of a port
1217 */
1218
1219     string Type() ;
1220
1221     // Link of an Input Port
1222 /*!
1223 Returns the link of an %Input %Port
1224 */
1225     SUPERV::Link Link() ;
1226
1227 /*!
1228 Returns a list of links of an Input %Port of an EndSwitchNode
1229 */
1230     SUPERV::ListOfLinks Links() ;
1231
1232 /*!
1233 Returns True if this port appears to be an %Input %Port of a Node
1234 */
1235     boolean IsInput() ;
1236
1237 /*!
1238 Returns True if an %Input %Value exists for that %Input %Port (without link)
1239 */
1240     boolean HasInput() ;
1241
1242 /*!
1243 Returns True if the %Port is linked (without value)
1244 */
1245 // Port with link (without Value)
1246     boolean IsLinked() ;
1247
1248     // Kind of a Port
1249 /*! Returns the type of this port.
1250 */
1251     SUPERV::KindOfPort Kind() ;
1252
1253     // Port from the service of the node
1254 /*!
1255 Returns True if the %Port is a parameter of a service
1256 */
1257     boolean IsParam() ;
1258     // Port is a Gate of the node
1259 /*!
1260 Returns True if the %Port appears to be a Gate Port of the Node
1261 */
1262     boolean IsGate() ;
1263     // Port is a parameter of an InLineNode
1264 /*!
1265 Returns True if the %Port appears to be a parameter of an InLine Node.
1266 */
1267     boolean IsInLine() ;
1268
1269     // Port is a LoopParameter (InitLoop or DoLoop) of an LoopNode
1270 /*!
1271 Returns True if the %Port appears to be a Loop Parameter (InitLoop or DoLoop) of a Loop Node
1272 */
1273     boolean IsLoop() ;
1274     // Port is an output parameter of a SwitchNode connected to an InGate
1275 /*!
1276 Returns True if the %Port appears to be a parameter of a switch node
1277 */
1278     // Port is a parameter of a switch node
1279     boolean IsSwitch() ;
1280     // Port is an Input parameter of a EndSwitchNode connected to several output ports
1281 /*!
1282 Returns True if the %Port appears to be an EndSwitch Node connected to several output ports.
1283 */
1284     boolean IsEndSwitch() ;
1285
1286     boolean IsDataStream() ;
1287
1288 /*! Returns the current state of the port.
1289 */
1290     SUPERV::GraphState State() ;
1291 /*! Returns True if computation is finished.
1292 */
1293     boolean IsDone() ;
1294
1295 /*! deactivate the objref of a Port when its node is destroyed
1296 */
1297     void Remove() ;
1298
1299   } ;
1300
1301   ////////////////////
1302   interface StreamPort : Port {
1303   ////////////////////
1304
1305     // Link of a StreamPort
1306 /*!
1307 Returns the link of a %StreamPort
1308 */
1309     SUPERV::StreamLink StreamLink() ;
1310
1311 /*! Returns the current Dependency of the DataStreamPort : TimeDependency or IterationDependency
1312 */
1313     SALOME_ModuleCatalog::DataStreamDependency Dependency() ;
1314     boolean SetDependency( in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
1315
1316 /*! Sets or Returns the current kinds of Schema, Interpolation and Extrapolation of the InDataStreamPort
1317 */
1318     boolean SetParams( in KindOfSchema aKindOfSchema ,
1319                        in KindOfInterpolation aKindOfInterpolation ,
1320                        in KindOfExtrapolation aKindOfExtrapolation ) ;
1321     boolean Params( out KindOfSchema aKindOfSchema ,
1322                     out KindOfInterpolation aKindOfInterpolation ,
1323                     out KindOfExtrapolation aKindOfExtrapolation ) ;
1324
1325 /*! Sets or Returns the current number of values ("NIVEAU") of the OutDataStreamPort
1326 */
1327     boolean SetNumberOfValues( in long aNumberOfValues ) ;
1328     long NumberOfValues() ;
1329
1330   } ;
1331
1332 };
1333 #endif