Share via


ToneIndicatorBasic Class

Definition

public abstract class ToneIndicatorBasic : Microsoft.PointOfService.ToneIndicator, IDisposable
type ToneIndicatorBasic = class
    inherit ToneIndicator
    interface IDisposable
Public MustInherit Class ToneIndicatorBasic
Inherits ToneIndicator
Implements IDisposable
Inheritance
Implements

Constructors

ToneIndicatorBasic()

Fields

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)
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)
StatisticToneSoundedCount

Indicates the number of tones sounded.

(Inherited from ToneIndicator)
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 to indicate whether the Sound method is performed asynchronously.

(Inherited from ToneIndicator)
CapCompareFirmwareVersion
CapMelody (Inherited from ToneIndicator)
CapPitch

Gets a Boolean value to indicate whether the hardware tone generator can vary the tone pitch.

(Inherited from ToneIndicator)
CapPowerReporting
CapStatisticsReporting
CapUpdateFirmware
CapUpdateStatistics
CapVolume

Gets a Boolean value to indicate whether the hardware tone generator can vary the tone volume.

(Inherited from ToneIndicator)
CheckHealthText

Gets a string that indicates the health of the device.

(Inherited from PosCommon)
Claimed
CommonProperties
Compatibility (Inherited from PosDevice)
DeviceDescription
DeviceEnabled
DeviceInstanceId (Inherited from PosCommon)
DeviceName
DevicePath

Gets or sets the hardware path of a device.

(Inherited from PosCommon)
ErrorCount
ExternallyClaimed
FreezeEvents
HardwareId (Inherited from PosCommon)
InterToneWait

Gets or sets the number of milliseconds of silence between tone1 and tone2.

(Inherited from ToneIndicator)
IsExclusiveUseDevice

Gets a Boolean value that indicates whether the ToneIndicator is an exclusive-use device.

(Inherited from ToneIndicator)
MelodyType (Inherited from ToneIndicator)
MelodyVolume (Inherited from ToneIndicator)
OutputId
PowerNotify
PowerState
ServiceObjectDescription
ServiceObjectVersion
State
SynchronizingObject

Gets or sets the object that is used to marshal the event handler calls issued because of a POS event.

(Inherited from PosCommon)
Tone1Duration

Gets or sets the duration of the first tone in milliseconds.

(Inherited from ToneIndicator)
Tone1Pitch

Gets or sets the pitch or frequency of the first tone in Hertz.

(Inherited from ToneIndicator)
Tone1Volume

Gets or sets the volume of the first tone.

(Inherited from ToneIndicator)
Tone2Duration

Gets or sets the duration of the second tone in milliseconds.

(Inherited from ToneIndicator)
Tone2Pitch

Gets or sets the pitch or frequency of the second tone in Hertz.

(Inherited from ToneIndicator)
Tone2Volume

Gets or sets the volume of the second tone.

(Inherited from ToneIndicator)

Methods

CheckHealth(HealthCheckLevel)

Tests the state of a device.

(Inherited from PosCommon)
Claim(Int32)
ClearOutput()
ClearOutputImpl()
Close()
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)
CreateStatistic(String, Boolean, String)
CreateStatistic(String, Boolean)
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)
Dispose()
Dispose(Boolean)
GetConfigurationProperty(String)

Used by the Service Object to retrieve the specified property from the XML configuration file.

(Inherited from PosCommon)
GetStatisticValue(String)
IncrementStatistic(String, Int32)
IncrementStatistic(String)
Invoke(Delegate, Object[])

Used by the Service Objects to raise an event.

(Inherited from PosCommon)
Open()
PreFireEvent(DeviceErrorEventArgs)
PreFireEvent(DirectIOEventArgs)
PreFireEvent(OutputCompleteEventArgs)
PreFireEvent(StatusUpdateEventArgs)
QueueEvent(DeviceErrorEventArgs)
QueueEvent(DirectIOEventArgs)
QueueEvent(OutputCompleteEventArgs)
QueueEvent(StatusUpdateEventArgs)
QueueEventAndWait(DeviceErrorEventArgs)
QueueEventAndWait(DirectIOEventArgs)
Release()
ResetStatistic(String)
ResetStatistics()
ResetStatistics(StatisticCategories)
ResetStatistics(String[])
RetrieveStatistic(String)
RetrieveStatistics()
RetrieveStatistics(StatisticCategories)
RetrieveStatistics(String[])
SetConfigurationProperty(String, String)

Sets a property value (or create a new property) in the XML configuration file.

(Inherited from PosCommon)
SetStatisticHandlers(String, GetStatistic, SetStatistic)
SetStatisticValue(String, Object)
Sound(Int32, Int32)

Sounds the indicator or starts it sounding asynchronously.

(Inherited from ToneIndicator)
SoundImmediate()

Sounds the hardware tone generator one time, synchronously.

(Inherited from ToneIndicator)
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)
UpdateStatistics(Statistic[])
UpdateStatistics(StatisticCategories, Object)
VerifyState(Boolean, Boolean)

Events

DeviceAddedEvent (Inherited from PosCommon)
DeviceRemovedEvent (Inherited from PosCommon)
DirectIOEvent
ErrorEvent
OutputCompleteEvent
StateChangedEvent
StatusUpdateEvent

Applies to