CTR NEX API Reference
nn::nex::DataStoreDataCode クラス

データ ID と表示用のデータコード文字列を相互変換するクラスです。 [詳解]

#include <RendezVous/Services/Jugem/DataStore/src/Common/DataStoreDataCode.h>

+ nn::nex::DataStoreDataCode の継承関係図

公開メンバ関数

qUnsignedInt64 GetDataCodeRaw ()
 内部データコードを取得します。 [詳解]
 
qUnsignedInt64 GetDataId ()
 データ ID を取得します。 [詳解]
 
qBool IsValid ()
 このオブジェクトが有効なデータコード文字列、有効なデータ ID もしくは有効な内部データコードから 生成されたものか判定します。 [詳解]
 
String ToDataCodeString ()
 データコード文字列を生成します。 [詳解]
 
String ToDataCodeStringZeroPad ()
 データコード文字列を生成します。 14文字に満たない場合は、上位を 0 で埋めます。 [詳解]
 

静的公開メンバ関数

static DataStoreDataCode CreateFromDataCodeRaw (const String &key, qUnsignedInt64 dataCodeRaw)
 64 ビット整数値の内部データコード から DataStoreDataCode オブジェクトを生成します [詳解]
 
static DataStoreDataCode CreateFromDataCodeString (const String &key, const String &dataCodeString)
 データコード文字列 から DataStoreDataCode オブジェクトを生成します [詳解]
 
static DataStoreDataCode CreateFromDataId (const String &key, qUnsignedInt64 dataId)
 データ ID から DataStoreDataCode オブジェクトを生成します [詳解]
 

詳解

データ ID と表示用のデータコード文字列を相互変換するクラスです。

データコード文字列とは、データ ID と チェックサムを含む、 0 1 2 3 4 5 6 7 8 9 B C D F G H J K L M N P R T V W X Y の28文字 からなる 最大 14 文字の文字列です。 データ ID は、最大 56 ビット まで利用可能です。

関数詳解

static DataStoreDataCode nn::nex::DataStoreDataCode::CreateFromDataId ( const String key,
qUnsignedInt64  dataId 
)
static

データ ID から DataStoreDataCode オブジェクトを生成します

56 ビットを超える場合は、 IsValid() が False となります。

引数
[in]keyチェックサム算出時の鍵。自タイトルのアクセスキーを指定してください。
[in]dataIdデータ ID
戻り値
DataStoreDataCode オブジェクト
参照
IsValid(), GetDataId()
static DataStoreDataCode nn::nex::DataStoreDataCode::CreateFromDataCodeString ( const String key,
const String dataCodeString 
)
static

データコード文字列 から DataStoreDataCode オブジェクトを生成します

データコード文字列の妥当性検証時に、データコード文字列に小文字が含まれる場合には大文字に変換され、入力ミスが疑われる文字は適切な文字に変換されます。 (I->1, Q->0, O->0, Z->2, S->5)

データコード文字列が妥当であるかは、 オブジェクト生成後に、 IsValid() でチェックしてくてください。

引数
[in]keyチェックサム算出時の鍵。自タイトルのアクセスキーを指定してください。
[in]dataCodeStringデータコード文字列
戻り値
DataStoreDataCode オブジェクト
参照
IsValid(), ToDataCodeString(), DataStoreConstants::MAX_DATACODE_STR_LEN
static DataStoreDataCode nn::nex::DataStoreDataCode::CreateFromDataCodeRaw ( const String key,
qUnsignedInt64  dataCodeRaw 
)
static

64 ビット整数値の内部データコード から DataStoreDataCode オブジェクトを生成します

内部データコードが妥当であるかは、 オブジェクト生成後に、 IsValid() でチェックしてくてください。

引数
[in]keyチェックサム算出時の鍵。自タイトルのアクセスキーを指定してください。
[in]dataCodeRaw内部データコード
戻り値
DataStoreDataCode オブジェクト
参照
IsValid(), GetDataCodeRaw()
qUnsignedInt64 nn::nex::DataStoreDataCode::GetDataId ( )

データ ID を取得します。

このオブジェクトが無効の場合は、 DataStoreConstants::INVALID_DATAID を返します。

戻り値
データ ID
String nn::nex::DataStoreDataCode::ToDataCodeString ( )

データコード文字列を生成します。

データコード文字列とは、データ ID と チェックサムを含む、 0 1 2 3 4 5 6 7 8 9 B C D F G H J K L M N P R T V W X Y の28文字 からなる 最大 14 文字の文字列です。 データ ID は、最大 56 ビット まで利用可能です。

このオブジェクトが無効の場合は、空文字列が返ります。

戻り値
データコード文字列
参照
IsValid(), DataStoreConstants::MAX_DATACODE_STR_LEN
String nn::nex::DataStoreDataCode::ToDataCodeStringZeroPad ( )

データコード文字列を生成します。 14文字に満たない場合は、上位を 0 で埋めます。

データコード文字列とは、データ ID と チェックサムを含む、 0 1 2 3 4 5 6 7 8 9 B C D F G H J K L M N P R T V W X Y の28文字 からなる 最大 14 文字の文字列です。 データ ID は、最大 56 ビット まで利用可能です。

このオブジェクトが無効の場合は、空文字列が返ります。

戻り値
データコード文字列
参照
IsValid()
qUnsignedInt64 nn::nex::DataStoreDataCode::GetDataCodeRaw ( )

内部データコードを取得します。

データ ID (56bit) とタイトル固有の チェックサム値 (8bit) から成る 64 ビットの整数値です。

この関数を使う前に IsValid() で、オブジェクトが有効であることを確認してください。

戻り値
内部データコード
参照
IsValid()
qBool nn::nex::DataStoreDataCode::IsValid ( )

このオブジェクトが有効なデータコード文字列、有効なデータ ID もしくは有効な内部データコードから 生成されたものか判定します。


戻り値一覧:

true 有効なオブジェクトである

false 有効なオブジェクトでない

参照
CreateFromDataId(), CreateFromDataCodeString(), CreateFromDataCodeRaw()
ToDataCodeString(), ToDataCodeStringZeroPad(), GetDataCodeRaw()