Main Page | File List | File Members

fwNode.ctl File Reference


Detailed Description

Creation Date
15/07/2003
Modification history
Constraints
The function fwNode_initialize() has to be called before creating any logical node.
Author:
Manuel Gonzalez Berges (IT-CO)

Function Documentation

_fwNode_create string  nodeNameOrAlias,
string  parentAlias,
string  nodeType,
dyn_string  editorPanels,
dyn_string  navigatorPanels,
dyn_string  childrenDpTypes,
dyn_string &  exceptionInfo
 

Creates a Framework node (dp type FwNode) of the selected type and configures it with the specified parameters.

Constraints
None
Usage
Private
PVSS managers
VISION, CTRL
Parameters:
nodeNameOrAlias 
parentAlias 
nodeType type of the node. Currently the following types are supported: -fwNode_TYPE_VENDOR: root nodes in the hardware view -fwNode_TYPE_LOGICAL_ROOT: root nodes in the logical view -fwNode_TYPE_LOGICAL: normal nodes in the logical view
editorPanels panels to be used when the node is selected in the Editor mode
navigatorPanels panels to be used when the node is selected in the Navigator mode
childrenDpTypes in the case of a vendor node, dp types that can be created
exceptionInfo details of any exceptions are returned here

fwNode_createLogical string  nodeAlias,
string  parentAlias,
dyn_string  editorPanels,
dyn_string  navigatorPanels,
dyn_string &  exceptionInfo
 

Creates a Framework logical node and configures it with the specified parameters. If no parent is specified, then it will be a logical root node.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
nodeAlias datapoint alias of the node. The node name will be of the form FwNodeXXXXXX, where XXXXXX is a sequential number
parentAlias datapoint alias of the parent in the logical view
editorPanels panels to be used when the node is selected in the Editor mode
navigatorPanels panels to be used when the node is selected in the Navigator mode
exceptionInfo details of any exceptions are returned here

fwNode_createVendor string  nodeName,
dyn_string  editorPanels,
dyn_string  navigatorPanels,
dyn_string  childrenDpTypes,
dyn_string &  exceptionInfo
 

Creates a Framework vendor node and configures it with the specified parameters. This nodes appear as root in the hardware view.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
nodeName name of the node
editorPanels panels to be used when the node is selected in the Editor mode
navigatorPanels panels to be used when the node is selected in the Navigator mode
childrenDpTypes in the case of a vendor node, dp types that can be created
exceptionInfo details of any exceptions are returned here

fwNode_getDpTypes string  nodeDpName,
dyn_string &  nodeDpTypes,
dyn_string &  exceptionInfo
 

If the node passed is of type fwNode_TYPE_VENDOR, the function returns the possible children datapoint types.

Constraints
Usage
Public
PVSS managers
CTRL, VISION
Parameters:
nodeDpName the datapoint name of the node
nodeDpTypes returns the datapoint types that can be created as children of the vendor node
exceptionInfo details of any exceptions are returned here

fwNode_getNodes string  systemName,
string  nodeType,
dyn_string &  nodes,
dyn_string &  exceptionInfo
 

Gets all the nodes of the specified type in the specified system

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
systemName name of the system that we are interested in
nodeType node type we are interested in: -fwNode_TYPE_VENDOR -fwNode_TYPE_LOGICAL -fwNode_TYPE_LOGICAL_ROOT -fwNode_TYPE_LOGICAL_DELETED_ROOT -fwNode_TYPE_ALL
nodes returns the nodes of the specified type in the specified system
exceptionInfo details of any exceptions are returned here

fwNode_getPanels string  nodeDpName,
string  mode,
dyn_string &  panels,
dyn_string &  exceptionInfo
 

Gets panels associated with a given datapoint of type FwNode.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
nodeDpName the datapoint name of the node
mode which mode we are interested in
panels returns the requested panels
exceptionInfo details of any exceptions are returned here

fwNode_getType string  nodeDpName,
string &  nodeType,
dyn_string &  exceptionInfo
 

Gets node type of a given datapoint. If the datapoint is not of type FwNode, an exception is raised.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
nodeDpName the datapoint name of the node
nodeType returns the node type
exceptionInfo details of any exceptions are returned here

fwNode_initialize  ) 
 

This function has to be called before creting any logical node. It initializes teh sequence numbers to be used for the node names.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL

fwNode_setDpTypes string  nodeDpName,
dyn_string  nodeDpTypes,
dyn_string &  exceptionInfo
 

If the node passed is of type fwNode_TYPE_VENDOR, the function sets the possible children datapoint types.

Constraints
Usage
Public
PVSS managers
CTRL, VISION
Parameters:
nodeDpName the datapoint name of the node
nodeDpTypes the datapoint types that can be created as children of the vendor node
exceptionInfo details of any exceptions are returned here

fwNode_setType string  nodeDpName,
string  nodeType,
dyn_string &  exceptionInfo
 

Sets node type of a given datapoint. If the datapoint is not of type FwNode, an exception is raised.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
nodeDpName the datapoint name of the node
nodeType the node type to be set
exceptionInfo details of any exceptions are returned here


Generated on Sat Feb 11 15:52:34 2006 by doxygen 1.3.5