JCOP Framework fwDevice component
8.3.0-SNAPSHOT-201901250830
|
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) | |
Deprecated functions of fwDevice component.
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.
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_createObject | ( | dyn_string & | device, |
dyn_string & | exceptionInfo | ||
) |
Initializes a device object with empty fields.
device | the device object |
exceptionInfo | details of any exceptions are returned here |
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:
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_doubleClickViewTable | ( | ) |
Opens the corresponding operation panel when an item in the table is double clicked.
fwDevice_getNameRoot | ( | string | deviceDpType, |
string & | nameRoot, | ||
dyn_string & | exceptionInfo | ||
) |
deviceDpType | device datapoint type (e.g. FwCaenBoard) |
nameRoot | root name used to name devices of the type deviceDpType |
exceptionInfo | details of any exceptions |
fwDevice_getChildrenLogical | ( | string | deviceDpAlias, |
dyn_string & | children, | ||
dyn_string | exceptionInfo | ||
) |
Get all the logical children devices of a device
deviceDpAlias | name of the device |
children | list of child devices |
exceptionInfo | details of any exception |