BumpBar Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the programmatic interface for a UPOS Bump Bar device.
public abstract class BumpBar : Microsoft.PointOfService.PosCommontype BumpBar = class
inherit PosCommonPublic MustInherit Class BumpBar
Inherits PosCommon- Inheritance
- Derived
Constructors
| BumpBar() |
Creates an instance of the BumpBar class. |
Fields
| DataEventKey |
Indicates the event type for DataEvent events. |
| ExtendedErrorFirmwareBadFile |
Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (Inherited from PosCommon) |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| StatisticBumpCount |
Incremented every time that the bump bar is pressed. |
| StatisticCommunicationErrorCount |
Holds the programmatic name of the Communication Error Count common statistic. (Inherited from PosCommon) |
| StatisticDeviceCategory |
Holds the programmatic name of the Device Category common statistic. (Inherited from PosCommon) |
| StatisticFirmwareRevision |
Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon) |
| StatisticHoursPoweredCount |
Holds the programmatic name of the Hours Powered On common statistic. (Inherited from PosCommon) |
| StatisticInstallationDate |
Holds the programmatic name of the Installation Date common statistic. (Inherited from PosCommon) |
| StatisticInterface |
Holds the programmatic name of the Interface common statistic. (Inherited from PosCommon) |
| StatisticManufactureDate |
Holds the programmatic name of the Manufacture Date common statistic. (Inherited from PosCommon) |
| StatisticManufacturerName |
Holds the programmatic name of the Manufacturer Name common statistic. (Inherited from PosCommon) |
| StatisticMechanicalRevision |
Holds the programmatic name of the Mechanical Revision common statistic. (Inherited from PosCommon) |
| StatisticModelName |
Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon) |
| StatisticSerialNumber |
Holds the programmatic name of the Serial Number common statistic. (Inherited from PosCommon) |
| StatisticUnifiedPOSVersion |
Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon) |
| StatusPowerOff |
Indicates that the device’s power is turned off or it is detached from the terminal. (Inherited from PosCommon) |
| StatusPowerOffline |
Indicates that the device is powered on but is either not ready or unable to respond to requests. (Inherited from PosCommon) |
| StatusPowerOffOffline |
Indicates that either the device’s power is off or it is offline. (Inherited from PosCommon) |
| StatusPowerOnline |
Indicates that the device’s power is turned on and it is ready for use. (Inherited from PosCommon) |
| StatusUpdateFirmwareComplete |
Indicates the update firmware process has completed successfully. (Inherited from PosCommon) |
| StatusUpdateFirmwareCompleteDeviceNotRestored |
Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceNeedsFirmware |
Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceOk |
Indicates the update firmware process failed. However, the device is still operational. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceUnknown |
Indicates the update firmware process failed. The device is in an indeterminate state. (Inherited from PosCommon) |
| StatusUpdateFirmwareFailedDeviceUnrecoverable |
Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (Inherited from PosCommon) |
| StatusUpdateFirmwareProgress |
Indicates the update firmware process has completed 1 to 100 percent successfully. (Inherited from PosCommon) |
| WaitForever |
Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (Inherited from PosCommon) |
Properties
| AsyncMode |
Gets or sets a Boolean value that indicates whether the BumpBarSound(DeviceUnits, Int32, Int32, Int32, Int32) method is performed asynchronously. |
| AutoToneDuration |
Gets or sets the duration of the automatic tone. |
| AutoToneFrequency |
Gets or sets the frequency of the automatic tone. |
| BumpBarDataCount |
Gets the number of queued Microsoft.PointOfService.BumpBar.DataEvents. |
| CapCompareFirmwareVersion |
Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (Inherited from PosCommon) |
| CapPowerReporting |
Gets the power reporting capabilities of the device. (Inherited from PosCommon) |
| CapStatisticsReporting |
Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (Inherited from PosCommon) |
| CapTone |
Gets a Boolean value that indicates whether the bump bar device supports an enunciator. |
| CapUpdateFirmware |
Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (Inherited from PosCommon) |
| CapUpdateStatistics |
Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (Inherited from PosCommon) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed |
Gets a Boolean value that indicates whether the device is claimed for exclusive access. (Inherited from PosCommon) |
| Compatibility | (Inherited from PosDevice) |
| CurrentUnitId |
Gets or sets the current bump bar unit ID. |
| DataCount |
Gets the number of currently queued DataEvent events. |
| DataEventEnabled |
Gets or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued. |
| DeviceDescription |
Gets a string identifying the device and the company that manufactured it. (Inherited from PosCommon) |
| DeviceEnabled |
Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (Inherited from PosCommon) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName |
Gets a short string identifying the device and any pertinent information about it. (Inherited from PosCommon) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| ErrorString |
Gets an error description. |
| ErrorUnits |
Gets a bitwise mask of the unit(s) that encountered an error. |
| EventString |
Gets a description of the error that occurred to the specified unit(s). |
| EventUnitId |
Gets the bump bar unit ID causing a DataEvent event. |
| EventUnits |
Gets a bitwise mask of the unit(s) when some events are delivered. |
| FreezeEvents |
Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice |
Gets a Boolean value that indicates whether the Bump Bar is an exclusive-use device. |
| Keys |
Gets the number of keys on the specified bump bar unit. |
| OutputId |
Gets the identifier of the most recently started asynchronous output. |
| PowerNotify |
Gets or sets the type of power notification selection made by the application. (Inherited from PosCommon) |
| PowerState |
Gets the current power condition. (Inherited from PosCommon) |
| ServiceObjectDescription |
Gets a string identifying the Service Object that supports the device and the company that produced it. (Inherited from PosCommon) |
| ServiceObjectVersion |
Gets the Service Object version number. (Inherited from PosCommon) |
| State |
Gets the current state of the device. (Inherited from PosCommon) |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
| Timeout |
Gets or sets the time-out value that is used to complete output methods. |
| UnitsOnline |
Gets a bitwise mask that indicates which bump bar units are online. |
Methods
| BumpBarSound(DeviceUnits, Int32, Int32, Int32, Int32) |
Sounds the bump bar enunciator for the bump bar(s) specified by the units parameter. |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) |
Requests exclusive access to the device. (Inherited from PosCommon) |
| ClearInput() |
Clears all buffered device input. |
| ClearOutput() |
Clears all buffered tone outputs. |
| Close() |
Releases the device and its resources. (Inherited from PosCommon) |
| CompareFirmwareVersion(String) |
Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon) |
| DeleteConfigurationProperty(String) |
Deletes the specified property from the XML configuration file. (Inherited from PosCommon) |
| DirectIO(Int32, Int32, Object) |
Used to communicate directly with the Service Object. (Inherited from PosCommon) |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for later input/output processing. (Inherited from PosCommon) |
| Release() |
Releases exclusive access to the device. (Inherited from PosCommon) |
| ResetStatistic(String) |
Resets the specified statistic to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics() |
Resets all statistics associated with a device to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(StatisticCategories) |
Resets all statistics for a specified category to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(String[]) |
Resets the specified statistics to 0 (zero). (Inherited from PosCommon) |
| RetrieveStatistic(String) |
Retrieves the specified device statistic. (Inherited from PosCommon) |
| RetrieveStatistics() |
Retrieves all device statistics. (Inherited from PosCommon) |
| RetrieveStatistics(StatisticCategories) |
Retrieves the statistics for the specified category. (Inherited from PosCommon) |
| RetrieveStatistics(String[]) |
Retrieves the specified statistics. (Inherited from PosCommon) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetKeyTranslation(DeviceUnits, Int32, Int32) |
Assigns a logical key value to key scan code. |
| UpdateFirmware(String) |
Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon) |
| UpdateStatistic(String, Object) |
Updates the value of a specified device statistic. (Inherited from PosCommon) |
| UpdateStatistics(Statistic[]) |
Updates a list of statistics with the corresponding specified values. (Inherited from PosCommon) |
| UpdateStatistics(StatisticCategories, Object) |
Updates the specified category of statistics with the specified value. (Inherited from PosCommon) |
Events
| DataEvent |
Raised by the service object to notify the application that input data from the bump bar is available. |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent |
Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon) |
| ErrorEvent |
Raised by the service object to notify the application that a bump bar error has been detected and a suitable response by the application is necessary to process the error condition. |
| OutputCompleteEvent |
Raised by the service object to notify the application that the queued output request associated with the OutputId property has completed successfully. |
| StatusUpdateEvent |
Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon) |