Methods

A FloBoss Scanner object supports the following object-specific methods, some of which are also available as pick actions from ViewX and Virtual ViewX:

• CancelPromotedScanning. This method lets you manually exit the Promoted Scanning mode. When this method is called, the scanner is configured to use the normal scanning rate and offset that are found on the scanner’s configuration form. The method takes no parameters.
• ChangeGasComp. This method lets you change the gas composition that is used in the AGA-8 (compressibility) calculation in the FloBoss. This method takes the gas composition parameters and then sets them all in the FloBoss in a single transaction.

This method is also available as a pick action. As such, if your user account has the relevant permissions, you can right-click on a FloBoss Scanner object in the Database Bar and then select the Change Gas Composition pick action. The Change Gas Composition window is displayed.

The parameters that you need to specify are listed in the table below. The parameters are listed in the order that they need to appear in the method call.

Set the Run Number to 0 for single run devices, like a FloBoss 103. For multi-run devices, like a FloBoss 107, set the Run Number to 0 for Run 1, 1 for Run 2, and so on. The value in the Run Number parameter is used in the Logical/Location field when sending the new parameters to the FloBoss.

If you select the Normalize option, the non-zero gas composition values are adjusted in equal proportion so that so that the sum of all of the elements equals 100.

The method call/pick action will be unsuccessful if the individual gas composition values do not sum to 100 and the Normalize option is not selected.

Points that monitor the gas composition will not be automatically updated after the ChangeGasComp method is called. You will either need to call the Refresh method on the FloBoss Scanner, or wait for the next poll for points to be updated.

• ResetCommCounters. This method takes no parameters and clears the communications counters that are mentioned in the section on Data Fields.
• EnablePromotedScanning. The method allows you to temporarily change the scanning rate on a Scanner object. It takes a single input parameter: Promoted Scan Duration. The units for this parameter are seconds. The Promoted Scan Duration defines the length of time that the Scanner object will be configured to use the Promoted Scan Rate. The promoted scanning mode will be exited automatically once the Promoted Scan Duration expires, or can be exited manually by calling the CancelPromotedScanning method.
• GetAlarms. This method takes no parameters and gets new alarms from the FloBoss and puts them in the data table that is referenced in the Alarm Data Table reference field on the Scanner tab of the FloBoss Scanner’s configuration Form. This method is only available if the Get Alarms on Scan check box is selected on the FloBoss Scanner’s configuration Form.
• GetEvents. This method takes no parameters and gets new events from the FloBoss and puts them in the data table that is referenced in the Event Data Table reference field on the Scanner tab of the FloBoss Scanner’s configuration Form. This method is only available if the Get Events on Scan check box is selected on the FloBoss Scanner’s configuration Form.
• SetClock. The method takes no parameters and sets the clock in the FloBoss to local plus any offset specified in the FloBoss Time Zone field on the FloBoss Scanner’s configuration Form.

  The time is always set to standard time. Daylight savings time is ignored.