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

順位計算に必要なパラメータです。 [詳解]

#include <RendezVous/Services/Jugem/Ranking/src/Common/RankingOrderParam.h>

公開メンバ関数

 RankingOrderParam ()
 コンストラクタです。
 
virtual ~RankingOrderParam ()
 デストラクタです。
 
RankingConstants::FilterGroupIndex GetFilterGroupIndex () const
 フィルタリングするグループのインデックスを取得します。 [詳解]
 
qByte GetFilterGroupNum () const
 フィルタリングするグループの値を取得します。 [詳解]
 
qByte GetLength () const
 取得するリストの長さを取得します。 [詳解]
 
qUnsignedInt32 GetOffset () const
 オフセットを取得します。 [詳解]
 
RankingConstants::OrderCalculation GetOrderCalculation () const
 順位の計算方法を取得します。 [詳解]
 
qByte GetTimeScope () const
 ランキングに表示するスコアの対象期間(タイムスコープ)を取得します。 [詳解]
 
void SetFilterGroupIndex (RankingConstants::FilterGroupIndex groupIndex_)
 フィルタリングするグループのインデックスをセットします。 [詳解]
 
void SetFilterGroupNum (qByte groupNum_)
 フィルタリングするグループの値をセットします。 [詳解]
 
void SetLength (qByte length_)
 取得するリストの長さをセットします [詳解]
 
void SetOffset (qUnsignedInt32 offset_)
 取得するリストのオフセットをセットします [詳解]
 
void SetOrderCalculation (RankingConstants::OrderCalculation orderCalculation_)
 順位の計算方法をセットします。 [詳解]
 
void SetTimeScope (RankingConstants::TimeScope timeScope_)
 ランキングに表示するスコアの対象期間(タイムスコープ)をセットします。 [詳解]
 

詳解

順位計算に必要なパラメータです。

関数詳解

void nn::nex::RankingOrderParam::SetOrderCalculation ( RankingConstants::OrderCalculation  orderCalculation_)

順位の計算方法をセットします。

順位の計算方法を指定します。デフォルトは RankingConstants::ORDER_CALCULATION_113 です。

引数
[in]orderCalculation_順位の計算方法を表す定数。
RankingConstants::OrderCalculation nn::nex::RankingOrderParam::GetOrderCalculation ( ) const

順位の計算方法を取得します。

戻り値
順位の計算方法を表す定数。
void nn::nex::RankingOrderParam::SetFilterGroupIndex ( RankingConstants::FilterGroupIndex  groupIndex_)

フィルタリングするグループのインデックスをセットします。

フィルタリングするグループを指定する定数を指定します。デフォルトは RankingConstants::FILTER_GROUP_INDEX_NONE (フィルタリングしない)です。

引数
[in]groupIndex_フィルタリングするグループを表す定数。
RankingConstants::FilterGroupIndex nn::nex::RankingOrderParam::GetFilterGroupIndex ( ) const

フィルタリングするグループのインデックスを取得します。

戻り値
フィルタリングするグループを表す定数。
void nn::nex::RankingOrderParam::SetFilterGroupNum ( qByte  groupNum_)

フィルタリングするグループの値をセットします。

フィルタリングするグループの値をセットします。 RankingOrderParam::SetFilterGroupIndex 関数で指定したインデックスのグループについて、本関数でセットした値によるフィルタリングが行われます。RankingOrderParam::SetFilterGroupIndex 関数で RankingConstants::FILTER_GROUP_INDEX_NONE をセットした場合、本関数でセットした値は無効になります。デフォルトは 0 です。

引数
[in]groupNum_フィルタリングするグループの値。
qByte nn::nex::RankingOrderParam::GetFilterGroupNum ( ) const

フィルタリングするグループの値を取得します。

戻り値
フィルタリングするグループの値。
void nn::nex::RankingOrderParam::SetTimeScope ( RankingConstants::TimeScope  timeScope_)

ランキングに表示するスコアの対象期間(タイムスコープ)をセットします。

RankingConstants::TIME_SCOPE_ALL をセットした場合は全ての期間を対象とします。

RankingConstants::TIME_SCOPE_CUSTOM_0 または RankingConstants::TIME_SCOPE_CUSTOM_1 をセットした場合は、NMAS で設定されたタイムスコープタイプの期間を対象とします。 ただし、TIME_SCOPE_CUSTOM_0 および TIME_SCOPE_CUSTOM_1 は初期状態では無効に設定されており、スコア登録の前にあらかじめ設定しておく必要があります。

本関数で設定しない場合のデフォルト値は RankingConstants::TIME_SCOPE_ALL です。

引数
[in]timeScope_タイムスコープを表す定数。
qByte nn::nex::RankingOrderParam::GetTimeScope ( ) const

ランキングに表示するスコアの対象期間(タイムスコープ)を取得します。

戻り値
タイムスコープを表す定数。
void nn::nex::RankingOrderParam::SetOffset ( qUnsignedInt32  offset_)

取得するリストのオフセットをセットします

取得するリストのオフセットを指定します。デフォルトは0です。

引数
[in]offset_スコアの値。
qUnsignedInt32 nn::nex::RankingOrderParam::GetOffset ( ) const

オフセットを取得します。

戻り値
オフセット。
void nn::nex::RankingOrderParam::SetLength ( qByte  length_)

取得するリストの長さをセットします

取得するリストの長さを指定します。0 ~ 255 の範囲で指定できます。デフォルトは10です。

引数
[in]length_リストの長さ。
qByte nn::nex::RankingOrderParam::GetLength ( ) const

取得するリストの長さを取得します。

戻り値
リストの長さ。