fwTrending
8.4.1
|
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) |
This library contains the functions required by the Trending Tree
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 | ||
) |
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
sParent | input, name of the parent of the node to be created |
sMode | input, the type of addition. Can be one of:
|
iDone | output, 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
sNode | input, name of the selected node |
sParent | input, 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
sNode | input, name of the selected node |
sParent | input, 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
sNode | input, name of the selected node |
sParent | input, 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
sNode | input, name of the selected node |
sParent | input, 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
sNode | input, name of the selected node |
sParent | input, 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.
sNode | input, name of the selected node |
sParent | input, 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.
sNode | input, name of the selected node |
sDevice | input, name of the device attached to the node |
sDeviceType | input, dp type of the device attached to the node |
bIsNeeded | output, TRUE if any template parameters are mentioned in configuration, else FALSE |
exceptionInfo | Any 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)
sNode | input, 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
sNode | input, the currently selected node in the tree |
sDevice | input, the name of the device attached to the selected node |
sDeviceType | input, the dpType of the device attached to the selected node |
bEditorMode | Optional 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
sDevice | input, the device to search for |
sParents | input, a list of parents of the nodes to which the device is attached |
sNodes | input, a list of the nodes to which the device is attached |
exceptionInfo | Any 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)
sDevice | input, the device to open the panel for |
sDeviceType | input, the dpType of the device |
exceptionInfo | Any 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)
sDevice | input, the device to open the panel for |
sDeviceType | input, the dpType of the device |
sTemplateParameters | input, any template parameters for the device are passed here |
exceptionInfo | Any exceptions are returned here |
void _fwTrendingTree_addClipboard | ( | ) |
Adds a clipboard to the Trend Tree
void _fwTrendingTree_upgradeTree | ( | ) |
Upgrades old trees to the new format of tree (new format as of fwTrending2.3)
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
node | Used 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.
device | input, the device to look at for template parameters |
parameterString | output, any template parameters that were configured by the user are returned here |
exceptionInfo | Any 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.
sNode | input, name of the selected node |
sParent | input, 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.
sNode | input, name of the selected node |
sParent | input, name of the parent of the selected node |