mirs_esp_pio
読み取り中…
検索中…
一致する文字列を見つけられません
Registry< Plugin, Data, Capacity > クラステンプレート

固定容量のタスク内プラグインレジストリ。ヒープ不使用。 [詳解]

#include <Registry.hpp>

公開メンバ関数

bool add (Plugin *plugin, uint32_t divider=1)
 プラグインを登録する。
size_t size () const
const char * name (size_t index) const
bool isEnabled (size_t index) const
bool beginPlugin (size_t index)
 プラグインを開始する。失敗時は無効化される。
void updateAll (Data &data)
 有効なプラグインのうち周期到来分を更新する。

詳解

template<typename Plugin, typename Data, size_t Capacity>
class Registry< Plugin, Data, Capacity >

固定容量のタスク内プラグインレジストリ。ヒープ不使用。

追加・削除は add() 1行。プラグイン同士は互いを知らない。 begin失敗のプラグインは無効化され、他は継続する。 divider指定で間引き周期(何制御周期に1回updateするか)をプラグイン毎に変えられる。

テンプレート引数
Pluginupdate(Data&)/begin()/name() を持つプラグイン型
Dataプラグインに渡すスナップショット型
Capacity最大登録数

Registry.hpp の 14 行目に定義があります。

関数詳解

◆ add()

template<typename Plugin, typename Data, size_t Capacity>
bool Registry< Plugin, Data, Capacity >::add ( Plugin * plugin,
uint32_t divider = 1 )
inline

プラグインを登録する。

引数
plugin登録対象(寿命は呼び出し側が保証すること)
divider間引き周期。1=毎周期
戻り値
true: 登録成功。false: 満杯・null・divider=0

Registry.hpp の 21 行目に定義があります。

◆ beginPlugin()

template<typename Plugin, typename Data, size_t Capacity>
bool Registry< Plugin, Data, Capacity >::beginPlugin ( size_t index)
inline

プラグインを開始する。失敗時は無効化される。

引数
index登録順序
戻り値
true: 開始成功(範囲外はfalse)

Registry.hpp の 49 行目に定義があります。

◆ isEnabled()

template<typename Plugin, typename Data, size_t Capacity>
bool Registry< Plugin, Data, Capacity >::isEnabled ( size_t index) const
inline
引数
index登録順序
戻り値
begin成功済みか(範囲外はfalse)

Registry.hpp の 41 行目に定義があります。

◆ name()

template<typename Plugin, typename Data, size_t Capacity>
const char * Registry< Plugin, Data, Capacity >::name ( size_t index) const
inline
引数
index登録順序
戻り値
プラグイン名(範囲外は空文字)

Registry.hpp の 35 行目に定義があります。

◆ size()

template<typename Plugin, typename Data, size_t Capacity>
size_t Registry< Plugin, Data, Capacity >::size ( ) const
inline
戻り値
登録数

Registry.hpp の 31 行目に定義があります。

◆ updateAll()

template<typename Plugin, typename Data, size_t Capacity>
void Registry< Plugin, Data, Capacity >::updateAll ( Data & data)
inline

有効なプラグインのうち周期到来分を更新する。

引数
dataプラグインに渡すスナップショット

Registry.hpp の 61 行目に定義があります。


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