fwDevice  8.4.0
fwDeviceDeprecated.ctl File Reference

Functions

 fwDevice_getStartingNumber (dyn_string device, int &startingNumber, dyn_string &exceptionInfo)
 
 fwDevice_createObject (dyn_string &device, dyn_string &exceptionInfo)
 
 fwDevice_processModelTemplate (string deviceDpName, string templateString, string &finalString, dyn_string &exceptionInfo)
 
 fwDevice_doubleClickViewTable ()
 
 fwDevice_getNameRoot (string deviceDpType, string &nameRoot, dyn_string &exceptionInfo)
 
 fwDevice_getChildrenLogical (string deviceDpAlias, dyn_string &children, dyn_string exceptionInfo)
 

Detailed Description

Deprecated functions of fwDevice component.

Function Documentation

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
devicedevice object. Either the device datapoint name or the device dp type and the model are required.
startingNumbernumber to start default naming
exceptionInfodetails of any exceptions
Deprecated:
2018-06-22
fwDevice_createObject ( dyn_string &  device,
dyn_string &  exceptionInfo 
)
Initializes a device object with empty fields.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
devicethe device object
exceptionInfodetails of any exceptions are returned here
Deprecated:
2018-06-22
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
deviceDpNamedevice to which the template belongs (e.g. CAEN/crate003/board07/channel005)
templateStringtemplate to be processed
finalStringresult of the processing
exceptionInfodetails of any exceptions
Deprecated:
2018-06-22
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
Deprecated:
2018-06-22
fwDevice_getNameRoot ( string  deviceDpType,
string &  nameRoot,
dyn_string &  exceptionInfo 
)
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
deviceDpTypedevice datapoint type (e.g. FwCaenBoard)
nameRootroot name used to name devices of the type deviceDpType
exceptionInfodetails of any exceptions
Deprecated:
2018-06-22
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
deviceDpAliasname of the device
childrenlist of child devices
exceptionInfodetails of any exception
Deprecated:
2018-06-22 One should use fwDevice_getChildren with type="LOGICAL" instead