WebCFace 2.9.0
Web-based Communication Framework & Dashboard-like UI
Loading...
Searching...
No Matches
member.h
Go to the documentation of this file.
1#pragma once
2#include <functional>
3#include <string>
4#include <vector>
5#include <optional>
6#include <chrono>
7#include "field.h"
8#ifdef WEBCFACE_MESON
9#include "webcface-config.h"
10#else
11#include "webcface/common/webcface-config.h"
12#endif
13
15
23class WEBCFACE_DLL Member : protected Field {
24 public:
25 Member() = default;
26 Member(const std::weak_ptr<internal::ClientData> &data_w,
27 const SharedString &member)
28 : Field(data_w, member) {}
29 Member(const Field &base) : Field(base.data_w, base.member_) {}
30
31 friend struct internal::ClientData;
32
37 const std::string &name() const { return member_.decode(); }
42 const std::wstring &nameW() const { return member_.decodeW(); }
43
44 using Field::child;
45 using Field::operator[];
46
47 using Field::canvas2D;
48 using Field::canvas3D;
49 using Field::func;
50 using Field::funcListener;
51 using Field::image;
52 using Field::robotModel;
53 using Field::text;
54 using Field::value;
55 using Field::view;
56
60 template <WEBCFACE_COMPLETE(Log)>
61 Log_ log(std::string_view name) const {
62 return this->child(name);
63 }
67 template <WEBCFACE_COMPLETE(Log)>
68 Log_ log(std::wstring_view name) const {
69 return this->child(name);
70 }
75 template <WEBCFACE_COMPLETE(Log)>
76 Log_ log() const;
77
78 using Field::canvas2DEntries;
79 using Field::canvas3DEntries;
80 using Field::children;
81 using Field::childrenRecurse;
82 using Field::funcEntries;
83 using Field::hasChildren;
84 using Field::imageEntries;
85 using Field::logEntries;
86 using Field::robotModelEntries;
87 using Field::textEntries;
88 using Field::valueEntries;
89 using Field::viewEntries;
95 [[deprecated]] std::vector<Value> values() const;
100 [[deprecated]] std::vector<Text> texts() const;
106 [[deprecated]] std::vector<RobotModel> robotModels() const;
112 [[deprecated]] std::vector<Func> funcs() const;
117 [[deprecated]] std::vector<View> views() const;
122 [[deprecated]] std::vector<Image> images() const;
123
132 bool exists() const;
140 bool connected() const;
148 const Member &
149 onDisconnect(std::function<void WEBCFACE_CALL_FP(Member)> callback) const;
157 template <typename F, typename std::enable_if_t<std::is_invocable_v<F>,
158 std::nullptr_t> = nullptr>
159 const Member &onDisconnect(F callback) const {
160 return onDisconnect(
161 [callback = std::move(callback)](const auto &) { callback(); });
162 }
170 const Member &
171 onConnect(std::function<void WEBCFACE_CALL_FP(Member)> callback) const;
179 template <typename F, typename std::enable_if_t<std::is_invocable_v<F>,
180 std::nullptr_t> = nullptr>
181 const Member &onConnect(F callback) const {
182 return onConnect(
183 [callback = std::move(callback)](const auto &) { callback(); });
184 }
185
192 const Member &
193 onValueEntry(std::function<void WEBCFACE_CALL_FP(Value)> callback) const;
200 const Member &
201 onTextEntry(std::function<void WEBCFACE_CALL_FP(Text)> callback) const;
208 const Member &onRobotModelEntry(
209 std::function<void WEBCFACE_CALL_FP(RobotModel)> callback) const;
216 const Member &
217 onFuncEntry(std::function<void WEBCFACE_CALL_FP(Func)> callback) const;
224 const Member &
225 onImageEntry(std::function<void WEBCFACE_CALL_FP(Image)> callback) const;
232 const Member &
233 onViewEntry(std::function<void WEBCFACE_CALL_FP(View)> callback) const;
240 const Member &onCanvas3DEntry(
241 std::function<void WEBCFACE_CALL_FP(Canvas3D)> callback) const;
248 const Member &onCanvas2DEntry(
249 std::function<void WEBCFACE_CALL_FP(Canvas2D)> callback) const;
256 const Member &
257 onLogEntry(std::function<void WEBCFACE_CALL_FP(Log)> callback) const;
258
265 const Member &
266 onSync(std::function<void WEBCFACE_CALL_FP(Member)> callback) const;
273 template <typename F, typename std::enable_if_t<std::is_invocable_v<F>,
274 std::nullptr_t> = nullptr>
275 const Member &onSync(F callback) const {
276 return onSync(
277 [callback = std::move(callback)](const auto &) { callback(); });
278 }
279
285 std::chrono::system_clock::time_point syncTime() const;
293 const std::string &libName() const;
298 const std::string &libVersion() const;
303 const std::string &remoteAddr() const;
304
316 std::optional<int> pingStatus() const;
328 const Member &
329 onPing(std::function<void WEBCFACE_CALL_FP(Member)> callback) const;
336 template <typename F, typename std::enable_if_t<std::is_invocable_v<F>,
337 std::nullptr_t> = nullptr>
338 const Member &onPing(F callback) const {
339 return onPing(
340 [callback = std::move(callback)](const auto &) { callback(); });
341 }
342
347 template <typename T, typename std::enable_if_t<std::is_same_v<T, Member>,
348 std::nullptr_t> = nullptr>
349 bool operator==(const T &other) const {
350 return static_cast<Field>(*this) == static_cast<Field>(other);
351 }
352 template <typename T, typename std::enable_if_t<std::is_same_v<T, Member>,
353 std::nullptr_t> = nullptr>
354 bool operator!=(const T &other) const {
355 return static_cast<Field>(*this) != static_cast<Field>(other);
356 }
357};
358extern template Log Member::log<Log, true>() const;
359
Canvas2Dの送受信データを表すクラス
Definition canvas2d.h:24
Canvas3Dの送受信データを表すクラス
Definition canvas3d.h:28
関数1つを表すクラス
Definition func.h:95
(ver1.3から追加) 画像の送受信データを表すクラス
Definition image.h:20
ログの送受信データを表すクラス
Definition log.h:65
Memberを指すクラス
Definition member.h:23
Member()=default
bool operator==(const T &other) const
Memberを比較
Definition member.h:349
const std::string & name() const
Member名
Definition member.h:37
Log_ log(std::wstring_view name) const
Definition member.h:68
const Member & onConnect(F callback) const
Memberがサーバーに接続したときに呼び出されるコールバックを設定
Definition member.h:181
Log_ log() const
const std::wstring & nameW() const
Member名 (wstring)
Definition member.h:42
bool operator!=(const T &other) const
Definition member.h:354
const Member & onSync(F callback) const
Memberがsync()したときのイベント
Definition member.h:275
Log_ log(std::string_view name) const
Definition member.h:61
const Member & onDisconnect(F callback) const
Memberが切断したときに呼び出されるコールバックを設定
Definition member.h:159
Member(const std::weak_ptr< internal::ClientData > &data_w, const SharedString &member)
Definition member.h:26
Member(const Field &base)
Definition member.h:29
const Member & onPing(F callback) const
通信速度が更新された時のイベント
Definition member.h:338
RobotModelの送受信データを表すクラス
Definition robot_model.h:26
u8stringとstringとwstringをshared_ptrで持ち共有する
Definition encoding.h:67
文字列の送受信データを表すクラス
Definition text.h:183
実数値またはその配列の送受信データを表すクラス
Definition value.h:59
Viewの送受信データを表すクラス
Definition view.h:36
ClientDataの参照とメンバ名とデータ名を持つクラス
Definition field.h:71
Field child(const SharedString &field) const
Definition field.cc:42
Definition client_internal.h:46
#define WEBCFACE_DLL
Definition webcface-config.h:69
#define WEBCFACE_NS_END
Definition webcface-config.h:118
#define WEBCFACE_NS_BEGIN
Definition webcface-config.h:117
#define WEBCFACE_CALL_FP
Definition webcface-config.h:107