PosCommon クラス (POS for .NET v1.14 SDK ドキュメント)

PosCommon は、すべての特定のインターフェイス クラスに対する基底クラスです。すべてのサービス オブジェクトは間接的にそこから派生します。 PosCommon には、Unified Point Of Service (UnifiedPOS) 仕様がすべてのデバイス クラスで必須にしている共通のプロパティ、メソッド、イベントが定義されています。

PosCommon プロパティ

次の表は、POS アプリケーションに使用できる PosCommon クラスのプロパティを説明したものです。

プロパティ	タイプ	説明
CapCompareFirmwareVersion	[bool]	サービス オブジェクトとデバイスが、物理デバイス内のファームウェア バージョンとファームウェア ファイルのバージョンとの比較をサポートするかどうかを示します。
CapPowerReporting	PowerReporting 列挙型	デバイスの電力レポート機能を示します。
CapStatisticsReporting	[bool]	使用状況に関するさまざまな統計情報をデバイスが蓄積し、提供できるかどうかを示します。
CapUpdateStatistics	[bool]	true に設定すると、デバイスの統計情報の一部またはすべてを、1 つの更新の場合 ResetStatistic メソッド、更新の一覧の場合は ResetStatistics メソッドを使って 0 (ゼロ) にリセットすることができます。また、1 つの更新の場合は UpdateStatistic メソッド、更新の一覧の場合は UpdateStatistics メソッドを使って、対応する指定値で更新することができます。
CapUpdateFirmware	[bool]	UpdateFirmware メソッドを使ってデバイスのファームウェアを更新できるかどうかを示します。
CheckHealthText	string	デバイスの正常性を示します。
Claimed	[bool]	デバイスが排他的アクセスを要求されているかどうかを示します。
DeviceDescription	string	デバイスとそれを製造した会社を識別する文字列を保持します。
DeviceEnabled	[bool]	デバイスが動作状態であるかどうかを示します。
DeviceName	string	UnifiedPOS では PhysicalDeviceName と呼ばれます。OLE for Retail POS (OPOS) では DeviceName と呼ばれます。
DevicePath	string	プラグ アンド プレイ デバイスの場合、POS for .NET によって設定されます。 非プラグ アンド プレイ デバイスの場合、構成ファイルを使って DevicePath を割り当てることができます。
FreezeEvents	[bool]	true に設定されている場合、アプリケーションはサービス オブジェクトに対してイベントを配信しないよう要求しています。
PowerNotify	PowerNotification 列挙型	アプリケーションによって選ばれた電源通知の種類を保持します。
PowerState	PowerState 列挙型	現在の電源状態を保持します。
ServiceObjectDescription	string	デバイスをサポートするサービス オブジェクトと、それを製造した会社を識別します。 このプロパティは、UnifiedPOS 仕様書には DeviceServiceDescription と記載されています。
ServiceObjectVersion	System.Version	サービス オブジェクトのバージョン番号を保持します。 このプロパティは、UnifiedPOS 仕様書には DeviceServiceVersion と記載されています。
State	ControlState 列挙型	デバイスの現在の状態を保持します。
SynchronizingObject	ISynchronizeInvoke	POS イベントからのイベント ハンドラーの呼び出しに対してマーシャリング オブジェクトを取得または設定します。

PosCommon メソッド

次の表は、アプリケーションに使用できる PosCommon クラスのメソッドを説明したものです。

メソッド	返り値の種類	説明
CheckHealth	string	デバイスに対して正常性チェックを実行します。 実行されるチェックの種類は、HealthCheckLevel パラメーターで示されます。 このメソッドを実行すると、CheckHealthText プロパティも更新されます。
要求	void	デバイスに対する排他的アクセスを要求します。 サービス オブジェクトの作成者は、OutOfMemory などの予期しない状況でのみ例外をスローすることをお勧めします。 そうでない場合、サービス オブジェクトは、デバイスが要求された場合は True を、タイムアウトが発生した場合は False を返すようにします。
閉じる	void	デバイスとそのリソースを解放します。
CompareFirmwareVersion	CompareFirmwareResult	指定したファームウェアのバージョンが物理デバイスのファームウェアのバージョンよりも新しいか、古いか、または同じかを判断します。
DirectIO	DirectIOData	サービス オブジェクトと直接通信するために使われます。 UnifiedPOS 仕様では、2 つの in/out パラメーターがあります。 POS for .NET で使われる場合、このメソッドは構造体を返し、in/out パラメーターはありません。
[ファイル]	void	後続の入出力プロセスのためにデバイスを開きます。
リリース	void	デバイスに対する排他的アクセスを解放します。
ResetStatistic	void	指定した統計情報値をゼロにリセットします。 POS for .NET で 1 つの統計情報に対する操作に使われます。
ResetStatistics	void	指定したカテゴリのすべての統計情報を 0 (ゼロ) にリセットします。
ResetStatistics	void	指定した統計情報を 0 (ゼロ) にリセットします。
ResetStatistics	void	デバイスに関連付けられたすべての統計情報を 0 (ゼロ) にリセットします。
RetrieveStatistic	string	指定したデバイスの統計情報を取得します。 POS for .NET で 1 つの統計情報に対する操作に使われます。
RetrieveStatistics	文字列	すべてのデバイスの統計情報を取得します。
RetrieveStatistics	void	指定したカテゴリの統計情報を取得します。
RetrieveStatistics	void	指定した統計情報を取得します。
UpdateFirmware	void	デバイスのファームウェアを、指定したファイル名に含まれるバージョンのファームウェアに更新します。
UpdateStatistic	void	統計情報を更新します。 1 つの統計情報に対する操作のために POS for .NET に追加されます。
UpdateStatistics	void	統計情報の一覧を、対応する指定した値で更新します。
UpdateStatistics	void	指定した統計情報のカテゴリを指定した値で更新します。

PosCommon イベント

次の表は、PosCommon クラス イベントを説明したものです。

メソッド	説明
DirectIOEvent	情報をアプリケーションに直接伝達するために、サービス オブジェクトによって生成されます。
StatusUpdateEvent	デバイスの状態の変化をアプリケーションに警告するために、サービス オブジェクトによって生成されます。

例

次のコード例は、すべてのサービス オブジェクトに共通するプロパティとメソッドを使って、接続されたデバイスに関する情報を表示する方法を示しています。

// 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();

参照

概念

• POS for .NET クラス ツリー