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.
|
Checks whether a device type can have default configuration
|
|
Checks whether an address configuration is correct and could be applied
|
|
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.
|
|
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.
|
|
Creates a device inside PVSS with the characteristics specified in the device object and having as parent the parent device.
|
|
Creates a data structure with all the parameters necessary to set up a DIM address
|
|
Initializes a device object with empty fields.
|
|
Creates a data structure with all the parameters necessary to set up an OPC address
|
|
Deletes a device and all of its children in the hardware hierarchy from the system
|
|
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.
|
|
This function will display the first of the configuration panels defined for the specified device.
|
|
Opens the corresponding operation panel when an item in the table is double clicked.
|
|
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.
|
|
Fills in the DP type of a device object
|
|
This function will return the address parameters to be used when configuring a device with the default addressing.
|
|
This functions returns the address parameter to be used by default when DIM is chosen as connection.
|
|
This functions returns the address parameter to be used by default when OPC is chosen as connection.
|
|
Returns the dp elements that can have an address for a given device type and device model.
|
|
Returns the label associated with the address mode (or direction) to be used for display to users.
|
|
Returns the dp elements that can have an alert for a given device type and device model.
|
|
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.
|
|
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)
|
|
Returns the Framework default archive class. For the moment this is constant for all device types
|
|
Returns the dp elements that can be archived for a given device.
|
|
Get all the children devices of a device
|
|
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.
|
|
Get all the children devices of a device ordered in slots
|
|
Get all the logical children devices of a device
|
|
For a given device type and device model, returns its datapoint elements that can have a specific config, based on the device definition.
|
|
For a given device type and device model, returns the definition information for the specific config, based on the device definition.
|
|
For a given device type and device model, returns its datapoint elements that can have a conversion config, based on the device definition.
|
|
Returns the default expert configuration panel for a specific device type and device model.
|
|
Returns the default logical configuration panels for a specific device type and device model.
|
|
Returns the default hardware configuration panels for a specific device type and device model.
|
|
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.
|
|
Returns the default logical operation panels for a specific device type and device model.
|
|
Returns the default hardware operation panels for a specific device type and device model.
|
|
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
|
|
For a given device type and device model, returns its datapoint elements that can have a dp function config, based on the device definition.
|
|
Returns the PVSS datapoint type associated with the given Framework device type.
|
|
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.
|
|
For a given device type and device model, returns a list of its datapoint elements and the correspondent PVSS address mode.
|
|
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.
|
|
For a given device type and device model, returns its datapoint elements that can have a format defined, based on the device definition.
|
|
Returns a list of the available slots in the device.
|
|
Goes through the device dp name and to returns the full hierarchy above it with device names and positions.
|
|
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)
|
|
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.
|
|
Gets all the leaf devices in the hardware hierarchy below below a given device.
|
|
Returns the model information for a given device object.
|
|
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.
|
|
Gets the datapoint used to contain information about the model of the given device.
|
|
Returns all the information with the characteristics of a model of a given device type.
|
|
For a given device, returns the number of slots the device has.
|
|
Returns the number used to start the numbering of the children of a specific device
|
|
Returns the symbols (reference panels) that can be used to represent the given device
|
|
Goes through the device dp name and returns the device name
|
|
|
|
Returns all the panels to be used for a given device.
|
|
Returns the device datapoint name of the parent device.
|
|
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.
|
|
Returns a list with the possible address types that can be used to configure a given device type and device model.
|
|
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).
|
|
Returns which dp types can be used as children of the specified dp type
|
|
For a given device type and device model, returns its datapoint elements that can have a pv_range config, based on the device definition.
|
|
For a given device type and device model, returns its datapoint elements that can have a smooth config, based on the device definition.
|
|
Returns the starting number to be used when numbering child devices in the given device.
|
|
Gets the device type associated with the given device datapoint type.
|
|
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.
|
|
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.
|
|
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).
|
|
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)
|
|
Sets the alias of the device and all its logical children to an empty string (""), so that they are removed from the logical hierarchy.
|
|
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.
|
|
Sets the address for the given device with the given parameters.
|
|
Sets the address for the given device and all of its children in the hardware hierarchy, with the given parameters.
|
|
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)
|
|
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)
|
|
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)
|
|
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)
|
|
Sets the default values for the dpes inside that have a default value spedified in the device/model definition
|
|
Sets the dp function for the given device with the given parameters.
|
|
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.
|
|
This function sets the model of a given device to the specified string, if the device type supports to have models defined.
|
|
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.
|