MGL::Task::Node クラス

タスクノード [詳解]

#include <mgl_task_node.h>

MGL::Task::Node の継承関係図

公開メンバ関数
constexpr	Node (Identifier identifier) noexcept
	コンストラクタ
constexpr Identifier	GetIdentifier () const noexcept
	このタスクノードのIDを取得
constexpr void	Kill () noexcept
	削除要求
constexpr bool	IsRequestedKill () const noexcept
	削除要求されているかを取得
constexpr void	SetResideLevel (ResideLevel resideLevel) noexcept
	常駐レベルの設定
constexpr ResideLevel	GetResideLevel () const noexcept
	常駐レベルの取得
constexpr bool	IsResident () const noexcept
	常駐タスクかどうかを取得
template<typename TaskIDType >
constexpr void	SetAsynchronous (bool isEnabled, TaskIDType barrierIdentifier=TaskIDType()) noexcept
	非同期実行の設定
constexpr bool	IsEnabledAsynchronous () const noexcept
	非同期実行が有効化されているかを取得
template<typename TaskIDType = Identifier>
constexpr TaskIDType	GetBarrierIdentifier () const noexcept
	非同期実行時のバリアIDを取得
constexpr bool	IsEnabledBarrier () const noexcept
	有効なバリアIDが設定されているかを取得
virtual void	OnInitialize () noexcept
	タスク生成時に呼び出される関数
template<typename EventIDType >
void	NotifyEvent (EventIDType event, void *argument) noexcept
	タスクへのイベント通知
virtual void	OnExecute (ExecuteStage stage) noexcept=0
	タスク実行時に呼び出される関数

限定公開メンバ関数
virtual void	OnReceiveTaskEvent (EventIdentifier eventID, void *argument) noexcept
	タスクのイベント受信処理

詳解

タスクノード

構築子と解体子

Node()

MGL::Task::Node::Node ( Identifier identifier )

inlineconstexprnoexcept

コンストラクタ

引数

[in]

identifier

タスクノードのID

関数詳解

GetIdentifier()

Identifier MGL::Task::Node::GetIdentifier ( ) const

inlinenodiscardconstexprnoexcept

このタスクノードのIDを取得

戻り値

タスクノードのID

GetResideLevel()

ResideLevel MGL::Task::Node::GetResideLevel ( ) const

inlinenodiscardconstexprnoexcept

常駐レベルの取得

戻り値

現在の常駐レベル

IsEnabledAsynchronous()

bool MGL::Task::Node::IsEnabledAsynchronous ( ) const

inlinenodiscardconstexprnoexcept

非同期実行が有効化されているかを取得

戻り値

true	有効化されている
false	有効化されていない

IsEnabledBarrier()

bool MGL::Task::Node::IsEnabledBarrier ( ) const

inlinenodiscardconstexprnoexcept

有効なバリアIDが設定されているかを取得

戻り値

true	バリアIDが有効
false	バリアIDが無効

IsRequestedKill()

bool MGL::Task::Node::IsRequestedKill ( ) const

inlinenodiscardconstexprnoexcept

削除要求されているかを取得

戻り値

true	されている
false	されていない

IsResident()

bool MGL::Task::Node::IsResident ( ) const

inlinenodiscardconstexprnoexcept

常駐タスクかどうかを取得

戻り値

true	常駐タスクである
false	常駐タスクでない

NotifyEvent()

template<typename EventIDType >

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

inlinenoexcept

タスクへのイベント通知

テンプレート引数

EventIDType

イベントの種類を表す型

引数

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

OnExecute()

virtual void MGL::Task::Node::OnExecute ( ExecuteStage stage )

pure virtualnoexcept

タスク実行時に呼び出される関数

引数

[in]

stage

実行ステージ

OnReceiveTaskEvent()

virtual void MGL::Task::Node::OnReceiveTaskEvent ( EventIdentifier eventID, void * argument )

inlineprotectedvirtualnoexcept

タスクのイベント受信処理

引数

[in]	eventID	イベントID
[in]	argument	引数

SetAsynchronous()

template<typename TaskIDType >

void MGL::Task::Node::SetAsynchronous ( bool isEnabled, TaskIDType barrierIdentifier = TaskIDType() )

inlineconstexprnoexcept

非同期実行の設定

テンプレート引数

TaskIDType

タスクの種類を表す型

引数

[in]	isEnabled	有効フラグ
[in]	barrierIdentifier	バリアID

SetResideLevel()

void MGL::Task::Node::SetResideLevel ( ResideLevel resideLevel )

inlineconstexprnoexcept

常駐レベルの設定

引数

[in]

resideLevel

設定する常駐レベル

---

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

• /Users/acerola/x/mgl/include/mgl/task/mgl_task_node.h