SUPERV.CNode Interface Reference

CNode interface More...

import "SUPERV.idl";

Inheritance diagram for SUPERV.CNode:


Public Member Functions
string	Name ()
SALOME_ModuleCatalog::Service	Service ()
SUPERV::KindOfNode	Kind ()
SUPERV::SDate	CreationDate ()
SUPERV::SDate	LastUpdateDate ()
string	Version ()
string	Author ()
string	Comment ()
boolean	SetName (in string aNewName)
boolean	SetAuthor (in string anAuthor)
boolean	SetComment (in string aComment)
SUPERV::Port	Port (in string aParameterName)
SUPERV::Port	GetInPort (in string aParameterName)
SUPERV::Port	GetOutPort (in string aParameterName)
SUPERV::StreamPort	GetInStreamPort (in string aParameterName)
SUPERV::StreamPort	GetOutStreamPort (in string aParameterName)
boolean	HasStreamPort ()
SUPERV::Port	Input (in string InputParameterName, in Value aValue)
SUPERV::ListOfPorts	Ports ()
SUPERV::ListOfStreamPorts	StreamPorts ()
SUPERV::ListOfLinks	Links ()
SUPERV::ListOfStreamLinks	StreamLinks ()
boolean	IsStreamGraph ()
boolean	IsGraph ()
boolean	IsMacro ()
boolean	IsFlowMacro ()
boolean	IsStreamMacro ()
boolean	IsHeadGraph ()
long	GraphLevel ()
boolean	IsComputing ()
boolean	IsFactory ()
boolean	IsInLine ()
boolean	IsGOTO ()
boolean	IsLoop ()
boolean	IsEndLoop ()
boolean	IsSwitch ()
boolean	IsEndSwitch ()
long	SubGraph ()
long	SubStreamGraph ()
long	Thread ()
boolean	IsWaiting ()
boolean	IsReady ()
boolean	IsRunning ()
boolean	IsDone ()
boolean	IsSuspended ()
SUPERV::GraphState	State ()
boolean	ReadyW ()
boolean	RunningW ()
boolean	DoneW ()
boolean	SuspendedW ()
boolean	Kill ()
boolean	KillDone ()
boolean	Stop ()
boolean	Suspend ()
boolean	SuspendDone ()
boolean	Resume ()
SUPERV::ControlState	Control ()
void	ControlClear ()
boolean	ContainerKill ()
void	Coords (in long X, in long Y)
long	X ()
long	Y ()
long	CpuUsed ()

Detailed Description

This is a base class of the SUPERVISION module. It contains a set of methods allowing:

creating a Computation node and setting its parameters (Name, Author, Comments etc.)
checking the current state of the node in the data flow
node execution follow-up
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)

Member Function Documentation

string SUPERV.CNode.Name ( )

Returns the name of the node(graph).

SALOME_ModuleCatalog::Service SUPERV.CNode.Service ( )

Returns the service of this node .

SUPERV::KindOfNode SUPERV.CNode.Kind ( )

Returns the type of the node.

SUPERV::SDate SUPERV.CNode.CreationDate ( )

Returns the date of creation of the node(graph).

SUPERV::SDate SUPERV.CNode.LastUpdateDate ( )

Returns the date of last update of the node(graph).

string SUPERV.CNode.Version ( )

Returns the name of the version of the node(graph).

string SUPERV.CNode.Author ( )

Returns the name of the author of the node(graph).

string SUPERV.CNode.Comment ( )

Returns the string containing comments about this node(graph).

boolean SUPERV.CNode.SetName ( in string aNewName )

Sets the name of the node(graph).
Parameters:

aNewName String value defining the name of the node(graph).

Returns:
True if the name has been updated.

boolean SUPERV.CNode.SetAuthor ( in string anAuthor )

Sets the name of the author. Returns True if it is updated.
Parameters:

anAuthor String value defining the name of the author.

Returns:
True if the name has been updated.

boolean SUPERV.CNode.SetComment ( in string aComment )

Allows to update the comments about this node(graph).
Parameters:

aComment String value containing a comment to this node(graph).

Returns:
True if the old comment has been updated.

SUPERV::Port SUPERV.CNode.Port ( in string aParameterName )

Gets a port of the node (for compatibility : see GetInPort - GetOutPort).

SUPERV::Port SUPERV.CNode.GetInPort ( in string aParameterName )

Gets an Input port in a node.
Parameters:

aParameterName This value sets the name of the parameter which will be defined in this port.

SUPERV::Port SUPERV.CNode.GetOutPort ( in string aParameterName )

Gets an Output port in a node.
Parameters:

aParameterName This value sets the name of the parameter which will be defined in this port.

SUPERV::StreamPort SUPERV.CNode.GetInStreamPort ( in string aParameterName )

Gets an Input StreamPort in a node.
Parameters:

aParameterName This value sets the name of the parameter which will be defined in this port.

SUPERV::StreamPort SUPERV.CNode.GetOutStreamPort ( in string aParameterName )

Gets an Output StreamPort in a node.
Parameters:

aParameterName This value sets the name of the parameter which will be defined in this port.

