Partilhar via


Informações sobre o PosCommon para Desenvolvedores de Objetos de Serviço (Documentação do SDK POS para .NET v1.14)

Na base do POS para a árvore de classes de objetos do .NET Server (Interface, Basic, Base) está PosCommon. Esta classe é uma implementação direta do capítulo "Propriedades Comuns, Métodos e Eventos" da especificação UPOS.

Cada POS para a classe Basic do .NET sobrepõe ou implementa propriedades e métodos PosCommon que são de particular importância para um desenvolvedor de Objeto de Serviço. Este tópico fornece informações sobre estes métodos e propriedades.

Propriedade CapPowerReporting

Depois de o POS para .NET abrir com sucesso um dispositivo, tenta recuperar o valor atual da CapPowerReporting propriedade. A PowerReporting classe é inicializada como Nenhuma, indicando que o Objeto de Serviço não consegue fornecer relatórios de energia. Se, no entanto, o dispositivo do Objeto de Serviço suportar relatórios de energia, o Objeto de Serviço pode definir o PowerReporting para Standard ou Advanced no método do Objeto de Serviço.

Propriedade CapStatisticsReporting

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da CapStatisticsReporting propriedade.

Quando as estatísticas são criadas para o dispositivo, o POS para .NET define o CapStatisticsReporting como true.

Propriedade CapUpdateStatistics

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da CapUpdateStatistics propriedade.

Quando as estatísticas são criadas para o dispositivo, e se essas estatísticas puderem ser reiniciadas ou atualizadas, então o POS para .NET define CapUpdateStatistics como verdadeiro.

Propriedade Reivindicada

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da Claimed propriedade.

Reivindicado é inicializado como falso. Afirmado deve ser definido como verdadeiro quando a aplicação chama o método Claim(Int32), e depois redefinido para falso quando a aplicação chama o método Release().

Propriedade Descrição do Dispositivo

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da DeviceDescription propriedade.

Propriedade DeviceEnabled

DeviceEnabled é uma propriedade de leitura/escrita.

Pode ser usado para devolver o estado atual do objeto; Ativado ou desativado. Se este objeto não tiver sido previamente aberto e ativado, esta propriedade retorna falso.

Esta propriedade também é usada para ativar ou desativar o dispositivo, definindo a propriedade do valor como verdadeiro ou falso. É comum que os Objetos de Serviço sobreponham esta propriedade e realizem aqui a sua inicialização e libertação de hardware.

Propriedade do Nome do Dispositivo

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da DeviceName propriedade.

Nas implementações de classes base , este valor é definido automaticamente com base no conteúdo do ServiceObject atributo.

Se não estiver a derivar da classe Base de um POS para .NET, e sim de uma classe de nível Interface ou Basic, então DeviceName deve ser definido pela entidade responsável pelo serviço durante a execução do método Open().

Propriedade FreezeEvents

FreezeEvents é uma propriedade de leitura/escrita.

O POS para .NET verifica que o dispositivo foi aberto e reclamado, depois recupera ou define o valor atual da propriedade FreezeEvents . Quando esta propriedade é definida como verdadeira, o POS para .NET coloca os eventos em fila até que esta propriedade seja definida como falsa, não que o mecanismo de fila possa variar de um tipo de dispositivo para outro.

A propriedade FreezeEvents é inicializada como falsa.

Propriedade PowerNotify

PowerNotify é uma propriedade de leitura/escrita.

O POS para .NET verifica que o dispositivo foi aberto e depois recupera ou define o valor atual do PowerNotify. Se o PowerNotify estiver definido, as notificações de estado de energia serão enviadas para a aplicação.

O PowerNotify é inicializado como Desabilitado.

Tentar definir PowerNotify pode causar as seguintes exceções.

Value Significado

Illegal

Uma das seguintes condições ocorreu:

  • O dispositivo está ativado.
  • P:Microsoft.PointOfService.PosCommon.CapPowerReporting está definido como Nenhum, indicando que o dispositivo não suporta notificação de energia.
  • O valor especificado não é um valor válido de enumeração T:Microsoft.PointOfService.PowerNotification.

Propriedade PowerState

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da PowerState propriedade. Se o CapPowerReporting estiver definido como Nenhum, o PowerNotify como Desabilitado, ou o DeviceEnabled como falso, o PowerState é devolvido como Desconhecido.

