fwTrending  8.4.1
fwTrendingTree.ctl File Reference

Functions

void TrendTree_navigator_selected (string sNode, string sParent)
 
void TrendTree_editor_selected (string sNode, string sParent)
 
void fwTrendingTree_addToTree (string sParent, string sMode, int &iDone)
 
void fwTrendingTree_showItemInfo (string sNode, string sParent)
 
void TrendTree_navigator_entered (string sNode, string sParent)
 
void TrendTree_editor_entered (string sNode, string sParent)
 
void TrendTree_nodeView (string sNode, string sParent)
 
void TrendTree_nodeSettings (string sNode, string sParent)
 
void TrendTree_nodeParameters (string sNode, string sParent)
 
void fwTrendingTree_checkIfNeedsTemplateParameters (string sNode, string sDevice, string sDeviceType, bool &bIsNeeded, dyn_string &exceptionInfo)
 
void fwTrendingTree_manageTrendingDevices (string sNode)
 
void fwTrendingTree_displayNode (string sNode, string sDevice, string sDeviceType, bool bEditorMode=TRUE)
 
void fwTrendingTree_findInTree (string sDevice, dyn_string &dsParents, dyn_string &dsNodes, dyn_string &exceptionInfo)
 
void fwTrendingTree_showEditorPanel (string sDevice, string sDeviceType, dyn_string &exceptionInfo)
 
void fwTrendingTree_showNavigatorPanel (string sDevice, string sDeviceType, string sTemplateParameters, dyn_string &exceptionInfo)
 
void _fwTrendingTree_addClipboard ()
 
void _fwTrendingTree_upgradeTree ()
 
void _fwTrendingTree_addSystemNameRecursive (string sNode)
 
void fwTrendingTree_getTemplateParameters (string sDevice, string &sParameterString, dyn_string &exceptionInfo)
 
void TrendTree_save_as_selected (string sNode, string sParent)
 
void TrendTree_save_as_entered (string sNode, string sParent)
 

Detailed Description

This library contains the functions required by the Trending Tree

Creation Date
04/11/04
Modification History
None
Constraints
Some functions rely on the fwTree and some require the Trending Editor and Navigator panel
Usage
Internal
PVSS managers
VISION
Author
Oliver Holme (IT-CO), Marco Boccioli (EN-ICE), Jonas Arroyo (EN-ICE)

Function Documentation

void TrendTree_navigator_selected ( string  sNode,
string  sParent 
)
TrendTree_navigator_selected

Function that is called when the user selects an item in the Trend Tree (Navigator mode)

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_editor_selected ( string  sNode,
string  sParent 
)
TrendTree_editor_selected

Function that is called when the user selects an item in the Trend Tree (Editor mode)

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void fwTrendingTree_addToTree ( string  sParent,
string  sMode,
int &  iDone 
)
Function that is called when the user chooses to Add an item in the Trend Tree (Editor mode)

Adapted from generic function in fwTreeDisplay.ctl

Constraints
Uses global variables: FwTreeTypes[], FwTreeNames[], FwActiveTrees[] and CurrTreeIndex
Usage
Internal
PVSS managers
VISION
Parameters
sParentinput, name of the parent of the node to be created
sModeinput, the type of addition. Can be one of:
  • "addnode" Add an emtpy node to the tree
  • "addnew" Create a new device (plot or page) and create a new node to add it in the tree
  • "addexisting" Create a new node to link to an existing device (plot or page)
iDoneoutput, value is 1 if the node was created, 0 if the process was stopped before creation
void fwTrendingTree_showItemInfo ( string  sNode,
string  sParent 
)
Function that displays the information about the currently selected node in the Trending Editor & Navigator
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_navigator_entered ( string  sNode,
string  sParent 
)
TrendTree_navigator_entered 

Function that is called when the user right-clicks an item in the Trend Tree (Navigator mode) It displays a contextual menu with the ncessary options for the selected device in the current mode.

Adapted from generic function in fwTreeDisplay.ctl

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_editor_entered ( string  sNode,
string  sParent 
)
TrendTree_editor_entered

Function that is called when the user right-clicks an item in the Trend Tree (Editor mode) It displays a contextual menu with the ncessary options for the selected device in the current mode.

Adapted from generic function in fwTreeDisplay.ctl

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_nodeView ( string  sNode,
string  sParent 
)
Function that is called when the user selects View from the contextual menu in the Trend Tree (Navigator mode)

Adapted from generic function in fwTreeDisplay.ctl

Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_nodeSettings ( string  sNode,
string  sParent 
)
TrendTree_nodeSettings

Function that is called when the user selects Settings from the contextual menu in the Trend Tree (Editor mode)

Adapted from generic function in fwTreeDisplay.ctl

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_nodeParameters ( string  sNode,
string  sParent 
)
TrendTree_nodeParameters

