Compartilhar via

Classe PosCommon (POS para documentação do SDK do .NET v1.14)

PosCommon é Base para todas as classes de interface específicas e todos os Objetos de Serviço derivam indiretamente dela. PosCommon define as propriedades, métodos e eventos comuns que a especificação UnifiedPOS (Unified Point Of Service) requer em todas as classes de dispositivo.

Propriedades de PosCommon

A tabela a seguir descreve as propriedades da classe PosCommon disponível para aplicativos POS.

Propriedade Type Descrição
CapCompareFirmwareVersion bool Indica se o objeto de serviço e o dispositivo oferecem suporte à comparação da versão do firmware com um arquivo de firmware no dispositivo físico.
CapPowerReporting Enumeração de PowerReporting Indica os recursos de relatório de energia do dispositivo.
CapStatisticsReporting bool Indica se o dispositivo pode acumular e fornecer várias estatísticas de uso.
CapUpdateStatistics bool Se definido como true, algumas ou todas as estatísticas do dispositivo podem ser redefinidas para 0 (zero) usando o método ResetStatistic no caso de uma atualização, e o método ResetStatistics no caso de uma lista de atualizações, ou as atualizações são realizadas pelo método UpdateStatistic no caso de uma atualização, e o método UpdateStatistics no caso de uma lista de atualizações com os valores especificados correspondentes.
CapUpdateFirmware bool Indica se o firmware do dispositivo pode ser atualizado por meio do método UpdateFirmware.
CheckHealthText string Indica a integridade do dispositivo.
Claimed bool Indica se o dispositivo teve o acesso exclusivo solicitado.
DeviceDescription string Contém uma cadeia de caracteres que identifica o dispositivo e a empresa que o fabricou.
DeviceEnabled bool Indica se o dispositivo está em um estado operacional.
DeviceName string UnifiedPOS o chama de PhysicalDeviceName. O OLE para Retail POS (OPOS) o chama de DeviceName.
DevicePath string Definido por POS para .NET para dispositivos Plug and Play. Para dispositivos não Plug and Play, o DevicePath pode ser atribuído usando um arquivo de configuração.
FreezeEvents bool Quando definido como true, o aplicativo solicitou que o Objeto de Serviço não entregasse eventos.
PowerNotify Enumeração de PowerNotification Contém o tipo de seleção de notificação de potência feita pelo aplicativo.
PowerState Enumeração de PowerState Mantém a condição de energia atual.
ServiceObjectDescription string Identifica o Objeto de Serviço que dá suporte ao dispositivo e à empresa que o produziu. Essa propriedade é listada como DeviceServiceDescription na especificação UnifiedPOS.
ServiceObjectVersion System.Version Contém o número de versão do Objeto de Serviço. Essa propriedade é listada como DeviceServiceVersion na especificação UnifiedPOS.
Estado Enumeração de ControlState Mantém o estado atual do dispositivo.
SynchronizingObject ISynchronizeInvoke Obtém ou define o objeto de marshalling para chamadas do manipulador de eventos de um evento de POS.

Métodos de PosCommon

A tabela a seguir descreve os métodos da classe PosCommon disponíveis para aplicativos.

Método Tipo de retorno Descrição
CheckHealth string Executa uma verificação de integridade no dispositivo. O tipo de verificação a ser executada é indicado pelo parâmetro HealthCheckLevel. O método também atualiza a propriedade CheckHealthText.
Declaração void Solicita acesso exclusivo ao dispositivo. Os gravadores de Objeto de Serviço são aconselhados a gerar apenas exceções em condições inesperadas, por exemplo, OutOfMemory. Do contrário, os Objetos de Serviço deverão retornar True se o dispositivo tiver sido reivindicado e False se ocorrer um tempo limite.
Fechar void Libera o dispositivo e seus recursos.
CompareFirmwareVersion CompareFirmwareResult Determina se a versão do firmware especificado é mais recente, mais antiga ou igual à versão do firmware no dispositivo físico.
DirectIO DirectIOData Usado para comunicação direta com o Objeto de Serviço. Na especificação UnifiedPOS, ele tem dois parâmetros de entrada/saída. Conforme usado pelo POS para .NET, esse método retorna uma estrutura e nenhum parâmetro de entrada/saída.
Aberto void Abre um dispositivo para processamento de entrada/saída subsequente.
Versão void Libera acesso exclusivo ao dispositivo.
ResetStatistic void Redefine a estatística especificada como zero. Usado no POS para .NET em operações com uma única estatística.
ResetStatistics void Redefine todas as estatísticas de uma categoria especificada como 0 (zero).
ResetStatistics void Redefine as estatísticas especificadas como 0 (zero).
ResetStatistics void Redefine todas as estatísticas associadas a um dispositivo para 0 (zero).
RetrieveStatistic string Recupera a estatística de dispositivo especificada. Usado no POS para .NET em operações com uma única estatística.
RetrieveStatistics string Recupera todas as estatísticas do dispositivo.
RetrieveStatistics void Recupera as estatísticas para a categoria especificada.
RetrieveStatistics void Recupera as estatísticas especificadas.
UpdateFirmware void Atualiza o firmware de um dispositivo com a versão do firmware contida no nome de arquivo especificado.
UpdateStatistic void Atualiza uma estatística. Adicionado ao POS para .NET em operações com uma única estatística.
UpdateStatistics void Atualiza uma lista de estatísticas com os valores especificados correspondentes.
UpdateStatistics void Atualiza a categoria de estatísticas especificada com o valor especificado.

Eventos de PosCommon

A tabela a seguir descreve os eventos de classe PosCommon.

Método Descrição
DirectIOEvent Gerado pelo Objeto de Serviço para comunicar informações diretamente ao aplicativo.
StatusUpdateEvent Gerado pelo Objeto de Serviço para alertar o aplicativo de uma alteração de status do dispositivo.

Exemplo

O exemplo de código a seguir demonstra como usar as propriedades e os métodos comuns a todos os Objetos de Serviço de modo a exibir informações sobre um 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 Também

Conceitos

  • Last updated on