O PowerState é inicializado como Desconhecido. Quando o PowerNotify está definido como Ativado e o DeviceEnabled é verdadeiro, o PowerState deve ser atualizado à medida que o Objeto de Serviço deteta alterações nas condições de energia. O POS para .NET deteta a alteração de estado quando o Objeto de Serviço define o PowerState e — se o PowerNotifyestiver ativado — coloca um StatusUpdateEvent evento em fila, notificando a aplicação.

A definição PowerState pode fazer com que as seguintes exceções sejam lançadas.

Value Significado

Illegal

Uma das seguintes condições ocorreu:

  • CapPowerReporting = Standard e PowerNotify estão definidos para Online, Off ou Offline.
  • CapPowerReporting = Avançado e PowerState estão definidos para Online, Desligado ou Desligado.

Propriedade ServiceObjectDescription

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da ServiceObjectDescription propriedade. O programador do Objeto de Serviço não deveria ter de definir este valor, uma vez que é definido pelo POS para a classe . NET Basic usando a informação de descrição fornecida no ServiceObject atributo.

Propriedade ServiceObjectVersion

O POS para .NET verifica que o dispositivo foi aberto e depois recupera o valor atual da ServiceObjectVersion propriedade. O programador do Objeto de Serviço não deve ter de definir este valor, pois é definido pelo POS para a classe . NET Basic usando a informação de versão fornecida no ServiceObject atributo.

Propriedade do Estado

Não é necessária verificação do estado do dispositivo — a aplicação pode recuperar o valor atual da State property.at a qualquer momento.

O estado é inicializado para Fechado. Se o Objeto de Serviço definir o Estado para um valor inválido ControlState , o POS para .NET lança uma exceção Ilegal. Alterações de Estado fazem com que o POS em .NET coloque um evento StateChangedEvent na fila.

Método de reivindicação

O POS para .NET verifica que a aplicação tem o dispositivo aberto.

Se o parâmetro de timeout for definido para um valor inferior a -1, o POS para .NET lança uma exceção. Se o valor de timeout for definido para -1, o método de Reclamação espera para sempre.

Se o dispositivo já for reclamado pela aplicação, o POS para .NET simplesmente retorna.

Se o dispositivo estiver a ser utilizado por outra aplicação, atinge-se timeout; o POS .NET lança uma exceção de tempo limite.

Se a Reclamação for bem-sucedida, o POS para .NET carrega as estatísticas do dispositivo e define a propriedade Reclamada como verdadeira.

Método Close

Se a aplicação chamar o Close() método quando o Estado está definido como Fechado, o POS para .NET lança uma exceção Closed. Se Estado estiver definido como Ocupado, o POS para .NET lança uma exceção Ocupado.

Se o método DeviceEnabled , quando Reclamado , estiver definido como falso, o POS para .NET lança uma exceção Ilegal. Se Estado estiver definido para Ocupado, POS para .NET chama o método ClearOutput. Se o dispositivo estiver ativado, o POS para .NET define o DeviceEnabled como falso. O POS para .NET limpa a fila de eventos e depois define Claimed como falso.

Método ResetStatistic

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método ResetStatistic(String).

Método ResetStatistics()

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método ResetStatistics().

ResetStatistics(parâmetro de categorias) Método

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método ResetStatistics(StatisticCategories).

Método ResetStatistics(parâmetro string)

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método ResetStatistics(String[]).

Método RetrieveStatistic

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método RetrieveStatistic(String).

Método RetrieveStatistics()

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método RetrieveStatistics().

Método RetrieveStatistics (parâmetro de categorias)

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método RetrieveStatistics(StatisticCategories).

Método RetrieveStatistics (parâmetro do tipo string)

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método RetrieveStatistics(String[]).

Método UpdateStatistic

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método UpdateStatistic(String, Object).

Método UpdateStatistics (parâmetro de categorias)

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método UpdateStatistics(StatisticCategories, Object).

Método UpdateStatistics (parâmetro de matriz de estatísticas)

O POS para .NET verifica que a aplicação abriu, reservou e ativou o dispositivo, e depois chama o método UpdateStatistics(Statistic[]).

Ver também

Reference

Conceitos

Outros recursos