ALL.Net Wi-Fi ルータの情報を提供するクラス。 [詳解]

#include <WiFiUnit.h>

公開メンバ関数
	WiFiUnit (::amdaemon::InnerIndexHolder)
	コンストラクタ。 [詳解]

bool	isCache () const
	キャッシュされた情報であるか否かを取得する。 [詳解]

bool	valid () const
	情報が有効であるか否かを取得する。 [詳解]

bool	isAuthGood () const
	ALL.Net認証が成功済みであるか否かを取得する。 [詳解]

const wchar_t *	getAuthGoodText () const
	ALL.Net認証が成功済みであるか否かを表す文字列を取得する。 [詳解]

const wchar_t *	getSerial () const
	ルータのシリアル文字列を取得する。 [詳解]

const wchar_t *	getFirmVersion () const
	ルータのファームウェアバージョンを取得する。 [詳解]

bool	isServerAlive () const
	ALL.Net Wi-Fi サーバ群との疎通が確認できているか否かを取得する。 [詳解]

const wchar_t *	getServerAliveText () const
	ALL.Net Wi-Fi サーバ群との疎通が確認できているか否かを表す文字列を取得する。 [詳解]

std::size_t	getAccessCount () const
	ルータにアクセス中の無線子機数を取得する。 [詳解]

const wchar_t *	getMasterSerial () const
	マスター ALL.Net Wi-Fi ルータのシリアル文字列を取得する。 [詳解]

詳解

ALL.Net Wi-Fi ルータの情報を提供するクラス。

参照: WiFi, WiFi::saveUnitCache, WiFi::clearUnitCache

このクラスのインスタンスをアプリ側で直接生成することはできない。 WiFi クラスのメンバ関数 WiFi::getUnit から取得すること。

このクラスが返す情報は、最新値の場合とキャッシュされた値の場合がある。キャッシュされた値であるか否かはメンバ関数 isCache で確認できる。

キャッシュに関して詳しくは WiFi クラスの説明を参照すること。

構築子と解体子

amdaemon::allnet::WiFiUnit::WiFiUnit ( ::amdaemon::InnerIndexHolder )

explicit

コンストラクタ。

覚え書き: アプリ側からは利用できない。

関数詳解

bool amdaemon::allnet::WiFiUnit::isCache ( ) const

キャッシュされた情報であるか否かを取得する。

戻り値

true	キャッシュされた情報である場合。
false	最新の情報である場合。

WiFi::isUnitCacheSaved と同じ値を返す。

キャッシュに関して詳しくは WiFi クラスの説明を参照すること。

bool amdaemon::allnet::WiFiUnit::valid ( ) const

情報が有効であるか否かを取得する。

戻り値

true	有効である場合。
false	無効である場合。

bool amdaemon::allnet::WiFiUnit::isAuthGood ( ) const

ALL.Net認証が成功済みであるか否かを取得する。

戻り値

true	成功済みである場合。
false	未成功であるか、情報が無効である場合。

参照: getAuthGoodText

ボードではなく ALL.Net Wi-Fi ルータの認証成否であることに注意。

この情報を表示に利用する場合、メンバ関数 getAuthGoodText の利用を推奨する。

const wchar_t* amdaemon::allnet::WiFiUnit::getAuthGoodText ( ) const

ALL.Net認証が成功済みであるか否かを表す文字列を取得する。

戻り値

GOOD	成功済みである場合。
BAD	未成功である場合。
""	情報が無効である場合。

参照: isAuthGood

ゲームテストモードでの表示に用いることを想定している。

const wchar_t* amdaemon::allnet::WiFiUnit::getSerial ( ) const

ルータのシリアル文字列を取得する。

戻り値: シリアル文字列。情報が無効ならば空文字列。

const wchar_t* amdaemon::allnet::WiFiUnit::getFirmVersion ( ) const

ルータのファームウェアバージョンを取得する。

戻り値: ファームウェアバージョン。情報が無効ならば空文字列。

bool amdaemon::allnet::WiFiUnit::isServerAlive ( ) const

ALL.Net Wi-Fi サーバ群との疎通が確認できているか否かを取得する。

戻り値

true	疎通が確認できている場合。
false	疎通が確認できていないか、情報が無効である場合。

参照: getServerAliveText

この情報を表示に利用する場合、メンバ関数 getServerAliveText の利用を推奨する。

const wchar_t* amdaemon::allnet::WiFiUnit::getServerAliveText ( ) const

ALL.Net Wi-Fi サーバ群との疎通が確認できているか否かを表す文字列を取得する。

戻り値

GOOD	疎通が確認できている場合。
BAD	疎通が確認できていない場合。
""	情報が無効である場合。

参照: isServerAlive

ゲームテストモードでの表示に用いることを想定している。

std::size_t amdaemon::allnet::WiFiUnit::getAccessCount ( ) const

ルータにアクセス中の無線子機数を取得する。

戻り値: アクセス中の無線子機数。情報が無効ならば 0 。

const wchar_t* amdaemon::allnet::WiFiUnit::getMasterSerial ( ) const

マスター ALL.Net Wi-Fi ルータのシリアル文字列を取得する。

戻り値: シリアル文字列。マスター ALL.Net Wi-Fi ルータが見つからないならば "N/A" 。情報が無効ならば空文字列。

マスター ALL.Net Wi-Fi ルータは店舗(ロケーション)ごとに1つだけ設置される。そのためこの関数は、同じ店舗内ならばどのルータであっても同じシリアル文字列を返す。

このクラス詳解は次のファイルから抽出されました:

WiFiUnit.h

公開メンバ関数

詳解

構築子と解体子

関数詳解