Main Page | File List | File Members

fwDevice.ctl File Reference


Detailed Description

This library contains functions associated with all Framework devices. The functions work at the device level, based on the information provided in the device/model definition. There different groups of functions

Functions to create, delete, rename, move devices Functions to handle the hardware and logical hierarchies Functions to do operations like setting the addresses, the alerts or the archiving or a whole device, based on some defaults.

Creation Date
11/07/02
Modification History
Constraints
fwDevice_initialize has to be called once per manager before using any other function in the library
Usage
Public
PVSS managers
VISION, CTRL
Author:
Manuel Gonzalez Berges (IT-CO)

Function Documentation

fwDevice_canHaveDefaults dyn_string  device,
dyn_bool &  canHaveDefaults,
dyn_string &  exceptionInfo
 

Checks whether a device type can have default configuration

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object (only the dp type/model or dp name is required)
canHaveDefaults whether the device can have default for: configs (index fwDEVICE_DEFAULT_CONFIGS) automatic children generation (index fwDEVICE_DEFAULT_CHILDREN)
exceptionInfo details of any exceptions are returned here

fwDevice_checkAddress dyn_string  device,
dyn_string  addressParameters,
bool &  isOk,
dyn_string &  exceptionInfo
 

Checks whether an address configuration is correct and could be applied

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object
addressParameters structure with the address configuration
isOk indicates whether the address specified in addressParameters can be used
exceptionInfo details of any exceptions are returned here, indicating if the address is correct

fwDevice_copy string  sourceDeviceDpName,
string  destinationDeviceDpName,
dyn_string &  exceptionInfo,
int  driverNumber = 1
 

Copies a device from source to destination. The copy includes all configs. The new address configs, by default will be in driver number 1. One has to be careful because PVSS doesn't allow duplicate output addresses, so if the driver number is the same as the one used in the source device, then there will be errors. There can also be problems if one copies the same device twice and one doesn't update the address configs between both copies. If the device supports default address config, it is recommended to apply it between copies.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
sourceDeviceDpName device object
destinationDeviceDpName parent device object
exceptionInfo details of any exceptions are returned here
driverNumber driver number for the destination device address configs

fwDevice_copyRecursively string  sourceDeviceDpName,
string  destinationDeviceDpName,
dyn_string &  exceptionInfo,
int  driverNumber = 1
 

Copies a device and all of its children from source to destination. The copy includes all configs. The new address configs, by default will be in driver number 1. One has to be careful because PVSS doesn't allow duplicate output addresses, so if the driver number is the same as the one used in the source device, then there will be errors. There can also be problems if one copies the same device twice and one doesn't update the address configs between both copies. If the device supports default address config, it is recommended to apply it between copies.

The copy is carried from bottom to top, to avoid the problem of references to non existing devices.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
sourceDeviceDpName device object:
destinationDeviceDpName parent device object
exceptionInfo details of any exceptions are returned here
driverNumber driver number for the destination device address configs

fwDevice_create dyn_string  device,
dyn_string  parentDevice,
dyn_string &  exceptionInfo
 

Creates a device inside PVSS with the characteristics specified in the device object and having as parent the parent device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object
parentDevice parent device object
exceptionInfo details of any exceptions are returned here

fwDevice_createDIMAddress int  driverNumber,
string  rootName,
int  timeInterval,
bool  timeStamp,
dyn_string &  addressParameters,
dyn_string &  exceptionInfo
 

Creates a data structure with all the parameters necessary to set up a DIM address

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
driverNumber driver number
rootName root name to build the DIM item name
timeInterval The time interval in seconds for periodic reception - 0 for on change (default)
timeStamp quality and time-stamp flag - 1 for quality and time-stamp (default)
addressParameters structure with the DIM parameters
exceptionInfo details of any exceptions are returned here

fwDevice_createObject dyn_string &  device,
dyn_string &  exceptionInfo
 

Initializes a device object with empty fields.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device the device object
exceptionInfo details of any exceptions are returned here

fwDevice_createOPCAddress int  driverNumber,
string  rootName,
string  opcServerName,
string  inOPCGroup,
string  outOPCGroup,
dyn_string &  addressParameters,
dyn_string &  exceptionInfo
 

Creates a data structure with all the parameters necessary to set up an OPC address

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
driverNumber driver number
rootName root name to build the OPC item name
opcServerName name given to the OPC server inside PVSS
inOPCGroup one of the PVSS OPC groups used to read data
outOPCGroup one of the PVSS OPC groups used to write data
addressParameters structure with the OPC parameters
exceptionInfo details of any exceptions are returned here

