Main Page | File List | File Members

fwDeviceEditorNavigator.ctl File Reference


Detailed Description

This library contains the functions needed by the Device Editor and Navigator. The tool displays all the devices of the system in a hierarchical way. It also allows to browse through them to display operation and configuration information.

Creation Date
31/10/2001
Modification History
Constraints
Requires the fwTreeView and fwGeneral components of the Framework installed.
Usage
Private
PVSS managers
VISION
Author:
Manuel Gonzalez Berges (IT-CO)

Function Documentation

_fwDeviceEditorNavigator_getModuleGeometry int  uiNumber,
string  reqModuleName,
dyn_int &  geometry,
dyn_string &  exceptionInfo
 

Returns the geometry of a given module in a given user interface.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
uiNumber manager number of the UI we are interested in
reqModuleName name of the module we are interested in
geometry returns the geometry of the module
exceptionInfo details of any exceptions are returned here

_fwDeviceEditorNavigator_getStatus string  device,
dyn_bool &  status,
dyn_string &  exceptionInfo
 

Returns current status of the Device Editor & Navigator. Currently this comprises: -whether a local or a remote system is selected -whether edit is possible Also the global variable (g_fwDEN_selectedSystem) with the current selected system is updated.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
device device dp name or dp alias
status array with current status -status[fwDEN_STATUS_LOCAL]: whether we are in the local system or not -status[fwDEN_STATUS_EDIT]: whether we are in Editor mode or not.
exceptionInfo details of any exceptions are returned here

fwDeviceEditorNavigator_callCommand string  command,
dyn_string  selectedNode,
dyn_string &  exceptionInfo
 

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
command 
selectedNode 
exceptionInfo returns details of any exceptions

fwDeviceEditorNavigator_displayAssociatedDevicePanel string  deviceDpName,
string  hierarchyType,
string  mode,
dyn_string &  exceptionInfo
 

This function will display the device panel for the current context in the device area of the Editor/Navigator.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
deviceDpName DP name of the device to display
hierarchyType hierarchy we are interested in -fwDevice_HARDWARE -fwDevice_LOGICAL
mode editor or navigator mode
exceptionInfo returns details of any exception

fwDeviceEditorNavigator_displayDevicePanel string  panel,
string  dpName,
string  hierarchyType,
dyn_string &  exceptionInfo
 

Displays the panel associated with the selected device in the current hierarchy.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
panel panel to display
dpName dp name of the device
hierarchyType 
exceptionInfo returns details of any exception

fwDeviceEditorNavigator_executeCommand string  dpe1,
string  command,
string  dpe2,
dyn_string  selectedNode
 

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
dpe1 
command 
dpe2 
selectedNode 

fwDeviceEditorNavigator_expandTree unsigned  initialPos,
string  referenceName = ""
 

This function expands the selected node with the children devices.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
initialPos position of the node in the TreeView to expand
referenceName name given to the Tree View panel (fwTreeView.pnl) when inserted as a reference.

fwDeviceEditorNavigator_init  ) 
 

This function has to be called at initialization of the Device Editor & Navigator It will set a dpConnect so that it is possible to execute the callback commands

Constraints
Usage
Private
PVSS managers
VISION

fwDeviceEditorNavigator_initTreeHardware  ) 
 

This function initializes the tree with the first level of the hierarchy of devices

Constraints
Usage
Private
PVSS managers
VISION

fwDeviceEditorNavigator_initTreeHardwareSelect  ) 
 

This function initializes the tree with the first level of the hierarchy of devices

Constraints
Usage
Private
PVSS managers
VISION

fwDeviceEditorNavigator_initTreeLogical  ) 
 

This function initializes the tree with the first level of the hierarchy of devices

Constraints
Usage
Private
PVSS managers
VISION

fwDeviceEditorNavigator_initTreeLogicalClipboard  ) 
 

This function initializes the tree with the first level of the hierarchy of devices

Constraints
Usage
Private
PVSS managers
VISION

fwDeviceEditorNavigator_openRootModule dyn_string &  exceptionInfo,
int  offsetX = 0,
int  offsetY = 0
 

Modification History:

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
exceptionInfo returns details of any exceptions
offsetX offset in the x direction to place device module
offsetY offset in the y direction to place device module

fwDeviceEditorNavigator_pasteLogical dyn_string  destDevice,
dyn_string  pastedDevice,
dyn_string &  exceptionInfo
 

Function to paste a device (pastedDevice) and its children as child of another device (destDevice) in the logical hierarchy

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
destDevice destination device object
pastedDevice pasted device object
exceptionInfo details of any exceptions are returned here

int fwDeviceEditorNavigator_refreshRootNode int  position,
string  systemName,
string  treeType,
dyn_string &  exceptionInfo,
string  referenceName = ""
 

This function is used to refresh the root node of the hierarchy at initialization or when the user clicks on it.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
position position of the node in the tree
systemName system to be refreshed. If empty then refresh all systems
treeType the following types are possible: -fwDevice_HARDWARE -fwDevice_HARDWARE_SELECT -fwDevice_LOGICAL -fwDevice_LOGICAL_CLIPBOARD
exceptionInfo returns details of any exceptions
referenceName name given to the Tree View panel (fwTreeView.pnl) when inserted as a reference.

fwDeviceEditorNavigator_rightClickHardware unsigned  pos  ) 
 

This function is called when the user right clicks in one of the devices in the TreeView. It allows the user to perform the following operations:

-expand a node -copy a reference to the selected device -paste a reference to the device in the clipboard from the selected device -remove a reference to the selected device from the current context

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
pos position of the selected node in the TreeView

fwDeviceEditorNavigator_rightClickLogical unsigned  pos  ) 
 

This function is called when the user right clicks in one of the devices in the TreeView. It allows the user to perform the following operations:

-expand a node -copy a reference to the selected device -paste a reference to the device in the clipboard from the selected device -remove a reference to the selected device from the current context

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
pos position of the selected node in the TreeView

fwDeviceEditorNavigator_rightClickLogicalClipboard unsigned  pos  ) 
 

This function is called when the user right clicks in one of the devices in the TreeView.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
pos position of the selected node in the TreeView

fwDeviceEditorNavigator_selectNode unsigned  pos  ) 
 

This function will display in the device area of the Editor/Navigator the information corresponding to the selected device in the hierarchy. This includes: the device name, the device label, the parent label, the device panel for the current context and the list of panels for the current mode (Editor or Navigator).

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
pos position of the selected node in the TreeView

fwDeviceEditorNavigator_setMode string  newMode,
bool  changePossible,
dyn_string &  exceptionInfo
 

Set the running mode of the Device Editor & Navigator.

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
newMode new mode to be set for the Device Editor and navigator
changePossible whether the button to change the mode should be enabled or not
exceptionInfo returns details of any exceptions

fwDeviceEditorNavigator_testExpand unsigned  pos  ) 
 

Function used to test the expand event in a DEM tree

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
pos position to be expanded in the tree

fwDeviceEditorNavigator_testSelect unsigned  pos  ) 
 

Function used to test the select event in a DEM tree

Constraints
Usage
Private
PVSS managers
VISION
Parameters:
pos position selected in the tree


Generated on Sat Feb 11 16:06:33 2006 by doxygen 1.3.5