Classes Basic des appareils POS pour .NET (documentation du SDK POS pour .NET v1.14)

Chaque appareil matériel dans POS pour .NET est représenté à la fois par une interface abstraite, comme la classe CashDrawer, et par une classe Basic, comme CashDrawerBasic. Les classes Basic dérivent de l’interface sous-jacente et contiennent une prise en charge fonctionnelle de base pour l’appareil. POS pour .NET fournit une prise en charge générique de l’ouverture, de la revendication et de l’activation de l’appareil, des statistiques d’appareil et de la gestion de la remise d’événements à l’application. En outre, chaque classe Basic contient un ensemble de méthodes héritées et protégées qui peuvent être implémentées par l’objet Service. Cette rubrique fournit des informations récapitulatives sur les classes Basic qui peuvent être utilisées par les objets Service qui dérivent de la classe Basic de l’appareil, au lieu de tirer parti de la classe Base d’appareil plus entièrement implémentée.

Constructeur

Chaque classe Basic inclut un constructeur qui crée une instance de la classe et initialise des statistiques pour la version UPOS, la catégorie d’appareil et la date d’installation.

Propriétés et méthodes communes

Chaque classe Basic fournit des définitions de propriété et de méthode PosCommon remplacées. Pour chacune de ces propriétés et méthodes, la classe Basic gère la validation de l’état, c’est-à-dire la vérification du fait que l’application a ouvert, revendiqué ou activé l’appareil, puis appelle l’implémentation de POS pour .NET de cette propriété ou méthode. Pour plus d’informations sur la classe PosCommon, consultez PosCommon.

L’objet Service peut utiliser la classe CommonProperties pour mettre à jour les propriétés PosCommon qui sont conçues en lecture seule pour l’application, ou pour mettre à jour ces propriétés sans se soucier de la validation de l’état.

Méthodes Dispose

Chaque classe Basic comprend deux méthodes Dispose implémentées pour une utilisation par l’objet Service. Pour plus d’informations sur leur fonctionnement, consultez la documentation de .NET Framework pour la classe IDisposable.

Ouverture, revendication et activation d’appareils

Chaque classe Basic fournit les fonctionnalités de base pour l’ouverture, la revendication et l’activation des appareils. Cependant, en règle générale, les objets Service veulent remplacer ces méthodes pour ajouter leur propre traitement personnalisé.

Méthodes et événements protégés pour les développeurs d’objets Service

Chaque classe Basic contient un groupe de méthodes et d’événements pour le développeur d’objets Service.

Les propriétés protégées suivantes sont définies comme suit :

• Propriété CommonProperties, qui retourne une instance de CommonProperties avec des valeurs get et set pour toutes les propriétés PosCommon. L’objet Service peut utiliser CommonProperties pour mettre à jour les propriétés sans se soucier de la validation de l’état ou de la désignation de la propriété en lecture seule pour l’application.
• Propriété ExternallyClaimed, que les objets Service peuvent récupérer pour déterminer si une autre instance de l’appareil a été revendiquée (auquel cas la propriété est définie sur true).
• Propriété ErrorCount. Quand l’objet Service interroge la valeur de ErrorCount, la classe Basic vérifie la file d’attente des événements et vérifie le nombre d’événements ErrorEvent trouvés, puis retourne ce décompte sous la forme de la valeur de ErrorCount.
• Propriété DataCount. POS pour .NET vérifie que l’appareil a été ouvert, puis retourne le nombre d’événements DataEvent actuellement mis en file d’attente pour l’appareil.

Les méthodes protégées suivantes sont définies :

• StateChangedEvent et StateChangedEventHandler délégué (classe EventArgs). L’objet Service peut les implémenter pour recevoir une notification quand la propriété State de l’appareil a changé.
• Méthodes protégées PreFireEvent pour chaque type d’événement pris en charge par l’appareil. Chaque classe Basic fournit une implémentation générique par défaut de PreFireEvent qui retourne immédiatement. Si l’objet Service doit mettre à jour son état interne avant l’envoi d’un événement à l’application, l’objet Service peut remplacer l’implémentation par défaut de PreFireEvent et fournir sa propre implémentation pour le type d’événement en question.
• Méthodes protégées QueueEvent pour chaque type d’événement pris en charge par l’appareil. L’objet Service appelle QueueEvent pour ajouter un événement à la file d’attente des événements. La classe Basic vérifie que l’appareil est activé, puis ajoute l’événement à la file d’attente des événements à délivrer à l’application. Immédiatement avant la remise, la classe Basic appelle le PreFireEvent approprié pour permettre à l’objet Service de mettre à jour son état interne. Quand PreFireEvent retourne, la classe Basic délivre l’événement à l’application.
• Méthodes protégées QueueEventAndWait. L’objet Service appelle QueueEventAndWait pour ajouter un événement ErrorEvent ou un événement DirectIOEvent à la file d’attente des événements, de laquelle l’objet Service attend une réponse de l’application. La classe Basic vérifie que l’appareil est activé, puis ajoute l’événement à la file d’attente des événements à délivrer à l’application quand les conditions sont correctes. Immédiatement avant la remise, la classe Basic appelle PreFireEvent pour permettre à l’objet Service de mettre à jour son état interne. Quand PreFireEvent retourne, la classe Basic délivre l’événement à l’application.
• Méthode VerifyState, qui prend deux valeurs booléennes, mustBeClaimed et mustBeEnabled. L’objet Service peut appeler l’implémentation POS pour .NET de cette méthode pour effectuer la validation d’état nécessaire pour l’appareil, avant un appel de méthode ou de propriété.
• Méthode CreateStatistic. L’objet Service doit utiliser ces méthodes pour créer des statistiques (spécifiques au fabricant) personnalisées. POS pour .NET gère la création et la gestion de toutes les statistiques définies par UPOS.
• Les méthodes SetStatisticValue et IncrementStatistic permettent à l’objet Service de mettre à jour une statistique spécifiée même si elle n’est pas définie comme réinitialisable (autrement dit, ces méthodes contournent les règles appliquées par les méthodes PosCommonResetStatistic(String) et UpdateStatistic(String, Object)).
• Méthode SetStatisticHandlers(String, GetStatistic, SetStatistic), qui permet aux objets Service de fournir des fonctions de rappel externe pour la récupération et la définition de statistiques basées sur le matériel. Si une propriété get n’est pas définie, la classe Basic suppose que la statistique est basée sur le logiciel et que sa valeur est conservée dans le fichier XML de statistiques. Si les propriétés get et set sont définies, la classe Basic appelle ces fonctions chaque fois que la statistique doit être mise à jour ou réinitialisée. Il incombe à l’objet Service de fournir du code pour mettre à jour la statistique dans le matériel.
• Méthode ClearInput. POS pour .NET efface les files d’attente des événements pour l’appareil, puis appelle l’implémentation de ClearInputImpl de l’objet Service.
• Méthode ClearInputImpl. L’objet Service doit implémenter cette méthode pour effacer les mémoires tampons matérielles de l’appareil.

Voir aussi

Autres ressources

• Développement d’un objet de service personnalisé
• Architecture des objets de service POS pour .NET