fwDevice_delete string  deviceDpName,
dyn_string &  exceptionInfo
 

Deletes a device and all of its children in the hardware hierarchy from the system

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName the data point name of device to be deleted, the system name is included
exceptionInfo details of any exceptions are returned here

fwDevice_deleteLogical dyn_string  device,
string  newParentDpAlias,
dyn_string &  exceptionInfo
 

Renames a device and all of its children in the logical view. Can be used to delete from the logical view by entering "" as the new parent alias.

Constraints
Works only for the local system
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object, only the data for the device dp alias needs to be present
newParentDpAlias dp alias set for the parent. It will be used as root. "" to cut to clipboard
exceptionInfo details of any exceptions are returned here

fwDevice_displayConfigurationPanel string  deviceDpName,
dyn_string &  exceptionInfo
 

This function will display the first of the configuration panels defined for the specified device.

Constraints
The panel to be displayed has to accept $sDpName and $bHierarchyBrowser as dollar parameters
Usage
Public
PVSS managers
VISION
Parameters:
deviceDpName name of the device to be passed as parameter to the panel
exceptionInfo details of any exceptions

fwDevice_doubleClickViewTable  ) 
 

Opens the corresponding operation panel when an item in the table is double clicked.

Constraints
Must be called from within the double click code of table widget.
It is used by the panels fwTableStatus or fwTableValueStatus.
Usage
JCOP Framework internal
PVSS managers
VISION

fwDevice_dpNames string  dpPattern,
string  dpType,
dyn_string &  dps,
dyn_string &  exceptionInfo
 

This function was only provided temporarily until the PVSS function dpNames worked correctly in a distributed system when specifying a dp type. Since this is now the case, the function is obsolete and has been updated to use fully the dpNames call. It is recommended to use directly the PVSS call.

