PosCommon (clase) (documentación del SDK de POS para .NET v1.14)

PosCommon es la clase base para todas las clases Interface específicas y todos los objetos de servicio se derivan indirectamente de ella. PosCommon define las propiedades, los métodos y los eventos comunes que la especificación Unified Point of Service (UnifiedPOS) requiere en todas las clases de dispositivo.

Propiedades de PosCommon

En la tabla siguiente se describen las propiedades de la clase PosCommon disponible para las aplicaciones POS.

Propiedad	Tipo	Descripción
CapCompareFirmwareVersion	bool	Indica si el objeto de servicio y el dispositivo admiten la comparación de la versión de firmware del dispositivo físico con la de un archivo de firmware.
CapPowerReporting	Enumeración PowerReporting	Indica las funcionalidad de generación de informes de alimentación del dispositivo.
CapStatisticsReporting	bool	Indica si el dispositivo puede acumular y proporcionar varias estadísticas sobre el uso.
CapUpdateStatistics	bool	Si se establece en true, algunas o todas las estadísticas del dispositivo se pueden restablecer en 0 (cero) con el método ResetStatistic para una actualización y el método ResetStatistics para una lista de actualizaciones, o bien se pueden actualizar con el método UpdateStatistic para una actualización y el método UpdateStatistics para una lista de actualizaciones con los valores especificados correspondientes.
CapUpdateFirmware	bool	Indica si el firmware del dispositivo se puede actualizar a través del método UpdateFirmware.
CheckHealthText	string	Indica el estado del dispositivo.
Claimed	bool	Indica si el dispositivo se reclama para acceso exclusivo.
DeviceDescription	string	Contiene una cadena que identifica el dispositivo y la empresa que lo fabricó.
DeviceEnabled	bool	Indica si el dispositivo está en un estado operativo.
DeviceName	string	UnifiedPOS lo denomina PhysicalDeviceName; OLE para Retail POS (OPOS) lo denomina DeviceName.
DevicePath	string	Lo establece POS para .NET para dispositivos Plug and Play. Para los dispositivos que no son Plug and Play, DevicePath se puede asignar usando un archivo de configuración.
FreezeEvents	bool	Cuando se establece en true, la aplicación ha solicitado que el objeto de servicio no entregue eventos.
PowerNotify	Enumeración PowerNotification	Contiene el tipo de selección de notificación de alimentación realizada por la aplicación.
PowerState	Enumeración PowerState	Contiene la condición de alimentación actual.
ServiceObjectDescription	string	Identifica el objeto de servicio que sustenta el dispositivo y la empresa que lo produjo. Esta propiedad aparece como DeviceServiceDescription en la especificación UnifiedPOS.
ServiceObjectVersion	System.Version	Contiene el número de versión del objeto de servicio. Esta propiedad aparece como DeviceServiceVersion en la especificación UnifiedPOS.
State	Enumeración ControlState	Contiene el estado actual del dispositivo.
SynchronizingObject	ISynchronizeInvoke	Obtiene o establece el objeto de serialización para las llamadas del controlador de eventos desde un evento de POS.

Métodos PosCommon

En la tabla siguiente se describen los métodos de la clase PosCommon disponibles para las aplicaciones.

Método	Tipo devuelto	Descripción
CheckHealth	string	Realiza una comprobación de estado en el dispositivo. El tipo de comprobación que se va a realizar se indica con el parámetro HealthCheckLevel. El método también actualiza la propiedad CheckHealthText.
Notificación	void	Solicita acceso exclusivo al dispositivo. Se recomienda que los escritores de objetos de servicio solo produzcan excepciones en condiciones inesperadas; por ejemplo, OutOfMemory. De lo contrario, los objetos de servicio deben devolver True si se ha reclamado el dispositivo y False si se ha agotado el tiempo de espera.
Cerrar	void	Libera el dispositivo y sus recursos.
CompareFirmwareVersion	CompareFirmwareResult	Determina si la versión del firmware especificado es más reciente, anterior o igual que la versión del firmware del dispositivo físico.
DirectIO	DirectIOData	Se usa para comunicarse directamente con el objeto de servicio. En la especificación UnifiedPOS, tiene dos parámetros in/out. En POS para .NET, este método devuelve una estructura sin parámetros in/out.
Abrir	void	Abre un dispositivo para el procesamiento posterior de entrada y salida.
Release	void	Libera el acceso exclusivo al dispositivo.
ResetStatistic	void	Restablece la estadística especificada en cero. Se usa en POS para .NET para las operaciones con una sola estadística.
ResetStatistics	void	Restablece todas las estadísticas de una categoría especificada en 0 (cero).
ResetStatistics	void	Restablece las estadísticas especificadas en 0 (cero).
ResetStatistics	void	Restablece todas las estadísticas asociadas a un dispositivo en 0 (cero).
RetrieveStatistic	string	Recupera la estadística del dispositivo especificada. Se usa en POS para .NET para las operaciones con una sola estadística.
RetrieveStatistics	string	Recupera todas las estadísticas del dispositivo.
RetrieveStatistics	void	Recupera las estadísticas de la categoría especificada.
RetrieveStatistics	void	Recupera las estadísticas especificadas.
UpdateFirmware	void	Actualiza el firmware de un dispositivo con la versión del firmware que hay en el nombre de archivo especificado.
UpdateStatistic	void	Actualiza una estadística. Se ha agregado a POS para .NET para las operaciones con una sola estadística.
UpdateStatistics	void	Actualiza una lista de estadísticas con los valores especificados correspondientes.
UpdateStatistics	void	Actualiza la categoría de estadísticas especificada con el valor especificado.

Eventos PosCommon

En la tabla siguiente se describen los eventos de clase PosCommon.

Método	Descripción
DirectIOEvent	Lo genera el objeto de servicio para comunicarle información directamente a la aplicación.
StatusUpdateEvent	Lo genera el objeto de servicio para alertar a la aplicación de un cambio de estado del dispositivo.

Ejemplo

El ejemplo de código siguiente muestra cómo usar las propiedades y los métodos comunes a todos los objetos de servicio para mostrar información sobre un dispositivo conectado.

// Create a derived class of PosCommon
public class PosCommonSample: PosCommon
{
    // Implement all base methods and properties.
    // ...
}

// Create instances for the example.
PosExplorer explorer = new PosExplorer();
PosCommonSample pcs = new PosCommonSample();
DeviceInfo device = explorer.GetDevice("MSR");
pcs = (PosCommonSample)explorer.CreateInstance(device);

// Open and claim the device, then print information
// about the device to the console.
pcs.Open();
pcs.Claim(1000);
Console.WriteLine("Name: {0}", pcs.DeviceName);
Console.WriteLine("Description: {0}", pcs.DeviceDescription);
Console.WriteLine("Path: {0}", pcs.DevicePath);
Console.WriteLine("Enabled: {0}", pcs.DeviceEnabled);

pcs.Close();

Consulte también

Conceptos

• Árbol de clases de POS para .NET