特定の監視情報に対する監視の制御を行うインターフェース More...
#include <ControlInterface.hpp>
Collaboration diagram for zao::endpoint::monitor::ControlInterface< T >:
Public Member Functions | |
| virtual bool | GetLatest (T &buffer)=0 |
| 最後に受信した情報を取得する。 | |
| virtual void | Unobserve ()=0 |
| 監視を停止する。 | |
| virtual bool | IsObserving () const noexcept=0 |
| 監視中か否かを取得する。 | |
| void | RegisterCallback (const std::shared_ptr< MonitorCallbackInterface< T > > &listener, bool use_weak_ptr) |
| コールバックの送信先をshared_ptrまたはweak_ptrで登録する | |
| virtual void | RegisterCallback (const std::shared_ptr< MonitorCallbackInterface< T > > &listener)=0 |
| コールバックの送信先をshared_ptrで登録する | |
| virtual void | RegisterCallback (const std::weak_ptr< MonitorCallbackInterface< T > > &listener_weak, StoreAsWeakPtrType)=0 |
| コールバックの送信先をweak_ptrで登録する | |
| virtual void | RegisterCallback (std::unique_ptr< MonitorCallbackInterface< T > > &&listener)=0 |
| コールバックの送信先をunique_ptrで登録する | |
Detailed Description
template<class T>
class zao::endpoint::monitor::ControlInterface< T >
class zao::endpoint::monitor::ControlInterface< T >
特定の監視情報に対する監視の制御を行うインターフェース
- Template Parameters
-
T 監視情報の型
Member Function Documentation
◆ GetLatest()
template<class T >
|
pure virtual |
最後に受信した情報を取得する。
- Parameters
-
buffer 情報の格納先
- Return values
-
true 取得に成功した(bufferの内容は有効) false 未受信であるか、監視が無効となっており取得に失敗した (bufferの内容は不定)
- Note
- MonitorCallbackInterface のコールバック内から呼び出してもよい。
◆ IsObserving()
|
pure virtualnoexceptinherited |
監視中か否かを取得する。
- Note
- MonitorCallbackInterface のコールバック内から呼び出してもよい。
◆ RegisterCallback() [1/4]
|
pure virtualinherited |
コールバックの送信先をshared_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
- 有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
- Parameters
-
listener 送信先への参照
◆ RegisterCallback() [2/4]
|
inlineinherited |
コールバックの送信先をshared_ptrまたはweak_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
- 有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
- Parameters
-
listener 送信先への参照 use_weak_ptr weak_ptrとして保持する場合にtrueを指定
- Deprecated:
- この関数は将来廃止予定です。 RegisterCallback(const std::shared_ptr<T>&) または RegisterCallback(const std::weak_ptr<T>&, StoreAsWeakPtrType) を使用してください。
◆ RegisterCallback() [3/4]
|
pure virtualinherited |
コールバックの送信先をweak_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
- 有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
- Parameters
-
listener_weak 送信先への参照(所有権を持たない)
◆ RegisterCallback() [4/4]
|
pure virtualinherited |
コールバックの送信先をunique_ptrで登録する
- Note
- 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
- 有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
- Parameters
-
listener 送信先への参照
◆ Unobserve()
|
pure virtualinherited |
監視を停止する。
- Note
- 本オブジェクトの破棄でも自動的に監視は停止される。
- MonitorCallbackInterface のコールバック内から呼び出してもよい。
The documentation for this class was generated from the following file:
- /home/jenkins/workspace/J2408.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/monitor/ControlInterface.hpp
