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)
const std::string &	name () const
	Member名
const std::wstring &	nameW () const
	Member名 (wstring)
Log	log (std::string_view name) const
Log	log (std::wstring_view name) const
Log	log () const
std::vector< Value >	values () const
	このmemberが公開しているvalueのリストを返す。
std::vector< Text >	texts () const
	このmemberが公開しているtextのリストを返す。
std::vector< RobotModel >	robotModels () const
	このmemberが公開しているrobotModelのリストを返す。
std::vector< Func >	funcs () const
	このmemberが公開しているfuncのリストを返す。
std::vector< View >	views () const
	このmemberが公開しているviewのリストを返す。
std::vector< Image >	images () const
	このmemberが公開しているimageのリストを返す。
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
Field	child (const SharedString &field) const
Field	child (std::string_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField
Field	child (std::wstring_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)
Field	child (int index) const
	「(thisの名前).(index)」を新しい名前とするField
Canvas2D	canvas2D (std::string_view field="") const
Canvas2D	canvas2D (std::wstring_view field) const
Canvas3D	canvas3D (std::string_view field="") const
Canvas3D	canvas3D (std::wstring_view field) const
Func	func (std::string_view field="") const
Func	func (std::wstring_view field) const
FuncListener	funcListener (std::string_view field) const
FuncListener	funcListener (std::wstring_view field) const
Image	image (std::string_view field="") const
Image	image (std::wstring_view field) const
RobotModel	robotModel (std::string_view field="") const
RobotModel	robotModel (std::wstring_view field) const
Text	text (std::string_view field="") const
Text	text (std::wstring_view field) const
Value	value (std::string_view field="") const
Value	value (std::wstring_view field) const
View	view (std::string_view field="") const
View	view (std::wstring_view field) const
std::vector< Canvas2D >	canvas2DEntries () const
std::vector< Canvas3D >	canvas3DEntries () const
std::vector< Func >	funcEntries () const
std::vector< Image >	imageEntries () const
std::vector< Log >	logEntries () const
std::vector< RobotModel >	robotModelEntries () const
std::vector< Text >	textEntries () const
std::vector< Value >	valueEntries () const
std::vector< View >	viewEntries () const

Protected Member Functions
std::shared_ptr< internal::ClientData >	dataLock () const
	data_wをlockし、失敗したらruntime_errorを投げる
std::shared_ptr< internal::ClientData >	setCheck () const
	data_wをlockし、memberがselfではなければinvalid_argumentを投げる
bool	expired () const
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[] (std::string_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField
Field	operator[] (std::wstring_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)
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() [1/2]

Canvas2D canvas2D

(

std::string_view

field = ""

)

const

canvas2D() [2/2]

Canvas2D canvas2D

(

std::wstring_view

field

)

const

canvas2DEntries()

std::vector< Canvas2D > canvas2DEntries

(

)

const

canvas3D() [1/2]

Canvas3D canvas3D

(

std::string_view

field = ""

)

const

canvas3D() [2/2]

Canvas3D canvas3D

(

std::wstring_view

field

)

const

canvas3DEntries()

std::vector< Canvas3D > canvas3DEntries

(

)

const

child() [1/4]

Field child

(

const SharedString &

field

)

const

child() [2/4]

Field child ( int  index ) const

inline

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

Since

ver1.11

child() [3/4]

Field child ( std::string_view  field ) const

inline

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

Since

ver1.11

child() [4/4]

Field child ( std::wstring_view  field ) const

inline

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

Since

ver2.0

dataLock()

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

inherited

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

expired()

bool expired ( ) const

inherited

func() [1/2]

Func func

(

std::string_view

field = ""

)

const

func() [2/2]

Func func

(

std::wstring_view

field

)

const

funcEntries()

std::vector< Func > funcEntries

(

)

const

funcListener() [1/2]

FuncListener funcListener

(

std::string_view

field

)

const

funcListener() [2/2]

FuncListener funcListener

(

std::wstring_view

field

)

const

funcs()

std::vector< Func > funcs

(

)

const

このmemberが公開しているfuncのリストを返す。

Deprecated:

1.6で funcEntries() に変更

image() [1/2]

Image image

(

std::string_view

field = ""

)

const

image() [2/2]

Image image

(

std::wstring_view

field

)

const

imageEntries()

std::vector< Image > imageEntries

(

)

const

images()

std::vector< Image > images

(

)

const

このmemberが公開しているimageのリストを返す。

Deprecated:

1.6で imageEntries() に変更

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]

Log log

(

)

const

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

log() [2/3]

Log log ( std::string_view  name ) const

inline

Since

ver2.4

log() [3/3]

Log log ( std::wstring_view  name ) const

inline

Since

ver2.4

logEntries()

std::vector< Log > logEntries

(

)

const

Since

ver2.4

member()

Member member ( ) const

inherited

Memberを返す

name()

const std::string & name ( ) const

inline

Member名

nameW()

const std::wstring & nameW ( ) const

inline

Member名 (wstring)

Since

ver2.0

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型の引数をとる関数

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/3]

Field operator[] ( int  index ) const

inlineinherited

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

Since

ver1.11

operator[]() [2/3]

Field operator[] ( std::string_view  field ) const

inlineinherited

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

Since

ver1.11

operator[]() [3/3]

Field operator[] ( std::wstring_view  field ) const

inlineinherited

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

Since

ver2.0

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() [1/2]

RobotModel robotModel

(

std::string_view

field = ""

)

const

robotModel() [2/2]

RobotModel robotModel

(

std::wstring_view

field

)

const

robotModelEntries()

std::vector< RobotModel > robotModelEntries

(

)

const

robotModels()

std::vector< RobotModel > robotModels

(

)

const

このmemberが公開しているrobotModelのリストを返す。

Deprecated:

1.6で robotModelEntries() に変更

setCheck()

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

inherited

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

syncTime()

std::chrono::system_clock::time_point syncTime

(

)

const

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

Since

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

text() [1/2]

Text text

(

std::string_view

field = ""

)

const

text() [2/2]

Text text

(

std::wstring_view

field

)

const

textEntries()

std::vector< Text > textEntries

(

)

const

texts()

std::vector< Text > texts

(

)

const

このmemberが公開しているtextのリストを返す。

Deprecated:

1.6で textEntries() に変更

value() [1/2]

Value value

(

std::string_view

field = ""

)

const

value() [2/2]

Value value

(

std::wstring_view

field

)

const

valueEntries()

std::vector< Value > valueEntries

(

)

const

values()

std::vector< Value > values

(

)

const

このmemberが公開しているvalueのリストを返す。

Deprecated:

1.6で valueEntries() に変更

view() [1/2]

View view

(

std::string_view

field = ""

)

const

view() [2/2]

View view

(

std::wstring_view

field

)

const

viewEntries()

std::vector< View > viewEntries

(

)

const

views()

std::vector< View > views

(

)

const

このmemberが公開しているviewのリストを返す。

Deprecated:

1.6で viewEntries() に変更

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