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

ランキングの取得に関するパラメータを表すクラスです。 [詳解]

#include <RendezVous/Services/Jugem/Ranking2/src/Common/Ranking2GetParam.h>

DDLCLASSRanking2GetParamを継承しています。

公開メンバ関数

 Ranking2GetParam ()
 コンストラクタです。
 
virtual ~Ranking2GetParam ()
 デストラクタです。
 
qUnsignedInt32 GetCategory () const
 カテゴリを取得します。 [詳解]
 
qUnsignedInt32 GetLength () const
 取得長を取得します。 [詳解]
 
qByte GetMode () const
 モードを取得します。 [詳解]
 
UniqueId GetNexUniqueId () const
 NEX ユニーク ID を取得します。 [詳解]
 
qByte GetNumSeasonsToGoBack () const
 さかのぼるシーズンの数を取得します。 [詳解]
 
qUnsignedInt32 GetOffset () const
 開始位置を取得します。 [詳解]
 
qUnsignedInt32 GetOptionFlags () const
 オプション指定フラグを取得します。 [詳解]
 
PrincipalID GetPrincipalId () const
 プリンシパル ID を取得します。 [詳解]
 
qUnsignedInt32 GetSortFlags () const
 ソートのオプション指定フラグを取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetCategory (qUnsignedInt32 category_)
 カテゴリをセットします。 [詳解]
 
void SetLength (qUnsignedInt32 length_)
 取得長をセットします。 [詳解]
 
void SetMode (qByte mode_)
 モードをセットします。 [詳解]
 
void SetNexUniqueId (UniqueId nexUniqueId_)
 NEX ユニーク IDをセットします。 [詳解]
 
void SetNumSeasonsToGoBack (qByte numSeasonsToGoBack_)
 さかのぼるシーズンの数をセットします。 [詳解]
 
void SetOffset (qUnsignedInt32 offset_)
 開始位置をセットします。 [詳解]
 
void SetOptionFlags (qUnsignedInt32 optionFlags_)
 オプション指定フラグをセットします。 [詳解]
 
void SetPrincipalId (PrincipalID principalId_)
 プリンシパル IDをセットします。 [詳解]
 
void SetSortFlags (qUnsignedInt32 sortFlags_)
 ソートのオプション指定フラグをセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 Ranking2GetParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

ランキングの取得に関するパラメータを表すクラスです。

関数詳解

qByte nn::nex::Ranking2GetParam::GetMode ( ) const

モードを取得します。

戻り値
モードの値。
void nn::nex::Ranking2GetParam::SetMode ( qByte  mode_)

モードをセットします。

引数
[in]mode_モードの値。デフォルトは Ranking2Mode::USER_RANKING。
参照
Ranking2Mode
qUnsignedInt32 nn::nex::Ranking2GetParam::GetCategory ( ) const

カテゴリを取得します。

戻り値
カテゴリの値。
void nn::nex::Ranking2GetParam::SetCategory ( qUnsignedInt32  category_)

カテゴリをセットします。

引数
[in]category_カテゴリの値。デフォルトは 0。
qByte nn::nex::Ranking2GetParam::GetNumSeasonsToGoBack ( ) const

さかのぼるシーズンの数を取得します。

戻り値
何回前のシーズンのランキングを取得するかを指定する値。 最新のランキングは 0 で、過去に向かって 1,2,3 …と増えます。デフォルト 0。
void nn::nex::Ranking2GetParam::SetNumSeasonsToGoBack ( qByte  numSeasonsToGoBack_)

さかのぼるシーズンの数をセットします。

引数
[in]numSeasonsToGoBack_何回前のシーズンのランキングを取得するかを指定する値。 最新のランキングは 0 で、過去に向かって 1,2,3 …と増えます。デフォルト 0。 0 ~ カテゴリ設定の過去シーズンの保存数の範囲内で指定します。
qUnsignedInt32 nn::nex::Ranking2GetParam::GetOffset ( ) const

開始位置を取得します。

戻り値
開始位置の値。
void nn::nex::Ranking2GetParam::SetOffset ( qUnsignedInt32  offset_)

開始位置をセットします。

引数
[in]offset_開始位置の値。デフォルトは 0。 有効な範囲は 0 ~ 最低順位 - 1 です。
qUnsignedInt32 nn::nex::Ranking2GetParam::GetLength ( ) const

取得長を取得します。

戻り値
取得長の値。
void nn::nex::Ranking2GetParam::SetLength ( qUnsignedInt32  length_)

取得長をセットします。

引数
[in]length_取得長の値。デフォルトは 10。 有効な範囲は 1 ~ Ranking2Constants::MAX_RANKING_LENGTH です。
PrincipalID nn::nex::Ranking2GetParam::GetPrincipalId ( ) const

プリンシパル ID を取得します。

戻り値
プリンシパル ID。
void nn::nex::Ranking2GetParam::SetPrincipalId ( PrincipalID  principalId_)

プリンシパル IDをセットします。

引数
[in]principalId_プリンシパル ID。デフォルトは INVALID_PRINCIPALID。
UniqueId nn::nex::Ranking2GetParam::GetNexUniqueId ( ) const

NEX ユニーク ID を取得します。

戻り値
NEX ユニーク ID。
void nn::nex::Ranking2GetParam::SetNexUniqueId ( UniqueId  nexUniqueId_)

NEX ユニーク IDをセットします。

引数
[in]nexUniqueId_NEX ユニーク ID。デフォルトは INVALID_UNIQUEID。
qUnsignedInt32 nn::nex::Ranking2GetParam::GetSortFlags ( ) const

ソートのオプション指定フラグを取得します。

戻り値
ソートのオプション指定フラグの値。
参照
Ranking2SortFlags
void nn::nex::Ranking2GetParam::SetSortFlags ( qUnsignedInt32  sortFlags_)

ソートのオプション指定フラグをセットします。

引数
[in]sortFlags_ソートのオプション指定フラグの値。デフォルトは 0。
参照
Ranking2SortFlags
qUnsignedInt32 nn::nex::Ranking2GetParam::GetOptionFlags ( ) const

オプション指定フラグを取得します。

戻り値
オプション指定フラグ。
参照
Ranking2GetOptionFlags
void nn::nex::Ranking2GetParam::SetOptionFlags ( qUnsignedInt32  optionFlags_)

オプション指定フラグをセットします。

引数
[in]optionFlags_オプション指定フラグ。
参照
Ranking2GetOptionFlags
void nn::nex::Ranking2GetParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

Ranking2GetParam オブジェクトの内容をトレースします。

引数
[in]uiTraceFlagsTraceLog::SetFlag() の引数と同様です。