fwNode  8.4.0
fwNode.ctl File Reference
 fwNode_initialize ()
 
 _fwNode_create (string nodeNameOrAlias, string parentAlias, string nodeType, dyn_string editorPanels, dyn_string navigatorPanels, dyn_string childrenDpTypes, dyn_string &exceptionInfo)
 
 fwNode_createLogical (string nodeAlias, string parentAlias, dyn_string editorPanels, dyn_string navigatorPanels, dyn_string &exceptionInfo)
 
 fwNode_createVendor (string nodeName, dyn_string editorPanels, dyn_string navigatorPanels, dyn_string childrenDpTypes, dyn_string &exceptionInfo)
 
 fwNode_getDpTypes (string nodeDpName, dyn_string &nodeDpTypes, dyn_string &exceptionInfo)
 
 fwNode_setDpTypes (string nodeDpName, dyn_string nodeDpTypes, dyn_string &exceptionInfo)
 
 fwNode_getNodes (string systemName, string nodeType, dyn_string &nodes, dyn_string &exceptionInfo)
 
 fwNode_getPanels (string nodeDpName, string mode, dyn_string &panels, dyn_string &exceptionInfo)
 
 fwNode_getType (string nodeDpName, string &nodeType, dyn_string &exceptionInfo)
 
 fwNode_setType (string nodeDpName, string nodeType, dyn_string &exceptionInfo)
 

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_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_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
nodeTypetype 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
editorPanelspanels to be used when the node is selected in the Editor mode
navigatorPanelspanels to be used when the node is selected in the Navigator mode
childrenDpTypesin the case of a vendor node, dp types that can be created
exceptionInfodetails 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
nodeAliasdatapoint alias of the node. The node name will be of the form FwNodeXXXXXX, where XXXXXX is a sequential number
parentAliasdatapoint alias of the parent in the logical view
editorPanelspanels to be used when the node is selected in the Editor mode
navigatorPanelspanels to be used when the node is selected in the Navigator mode
exceptionInfodetails 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
nodeNamename of the node
editorPanelspanels to be used when the node is selected in the Editor mode
navigatorPanelspanels to be used when the node is selected in the Navigator mode
childrenDpTypesin the case of a vendor node, dp types that can be created
exceptionInfodetails 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
nodeDpNamethe datapoint name of the node
nodeDpTypesreturns the datapoint types that can be created as children of the vendor node
exceptionInfodetails of any exceptions are returned here
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
nodeDpNamethe datapoint name of the node
nodeDpTypesthe datapoint types that can be created as children of the vendor node
exceptionInfodetails 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
systemNamename of the system that we are interested in
nodeTypenode type we are interested in: -fwNode_TYPE_VENDOR -fwNode_TYPE_LOGICAL -fwNode_TYPE_LOGICAL_ROOT -fwNode_TYPE_LOGICAL_DELETED_ROOT -fwNode_TYPE_ALL
nodesreturns the nodes of the specified type in the specified system
exceptionInfodetails 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
nodeDpNamethe datapoint name of the node
modewhich mode we are interested in
panelsreturns the requested panels
exceptionInfodetails 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
nodeDpNamethe datapoint name of the node
nodeTypereturns the node type
exceptionInfodetails 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
nodeDpNamethe datapoint name of the node
nodeTypethe node type to be set
exceptionInfodetails of any exceptions are returned here