1 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
18 // See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
23 // Author : Jean Rahuel
26 /*! \file SUPERV.idl This file contains a set of interfaces of the %SUPERVISION module
29 #ifndef __SUPERV_IDL__
30 #define __SUPERV_IDL__
32 #include "SALOME_ModuleCatalog.idl"
33 #include "SALOME_Component.idl"
34 #include "SALOMEDS.idl"
36 The main package of interfaces of %SUPERVISION module
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.
45 enum KindOfPort { UndefinedParameter ,
53 DataStreamParameter } ;
56 This enumeration contains a set of dependencies of InPorts and OutPorts.
58 // enum KindOfDependency { UndefinedDependency , TimeDependency , IterationDependency } ;
61 This enumeration contains a set of schemas of InPorts.
63 enum KindOfSchema { SCHENULL , TI , TF , DELTA } ;
66 This enumeration contains a set of interpolations of InPorts.
68 enum KindOfInterpolation { INTERNULL , L0 , L1 } ;
71 This enumeration contains a set of extrapolations of InPorts.
73 enum KindOfExtrapolation { EXTRANULL , E0 , E1 } ;
76 This enumeration contains a set of dependencies of Ports.
78 enum KindOfDataStreamTrace { WithoutTrace , SummaryTrace , DetailedTrace } ;
81 This enumeration contains a set of elements defining the type of the node.
83 enum KindOfNode { FactoryNode ,
97 This struct contains fields defining the date.
108 This enumeration contains a set of elements defining the type of operation, which has been performed
112 enum GraphEvent { UndefinedEvent ,
125 // UndefinedState : Non existing Node, Port etc...
127 This enumeration contains a set of elements defining the current state of the node(graph).
130 enum GraphState { UndefinedState ,
141 SuspendErroredState ,
145 NumberOfGraphStates } ;
147 /*! A sequence of string values.
149 typedef sequence<string> ListOfStrings ;
154 interface StreamLink ;
156 typedef sequence<Link> ListOfLinks ;
157 typedef sequence<StreamLink> ListOfStreamLinks ;
160 interface StreamPort ;
162 typedef sequence<Port> ListOfPorts ;
163 typedef sequence<StreamPort> ListOfStreamPorts ;
174 interface StreamGraph ;
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 ;
187 This struct contains fields defining different types of nodes.
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 ;
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
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...).
212 enum ControlState { VoidState ,
213 ToSuspendStartState ,
219 NumberOfControlStates } ;
224 /*! \brief interface %SuperG
226 This interface contains a set of methods necessary for management of a %graph.
228 interface SuperG : Engines::Component, SALOMEDS::Driver {
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 ) ;
237 Constructs a graph with possibility to read/edit it
238 \param aGraph %aGraphName or %aGraphXmlFile
240 SUPERV::Graph Graph(in string aGraph ) ; // aGraphName or aGraphXmlFile
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
248 SUPERV::Graph GraphE(in string aGraph ) ; // aGraphName or aGraphXmlFile
251 Constructs a StreamGraph with possibility to read/edit it
252 \param aGraph %aGraphName or %aGraphXmlFile
254 SUPERV::StreamGraph StreamGraph(in string aGraph ) ; // aGraphName or aGraphXmlFile
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
262 SUPERV::StreamGraph StreamGraphE(in string aGraph ) ; // aGraphName or aGraphXmlFile
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.
268 SUPERV::Value StringValue( in string aString ) ;
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.
273 SUPERV::Value AnyValue( in any anAny ) ;
275 Gets a graph with a definite %IOR
276 \param ior String parameter defining %IOR of the graph.
278 SUPERV::Graph getGraph(in string ior); // get Graph from is IOR
281 Gets a graph with a definite %IOR
282 \param ior String parameter defining %IOR of the graph.
284 SUPERV::StreamGraph getStreamGraph(in string ior); // get Graph from is IOR
286 Returns a duplicate of the object (omniORB4 problem).
288 Object ToObject( in Object anObject ) ;
292 /*! \brief %CNode interface
294 This is a base class of the SUPERVISION module. It contains a set of methods allowing:
296 <li>creating a <b>Computation</b> node and setting its parameters (Name, Author, Comments etc.)
297 <li>checking the current state of the node in the data flow
298 <li>node execution follow-up
299 <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)
304 interface CNode : Engines::Component {
309 Returns the name of the node(graph).
313 Returns the service of this node .
315 SALOME_ModuleCatalog::Service Service() ;
317 Returns the type of the node.
319 SUPERV::KindOfNode Kind() ;
321 Returns the date of creation of the node(graph).
323 SUPERV::SDate CreationDate() ;
325 Returns the date of last update of the node(graph).
327 SUPERV::SDate LastUpdateDate() ;
329 Returns the name of the version of the node(graph).
333 Returns the name of the author of the node(graph).
337 Returns the string containing comments about this node(graph).
343 Sets the name of the node(graph).
344 \param aNewName String value defining the name of the node(graph).
345 \return True if the name has been updated.
347 boolean SetName(in string aNewName ) ;
349 Sets the name of the author. Returns True if it is updated.
350 \param anAuthor String value defining the name of the author.
351 \return True if the name has been updated.
353 boolean SetAuthor(in string anAuthor ) ;
355 Allows to update the comments about this node(graph).
356 \param aComment String value containing a comment to this node(graph).
357 \return True if the old comment has been updated.
359 boolean SetComment(in string aComment ) ;
362 Gets a port of the node (for compatibility : see GetInPort - GetOutPort).
364 SUPERV::Port Port( in string aParameterName ) ;
366 /*! Gets an Input port in a node.
367 \param aParameterName This value sets the name of the parameter which will be defined in this port.
369 SUPERV::Port GetInPort( in string aParameterName ) ;
371 /*! Gets an Output port in a node.
372 \param aParameterName This value sets the name of the parameter which will be defined in this port.
374 SUPERV::Port GetOutPort( in string aParameterName ) ;
376 /*! Gets an Input StreamPort in a node.
377 \param aParameterName This value sets the name of the parameter which will be defined in this port.
379 SUPERV::StreamPort GetInStreamPort( in string aParameterName ) ;
381 /*! Gets an Output StreamPort in a node.
382 \param aParameterName This value sets the name of the parameter which will be defined in this port.
384 SUPERV::StreamPort GetOutStreamPort( in string aParameterName ) ;
387 Returns true if a Node (or Graph) has StreamPorts
389 boolean HasStreamPort() ;
392 Enters a value into an Input %Port
394 SUPERV::Port Input( in string InputParameterName ,
398 Gets a list of ports of the node(graph)
400 SUPERV::ListOfPorts Ports() ;
403 Gets a list of ports of the node(graph)
405 SUPERV::ListOfStreamPorts StreamPorts() ;
407 /*! Gets a list of links of a node(graph)
409 SUPERV::ListOfLinks Links() ;
411 /*! Gets a list of StreamLinks of a node(graph)
413 SUPERV::ListOfStreamLinks StreamLinks() ;
416 Returns True if this node is a graph.
418 boolean IsStreamGraph() ;
420 Returns True if this node is a graph.
425 Returns True if this node is a MacroNode of a DataFlowGraph or a DataStreamGraph.
429 Returns True if this node is a MacroNode of a DataFlowGraph.
431 boolean IsFlowMacro() ;
433 Returns True if this node is a MacroNode of a DataStreamGraph.
435 boolean IsStreamMacro() ;
438 Returns True if this node is a Head Graph .
440 boolean IsHeadGraph() ;
442 Returns the MacroNode Level of this node.
447 Returns True if the node appears to be a %computing node.
449 boolean IsComputing() ;
451 Returns True if the node appears to be a %factory node.
453 boolean IsFactory() ;
455 Returns True if the node appears to be an %inline node.
459 Returns True if the node appears to be a %GOTO node.
463 Returns True if the node appears to be a %loop node.
467 Returns True if the node appears to be an %endloop node.
469 boolean IsEndLoop() ;
471 Returns True if the node appears to be a %switch node.
475 Returns True if the node appears to be a %endswitch node.
477 boolean IsEndSwitch() ;
480 Returns the numero of subgraph of a node.
484 Returns the numero of substreamgraph of a node.
486 long SubStreamGraph() ;
489 Returns the number of threads of the graph.
494 Returns True if the node(graph) is waiting for Data input
496 boolean IsWaiting() ;
499 Returns True if the node(graph) is ready for execution
504 Returns True if the node(graph) is currently running
506 boolean IsRunning() ;
509 Returns True if execution is finished
514 Returns True if execution is suspended
517 boolean IsSuspended() ;
519 Returns the current state of the graph.
521 SUPERV::GraphState State() ;
524 Waits for ready_to_run state, Suspend and return.
528 /*! Waits for running state, Suspend and return.
532 /*! Waits for done state, Suspend and return.
536 /*! Waits for Suspend state and return.
538 boolean SuspendedW() ;
544 If not running : will be killed when ready to run.
545 If running : kills immediatly.
551 Execution will be killed only just after running (only for nodes).
557 If not running : will be stopped when ready to run.
558 If running : stops immediatly
561 /*! Suspends execution.
563 If not running : will be Suspended when ready to run. It is used in step-by-step execution.
564 If running : suspends immediatly
567 /*! Suspends execution only just after running.
569 boolean SuspendDone();
571 /*! Resumes execution.
573 If Suspended : running will be continued.
574 If not Suspended : cancels the current ControlState ( Suspend, Kill, ...)
579 // Control state required : Kill, Suspend, Stop
581 Returns control state of the node(graph).
583 SUPERV::ControlState Control() ;
585 Clears the control state of the node(graph).
587 void ControlClear() ;
589 boolean ContainerKill();
592 Sets the position of the node in the window.
594 void Coords( in long X , in long Y ) ;
596 Returns the position of the node along X-axis.
600 Returns the position of the node along Y-axis.
604 Returns the Cpu used by a node for execution of calculations in seconds.
609 /*! \brief %FNode class
611 This class is necessary for management of factory nodes in a data flow. Besides the inherited methods it contains some methods allowing to define
612 the component from the container, which will be called for execution of the calculation.
615 interface FNode : CNode {
617 /*! Gets the name of the component, which will be called for execution of the calculation.
619 string GetComponentName() ;
620 /*! Gets the name of the interface of the component.
622 string GetInterfaceName() ;
623 /*! Gets the container containing the component, which will be called for execution of the calculation.
625 string GetContainer() ;
626 /*! Sets the name of the component, which will be called for execution of the calculation.
627 \param aComponentName Name of the component.
629 boolean SetComponentName(in string aComponentName ) ;
630 /*! Sets the name of the interface of the component.
631 \param anInterfaceName Name of the interface.
633 boolean SetInterfaceName(in string anInterfaceName ) ;
634 /*! Gets the container containing the component, which will be called for execution of the calculation.
635 \param aContainer Container containing the component.
637 boolean SetContainer(in string aContainer ) ;
639 /*! \brief %INode class
641 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
642 executed for performing calculations, as well as input and output parameters for the node.
646 interface INode : CNode {
649 /*! Sets Python function for the InLine Node.
650 \param FuncName Name of the function
651 \param aPyInitFunction Python initialization function of the InLine Node
653 void SetPyFunction( in string FuncName ,
654 in SUPERV::ListOfStrings aPyInitFunction ) ;
655 /*! Returns Python function of the InLine Node.
657 SUPERV::ListOfStrings PyFunction() ;
658 /*! Returns the name of the Python function of the InLine Node.
660 string PyFuncName() ;
662 /*! Creates an Input port in a node.
663 \param aParameterName This value sets the name of the parameter which will be defined in this port.
664 \param aParameterType This value sets the type of the parameter which will be defined in this port.
666 SUPERV::Port InPort( in string aParameterName , in string aParameterType ) ;
667 /*! Creates an Output port in an Inline node.
668 \param aParameterName This value sets the name of the parameter which will be defined in this port.
669 \param aParameterType This value sets the type of the parameter which will be defined in this port.
671 SUPERV::Port OutPort( in string aParameterName , in string aParameterType ) ;
673 /*! Creates an Input DataStreamPort in an Inline node.
674 \param aParameterName This value sets the name of the parameter which will be defined in this port.
675 \param aParameterType This value sets the type of the parameter which will be defined in this port.
677 SUPERV::StreamPort InStreamPort( in string aParameterName , in SALOME_ModuleCatalog::DataStreamType aParameterType , in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
679 /*! Creates an Output DataStreamPort in an Inline node.
680 \param aParameterName This value sets the name of the parameter which will be defined in this port.
681 \param aParameterType This value sets the type of the parameter which will be defined in this port.
683 SUPERV::StreamPort OutStreamPort( in string aParameterName , in SALOME_ModuleCatalog::DataStreamType aParameterType , in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
686 /*! \brief %GNode class
688 This class is necessary for management of GOTO/EndLoop/EndSwitch nodes in the dataflow.
689 Besides the inherited methods it contains some methods allowing to define the couple node, which will be linked to this one.
691 // GOTO/EndLoop/EndSwitch Nodes
693 interface GNode : INode {
695 /*! Sets the coupled InLine Node to this GOTO/EndLoop/EndSwitch Node.
697 boolean SetCoupled( in string anInLineNode ) ;
698 /*! Returns the coupled InLine Node to this GOTO/EndLoop/EndSwitch Node.
700 SUPERV::INode Coupled() ;
702 /*! %Loop Nodes class
706 interface LNode : GNode {
708 /*! Sets Python Init function of the Loop Node.
709 \param InitName Name of the Init function
710 \param aPyInitFunction Python Init function
712 void SetPyInit( in string InitName ,
713 in SUPERV::ListOfStrings aPyInitFunction ) ;
714 /*! Returns Python Init function of the Loop Node.
716 SUPERV::ListOfStrings PyInit() ;
717 /*! Returns the name of the Python Init function of the Loop Node.
719 string PyInitName() ;
721 /*! Sets Python More function of the Loop Node.
722 \param MoreName Name of the More function
723 \param aPyMoreFunction Python More function
725 void SetPyMore( in string MoreName ,
726 in SUPERV::ListOfStrings aPyMoreFunction ) ;
727 /*! Returns Python More function of the Loop Node.
729 SUPERV::ListOfStrings PyMore() ;
730 /*! Returns the name of the Python More function of the Loop Node.
732 string PyMoreName() ;
734 /*! Sets Python Next function of the Loop Node.
735 \param NextName Name of the Next function
736 \param aPy NextFunction Python Next function
738 void SetPyNext( in string NextName ,
739 in SUPERV::ListOfStrings aPyNextFunction ) ;
741 /*! Returns Python Next function of the Loop Node.
743 SUPERV::ListOfStrings PyNext() ;
744 /*! Returns the name of the Python Next function of the Loop Node.
746 string PyNextName() ;
752 interface ELNode : GNode {
758 interface SNode : GNode {
764 interface ESNode : GNode {
768 /*! \brief Interface of a graph
770 This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
774 interface Graph : GNode {
777 /*! Creates a Computing Node in a Graph.
779 SUPERV::CNode CNode( in SALOME_ModuleCatalog::Service aService ) ;
781 /*! Creates a Factory Node in a Graph.
783 SUPERV::FNode FNode( in string aComponentName ,
784 in string anInterfaceName ,
785 in SALOME_ModuleCatalog::Service aService ) ;
787 /*! Creates an InLine Node in a Graph.
789 SUPERV::INode INode( in string FuncName , in ListOfStrings aPythonFunction ) ;
791 /*! Creates a GOTO Node and links it to the corresponding InLine node.
793 SUPERV::GNode GNode( in string FuncName , in ListOfStrings aPythonFunction ,
794 in string anINode ) ;
796 /*! Creates a Loop Node ("for" or "while" loop) and links it to the corresponding end of loop node.
798 SUPERV::LNode LNode( in string InitName , in ListOfStrings InitFunction ,
799 in string MoreName , in ListOfStrings MoreFunction ,
800 in string NextName , in ListOfStrings NextFunction ,
801 out SUPERV::INode anEndOfLoop ) ;
803 /*! Creates a conditional "if/elseif/else" or "switch" node and the corresponding end node
805 SUPERV::SNode SNode( in string FuncName , in ListOfStrings aPythonFunction ,
806 out SUPERV::INode anEndOfSwitch ) ;
808 /*! Creates a "MacroNode" node which corresponds to a Graph with a xml file
810 SUPERV::Graph MNode( in string aXmlFileName ) ;
812 /*! Creates a "MacroNode" node which corresponds to a Graph with a Graph
814 SUPERV::Graph GraphMNode( in Graph aGraph ) ;
816 /*! Returns a Graph of a "MacroNode" or a "MacroNode" of a Graph
818 SUPERV::Graph FlowObjRef() ;
820 /*! Returns a StreamGraph of a "MacroNode" or a "MacroNode" of a StreamGraph
822 SUPERV::StreamGraph StreamObjRef() ;
824 /*! Returns an existing node with a definite name.
825 \param aNodeName Name of the Node.
827 SUPERV::CNode Node( in string aNodeName ) ;
829 /*! Creates a CORBA Component Object Reference
831 Engines::Component ComponentRef( in string aComputerContainer ,
832 in string aComponentName ) ;
834 /*! Creates a link connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
836 SUPERV::Link Link( in SUPERV::Port OutputPort ,
837 in SUPERV::Port InputPort ) ;
840 Give the last error[s] message[s]
841 \return string[s] corresponding to last error[s].
846 Imports a graph into a file with XML format
847 \param anXmlFile String parameter defining the name of the XML file.
848 \return True, if the graph has been successfully imported.
850 boolean Import( in string anXmlFile ) ;
853 Exports a graph to a file with XML format
854 \param anXmlFile String parameter defining the name of the XML file.
855 \return True, if the graph has been successfully exported.
857 boolean Export( in string anXmlFile ) ;
860 Exports a graph to a string in python format
862 string SavePY( in boolean importSuperV ) ;
865 Returns True if the graph is read Only.
867 boolean IsReadOnly() ;
870 Starts asynchronous execution of the graph.
875 Assigns to the %Node an %Event and a %State of the %Node, if the Event is
876 available. And returns immediately Nil, NoEvent and NoState if not.
877 Returns false if the graph is finished, suspended, killed or stopped.
878 \param aNode %Node for which this method is called
879 \param anEvent An operation, which has been performed on this node(graph).
880 \param aState Current state of the graph
882 boolean EventNoW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
883 out SUPERV::GraphState aState ) ;
886 Assigns to the %Node an %Event and a %State of the %Node, if the Event is
887 available. Waits if it is not available at the current moment.
888 Returns false if the graph is finished, suspended, killed or stopped.
889 \param aNode %Node for which this method is called
890 \param anEvent An operation, which has been performed on this node(graph).
891 \param aState Current state of the graph
893 boolean Event( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
894 out SUPERV::GraphState aState ) ;
896 // Same as Event but execution of the thread is suspended between the
897 // return of EventW and the next call to EventW
899 Assigns to the %Node an %Event and a %State of the %Node, if the Event is
900 available. And returns immediately Nil, NoEvent and NoState if not.
901 Returns false if the graph is finished, suspended, killed or stopped.
902 \note <BR>Execution of the thread is suspended between the return of this
903 method and its next usage.
904 \param aNode %Node for which this method is called
905 \param anEvent An operation, which has been performed on this node(graph).
906 \param aState Current state of the graph
908 boolean EventW( out SUPERV::CNode aNode , out SUPERV::GraphEvent anEvent ,
909 out SUPERV::GraphState aState ) ;
910 /*! \name Methods used for inner debugging purposes of threads management :
916 SUPERV::ListOfNodes LevelNodes( in long aLevel ) ;
922 Returns the number of currently running threads.
926 Returns the number of suspended threads.
928 long SuspendedThreads();
930 Returns True if the graph is valid.
934 Returns True if the graph can be executed.
936 boolean IsExecutable() ;
938 Returns True if the graph is being currently edited.
940 boolean IsEditing() ;
942 Returns True if the graph is being currently executed.
944 boolean IsExecuting() ;
946 long LastLevelDone() ;
949 Launches step-by-step execution of the graph.
950 \note The execution is suspended immediatly after performance of operations of the first node and
951 user can specify the nodes, where execution will be again suspended after its resuming.
955 Allows to copy one graph into another.
957 SUPERV::Graph Copy() ;
959 Convert a FlowGraph to a StreamGraph.
961 SUPERV::StreamGraph ToStreamGraph() ;
965 boolean Merge( in Graph aGraph ) ;
967 Returns a list of nodes of the graph.
969 SUPERV::ListOfNodes Nodes() ;
971 Returns a list of links of the graph.
973 SUPERV::ListOfLinks GLinks() ;
975 Gets IOR of the garph.
980 Returns the number of independent subgraphs
982 long SubGraphsNumber() ;
984 Returns a list of Nodes of a SubGraph.
986 SUPERV::ListOfNodes SubGraphsNodes( in long SubGraphNumber ) ;
988 /*! Forces use of Editor's data model and destroy of Executor
998 /*! \brief Interface of a StreamGraph
1000 This interface includes a set of methods used for management of the graphs in %SUPERVISION module.
1003 /////////////////////
1004 interface StreamGraph : Graph {
1005 /////////////////////
1008 Allows to copy one graph into another.
1010 SUPERV::StreamGraph StreamCopy() ;
1011 /*! Creates a "MacroNode" node which corresponds to a StreamGraph with a xml file
1013 SUPERV::StreamGraph StreamMNode( in string aXmlFileName ) ;
1015 /*! Creates a "MacroNode" node which corresponds to a StreamGraph with a Graph
1017 SUPERV::StreamGraph StreamGraphMNode( in StreamGraph aStreamGraph ) ;
1020 Creates a link connecting two ports (%Output %Port and %Input %Port) of the nodes in a Graph
1022 SUPERV::StreamLink StreamLink( in SUPERV::StreamPort OutputPort ,
1023 in SUPERV::StreamPort InputPort ) ;
1026 Returns a list of links of the graph.
1028 SUPERV::ListOfStreamLinks GStreamLinks() ;
1029 boolean SetStreamParams( in long Timeout ,
1030 in SUPERV::KindOfDataStreamTrace DataStreamTrace ,
1031 in double DeltaTime ) ;
1032 void StreamParams( out long Timeout ,
1033 out SUPERV::KindOfDataStreamTrace DataStreamTrace ,
1034 out double DeltaTime ) ;
1037 Returns the number of independent subStreamgraphs
1039 long SubStreamGraphsNumber() ;
1041 Returns a list of Nodes of a SubStreamGraph.
1043 SUPERV::ListOfNodes SubStreamGraphsNodes( in long SubStreamGraphNumber ) ;
1046 Convert a StreamGraph to a FlowGraph.
1048 SUPERV::Graph ToFlowGraph() ;
1051 Merge a StreamGraph.
1053 boolean StreamMerge( in StreamGraph aStreamGraph ) ;
1062 /*! \brief Interface of the %link
1064 This interface contains a set of methods used for representation and management of the links
1065 connecting nodes in a %graph.
1069 interface Link : Engines::Component {
1072 Returns the %Output %Port of the Link
1074 SUPERV::Port OutPort() ;
1077 Returns the %Input %Port of the Link
1079 SUPERV::Port InPort() ;
1082 /*! \name Methods used for representation of links in GUI of %SALOME application :
1086 Returns the number of coordinate points which are included in the link.
1087 \note <BR>Every link can contain a set of coordinate points which constitute it. These points have
1088 index numbers (beginning from 1) and coordinates defining their position in the window. Indexing of
1089 the points starts from input port to output port of the corresponding link.
1093 Adds a coordinate point to the link.
1094 \param index Index of the point.
1095 \param X Coordinates of the point.
1096 \param Y Coordinates of the point.
1098 boolean AddCoord( in long index , in long X , in long Y ) ;
1100 Changes the location of a definite coordinate point of the link.
1101 \param index Index of the point.
1102 \param X Coordinates of the point.
1103 \param Y Coordinates of the point.
1106 boolean ChangeCoord( in long index , in long X , in long Y ) ;
1108 Removes a coordinate point of the link.
1109 \param index Index of the point.
1112 boolean RemoveCoord( in long index ) ;
1115 Sets the location of a coordinate point of the link.
1116 \param index Index of the point.
1117 \param X Coordinates of the point.
1118 \param Y Coordinates of the point.
1121 boolean Coords( in long index , out long X , out long Y ) ;
1126 /*! Checks if the types of Ports that it connects are compatible
1130 /*! Check if the Link equals to the another given Link
1132 boolean IsEqual( in SUPERV::Link aLink );
1141 /*! \brief Interface of the %link
1143 This interface contains a set of methods used for representation and management of the links
1144 connecting nodes in a %graph.
1147 ////////////////////
1148 interface StreamLink : Link {
1149 ////////////////////
1151 Returns the %Output %StreamPort of the StreamLink
1153 SUPERV::StreamPort OutStreamPort() ;
1156 Returns the %Input %StreamPort of the StreamLink
1158 SUPERV::StreamPort InStreamPort() ;
1167 /*! \brief %Value interface
1169 This interface contains a set of methods used for setting initial parameters of the ports
1173 interface Value : Engines::Component {
1176 Converts the given value into a value of string type.
1180 Converts the given value into a value of independant data type.
1184 Returns True if the value represents an IOR.
1188 Gets data type of the component.
1190 string ComponentDataType() ;
1195 /*! \brief %Port interface
1197 This interface contains a set of methods used for management of the ports.
1201 interface Port : Value {
1205 Gives a value to an Input %Port
1206 \param aValue This parameter defines the input value
1208 boolean Input( in SUPERV::Value aValue ) ;
1211 Returns the node of the port
1213 SUPERV::CNode Node() ;
1215 Sets the name of the port.
1219 /* Gets the type of a port.
1220 \return A string defining the type of a port
1225 // Link of an Input Port
1227 Returns the link of an %Input %Port
1229 SUPERV::Link Link() ;
1232 Returns a list of links of an Input %Port of an EndSwitchNode
1234 SUPERV::ListOfLinks Links() ;
1237 Returns True if this port appears to be an %Input %Port of a Node
1242 Returns True if an %Input %Value exists for that %Input %Port (without link)
1244 boolean HasInput() ;
1247 Returns True if the %Port is linked (without value)
1249 // Port with link (without Value)
1250 boolean IsLinked() ;
1253 /*! Returns the type of this port.
1255 SUPERV::KindOfPort Kind() ;
1257 // Port from the service of the node
1259 Returns True if the %Port is a parameter of a service
1262 // Port is a Gate of the node
1264 Returns True if the %Port appears to be a Gate Port of the Node
1267 // Port is a parameter of an InLineNode
1269 Returns True if the %Port appears to be a parameter of an InLine Node.
1271 boolean IsInLine() ;
1273 // Port is a LoopParameter (InitLoop or DoLoop) of an LoopNode
1275 Returns True if the %Port appears to be a Loop Parameter (InitLoop or DoLoop) of a Loop Node
1278 // Port is an output parameter of a SwitchNode connected to an InGate
1280 Returns True if the %Port appears to be a parameter of a switch node
1282 // Port is a parameter of a switch node
1283 boolean IsSwitch() ;
1284 // Port is an Input parameter of a EndSwitchNode connected to several output ports
1286 Returns True if the %Port appears to be an EndSwitch Node connected to several output ports.
1288 boolean IsEndSwitch() ;
1290 boolean IsDataStream() ;
1292 /*! Returns the current state of the port.
1294 SUPERV::GraphState State() ;
1295 /*! Returns True if computation is finished.
1299 /*! deactivate the objref of a Port when its node is destroyed
1305 ////////////////////
1306 interface StreamPort : Port {
1307 ////////////////////
1309 // Link of a StreamPort
1311 Returns the link of a %StreamPort
1313 SUPERV::StreamLink StreamLink() ;
1315 /*! Returns the current Dependency of the DataStreamPort : TimeDependency or IterationDependency
1317 SALOME_ModuleCatalog::DataStreamDependency Dependency() ;
1318 boolean SetDependency( in SALOME_ModuleCatalog::DataStreamDependency aDependency ) ;
1320 /*! Sets or Returns the current kinds of Schema, Interpolation and Extrapolation of the InDataStreamPort
1322 boolean SetParams( in KindOfSchema aKindOfSchema ,
1323 in KindOfInterpolation aKindOfInterpolation ,
1324 in KindOfExtrapolation aKindOfExtrapolation ) ;
1325 boolean Params( out KindOfSchema aKindOfSchema ,
1326 out KindOfInterpolation aKindOfInterpolation ,
1327 out KindOfExtrapolation aKindOfExtrapolation ) ;
1329 /*! Sets or Returns the current number of values ("NIVEAU") of the OutDataStreamPort
1331 boolean SetNumberOfValues( in long aNumberOfValues ) ;
1332 long NumberOfValues() ;