BumpBar Members
2/27/2008
Defines the programmatic interface for a UPOS Bump Bar device.
The following tables list the members exposed by the BumpBar type.
Protected Constructors
Name | Description | |
---|---|---|
BumpBar | Creates an instance of the BumpBar class. |
Top
Public Fields
Name | Description | |
---|---|---|
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) |
Top
Public Properties
(see also Protected Properties )
Name | Description | |
---|---|---|
AsyncMode | Gets or sets a Boolean value that indicates whether the BumpBarSound 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 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 | Gets the compatibility level of a device. (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) | |
DeviceName | Gets a short string identifying the device and any pertinent information about it. (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) | |
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. |
Top
Protected Properties
Name | Description | |
---|---|---|
DeviceInstanceId | (inherited from PosCommon ) | |
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) | |
HardwareId | (inherited from PosCommon ) | |
IsExclusiveUseDevice | Overridden. Gets a Boolean value that indicates whether the Bump Bar is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
Name | Description | |
---|---|---|
BumpBarSound | Sounds the bump bar enunciator for the bump bar(s) specified by the units parameter. | |
CheckHealth | (inherited from PosCommon ) | |
Claim | (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 | (inherited from PosCommon ) | |
DirectIO | (inherited from PosCommon ) | |
Equals | Overloaded. (inherited from Object ) | |
GetHashCode | (inherited from Object ) | |
GetType | (inherited from Object ) | |
Open | Opens a device for later input/output processing. (inherited from PosCommon) | |
ReferenceEquals | (inherited from Object ) | |
Release | Releases exclusive access to the device. (inherited from PosCommon) | |
ResetStatistic | (inherited from PosCommon ) | |
ResetStatistics | Overloaded. (inherited from PosCommon ) | |
RetrieveStatistic | (inherited from PosCommon ) | |
RetrieveStatistics | Overloaded. (inherited from PosCommon ) | |
SetKeyTranslation | Assigns a logical key value to key scan code. | |
ToString | (inherited from Object ) | |
UpdateFirmware | (inherited from PosCommon ) | |
UpdateStatistic | (inherited from PosCommon ) | |
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
Top
Protected Methods
Name | Description | |
---|---|---|
DeleteConfigurationProperty | (inherited from PosCommon ) | |
Finalize | (inherited from Object ) | |
GetConfigurationProperty | (inherited from PosCommon ) | |
Invoke | (inherited from PosCommon ) | |
MemberwiseClone | (inherited from Object ) | |
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
Name | Description | |
---|---|---|
DataEvent | Raised by the service object to notify the application that input data from the bump bar is available. | |
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) |
Top
Protected Events
Name | Description | |
---|---|---|
DeviceAddedEvent | (inherited from PosCommon ) | |
DeviceRemovedEvent | (inherited from PosCommon ) |
Top