Constraints
None
Usage
JCOP Framework internal
PVSS managers
VISION, CTRL
Parameters:
dpPattern pattern that the datapoint names should follow (e.g. CAEN/crate01/*)
dpType desired datapoint type. No wildcards allowed (e.g. FwCaenBoard)
dps datapoints that meet the specifier conditions for name and type
exceptionInfo details of any exceptions

fwDevice_fillDpType dyn_string &  device,
dyn_string &  exceptionInfo
 

Fills in the DP type of a device object

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object
exceptionInfo details of any exceptions

fwDevice_getAddressDefaultParams string  deviceDpType,
dyn_string &  addressParameters,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

This function will return the address parameters to be used when configuring a device with the default addressing.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
addressParameters returns a structure with the default address parameters, if they have been set
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getAddressDefaultParamsDIM string  deviceDpType,
dyn_string &  addressParameters,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

This functions returns the address parameter to be used by default when DIM is chosen as connection.

Constraints
None
Usage
Public
managers VISION, CTRL

Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
addressParameters returns the default DIM parameters, if they have been set
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getAddressDefaultParamsOPC string  deviceDpType,
dyn_string &  addressParameters,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

This functions returns the address parameter to be used by default when OPC is chosen as connection.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
addressParameters returns the default OPC parameters, if they have been set
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getAddressElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the dp elements that can have an address for a given device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have an address
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getAddressModeLabel int  addressMode,
string &  label,
dyn_string &  exceptionInfo
 

Returns the label associated with the address mode (or direction) to be used for display to users.

Constraints
Requires fwDevice_ADDRESS_MODE_TO_LABEL to be initialized
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
addressMode address mode
label label associated with the address mode
exceptionInfo details of any exceptions

fwDevice_getAlertElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the dp elements that can have an alert for a given device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have an alert
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getAllItems string  deviceDpType,
string  addressType,
dyn_string &  items,
dyn_string &  elements,
dyn_int &  modes,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns all the elements of a device type that can have an address, with the items to which each element is connected and the address mode.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
addressType selected address type(e.g. fwDevice_ADDRESS_OPC)
items list with the address items
elements list with the PVSS datapoint elements
modes list with the adress modes
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getAllTypes dyn_dyn_string &  types,
dyn_string &  exceptionInfo
 

Returns all the datapoints that have been declared as Framework devices. The declaration as a Framework device requires only the existance of a definition for the device (a datapoint of type _FwDeviceDefinition, named after the datapoint type of the device and a suffix) and the following dpes filled in the definition: .type (device type, e.g. CAEN Channel) .dpType (datapoint type, e.g. FwCaenBoard)

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
types matrix containing the device types and the device datapoint types types[1] = device types types[2] = datapoint types
exceptionInfo details of any exceptions

fwDevice_getArchiveClass string  deviceDpType,
string &  archiveClass,
dyn_string &  exceptionInfo
 

Returns the Framework default archive class. For the moment this is constant for all device types

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
archiveClass archiver to be used
exceptionInfo details of any exceptions

fwDevice_getArchiveElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the dp elements that can be archived for a given device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can be archived
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getChildren string  device,
string  type,
dyn_string &  children,
dyn_string &  exceptionInfo
 

Get all the children devices of a device

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device datapoint name or datapoint alias of the device
type type of hierarchy (fwDevice_HARDWARE or fwDevice_LOGICAL)
children list of child devices
exceptionInfo details of any exception

fwDevice_getChildrenDpTypes dyn_string  device,
dyn_string &  childrenDpTypes,
dyn_string &  exceptionInfo
 

Gets the possible dp types that a device can have as children. It is a combination of fwDevice_getModelChildrenDpTypes (gets the possible children for the model) and fwDevice_getPossibleDpTypes (gets the possible children for the dp type). It will first try the model and if there are no possible children then try the dp type.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object (only the dp type or dp name is required)
childrenDpTypes possible children dp types
exceptionInfo details of any exceptions are returned here, indicating if the address is correct

fwDevice_getChildrenInSlots dyn_string  device,
string  type,
dyn_string &  orderedChildren,
dyn_string &  exceptionInfo
 

Get all the children devices of a device ordered in slots

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object
type type of hierarchy fwDevice_HARDWARE or fwDevice_LOGICAL
orderedChildren list of child devices ordered in slots
exceptionInfo details of any exception

fwDevice_getChildrenLogical string  deviceDpAlias,
dyn_string &  children,
dyn_string  exceptionInfo
 

Get all the logical children devices of a device

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpAlias name of the device
children list of child devices
exceptionInfo details of any exception

fwDevice_getConfigElements string  deviceDpType,
int  configIndex,
dyn_dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns its datapoint elements that can have a specific config, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
configIndex selected config. Has to be one of the supported config indexes (SUPPORTED_CONFIGS)
elements structure with the dpes and the correspondent device property name elements[fwDevice_ELEMENTS_INDEX] dp elements that can have the selected config elements[fwDevice_PROPERTY_NAMES_INDEX] property names for the above elements elements[fwDevice_USER_DATA_INDEX] user data for the above elements elements[fwDevice_DESCRIPTION_INDEX] description for the above elements
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getConfigObjects string  deviceDpType,
int  configIndex,
dyn_dyn_string &  objects,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns the definition information for the specific config, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
configIndex selected config. It has to be one of the supported config indexes (SUPPORTED_CONFIGS)
objects array of objects with selected config data for each device property
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getConversionElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns its datapoint elements that can have a conversion config, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have conversion
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDefaultConfigurationExpertPanels string  deviceDpType,
string &  panel,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the default expert configuration panel for a specific device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
panel default expert configuration panel
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDefaultConfigurationLogicalPanels string  deviceDpType,
dyn_string &  panels,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the default logical configuration panels for a specific device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
panels default logical configuration panels
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDefaultConfigurationPanels string  deviceDpType,
dyn_string &  panels,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the default hardware configuration panels for a specific device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
panels default hardware configuration panels
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDefaultName dyn_string  device,
int  position,
string &  defaultName,
dyn_string &  exceptionInfo
 

Returns the default name for a given device dp type and device model, in a given position in its parent. The name is built with the information contained in the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. It has to contain either the device dp type, or the device dp type and the device dp model if one wants to include model specific characteristics.
position position of the device in the parent
defaultName default name
exceptionInfo details of any exceptions

fwDevice_getDefaultOperationLogicalPanels string  deviceDpType,
dyn_string &  panels,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the default logical operation panels for a specific device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
panels default logical operation panels
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDefaultOperationPanels string  deviceDpType,
dyn_string &  panels,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the default hardware operation panels for a specific device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
panels default hardware operation panels
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDefinitionDp dyn_string  device,
string &  definitionDp,
dyn_string &  exceptionInfo
 

Returns the dp that has to be read to get the definition to be used to configure the device. The dp can be linked to the device type or to the device model

Constraints
None
Usage
JCOP Framework internal
PVSS managers
VISION, CTRL
Parameters:
device device object. It has to contain the device dp name, the device dp type, or the device dp type and the device dp model if one wants to include model specific characteristics.
definitionDp dp (or structure dpe) containing the definition to be used for the device object
exceptionInfo details of any exceptions

fwDevice_getDpFunctionElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns its datapoint elements that can have a dp function config, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have a dp function
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getDpType string  deviceType,
string &  deviceDpType,
dyn_string &  exceptionInfo
 

Returns the PVSS datapoint type associated with the given Framework device type.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceType device type
deviceDpType device datapoint type
exceptionInfo details of any exceptions

fwDevice_getElementPossibleConfigs string  deviceDpType,
string  dpElement,
dyn_bool &  possibleConfigs,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device datapoint and device model, and a datapoint element inside the datapoint type, the function returns a list with the PVSS configs that the datapoint element can have.

Constraints
the device must be of one of the valid framework types
Usage
Public
PVSS managers:
VISION, CTRL
Parameters:
deviceDpType device datapoint type from which info is requested (e.g. FwCaenBoard)
dpElement datapoint element inside the devive datapoint type
possibleConfigs boolean list that indicates the possible configs. Each position in the array correponds to one of the supported configs indexes defined in the begining of this file (fwDevice_ADDRESS_INDEX, etc)
exceptionInfo returns details of any exceptions
deviceModel device model (e.g. A834P)

fwDevice_getElements string  deviceDpType,
dyn_string &  elements,
dyn_int &  mode,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns a list of its datapoint elements and the correspondent PVSS address mode.

Constraints
Currently only works with OPC addresses.
Usage
JCOP Framework internal
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
elements list of datapoint elements
mode list of PVSS address modes correpondent to the datapoint elements
exceptionInfo details of any exceptions
deviceModel device model (e.g. A834P)

fwDevice_getElementsOfType string  deviceDpType,
string  selectedType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns the dp elements in a device type (e.g. FwCaenBoard) that are of the selected data type (e.g FLOAT, REFERENCE). This is based in the device definition, and not in the PVSS datapoint element type.

Constraints
None
Usage
JCOP Framework internal
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
selectedType required data type for the dpes. The possible types are: fwDevice_DPE_TYPE_REFERENCE fwDevice_DPE_TYPE_INT fwDevice_DPE_TYPE_FLOAT fwDevice_DPE_TYPE_BOOL fwDevice_DPE_TYPE_STRING
elements elements with the required data type
exceptionInfo details of any exceptions
deviceModel device model (e.g. A834P)

fwDevice_getFormatElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns its datapoint elements that can have a format defined, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have a dp function
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getFreeSlots dyn_string  device,
dyn_int &  freeSlots,
dyn_string &  exceptionInfo
 

Returns a list of the available slots in the device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object
freeSlots freeSlots currently available in the device
exceptionInfo details of any exceptions

fwDevice_getHierarchy string  deviceDpName,
dyn_dyn_string &  deviceHierarchy,
dyn_string &  exceptionInfo
 

Goes through the device dp name and to returns the full hierarchy above it with device names and positions.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
deviceHierarchy structure containing the hierarchy from the given device going to its parent, grandparent, ect. Each row in the dyn_dyn_string has the following structure:
  1. device dp name
  2. device position as string (keeping trailing 0s)
  3. device position as int
So for example, deviceHierarchy[3][1] will contain the device dp name of the grandparent.
exceptionInfo details of any exceptions

fwDevice_getInstancePanels string  deviceDpName,
string  mode,
dyn_string &  panelList,
dyn_string &  exceptionInfo
 

Returns the panels asscociated with a device instance. At the moment, the only device that can have a panel associated to an instance is the Node (FwNode)

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName device datapoint name
mode whether Navigator or Editor mode panels are wanted
panelList list with the panels
exceptionInfo details of any exceptions

fwDevice_getItems string  deviceDpType,
string  addressType,
string  direction,
dyn_string &  items,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, and a requested address direction, returns a list of items and its associated datapoint elements, based on the device definition.

Constraints
None
Usage
Public
PVSS manager usage: VISION, CTRL

Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
addressType address type (e.g. fwDevice_ADDRESS_OPC)
direction direction of the requested items: Input: "IN" or fwDevice_ADDRESS_DPES_INPUT Output: "OUT" or fwDevice_ADDRESS_DPES_OUTPUT Input/Output: fwDevice_ADDRESS_DPES_INPUT_OUTPUT
items list of items of the requested address type
elements list of elements correspondent to the list of items
exceptionInfo details of any exceptions
deviceModel device model (e.g. A834P)

fwDevice_getLeafs string  deviceDpName,
dyn_string &  leafs,
dyn_string &  exceptionInfo
 

Gets all the leaf devices in the hardware hierarchy below below a given device.

Constraints
Works only for the hardware hierarchy.
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName device datapoint name
leafs list of devices that are leafs in the hierarchy below deviceDpName
exceptionInfo details of any exceptions

fwDevice_getModel dyn_string  device,
string &  model,
dyn_string &  exceptionInfo
 

Returns the model information for a given device object.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Only the device datapoint name is relevant.
model returns the device model if it exists
exceptionInfo details of any exceptions

fwDevice_getModelChildrenDpTypes dyn_string  device,
dyn_string &  childrenDpTypes,
dyn_string &  exceptionInfo
 

Returns the possible children datapoint types for a given device type and device model (contained in the device object). The information is retrieved from a device model definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object
childrenDpTypes list of possible children datapoint types for the given device type and model
exceptionInfo details of any exceptions

fwDevice_getModelDp dyn_string  device,
dyn_string &  modelDp,
dyn_string &  exceptionInfo
 

Gets the datapoint used to contain information about the model of the given device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Either the device datapoint name or the device dp type and the model are required.
modelDp structure with the following information: modelDp[1] = dp defining the model modelDp[2] = model
exceptionInfo details of any exceptions

fwDevice_getModelProperties dyn_string  device,
dyn_dyn_string &  modelProperties,
dyn_string &  exceptionInfo
 

Returns all the information with the characteristics of a model of a given device type.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Either the device datapoint name or the device dp type and the model are required.
modelProperties information with the characteristics of the model:
  1. Slots
  2. Symbols
  3. Units
  4. Limits
  5. Width
  6. Children dp types
  7. Name root
  8. Name digits
  9. Starting number
exceptionInfo details of any exceptions

fwDevice_getModelSlots dyn_string  device,
int &  numberOfSlots,
dyn_string &  exceptionInfo
 

For a given device, returns the number of slots the device has.

Constraints
Only supported for Framework devices that have a model defined
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Either the device datapoint name or the device dp type and the model are required.
numberOfSlots number of children devices the device can hold
exceptionInfo details of any exceptions

fwDevice_getModelStartingNumber dyn_string  device,
int &  startingNumber,
dyn_string &  exceptionInfo
 

Returns the number used to start the numbering of the children of a specific device

Constraints
Only supported for Framework devices that have a model defined
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Either the device datapoint name or the device dp type and the model are required.
startingNumber number used to start the numbering
exceptionInfo details of any exceptions

fwDevice_getModelSymbols dyn_string  device,
dyn_string &  symbolFileNames,
dyn_string &  exceptionInfo
 

Returns the symbols (reference panels) that can be used to represent the given device

Constraints
Only supported for Framework devices that have a model defined
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Either the device datapoint name or the device dp type and the model are required.
symbolFileNames list of symbols (reference panels) that can be used to represent the device
exceptionInfo details of any exceptions

fwDevice_getName string  deviceDpName,
string &  deviceName,
dyn_string &  exceptionInfo
 

Goes through the device dp name and returns the device name

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
deviceName returned name of the device (e.g. channel005)
exceptionInfo details of any exceptions

fwDevice_getNameRoot string  deviceDpType,
string &  nameRoot,
dyn_string &  exceptionInfo
 

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
nameRoot root name used to name devices of the type deviceDpType
exceptionInfo details of any exceptions

fwDevice_getPanels dyn_string  device,
dyn_dyn_string &  panels,
dyn_string &  exceptionInfo
 

Returns all the panels to be used for a given device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. It has to contain the device dp name, the device dp type, or the device dp type and the device dp model if one wants to include model specific characteristics.
panels returns all the panels for the specified device. Each row of the matrix contains the list of panels of one type. To access the matrix the constants of the form fwDevice_PANEL_XXXXX_XXXXX have to be used. For example, panels[fwDevice_PANELS_HARDWARE_OPERATION] will return the list of operation panels of the device in the hardware hierarchy. The constants are: fwDevice_PANEL_NAVIGATOR_HARDWARE fwDevice_PANEL_NAVIGATOR_LOGICAL fwDevice_PANEL_EDITOR_HARDWARE fwDevice_PANEL_EDITOR_LOGICAL fwDevice_PANEL_EDITOR_EXPERT fwDevice_PANEL_EDITOR_HARDWARE_ADD fwDevice_PANEL_EDITOR_HARDWARE_REMOVE
exceptionInfo details of any exceptions

fwDevice_getParent string  deviceDpName,
string &  deviceDpParent,
dyn_string &  exceptionInfo
 

Returns the device datapoint name of the parent device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
deviceDpParent returns the dp name of the parent device (e.g. CAEN/crate003/board07)
exceptionInfo details of any exceptions

fwDevice_getPosition string  deviceDpName,
string &  name,
int &  position,
dyn_string &  exceptionInfo
 

Goes through the device dp name and returns the device name without any trailing number and the position if the dp name ends in an integer number.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
name returns root name of the device (e.g. channel)
position position of the device coded in the name (e.g. 5), or -1 if no position could be found
exceptionInfo details of any exceptions

fwDevice_getPossibleAddressTypes string  deviceDpType,
dyn_string &  addressTypes,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

Returns a list with the possible address types that can be used to configure a given device type and device model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
addressTypes list of possible address types
exceptionInfo details of any exceptions
deviceModel device model (e.g. A834P)

fwDevice_getPossibleChildren dyn_string  device,
dyn_dyn_string &  childrenDpTypesAndModels,
dyn_string &  exceptionInfo
 

Gets the possible combinations dp type - model that a device can have as children. It is a combination of all the information available in the _FwDeviceDefinition and _FwDeviceModel datapoints. For that several functions are used:

fwDevice_getModelChildrenDpTypes (gets the possible children for the model) fwDevice_getPossibleDpTypes (gets the possible children for the dp type).

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object (dp type and model, or dp name are required)
childrenDpTypesAndModels matrix containing list of possible children dp type - models: childrenDpTypesAndModels[x][1] = device dp type childrenDpTypesAndModels[x][2] = device model 1 of the above device dp type childrenDpTypesAndModels[x][3] = device model 2 of the above device dp type ... childrenDpTypesAndModels[x][n] = device model n - 1 of the above device dp type
exceptionInfo details of any exceptions

fwDevice_getPossibleChildrenDpTypes string  deviceDpType,
dyn_string &  childrenDpTypes,
dyn_string &  exceptionInfo
 

Returns which dp types can be used as children of the specified dp type

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
childrenDpTypes list of possible children dp types
exceptionInfo details of any exceptions

fwDevice_getPvRangeElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns its datapoint elements that can have a pv_range config, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have pv range
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getSmoothingElements string  deviceDpType,
dyn_string &  elements,
dyn_string &  exceptionInfo,
string  deviceModel = ""
 

For a given device type and device model, returns its datapoint elements that can have a smooth config, based on the device definition.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType datapoint type of the device (e.g. FwCaenBoard)
elements elements that can have smoothing
exceptionInfo details of any exceptions
deviceModel model of the device (e.g. A834P)

fwDevice_getStartingNumber dyn_string  device,
int &  startingNumber,
dyn_string &  exceptionInfo
 

Returns the starting number to be used when numbering child devices in the given device.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Either the device datapoint name or the device dp type and the model are required.
startingNumber number to start default naming
exceptionInfo details of any exceptions

fwDevice_getType string  deviceDpType,
string &  deviceType,
dyn_string &  exceptionInfo
 

Gets the device type associated with the given device datapoint type.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
deviceType device type associated to deviceDpType
exceptionInfo details of any exceptions

fwDevice_getTypeModels string  deviceDpType,
string  parentDpName,
dyn_string &  models,
dyn_string &  exceptionInfo,
string  parentModel = ""
 

Returns a list of possible device models for a given device datapoint type. Optionally, it is possible to restrict the search to possible models, when the type it is used as child of a given device type/model.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpType device datapoint type (e.g. FwCaenBoard)
parentDpName defines parent device type/model to restrict search
models returns all models of the device type
exceptionInfo details of any exceptions
parentModel optional model of the parent (e.g. SY527)

fwDevice_initialize  ) 
 

Initializes constants required for the fwDevice.ctl library. This function has to be called prior to any other function in the library. It is required once per manager.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL

fwDevice_processAddressTemplate string  deviceDpName,
string  templateString,
string &  finalString,
dyn_string &  exceptionInfo,
dyn_dyn_string  deviceHierarchy = ""
 

This function is used to process a template string for an address, replacing the tokens by their value. The tokens have to be appended by a number to indicate a position in the hierarchy. The numbering starts with 1 referencing the current device, 2 referencing the parent and so on. The possible tokens are:

dpName: references a device dp name (e.g. %dpName1% references the current device dp name) name: references a device name (e.g. %name2% references the device name of the parent of the current device) pos: references the position of the device. The position is taken from the dp name and treated as a string, so, for example, it may contain trailing zeros (e.g. %pos2% references the position of the parent device in the grandparent). decPos: references the position of the device. The position is taken from the dp name and treated as an int (e.g. %decPos2% references the position of the parent device in the grandparent).

Constraints
None
Usage
JCOP Framework internal
PVSS managers
VISION, CTRL
Parameters:
deviceDpName device to which the template belongs (e.g. CAEN/crate003/board07/channel005)
templateString template to be processed
finalString result of the processing
exceptionInfo details of any exceptions
deviceHierarchy optionally it is possible to pass the hierarchy as returned by fwDevice_getHierarchy, to speed up

fwDevice_processModelTemplate string  deviceDpName,
string  templateString,
string &  finalString,
dyn_string &  exceptionInfo
 

This function is used to process a template string and substitute some tokens related to model information. The tokens have to be appended by a number to indicate a position in the hierarchy. The numbering starts with 1 referencing the current device, 2 referencing the parent and so on. The possible tokens are:

model: references a device model (e.g. %model2% references the model of the parent of the given device)

Constraints
None
Usage
JCOP Framework internal
PVSS managers
VISION, CTRL
Parameters:
deviceDpName device to which the template belongs (e.g. CAEN/crate003/board07/channel005)
templateString template to be processed
finalString result of the processing
exceptionInfo details of any exceptions

fwDevice_removeAliasRecursively dyn_string  device,
dyn_string &  exceptionInfo
 

Sets the alias of the device and all its logical children to an empty string (""), so that they are removed from the logical hierarchy.

Constraints
Only local because of limitation of dpAliasToName
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Only device DP alias is required.
exceptionInfo details of any exceptions

fwDevice_renameLogical dyn_string  device,
string  newDeviceAlias,
dyn_string &  exceptionInfo
 

Renames the device in the logical view (sets the device alias to the new value) and consequently changes all its logical children so that the hierarchy is preserved. It is important to stress that what is changed is the device alias (e.g. wire001, and not the device dp alias (e.g. chamber03/plane02/wire001), so the device stays in the same position in the logical hierarchy. To move a device in the logical hierarchy, one has to use the copy/paste features of the Device Editor and Navigator.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
device device object. Only device DP alias is required.
newDeviceAlias new device alias for the device
exceptionInfo details of any exceptions

fwDevice_setAddress string  deviceDpName,
dyn_string  addressParameters,
dyn_string &  exceptionInfo,
string  itemPrefix = "",
dyn_string  dpes = makeDynString("")
 

Sets the address for the given device with the given parameters.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
addressParameters parameters to be used when setting the address
exceptionInfo details of any exceptions
itemPrefix prefix to be used for all the item names in the addresses
dpes list of dpes to consider, if empty all dpes are considered

fwDevice_setAddressRecursively string  deviceDpName,
dyn_string  addressParameters,
dyn_string &  exceptionInfo,
string  hierarchyType = "HARDWARE"
 

Sets the address for the given device and all of its children in the hardware hierarchy, with the given parameters.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07)
addressParameters parameters to be used when setting the address
exceptionInfo details of any exceptions
hierarchyType hierarchy where to apply the recursive action -fwDevice_HARDWARE -fwDevice_LOGICAL the default value is fwDevice_HARDWARE. The constant cannot be used because of the PVSS bug when using default values in recursive functions

fwDevice_setAlert string  deviceDpName,
string  operation,
dyn_string &  exceptionInfo
 

This function can be used to perform several operations on the alert config of the given device, based on the device definition information: Set the alert for the dpes that can have a default according to the definition (operation = fwDevice_ALERT_SET) Unset the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_UNSET) Mask the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_MASK) Unmask the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_UNMASK) Acknowledge the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_ACK) Unset the summary alert (operation = fwDevice_ALERT_SUMMARY_UNSET)

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
operation operation to be performed as specified in the description
exceptionInfo details of any exceptions

fwDevice_setAlertRecursively string  deviceDpName,
string  operation,
dyn_string &  exceptionInfo,
string  hierarchyType = "HARDWARE"
 

This function can be used to perform several operations on the alert config of the given device and all of its children in the hardware hierarchy, based on the device definition information: Set the alert for the dpes that can have a default according to the default in the definition (operation = fwDevice_ALERT_SET) Unset the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_UNSET) Mask the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_MASK) Unmask the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_UNMASK) Acknowledge the alert for the dpes that can have it according to the definition (operation = fwDevice_ALERT_ACK) Unset the summary alert (operation = fwDevice_ALERT_SUMMARY_UNSET)

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07)
operation operation to be performed as specified in the description
exceptionInfo details of any exceptions
hierarchyType hierarchy where to apply the recursive action -fwDevice_HARDWARE -fwDevice_LOGICAL the default value is fwDevice_HARDWARE. The constant cannot be used because of the PVSS bug when using default values in recursive functions

fwDevice_setArchive string  deviceDpName,
string  archiveClass,
string  operation,
dyn_string &  exceptionInfo
 

This function can be used to perform several operations on the archive config of the given device, based on the device definition information: Set the archive for the dpes that can have it according to the default in the definition (operation = fwDevice_ARCHIVE_SET) Unset the archive for the dpes that can have it according to the definition (operation = fwDevice_ARCHIVE_UNSET)

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
archiveClass name of the PVSS archive class to be used for the configs
operation operation to be performed as specified in the description
exceptionInfo details of any exceptions

fwDevice_setArchiveRecursively string  deviceDpName,
string  archiveClass,
string  operation,
dyn_string &  exceptionInfo,
string  hierarchyType = "HARDWARE"
 

This function can be used to perform several operations on the archive config of the given device and all of its children in the hardware hierarchy, based on the device definition information: Set the archive for the dpes that can have it according to the definition (operation = fwDevice_ARCHIVE_SET) Unset the archive for the dpes that can have it according to the definition (operation = fwDevice_ARCHIVE_UNSET)

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07)
archiveClass name of the PVSS archive class to be used for the configs
operation operation to be performed as specified in the description
exceptionInfo details of any exceptions
hierarchyType hierarchy where to apply the recursive action -fwDevice_HARDWARE -fwDevice_LOGICAL the default value is fwDevice_HARDWARE. The constant cannot be used because of the PVSS bug when using default values in recursive functions

fwDevice_setDefaultValues string  deviceDpName,
dyn_string &  exceptionInfo
 

Sets the default values for the dpes inside that have a default value spedified in the device/model definition

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
exceptionInfo details of any exceptions

fwDevice_setDpFunction string  deviceDpName,
string  operation,
dyn_string &  exceptionInfo,
string  definitionDp = "",
dyn_dyn_string  deviceHierarchy = ""
 

Sets the dp function for the given device with the given parameters.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
operation operation to be performed: -Set DpFunction: fwDevice_DPFUNCTION_SET -Unset DpFunction: fwDevice_DPFUNCTION_UNSET
exceptionInfo details of any exceptions
definitionDp where to read the device definition. It is optional. If it is required by the function and it has not been passed, the function will get it
deviceHierarchy device hierarchy above deviceDpName (including it). It is optional. If it is required by the function and it has not been passed, the function will get it

fwDevice_setDpFunctionRecursively string  deviceDpName,
string  operation,
dyn_string &  exceptionInfo,
string  definitionDp = "",
dyn_dyn_string  deviceHierarchy = "",
string  hierarchyType = fwDevice_HARDWARE
 

Sets the dp function for the given device and all of its children in the specified hierarchy with the given parameters. By default the hardware hierarchy is used.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
operation operation to be performed: -Set DpFunction: fwDevice_DPFUNCTION_SET -Unset DpFunction: fwDevice_DPFUNCTION_UNSET
exceptionInfo details of any exceptions
definitionDp where to read the device definition. It is optional. If it is required by the function and it has not been passed, the function will get it
deviceHierarchy device hierarchy above deviceDpName (including it). It is optional. If it is required by the function and it has not been passed, the function will get it
hierarchyType hierarchy where to apply the recursive action -fwDevice_HARDWARE -fwDevice_LOGICAL

fwDevice_setModel string  deviceDpName,
string  deviceModel,
dyn_string &  exceptionInfo
 

This function sets the model of a given device to the specified string, if the device type supports to have models defined.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
deviceModel device model
exceptionInfo details of any exceptions

fwDevice_setPropertyRecursively string  deviceDpName,
string  element,
string  hierarchyType,
string  value,
dyn_string  exceptionInfo
 

Sets a new value for a given element in the given device, and for all of its children in the specified hierarchy if they have also that element.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
deviceDpName dp name of the device (e.g. CAEN/crate003/board07/channel005)
element element in the datapoint to be set
hierarchyType hierarchy type, either fwDevice_HARDWARE or fwDevice_LOGICAL
value value to be set
exceptionInfo details of any exceptions


Generated on Thu Feb 9 15:20:19 2006 by doxygen 1.3.5