Module: Miyako::Diagram::TriggerBase

Included in:
DefaultTrigger
Defined in:
lib/Miyako/API/diagram.rb

Overview

遷移条件モジュール

遷移図の移動条件を構成するモジュール。

mixinすることで、遷移条件構成に必要なメソッドを定義できる。 各メソッドは、前処理・後処理と、遷移条件の判別式を定義できる。 判別式をあらわすメソッドは、必ずtrue/falseをかえすように設計する。 判別式を用意できるのは、updateとrenderの処理のみ。 あとは、initializeメソッドなどで、必要なインスタンスを作成することができる。

Instance Method Summary collapse

Instance Method Details

#post_processObject

後始末を実装する

Processor#stop メソッドが呼び出されたときの処理を実装する


149
150
# File 'lib/Miyako/API/diagram.rb', line 149

def post_process
end

#post_renderObject

ノードのレンダリング処理が終わった後の後始末を行う

Screen.update メソッドを呼び出しているときは、本メソッドを実装する必要はない NodeBase#render を呼び出された後の処理を実装する


177
178
# File 'lib/Miyako/API/diagram.rb', line 177

def post_render
end

#post_updateObject

ノードの更新処理が終わった後の後始末を行う

NodeBase#update を呼び出された後の処理を実装する


162
163
# File 'lib/Miyako/API/diagram.rb', line 162

def post_update
end

#pre_processObject

前処理を実装する

Processor#start メソッドが呼び出されたときの処理を実装する


144
145
# File 'lib/Miyako/API/diagram.rb', line 144

def pre_process
end

#render?Boolean

ノードのレンダリング処理を行うかどうかの問い合わせメソッドを実装する

NodeBase#render を呼び出すかどうかを返す処理を実装する デフォルトでは、無条件で true を返す Screen.update メソッドを呼び出しているときは、本メソッドを実装する必要はない

返却値

NodeBase#render メソッドを呼び出したいときは true を返す

Returns:

  • (Boolean)

170
171
172
# File 'lib/Miyako/API/diagram.rb', line 170

def render?
  return true
end

#update?Boolean

ノードの更新処理を行うかどうかの問い合わせメソッドを実装する

NodeBase#update を呼び出すかどうかを返す処理を実装する デフォルトでは、無条件で true を返す

返却値

NodeBase#update メソッドを呼び出したいときは true を返す

Returns:

  • (Boolean)

156
157
158
# File 'lib/Miyako/API/diagram.rb', line 156

def update?
  return true
end