boolean SUPERV.CNode.HasStreamPort ( )

Returns true if a Node (or Graph) has StreamPorts

SUPERV::Port SUPERV.CNode.Input ( in string InputParameterName,

in Value aValue

)

Enters a value into an Input Port

SUPERV::ListOfPorts SUPERV.CNode.Ports ( )

Gets a list of ports of the node(graph)

SUPERV::ListOfStreamPorts SUPERV.CNode.StreamPorts ( )

Gets a list of ports of the node(graph)

SUPERV::ListOfLinks SUPERV.CNode.Links ( )

Gets a list of links of a node(graph)

SUPERV::ListOfStreamLinks SUPERV.CNode.StreamLinks ( )

Gets a list of StreamLinks of a node(graph)

boolean SUPERV.CNode.IsStreamGraph ( )

Returns True if this node is a graph.

boolean SUPERV.CNode.IsGraph ( )

Returns True if this node is a graph.

boolean SUPERV.CNode.IsMacro ( )

Returns True if this node is a MacroNode of a DataFlowGraph or a DataStreamGraph.

boolean SUPERV.CNode.IsFlowMacro ( )

Returns True if this node is a MacroNode of a DataFlowGraph.

boolean SUPERV.CNode.IsStreamMacro ( )

Returns True if this node is a MacroNode of a DataStreamGraph.

boolean SUPERV.CNode.IsHeadGraph ( )

Returns True if this node is a Head Graph .

long SUPERV.CNode.GraphLevel ( )

Returns the MacroNode Level of this node.

boolean SUPERV.CNode.IsComputing ( )

Returns True if the node appears to be a computing node.

boolean SUPERV.CNode.IsFactory ( )

Returns True if the node appears to be a factory node.

boolean SUPERV.CNode.IsInLine ( )

Returns True if the node appears to be an inline node.

boolean SUPERV.CNode.IsGOTO ( )

Returns True if the node appears to be a GOTO node.

boolean SUPERV.CNode.IsLoop ( )

Returns True if the node appears to be a loop node.

boolean SUPERV.CNode.IsEndLoop ( )

Returns True if the node appears to be an endloop node.

boolean SUPERV.CNode.IsSwitch ( )

Returns True if the node appears to be a switch node.

boolean SUPERV.CNode.IsEndSwitch ( )

Returns True if the node appears to be a endswitch node.

long SUPERV.CNode.SubGraph ( )

Returns the numero of subgraph of a node.

long SUPERV.CNode.SubStreamGraph ( )

Returns the numero of substreamgraph of a node.

long SUPERV.CNode.Thread ( )

Returns the number of threads of the graph.

boolean SUPERV.CNode.IsWaiting ( )

Returns True if the node(graph) is waiting for Data input

boolean SUPERV.CNode.IsReady ( )

Returns True if the node(graph) is ready for execution

boolean SUPERV.CNode.IsRunning ( )

Returns True if the node(graph) is currently running

boolean SUPERV.CNode.IsDone ( )

Returns True if execution is finished

boolean SUPERV.CNode.IsSuspended ( )

Returns True if execution is suspended

SUPERV::GraphState SUPERV.CNode.State ( )

Returns the current state of the graph.

boolean SUPERV.CNode.ReadyW ( )

Waits for ready_to_run state, Suspend and return.

boolean SUPERV.CNode.RunningW ( )

Waits for running state, Suspend and return.

boolean SUPERV.CNode.DoneW ( )

Waits for done state, Suspend and return.

boolean SUPERV.CNode.SuspendedW ( )

Waits for Suspend state and return.

boolean SUPERV.CNode.Kill ( )

Kills execution.
If not running : will be killed when ready to run. If running : kills immediatly.

boolean SUPERV.CNode.KillDone ( )

Kills execution.
Execution will be killed only just after running (only for nodes).

boolean SUPERV.CNode.Stop ( )

Stops execution.
If not running : will be stopped when ready to run. If running : stops immediatly

boolean SUPERV.CNode.Suspend ( )

Suspends execution.
If not running : will be Suspended when ready to run. It is used in step-by-step execution. If running : suspends immediatly

boolean SUPERV.CNode.SuspendDone ( )

Suspends execution only just after running.

boolean SUPERV.CNode.Resume ( )

Resumes execution.
If Suspended : running will be continued. If not Suspended : cancels the current ControlState ( Suspend, Kill, ...)

SUPERV::ControlState SUPERV.CNode.Control ( )

Returns control state of the node(graph).

void SUPERV.CNode.ControlClear ( )

Clears the control state of the node(graph).

boolean SUPERV.CNode.ContainerKill ( )

void SUPERV.CNode.Coords ( in long X,

in long Y

)

Sets the position of the node in the window.

long SUPERV.CNode.X ( )

Returns the position of the node along X-axis.

long SUPERV.CNode.Y ( )

Returns the position of the node along Y-axis.

long SUPERV.CNode.CpuUsed ( )

Returns the Cpu used by a node for execution of calculations in seconds.

SUPERV.CNode Interface Reference

Public Member Functions

Detailed Description

Member Function Documentation