Function that is called when the user selects Template Parameters from the contextual menu in the Trend Tree (Editor mode) Reads any existing settings from the node user data and then lets the user modify the values for any required parameters. This modified value is then saved back to the user data.

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void fwTrendingTree_checkIfNeedsTemplateParameters ( string  sNode,
string  sDevice,
string  sDeviceType,
bool &  bIsNeeded,
dyn_string &  exceptionInfo 
)
Checks if any template parameters are mentioned in the configuration for the given node/device in the tree.
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sDeviceinput, name of the device attached to the node
sDeviceTypeinput, dp type of the device attached to the node
bIsNeededoutput, TRUE if any template parameters are mentioned in configuration, else FALSE
exceptionInfoAny exceptions are returned here
void fwTrendingTree_manageTrendingDevices ( string  sNode)
Function that is called when the user selects "Manage Plots and Pages..." from the contextual menu in the Trend Tree (Editor mode)
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, used to determine the panel title and also passed as $ parameter to panel (but this is not used by the panel)
void fwTrendingTree_displayNode ( string  sNode,
string  sDevice,
string  sDeviceType,
bool  bEditorMode = TRUE 
)
Function that is used to show either the editor or navigator panel for a specific tree node
Constraints
Only works for devices other than tree nodes (i.e. TrendingPages or TrendingPlots)
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, the currently selected node in the tree
sDeviceinput, the name of the device attached to the selected node
sDeviceTypeinput, the dpType of the device attached to the selected node
bEditorModeOptional parameter, default value TRUE. TRUE to display editor panel, FALSE to show navigator panel.
void fwTrendingTree_findInTree ( string  sDevice,
dyn_string &  dsParents,
dyn_string &  dsNodes,
dyn_string &  exceptionInfo 
)
Finds all the occurences of a given device tree
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sDeviceinput, the device to search for
sParentsinput, a list of parents of the nodes to which the device is attached
sNodesinput, a list of the nodes to which the device is attached
exceptionInfoAny exceptions are returned here
void fwTrendingTree_showEditorPanel ( string  sDevice,
string  sDeviceType,
dyn_string &  exceptionInfo 
)
Shows the editor panel for the given device (panel to be shown is read from device definitions)
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sDeviceinput, the device to open the panel for
sDeviceTypeinput, the dpType of the device
exceptionInfoAny exceptions are returned here
void fwTrendingTree_showNavigatorPanel ( string  sDevice,
string  sDeviceType,
string  sTemplateParameters,
dyn_string &  exceptionInfo 
)
Shows the navigator panel for the given device (panel to be shown is read from device definitions)
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sDeviceinput, the device to open the panel for
sDeviceTypeinput, the dpType of the device
sTemplateParametersinput, any template parameters for the device are passed here
exceptionInfoAny exceptions are returned here
void _fwTrendingTree_addClipboard ( )
Adds a clipboard to the Trend Tree
Constraints
Only needs to be run once
Usage
Internal
PVSS managers
VISION
void _fwTrendingTree_upgradeTree ( )
Upgrades old trees to the new format of tree (new format as of fwTrending2.3)
Constraints
Should only be run once
Usage
Internal
PVSS managers
VISION
void _fwTrendingTree_addSystemNameRecursive ( string  sNode)
Goes through old trees and adds the system name to any device references that do not contain the system name
Constraints
If not system name is specified, it is assumed that the device is on the local system
Usage
Internal
PVSS managers
VISION
Parameters
nodeUsed to recursively work through the tree. Give the name of the top node of the tree
void fwTrendingTree_getTemplateParameters ( string  sDevice,
string &  sParameterString,
dyn_string &  exceptionInfo 
)
For a given device connected to a tree node, this function will check if any template parameters are required.

If so, a dialog is shown and the user can enter values for the template parameters (or choose not to). This string is then returned by the function, and the value should then be stored in the userData of the relevant data.

Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
deviceinput, the device to look at for template parameters
parameterStringoutput, any template parameters that were configured by the user are returned here
exceptionInfoAny exceptions are returned here
void TrendTree_save_as_selected ( string  sNode,
string  sParent 
)
TrendTree_save_as_selected

Function that is called when the user clicks on an item in the Trend Tree (save_as mode) It will check if node tree selected is a Trending node (neither Plot or Page), and will selected it.

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node
void TrendTree_save_as_entered ( string  sNode,
string  sParent 
)
TrendTree_save_as_entered

Function that is called when the user right-clicks an item in the Trend Tree (save_as mode) It displays a contextual menu with the ncessary options for the selected device in the current mode.

Reviewed:
2018-06-22 Callback
Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
sNodeinput, name of the selected node
sParentinput, name of the parent of the selected node