MGL::Task::WeakNode クラス

弱参照タスクノード [詳解]

#include <mgl_task_weak_node.h>

公開メンバ関数
constexpr	WeakNode () noexcept=default
	コンストラクタ
	WeakNode (size_t listIndex) noexcept
	コンストラクタ
	WeakNode (const Node *node) noexcept
	コンストラクタ
bool	Set (size_t listIndex) noexcept
	ノードの設定
bool	Set (const Node *node) noexcept
	ノードの設定
Node *	Get () const noexcept
	ノードの取得
bool	IsValid () const noexcept
	参照先の有効状態を取得
	operator bool () const noexcept
	有効状態をbool型へのキャストで取得
bool	operator! () const noexcept
	有効状態を否定演算子で取得
template<class T , Identifier identifier = Identifier(T::kTaskIdentifier)>
T *	Get () const noexcept
	指定したタスクノードにキャストして取得
template<typename EventIDType >
bool	NotifyEvent (EventIDType event, void *argument) noexcept
	タスクへのイベント通知
bool	Kill (ResideLevel resideLevel=ResideLevel::NoResident) noexcept
	参照先タスクを削除

詳解

弱参照タスクノード

構築子と解体子

WeakNode() [1/2]

MGL::Task::WeakNode::WeakNode ( size_t listIndex )

noexcept

コンストラクタ

引数

[in]

listIndex

ノードリスト上のインデックス

WeakNode() [2/2]

MGL::Task::WeakNode::WeakNode ( const Node * node )

noexcept

コンストラクタ

引数

[in]

node

タスクノード

関数詳解

Get() [1/2]

Node * MGL::Task::WeakNode::Get ( ) const

nodiscardnoexcept

ノードの取得

戻り値

参照先のタスクノード．既に寿命が切れている場合はnullptr

Get() [2/2]

template<class T , Identifier identifier = Identifier(T::kTaskIdentifier)>

T * MGL::Task::WeakNode::Get ( ) const

inlinenodiscardnoexcept

指定したタスクノードにキャストして取得

テンプレート引数

T	キャスト先のクラス
identifier	Tと関連付けられたタスクノードID

戻り値

参照先のIDと引数のIDが一致していればキャストしたタクスノードを返し，そうで無ければnullptrを返す

覚え書き

キャスト先のクラスに静的なメンバ変数kTaskIdentifierが定義されている場合， テンプレート引数のidentifierを省略することでそちらを参照する．

IsValid()

bool MGL::Task::WeakNode::IsValid ( ) const

inlinenodiscardnoexcept

参照先の有効状態を取得

戻り値

true	無効
false	有効

Kill()

bool MGL::Task::WeakNode::Kill ( ResideLevel resideLevel = ResideLevel::NoResident )

inlinenoexcept

参照先タスクを削除

引数

[in]

resideLevel

常駐レベル

戻り値

true	成功
false	失敗

NotifyEvent()

template<typename EventIDType >

bool MGL::Task::WeakNode::NotifyEvent ( EventIDType event, void * argument )

inlinenoexcept

タスクへのイベント通知

テンプレート引数

EventIDType

イベントの種類を表す型

引数

[in]	event	通知するイベントの種類
[in]	argument	通知先のタスクに渡す引数

戻り値

true	成功
false	失敗

operator bool()

MGL::Task::WeakNode::operator bool ( ) const

inlineexplicitnoexcept

有効状態をbool型へのキャストで取得

戻り値

true	有効
false	無効

operator!()

bool MGL::Task::WeakNode::operator! ( ) const

inlinenoexcept

有効状態を否定演算子で取得

戻り値

true	無効
false	有効

Set() [1/2]

bool MGL::Task::WeakNode::Set ( const Node * node )

noexcept

ノードの設定

引数

[in]

node

タスクノード

戻り値

true	成功
false	失敗

Set() [2/2]

bool MGL::Task::WeakNode::Set ( size_t listIndex )

noexcept

ノードの設定

引数

[in]

listIndex

ノードリスト上のインデックス

戻り値

true	成功
false	失敗

---

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

• /Users/acerola/x/mgl/include/mgl/task/mgl_task_weak_node.h
• /Users/acerola/x/mgl/src/task/mgl_task_weak_node.cc