Member Class Reference

Memberを指すクラス More...

#include <webcface/member.h>

Inheritance diagram for Member:

Collaboration diagram for Member:

Public Member Functions
	Member ()=default
	Member (const std::weak_ptr< internal::ClientData > &data_w, const SharedString &member)
	Member (const Field &base)
StringView	name () const
	Member名
WStringView	nameW () const
	Member名 (wstring)
template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>
Log_	log (StringInitializer name) const
template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>
Log_	log () const
bool	exists () const
	Memberのデータが存在するかどうかを返す
bool	connected () const
	Memberがサーバーに接続できているときtrueを返す
const Member &	onDisconnect (std::function< void(Member)> callback) const
	Memberが切断したときに呼び出されるコールバックを設定
template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Member &	onDisconnect (F callback) const
	Memberが切断したときに呼び出されるコールバックを設定
const Member &	onConnect (std::function< void(Member)> callback) const
	Memberがサーバーに接続したときに呼び出されるコールバックを設定
template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Member &	onConnect (F callback) const
	Memberがサーバーに接続したときに呼び出されるコールバックを設定
const Member &	onValueEntry (std::function< void(Value)> callback) const
	valueが追加された時のイベント
const Member &	onTextEntry (std::function< void(Text)> callback) const
	textが追加された時のイベント
const Member &	onRobotModelEntry (std::function< void(RobotModel)> callback) const
	robotModelが追加された時のイベント
const Member &	onFuncEntry (std::function< void(Func)> callback) const
	funcが追加された時のイベント
const Member &	onImageEntry (std::function< void(Image)> callback) const
	imageが追加されたときのイベント
const Member &	onViewEntry (std::function< void(View)> callback) const
	viewが追加されたときのイベント
const Member &	onCanvas3DEntry (std::function< void(Canvas3D)> callback) const
	canvas3dが追加されたときのイベント
const Member &	onCanvas2DEntry (std::function< void(Canvas2D)> callback) const
	canvas2dが追加されたときのイベント
const Member &	onLogEntry (std::function< void(Log)> callback) const
	logが追加されたときのイベント
const Member &	onSync (std::function< void(Member)> callback) const
	Memberがsync()したときのイベント
template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Member &	onSync (F callback) const
	Memberがsync()したときのイベント
std::chrono::system_clock::time_point	syncTime () const
	最後のsync()の時刻を返す
const std::string &	libName () const
	このMemberが使っているWebCFaceライブラリの識別情報
const std::string &	libVersion () const
	このMemberが使っているWebCFaceのバージョン
const std::string &	remoteAddr () const
	このMemberのIPアドレス
std::optional< int >	pingStatus () const
	通信速度を調べる
const Member &	onPing (std::function< void(Member)> callback) const
	通信速度が更新された時のイベント
template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Member &	onPing (F callback) const
	通信速度が更新された時のイベント
template<typename T , typename std::enable_if_t< std::is_same_v< T, Member >, std::nullptr_t > = nullptr>
bool	operator== (const T &other) const
	Memberを比較
