文字列の送受信データを表すクラス More...

#include <webcface/text.h>

Inheritance diagram for Text:

Collaboration diagram for Text:

Public Member Functions
	Text ()=default

	Text (const Field &base)

	Text (const Field &base, const SharedString &field)

Text	child (std::string_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField

Text	child (std::wstring_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)

Text	child (int index) const

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

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

Text	operator[] (const char *field) const

Text	operator[] (const wchar_t *field) const

Text	operator[] (int index) const

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

template<typename F , typename std::enable_if_t< std::is_invocable_v< F, Text >, std::nullptr_t > = nullptr>
const Text &	onChange (F callback) const
	値が変化したときに呼び出されるコールバックを設定

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Text &	onChange (F callback) const
	値が変化したときに呼び出されるコールバックを設定

template<typename T >
void	appendListener (T &&callback) const

const Text &	set (std::string_view v) const
	文字列をセットする

const Text &	set (std::wstring_view v) const
	文字列をセットする (wstring)

const Text &	operator= (std::string_view v) const
	文字列をセットする

const Text &	operator= (std::wstring_view v) const
	文字列をセットする (wstring)

const Text &	request () const
	文字列をリクエストする

std::optional< std::string >	tryGet () const
	文字列を返す

std::optional< std::wstring >	tryGetW () const
	文字列を返す (wstring)

const std::string &	get () const
	文字列を返す (const参照)

const std::wstring &	getW () const
	文字列を返す (wstring const参照)

	operator const std::string & () const

	operator const std::wstring & () const

bool	exists () const
	このフィールドにデータが存在すればtrue

std::chrono::system_clock::time_point	time () const
	syncの時刻を返す

const Text &	free () const
	値やリクエスト状態をクリア

bool	operator== (std::string_view rhs) const

bool	operator!= (std::string_view rhs) const

bool	operator== (std::wstring_view rhs) const

bool	operator!= (std::wstring_view rhs) const

template<typename T , typename std::enable_if_t< std::is_same_v< T, Text >, std::nullptr_t > = nullptr>
bool	operator== (const T &other) const
	Textの参照先を比較

template<typename T , typename std::enable_if_t< std::is_same_v< T, Text >, std::nullptr_t > = nullptr>
bool	operator!= (const T &other) const

bool	operator< (const Text &) const =delete

bool	operator<= (const Text &) const =delete

bool	operator> (const Text &) const =delete

bool	operator>= (const Text &) const =delete

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

Member	member () const
	Memberを返す

const std::string &	name () const
	field名を返す

const std::wstring &	nameW () const
	field名を返す (wstring)

Protected Member Functions
const Variant &	onChange (std::function< void(Variant)> callback) const
	値が変化したときに呼び出されるコールバックを設定

const Variant &	set (const ValAdaptor &v) const
	値をセットする

template<typename T , typename std::enable_if_t< std::is_convertible_v< ValAdaptor, T >, std::nullptr_t > = nullptr>
	operator T () const

bool	empty () const
	値が空かどうか調べる

const std::string &	asStringRef () const
	文字列として返す

const std::wstring &	asWStringRef () const
	文字列として返す (wstring)

std::string	asString () const
	文字列として返す(コピー)

std::wstring	asWString () const
	文字列として返す(コピー) (wstring)

double	asDouble () const
	実数として返す

int	asInt () const
	int型の整数として返す

long long	asLLong () const
	long long型の整数として返す

bool	asBool () const
	bool値を返す

bool	operator== (const Field &other) const

bool	operator== (const FieldBase &rhs) const

bool	operator!= (const Field &other) const

bool	operator!= (const FieldBase &rhs) const

bool	operator< (const Variant &) const =delete

bool	operator<= (const Variant &) const =delete

bool	operator> (const Variant &) const =delete

bool	operator>= (const Variant &) const =delete

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

SharedString	lastName8 () const

Field	child (const SharedString &field) const

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

Value	value (std::string_view field="") const

Value	value (std::wstring_view field) const

Text	text (std::string_view field="") const

Text	text (std::wstring_view field) const

RobotModel	robotModel (std::string_view field="") const

RobotModel	robotModel (std::wstring_view field) const

Image	image (std::string_view field="") const

Image	image (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

View	view (std::string_view field="") const

View	view (std::wstring_view field) const

Canvas3D	canvas3D (std::string_view field="") const

Canvas3D	canvas3D (std::wstring_view field) const

Canvas2D	canvas2D (std::string_view field="") const

Canvas2D	canvas2D (std::wstring_view field) const

Log	log (std::string_view field="") const

Log	log (std::wstring_view field) const

std::vector< Value >	valueEntries () const

std::vector< Text >	textEntries () const

std::vector< RobotModel >	robotModelEntries () const

std::vector< Func >	funcEntries () const

std::vector< View >	viewEntries () const

std::vector< Canvas3D >	canvas3DEntries () const

std::vector< Canvas2D >	canvas2DEntries () const

std::vector< Image >	imageEntries () const

std::vector< Log >	logEntries () const

bool	isSelf () const
	memberがselfならtrue

Protected Attributes
std::weak_ptr< internal::ClientData >	data_w
	ClientDataの参照

SharedString	member_
	メンバー名

SharedString	field_
	フィールド名

Detailed Description

文字列の送受信データを表すクラス

コンストラクタではなく Member::text() を使って取得してください

Constructor & Destructor Documentation

◆ Text() [1/3]

Text ( )

default

◆ Text() [2/3]

Text ( const Field & base )

inline

◆ Text() [3/3]

Text	(	const Field &	base,
		const SharedString &	field
	)

inline

Member Function Documentation

◆ appendListener()

template<typename T >

void appendListener ( T && callback ) const

inline

Deprecated:: ver1.11まではEventTarget::appendListener()でコールバックを追加できたが、 ver2.0からコールバックは1個のみになった。互換性のため残しているがonChange()と同じ

◆ asBool()

bool asBool ( ) const

inlineinherited

bool値を返す

◆ asDouble()

double asDouble ( ) const

inlineinherited

実数として返す

◆ asInt()

int asInt ( ) const

inlineinherited

int型の整数として返す

◆ asLLong()

long long asLLong ( ) const

inlineinherited

long long型の整数として返す

◆ asString()

std::string asString ( ) const

inlineinherited

文字列として返す(コピー)

◆ asStringRef()

const std::string & asStringRef ( ) const

inlineinherited

文字列として返す

std::stringのconst参照を返す。参照は少なくとも次のClient::sync()までは有効

◆ asWString()

std::wstring asWString ( ) const

inlineinherited

文字列として返す(コピー) (wstring)

◆ asWStringRef()

const std::wstring & asWStringRef ( ) const

inlineinherited

文字列として返す (wstring)

See also: asStringRef()

◆ canvas2D() [1/2]

Canvas2D canvas2D ( std::string_view field = "" ) const

inherited

◆ canvas2D() [2/2]

Canvas2D canvas2D ( std::wstring_view field ) const

inherited

◆ canvas2DEntries()

std::vector< Canvas2D > canvas2DEntries ( ) const

inherited

◆ canvas3D() [1/2]

Canvas3D canvas3D ( std::string_view field = "" ) const

inherited

◆ canvas3D() [2/2]

Canvas3D canvas3D ( std::wstring_view field ) const

inherited

◆ canvas3DEntries()

std::vector< Canvas3D > canvas3DEntries ( ) const

inherited

◆ child() [1/4]

Field child ( const SharedString & field ) const

inherited

◆ child() [2/4]

Text child ( int index ) const

inline

Since: ver1.11

◆ child() [3/4]

Text child ( std::string_view field ) const

inline

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

◆ child() [4/4]

Text 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を投げる

◆ empty()

bool empty ( ) const

inlineinherited

値が空かどうか調べる

◆ exists()

bool exists ( ) const

このフィールドにデータが存在すればtrue

Since: ver2.1

tryGet() などとは違って、実際のデータを受信しない。リクエストも送信しない。

◆ expired()

bool expired ( ) const

inherited

◆ free()

const Text & free ( ) const

値やリクエスト状態をクリア

◆ func() [1/2]

Func func ( std::string_view field = "" ) const

inherited

◆ func() [2/2]

Func func ( std::wstring_view field ) const

inherited

◆ funcEntries()

std::vector< Func > funcEntries ( ) const

inherited

◆ funcListener() [1/2]

FuncListener funcListener ( std::string_view field ) const

inherited

◆ funcListener() [2/2]

FuncListener funcListener ( std::wstring_view field ) const

inherited

◆ get()

const std::string & get ( ) const

文字列を返す (const参照)

~~ver1.10〜文字列以外の型も扱うためValAdaptor型に変更~~
ver2.0〜 stringに戻した
ver2.0〜 const参照に変更参照は少なくとも次のClient::sync()までは有効

◆ getW()

const std::wstring & getW ( ) const

文字列を返す (wstring const参照)

Since: ver2.0

参照は少なくとも次のClient::sync()までは有効

◆ image() [1/2]

Image image ( std::string_view field = "" ) const

inherited

◆ image() [2/2]

Image image ( std::wstring_view field ) const

inherited

◆ imageEntries()

std::vector< Image > imageEntries ( ) const

inherited

◆ isSelf()

bool isSelf ( ) const

inherited

memberがselfならtrue

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

◆ lastName()

std::string lastName ( ) const

inline

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

Since: ver1.11

◆ lastName8()

SharedString lastName8 ( ) const

protectedinherited

◆ lastNameW()

std::wstring lastNameW ( ) const

inlineinherited

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

Since: ver2.0

◆ log() [1/2]

Log log ( std::string_view field = "" ) const

inherited

Since: ver2.4

◆ log() [2/2]

Log log ( std::wstring_view field ) const

inherited

Since: ver2.4

◆ logEntries()

std::vector< Log > logEntries ( ) const

inherited

Since: ver2.4

◆ member()

Member member ( ) const

Memberを返す

◆ name()

const std::string & name ( ) const

inline

field名を返す

◆ nameW()

const std::wstring & nameW ( ) const

inline

field名を返す (wstring)

Since: ver2.0

◆ onChange() [1/3]

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

const Text & onChange ( F callback ) const

inline

値が変化したときに呼び出されるコールバックを設定

Since: ver2.0

Parameters

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

◆ onChange() [2/3]

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

const Text & onChange ( F callback ) const

inline

値が変化したときに呼び出されるコールバックを設定

Since: ver2.0

Parameters

callback 引数をとらない関数

◆ onChange() [3/3]

const Variant & onChange ( std::function< void(Variant)> callback ) const

inherited

値が変化したときに呼び出されるコールバックを設定

Parameters

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

◆ operator const std::string &()

operator const std::string & ( ) const

inline

◆ operator const std::wstring &()

operator const std::wstring & ( ) const

inline

◆ operator T()

template<typename T , typename std::enable_if_t< std::is_convertible_v< ValAdaptor, T >, std::nullptr_t > = nullptr>

operator T ( ) const

inlineinherited

◆ operator!=() [1/5]

bool operator!= ( const Field & other ) const

inlineinherited

◆ operator!=() [2/5]

bool operator!= ( const FieldBase & rhs ) const

inlineinherited

◆ operator!=() [3/5]

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

bool operator!= ( const T & other ) const

inline

◆ operator!=() [4/5]

bool operator!= ( std::string_view rhs ) const

inline

◆ operator!=() [5/5]

bool operator!= ( std::wstring_view rhs ) const

inline

◆ operator<() [1/2]

bool operator< ( const Text & ) const

delete

◆ operator<() [2/2]

bool operator< ( const Variant & ) const

deleteinherited

◆ operator<=() [1/2]

bool operator<= ( const Text & ) const

delete

◆ operator<=() [2/2]

bool operator<= ( const Variant & ) const

deleteinherited

◆ operator=() [1/2]

const Text & operator= ( std::string_view v ) const

inline

文字列をセットする

◆ operator=() [2/2]

const Text & operator= ( std::wstring_view v ) const

inline

文字列をセットする (wstring)

Since: ver2.0

◆ operator==() [1/5]

bool operator== ( const Field & other ) const

inherited

◆ operator==() [2/5]

bool operator== ( const FieldBase & rhs ) const

inlineinherited

◆ operator==() [3/5]

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

bool operator== ( const T & other ) const

inline

Textの参照先を比較

Since: ver1.11

1.10まではText同士を比較すると中の値が比較されていた。大小の比較も同様に中の値で比較されると非自明な挙動になるのでdeleteしている。

◆ operator==() [4/5]

bool operator== ( std::string_view rhs ) const

inline

◆ operator==() [5/5]

bool operator== ( std::wstring_view rhs ) const

inline

◆ operator>() [1/2]

bool operator> ( const Text & ) const

delete

◆ operator>() [2/2]

bool operator> ( const Variant & ) const

deleteinherited

◆ operator>=() [1/2]

bool operator>= ( const Text & ) const

delete

◆ operator>=() [2/2]

bool operator>= ( const Variant & ) const

deleteinherited

◆ operator[]() [1/5]

Text operator[] ( const char * field ) const

inline

operator[](long, const char *)と解釈されるのを防ぐための定義

Since: ver1.11

◆ operator[]() [2/5]

Text operator[] ( const wchar_t * field ) const

inline

Since: ver2.0

◆ operator[]() [3/5]

Text operator[] ( int index ) const

inline

child()と同じ

Since: ver1.11

◆ operator[]() [4/5]

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

inline

child()と同じ

Since: ver1.11

◆ operator[]() [5/5]

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

inline

child()と同じ

Since: ver2.0

◆ parent()

Text parent ( ) const

inline

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

Since: ver1.11

◆ request()

const Text & request ( ) const

inline

文字列をリクエストする

Since: ver1.7

◆ robotModel() [1/2]

RobotModel robotModel ( std::string_view field = "" ) const

inherited

◆ robotModel() [2/2]

RobotModel robotModel ( std::wstring_view field ) const

inherited

◆ robotModelEntries()

std::vector< RobotModel > robotModelEntries ( ) const

inherited

◆ set() [1/3]

const Variant & set ( const ValAdaptor & v ) const

protectedinherited

値をセットする

Since: ver1.10

◆ set() [2/3]

const Text & set ( std::string_view v ) const

inline

文字列をセットする

(ver2.0からstd::stringをstd::string_viewに変更)

◆ set() [3/3]

const Text & set ( std::wstring_view v ) const

inline

文字列をセットする (wstring)

Since: ver2.0

◆ setCheck()

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

inherited

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

◆ text() [1/2]

Text text ( std::string_view field = "" ) const

inherited

◆ text() [2/2]

Text text ( std::wstring_view field ) const

inherited

◆ textEntries()

std::vector< Text > textEntries ( ) const

inherited

◆ time()

std::chrono::system_clock::time_point time ( ) const

syncの時刻を返す

Deprecated:: 1.7でMember::syncTime()に変更

◆ tryGet()

std::optional< std::string > tryGet ( ) const

文字列を返す

~~ver1.10〜文字列以外の型も扱うためValAdaptor型に変更~~
ver2.0〜 stringに戻した

◆ tryGetW()

std::optional< std::wstring > tryGetW ( ) const

文字列を返す (wstring)

Since: ver2.0

◆ value() [1/2]

Value value ( std::string_view field = "" ) const

inherited

◆ value() [2/2]

Value value ( std::wstring_view field ) const

inherited

◆ valueEntries()

std::vector< Value > valueEntries ( ) const

inherited

◆ view() [1/2]

View view ( std::string_view field = "" ) const

inherited

◆ view() [2/2]

View view ( std::wstring_view field ) const

inherited

◆ viewEntries()

std::vector< View > viewEntries ( ) const

inherited

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/text.h
client/src/text.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Text() [1/3]

◆ Text() [2/3]

◆ Text() [3/3]

Member Function Documentation

◆ appendListener()

◆ asBool()

◆ asDouble()

◆ asInt()

◆ asLLong()

◆ asString()

◆ asStringRef()

◆ asWString()

◆ asWStringRef()

◆ canvas2D() [1/2]

◆ canvas2D() [2/2]

◆ canvas2DEntries()

◆ canvas3D() [1/2]

◆ canvas3D() [2/2]

◆ canvas3DEntries()

◆ child() [1/4]

◆ child() [2/4]

◆ child() [3/4]

◆ child() [4/4]

◆ dataLock()

◆ empty()

◆ exists()

◆ expired()

◆ free()

◆ func() [1/2]

◆ func() [2/2]

◆ funcEntries()

◆ funcListener() [1/2]

◆ funcListener() [2/2]

◆ get()

◆ getW()

◆ image() [1/2]

◆ image() [2/2]

◆ imageEntries()

◆ isSelf()

◆ lastName()

◆ lastName8()

◆ lastNameW()

◆ log() [1/2]

◆ log() [2/2]

◆ logEntries()

◆ member()

◆ name()

◆ nameW()

◆ onChange() [1/3]

◆ onChange() [2/3]

◆ onChange() [3/3]

◆ operator const std::string &()

◆ operator const std::wstring &()

◆ operator T()

◆ operator!=() [1/5]

◆ operator!=() [2/5]

◆ operator!=() [3/5]

◆ operator!=() [4/5]

◆ operator!=() [5/5]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator<=() [1/2]

◆ operator<=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/5]

◆ operator==() [2/5]

◆ operator==() [3/5]

◆ operator==() [4/5]

◆ operator==() [5/5]

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ operator>=() [1/2]

◆ operator>=() [2/2]

◆ operator[]() [1/5]