Scale Class

Definition

Defines the programmatic interface for a UPOS scale device.

public abstract class Scale : Microsoft.PointOfService.PosCommon
type Scale = class
    inherit PosCommon
Public MustInherit Class Scale
Inherits PosCommon
Inheritance
Derived

Constructors

Scale()

Creates an instance of the Scale class.

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

Indicates the weight was over MaximumWeight.

ExtendedErrorSameWeight

Indicates the scale is reporting that the item/weight on the scale is identical to the previously reported item/weight (that is, the item has not been removed from the scale).

ExtendedErrorStatistics

Indicates a specified statistic could not be reset or updated.

(Inherited from PosCommon)
ExtendedErrorStatisticsDependency (Inherited from PosCommon)
ExtendedErrorUnderZero

Indicates the scale is reporting a weight that is less than zero due to a calibration error.

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

Indicates good weight read count for statistics reporting.

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

Indicates the scale is not ready to weigh.

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

Indicates scale weight is stable.

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

Indicates scale weight is overweight.

StatusWeightUnderZero

Indicates scale weight is less than zero.

StatusWeightUnstable

Indicates the scale weight is unstable.

StatusWeightZero

Indicates the scale weight is zero.

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

Indicates whether ReadWeight is performed asynchronously.

AutoDisable

Indicates whether POS for .NET automatically disables the scale when data is received.

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

Indicates whether a scale has a display.

CapDisplayText

Indicates whether a scale can display text.

CapFreezeValue

Indicates whether a scale supports the freezeValue method.

CapPowerReporting

Gets the power reporting capabilities of the device.

(Inherited from PosCommon)
CapPriceCalculating

Indicates whether a scale can calculate prices.

CapReadLiveWeightWithTare

Indicates whether a scale supports live weight measurements incorporating a tare value.

CapSetPriceCalculationMode

Indicates whether a scale supports different methods to calculate price.

CapSetUnitPriceWithWeightUnit

Indicates whether a scale can use different weight unit types apart from the default scale weight unite types..

CapSpecialTare

Indicates whether a scale can use different tare values in replacement of or in addition to the default scale tare value used in determining the net weight.

CapStatisticsReporting

Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage.

(Inherited from PosCommon)
CapStatusUpdate
CapTarePriority

Indicates whether a scale can use multiple tare values in a certain ranking order for the calculation of net weight and item price.

CapTareWeight

Indicates whether a scale supports a tare.

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

Indicates whether an application can set scale weight to zero.

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

Holds the number of currently queued DataEvent events.

DataEventEnabled

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

Indicates whether the Scale is an exclusive-use device.

MaxDisplayTextChars

Holds the number of characters that can be displayed.

MaximumWeight

Holds the maximum weight measurement possible from the scale.

MinimumWeight

Holds the minimum weight measurement possible from the scale.

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

Holds the sales price read from a price-calculating scale.

ScaleLiveWeight
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)
StatusNotify
SynchronizingObject

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

(Inherited from PosCommon)
TareWeight

Holds the tare weight of scale data.

UnitPrice

Holds the unit price of the article to be weighed.

WeightUnit

Holds the unit of weight of scale data.

ZeroValid

Indicates whether an application can report a valid weight as zero.

Methods

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 device input that has been buffered.

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)
DisplayText(String)

Updates display text.

DoPriceCalculating(Int32, Int32, Decimal, Decimal, Int32, Int32, Int32, Decimal, Int32)
FreezeValue(Int32, Boolean)
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)
ReadLiveWeightWithTare(Int32, Int32, Int32)
ReadWeight(Int32)

Reads a weight from the scale.

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)
SetPriceCalculationMode(PriceCalculationMode)
SetSpecialTare(SpecialTare, Int32)
SetTarePriority(TarePriority)
SetUnitPriceWithWeightUnit(Decimal, Int32, Int32, Int32)
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)
ZeroScale()

Sets the scale weight to zero.

Events

DataEvent

Fired by the service object to notify the application that an asynchronous ReadWeight has completed.

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

Fired by the service object to notify the application that a scale device error has been detected and a suitable response by the application is necessary to process the error condition.

StatusUpdateEvent

Raised by the Service Object to alert the application of a device status change.

(Inherited from PosCommon)

Applies to