template<typename T , typename std::enable_if_t< std::is_same_v< T, Member >, std::nullptr_t > = nullptr>
bool	operator!= (const T &other) const
template<typename T , bool >
T	log () const
Field	child (const SharedString &field) const
Field	child (StringInitializer field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField
Field	child (int index) const
	「(thisの名前).(index)」を新しい名前とするField
template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>
Canvas2D_	canvas2D (StringInitializer field=StringInitializer()) const
template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>
Canvas3D_	canvas3D (StringInitializer field=StringInitializer()) const
template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>
Func_	func (StringInitializer field=StringInitializer()) const
template<typename FuncListener_ = FuncListener, bool = ::webcface::traits::assertCompleteFuncListener < std::enable_if_t<std::is_same_v< FuncListener_, FuncListener >, FuncListener_>>()>
FuncListener_	funcListener (StringInitializer field=StringInitializer()) const
template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>
Image_	image (StringInitializer field=StringInitializer()) const
template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>
RobotModel_	robotModel (StringInitializer field=StringInitializer()) const
template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>
Text_	text (StringInitializer field=StringInitializer()) const
template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>
Value_	value (StringInitializer field=StringInitializer()) const
template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>
View_	view (StringInitializer field=StringInitializer()) const
template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>
std::vector< Canvas2D_ >	canvas2DEntries () const
	「(thisの名前).(追加の名前)」で公開されているcanvas2Dのリストを返す。
template<typename T , bool >
std::vector< T >	canvas2DEntries () const
template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>
std::vector< Canvas3D_ >	canvas3DEntries () const
	「(thisの名前).(追加の名前)」で公開されているcanvas3Dのリストを返す。
template<typename T , bool >
std::vector< T >	canvas3DEntries () const
std::vector< Field >	children () const
	「(thisの名前).(追加の名前)」で公開されているデータのリスト
std::vector< Field >	childrenRecurse () const
	「(thisの名前).(追加の名前)」で公開されているデータのリスト(再帰)
template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>
std::vector< Func_ >	funcEntries () const
	「(thisの名前).(追加の名前)」で公開されているfuncのリストを返す。
template<typename T , bool >
std::vector< T >	funcEntries () const
bool	hasChildren () const
	「(thisの名前).(追加の名前)」で公開されているデータが存在するかどうかを返す
template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>
std::vector< Image_ >	imageEntries () const
	「(thisの名前).(追加の名前)」で公開されているimageのリストを返す。
template<typename T , bool >
std::vector< T >	imageEntries () const
template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>
std::vector< Log_ >	logEntries () const
	「(thisの名前).(追加の名前)」で公開されているlogのリストを返す。
template<typename T , bool >
std::vector< T >	logEntries () const
template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>
std::vector< RobotModel_ >	robotModelEntries () const
	「(thisの名前).(追加の名前)」で公開されているrobotModelのリストを返す。
template<typename T , bool >
std::vector< T >	robotModelEntries () const
template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>
std::vector< Text_ >	textEntries () const
	「(thisの名前).(追加の名前)」で公開されているtextのリストを返す。
template<typename T , bool >
std::vector< T >	textEntries () const
template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>
std::vector< Value_ >	valueEntries () const
	「(thisの名前).(追加の名前)」で公開されているvalueのリストを返す。
template<typename T , bool >
std::vector< T >	valueEntries () const
template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>
std::vector< View_ >	viewEntries () const
	「(thisの名前).(追加の名前)」で公開されているviewのリストを返す。
template<typename T , bool >
std::vector< T >	viewEntries () const

Protected Member Functions
std::shared_ptr< internal::ClientData >	dataLock () const
	data_wをlockし、失敗したらSanityErrorを投げる
std::shared_ptr< internal::ClientData >	setCheck () const
	data_wをlockし、memberがselfではなければIntrusionを投げる
bool	expired () const
template<typename Member_ = Member, bool = ::webcface::traits::assertCompleteMember < std::enable_if_t<std::is_same_v< Member_, Member >, Member_>>()>
Member_	member () const
	Memberを返す
SharedString	lastName8 () const
std::string	lastName () const
	nameのうちピリオドで区切られた最後の部分を取り出す
std::wstring	lastNameW () const
	nameのうちピリオドで区切られた最後の部分を取り出す (wstring)
Field	parent () const
	nameの最後のピリオドの前までを新しい名前とするField
Field	operator[] (StringInitializer field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField
Field	operator[] (int index) const
	「(thisの名前).(index)」を新しい名前とするField
bool	isSelf () const
	memberがselfならtrue
bool	operator== (const Field &other) const
bool	operator== (const FieldBase &rhs) const
bool	operator!= (const Field &other) const
bool	operator!= (const FieldBase &rhs) const

Protected Attributes
std::weak_ptr< internal::ClientData >	data_w
	ClientDataの参照
SharedString	member_
	メンバー名
SharedString	field_
	フィールド名

Friends
struct	internal::ClientData

Detailed Description

Memberを指すクラス

コンストラクタではなく Client::member(), Client::members() Client::onMemberEntry() などから取得すること

Constructor & Destructor Documentation

Member() [1/3]

Member ( )

default

Member() [2/3]

Member ( const std::weak_ptr< internal::ClientData > &  data_w, const SharedString &  member  )

inline

Member() [3/3]

Member ( const Field &  base )

inline

Member Function Documentation

canvas2D()

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>

Canvas2D_ canvas2D ( StringInitializer  field = StringInitializer() ) const

inline

canvas2DEntries() [1/2]

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>

template std::vector< Canvas2D > canvas2DEntries< Canvas2D, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているcanvas2Dのリストを返す。

Since

ver1.6

See also

childrenRecurse()

canvas2DEntries() [2/2]

template<typename T , bool >

template std::vector< Canvas2D > canvas2DEntries< Canvas2D, true >

(

)

const

canvas3D()

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>

Canvas3D_ canvas3D ( StringInitializer  field = StringInitializer() ) const

inline

canvas3DEntries() [1/2]

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>

template std::vector< Canvas3D > canvas3DEntries< Canvas3D, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているcanvas3Dのリストを返す。

Since

ver1.6

See also

childrenRecurse()

canvas3DEntries() [2/2]

template<typename T , bool >

template std::vector< Canvas3D > canvas3DEntries< Canvas3D, true >

(

)

const

child() [1/3]

Field child

(

const SharedString &

field

)

const

child() [2/3]

Field child ( int  index ) const

inline

「(thisの名前).(index)」を新しい名前とするField

Since

ver1.11

Deprecated:

ver2.8〜

child() [3/3]

Field child ( StringInitializer  field ) const

inline

「(thisの名前).(追加の名前)」を新しい名前とするField

Since

ver1.11

ver2.0〜 wstring対応, ver3.0〜 StringInitializer 型で置き換え

children()

std::vector< Field > children

(

)

const

「(thisの名前).(追加の名前)」で公開されているデータのリスト

Since

ver2.6

• データ型を問わずすべてのデータを列挙する。
• childrenRecurse() と異なり、 名前にさらにピリオドが含まれる場合はその前までの名前を返す。
• 同名で複数のデータが存在する場合も1回のみカウントする。

See also

childrenRecurse(), hasChildren()

childrenRecurse()

std::vector< Field > childrenRecurse

(

)

const

「(thisの名前).(追加の名前)」で公開されているデータのリスト(再帰)

Since

ver2.6

• データ型を問わずすべてのデータを列挙する。
• 同名で複数のデータが存在する場合も1回のみカウントする。

See also

children(), hasChildren()

connected()

bool connected

(

)

const

Memberがサーバーに接続できているときtrueを返す

Since

ver2.9

• 自身を表すMemberに対する connected() は、Client::connected() と同じ。
• 自身のサーバーとの通信が切断された場合、全メンバーについてfalseとなる

dataLock()

std::shared_ptr< internal::ClientData > dataLock ( ) const

inherited

data_wをlockし、失敗したらSanityErrorを投げる

exists()

bool exists

(

)

const

Memberのデータが存在するかどうかを返す

Since

ver2.9

• connected() とは異なり、切断後もサーバーにデータが残っていてまだデータを受信でき、trueになる場合がある

expired()

bool expired ( ) const

inherited

func()

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>

Func_ func ( StringInitializer  field = StringInitializer() ) const

inline

funcEntries() [1/2]

template<typename T , bool >

template std::vector< Func > funcEntries< Func, true >

(

)

const

funcEntries() [2/2]

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>

template std::vector< Func > funcEntries< Func, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているfuncのリストを返す。

Since

ver1.6

See also

childrenRecurse()

funcListener()

template<typename FuncListener_ = FuncListener, bool = ::webcface::traits::assertCompleteFuncListener < std::enable_if_t<std::is_same_v< FuncListener_, FuncListener >, FuncListener_>>()>

FuncListener_ funcListener ( StringInitializer  field = StringInitializer() ) const

inline

hasChildren()

bool hasChildren

(

)

const

「(thisの名前).(追加の名前)」で公開されているデータが存在するかどうかを返す

Since

ver2.6

See also

children(), childrenRecurse()

image()

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>

Image_ image ( StringInitializer  field = StringInitializer() ) const

inline

imageEntries() [1/2]

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>

template std::vector< Image > imageEntries< Image, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているimageのリストを返す。

Since

ver1.6

See also

childrenRecurse()

imageEntries() [2/2]

template<typename T , bool >

template std::vector< Image > imageEntries< Image, true >

(

)

const

isSelf()

bool isSelf ( ) const

inherited

memberがselfならtrue

data_wがlockできなければruntime_errorを投げる

lastName()

std::string lastName ( ) const

inlineinherited

nameのうちピリオドで区切られた最後の部分を取り出す

Since

ver1.11

lastName8()

SharedString lastName8 ( ) const

protectedinherited

lastNameW()

std::wstring lastNameW ( ) const

inlineinherited

nameのうちピリオドで区切られた最後の部分を取り出す (wstring)

Since

ver2.0

libName()

const std::string & libName

(

)

const

このMemberが使っているWebCFaceライブラリの識別情報

Returns

このライブラリの場合は"cpp", javascriptクライアントは"js", pythonクライアントは"python"を返す。

libVersion()

const std::string & libVersion

(

)

const

このMemberが使っているWebCFaceのバージョン

log() [1/3]

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>

template Log log< Log, true >

(

)

const

ver2.4〜: nameを省略した場合 "default" として送信される。

log() [2/3]

template<typename T , bool >

template Log log< Log, true >

(

)

const

log() [3/3]

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>

Log_ log ( StringInitializer  name ) const

inline

Since

ver2.4

logEntries() [1/2]

template<typename T , bool >

template std::vector< Log > logEntries< Log, true >

(

)

const

logEntries() [2/2]

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>

template std::vector< Log > logEntries< Log, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているlogのリストを返す。

Since

ver2.4

See also

childrenRecurse()

member()

template<typename Member_ = Member, bool = ::webcface::traits::assertCompleteMember < std::enable_if_t<std::is_same_v< Member_, Member >, Member_>>()>

Member_ member ( ) const

inlineinherited

Memberを返す

name()

StringView name ( ) const

inline

Member名

ver3.0〜 std::stringの参照から StringView に変更

nameW()

WStringView nameW ( ) const

inline

Member名 (wstring)

Since

ver2.0

ver3.0〜 std::wstringの参照から WStringView に変更

onCanvas2DEntry()

const Member & onCanvas2DEntry

(

std::function< void(Canvas2D)>

callback

)

const

canvas2dが追加されたときのイベント

Since

ver2.0

Parameters

callback

Canvas2D型の引数をとる関数

onCanvas3DEntry()

const Member & onCanvas3DEntry

(

std::function< void(Canvas3D)>

callback

)

const

canvas3dが追加されたときのイベント

Since

ver2.0

Parameters

callback

Canvas3D型の引数をとる関数

onConnect() [1/2]

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>

const Member & onConnect ( F  callback ) const

inline

Memberがサーバーに接続したときに呼び出されるコールバックを設定

Since

ver2.9

Parameters

callback

引数をとらない関数

• Client::onMemberEntry の直後に呼び出される。

onConnect() [2/2]

const Member & onConnect

(

std::function< void(Member)>

callback

)

const

Memberがサーバーに接続したときに呼び出されるコールバックを設定

Since

ver2.9

Parameters

callback

Member型の引数(thisが渡される)を1つ取る関数

• Client::onMemberEntry の直後に呼び出される。

onDisconnect() [1/2]

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>

const Member & onDisconnect ( F  callback ) const

inline

Memberが切断したときに呼び出されるコールバックを設定

Since

ver2.9

Parameters

callback

引数をとらない関数

• 自身のサーバーとの通信が切断された場合も、全メンバーについて呼び出される。

onDisconnect() [2/2]

const Member & onDisconnect

(

std::function< void(Member)>

callback

)

const

Memberが切断したときに呼び出されるコールバックを設定

Since

ver2.9

Parameters

callback

Member型の引数(thisが渡される)を1つ取る関数

• 自身のサーバーとの通信が切断された場合も、全メンバーについて呼び出される。

onFuncEntry()

const Member & onFuncEntry

(

std::function< void(Func)>

callback

)

const

funcが追加された時のイベント

Since

ver2.0

Parameters

callback

Func型の引数をとる関数

onImageEntry()

const Member & onImageEntry

(

std::function< void(Image)>

callback

)

const

imageが追加されたときのイベント

Since

ver2.0

Parameters

callback

Image型の引数をとる関数

onLogEntry()

const Member & onLogEntry

(

std::function< void(Log)>

callback

)

const

logが追加されたときのイベント

Since

ver2.4

Parameters

callback

Log型の引数をとる関数

onPing() [1/2]

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>

const Member & onPing ( F  callback ) const

inline

通信速度が更新された時のイベント

Since

ver2.0

Parameters

callback

引数をとらない関数

onPing() [2/2]

const Member & onPing

(

std::function< void(Member)>

callback

)

const

通信速度が更新された時のイベント

Since

ver2.0

• 通常は約5秒に1回更新される。
• pingStatus() と同様、通信速度データのリクエストも行う。
• ver2.0〜 Client自身に対しても使用可能

Parameters

callback

Member型の引数を取る関数

See also

pingStatus()

onRobotModelEntry()

const Member & onRobotModelEntry

(

std::function< void(RobotModel)>

callback

)

const

robotModelが追加された時のイベント

Since

ver2.0

Parameters

callback

RobotModel型の引数をとる関数

onSync() [1/2]

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>

const Member & onSync ( F  callback ) const

inline

Memberがsync()したときのイベント

Since

ver2.0

Parameters

callback

引数をとらない関数

onSync() [2/2]

const Member & onSync

(

std::function< void(Member)>

callback

)

const

Memberがsync()したときのイベント

Since

ver2.0

Parameters

callback

Member型の引数をとる関数

onTextEntry()

const Member & onTextEntry

(

std::function< void(Text)>

callback

)

const

textが追加された時のイベント

Since

ver2.0

Parameters

callback

Text型の引数をとる関数

onValueEntry()

const Member & onValueEntry

(

std::function< void(Value)>

callback

)

const

valueが追加された時のイベント

Since

ver2.0

Parameters

callback

Value型の引数をとる関数

onViewEntry()

const Member & onViewEntry

(

std::function< void(View)>

callback

)

const

viewが追加されたときのイベント

Since

ver2.0

Parameters

callback

View型の引数をとる関数

operator!=() [1/3]

bool operator!= ( const Field &  other ) const

inlineinherited

operator!=() [2/3]

bool operator!= ( const FieldBase &  rhs ) const

inlineinherited

operator!=() [3/3]

template<typename T , typename std::enable_if_t< std::is_same_v< T, Member >, std::nullptr_t > = nullptr>

bool operator!= ( const T &  other ) const

inline

operator==() [1/3]

bool operator== ( const Field &  other ) const

inherited

operator==() [2/3]

bool operator== ( const FieldBase &  rhs ) const

inlineinherited

operator==() [3/3]

template<typename T , typename std::enable_if_t< std::is_same_v< T, Member >, std::nullptr_t > = nullptr>

bool operator== ( const T &  other ) const

inline

Memberを比較

Since

ver1.11

operator[]() [1/2]

Field operator[] ( int  index ) const

inlineinherited

「(thisの名前).(index)」を新しい名前とするField

Since

ver1.11

Deprecated:

ver2.8〜

operator[]() [2/2]

Field operator[] ( StringInitializer  field ) const

inlineinherited

「(thisの名前).(追加の名前)」を新しい名前とするField

Since

ver1.11

ver2.0〜 wstring対応, ver3.0〜 StringInitializer 型で置き換え

parent()

Field parent ( ) const

inherited

nameの最後のピリオドの前までを新しい名前とするField

Since

ver1.11

pingStatus()

std::optional< int > pingStatus

(

)

const

通信速度を調べる

• 初回の呼び出しで通信速度データをリクエストし、 sync()後通信速度が得られるようになる
• ver2.0〜 Client自身に対しても使用可能 (Client::pingStatus() または member("自分の名前").pingStatus())

Returns

初回→ std::nullopt, 2回目以降(取得できれば)→ pingの往復時間 (ms)

See also

onPing()

remoteAddr()

const std::string & remoteAddr

(

)

const

このMemberのIPアドレス

robotModel()

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>

RobotModel_ robotModel ( StringInitializer  field = StringInitializer() ) const

inline

robotModelEntries() [1/2]

template<typename T , bool >

template std::vector< RobotModel > robotModelEntries< RobotModel, true >

(

)

const

robotModelEntries() [2/2]

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>

template std::vector< RobotModel > robotModelEntries< RobotModel, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているrobotModelのリストを返す。

Since

ver1.6

See also

childrenRecurse()

setCheck()

std::shared_ptr< internal::ClientData > setCheck ( ) const

inherited

data_wをlockし、memberがselfではなければIntrusionを投げる

syncTime()

std::chrono::system_clock::time_point syncTime

(

)

const

最後のsync()の時刻を返す

Since

ver1.7 (Value::time(), Text::time() 等から変更)

text()

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>

Text_ text ( StringInitializer  field = StringInitializer() ) const

inline

textEntries() [1/2]

template<typename T , bool >

template std::vector< Text > textEntries< Text, true >

(

)

const

textEntries() [2/2]

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>

template std::vector< Text > textEntries< Text, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているtextのリストを返す。

Since

ver1.6

See also

childrenRecurse()

value()

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>

Value_ value ( StringInitializer  field = StringInitializer() ) const

inline

valueEntries() [1/2]

template<typename T , bool >

template std::vector< Value > valueEntries< Value, true >

(

)

const

valueEntries() [2/2]

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>

template std::vector< Value > valueEntries< Value, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているvalueのリストを返す。

Since

ver1.6

See also

childrenRecurse()

view()

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>

View_ view ( StringInitializer  field = StringInitializer() ) const

inline

viewEntries() [1/2]

template<typename T , bool >

template std::vector< View > viewEntries< View, true >

(

)

const

viewEntries() [2/2]

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>

template std::vector< View > viewEntries< View, true >

(

)

const

「(thisの名前).(追加の名前)」で公開されているviewのリストを返す。

Since

ver1.6

See also

childrenRecurse()

Friends And Related Symbol Documentation

internal::ClientData

friend struct internal::ClientData

friend

Member Data Documentation

data_w

std::weak_ptr<internal::ClientData> data_w

inherited

ClientDataの参照

ClientData内に保持するクラスもあるので循環参照を避けるためweak_ptr

field_

SharedString field_

inherited

フィールド名

Memberなどフィールド名が不要なクラスでは使用しない

member_

SharedString member_

inherited

メンバー名

---

The documentation for this class was generated from the following files:

• client/include/webcface/member.h
• client/src/member.cc