実数値またはその配列の送受信データを表すクラス More...

#include <webcface/value.h>

Inheritance diagram for Value:

Collaboration diagram for Value:

Public Member Functions
	Value ()=default

	Value (const Field &base)

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

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

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

Value	child (int index) const

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

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

Value	operator[] (const char *field) const

Value	operator[] (const wchar_t *field) const

Value	operator[] (int index) const

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

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

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

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

const Value &	set (double v) const
	値をセットする

const Value &	set (std::vector< double > v) const
	vector型配列をセットする

template<typename R , typename traits::ArrayLikeTrait< R >::ArrayLike = traits::TraitOk>
const Value &	set (const R &range) const
	配列型の値をセットする

const Value &	resize (std::size_t size) const
	配列をセット、またはすでにsetされていればリサイズする

const Value &	push_back (double v) const
	値をセット、またはすでに配列がsetされていれば末尾に追加

template<typename T >
const Value &	operator= (T &&v) const
	数値または配列をセットする

const Value &	operator= (std::vector< double > v) const
	vector型配列をセットする

const Value &	request () const
	値をリクエストする

std::optional< double >	tryGet () const
	値を返す

std::optional< std::vector< double > >	tryGetVec () const
	値をvectorで返す

double	get () const
	値を返す

std::vector< double >	getVec () const
	値をvectorで返す

	operator double () const

	operator std::vector () const

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

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

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

const Value &	operator+= (double rhs) const

const Value &	operator-= (double rhs) const

const Value &	operator*= (double rhs) const

const Value &	operator/= (double rhs) const

const Value &	operator%= (std::int32_t rhs) const

const Value &	operator<<= (std::int32_t rhs) const

const Value &	operator>>= (std::int32_t rhs) const

const Value &	operator&= (std::int32_t rhs) const

const Value &	operator\|= (std::int32_t rhs) const

const Value &	operator^= (std::int32_t rhs) const

const Value &	operator++ () const
	1足したものをsetした後自身を返す

double	operator++ (int) const
	1足したものをsetし、足す前の値を返す

const Value &	operator-- () const
	1引いたものをsetした後自身を返す

double	operator-- (int) const
	1引いたものをsetし、足す前の値を返す

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

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

bool	operator< (const Value &) const =delete

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

bool	operator> (const Value &) const =delete

bool	operator>= (const Value &) 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
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

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_
	フィールド名

Detailed Description

実数値またはその配列の送受信データを表すクラス

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

Constructor & Destructor Documentation

◆ Value() [1/3]

Value ( )

default

◆ Value() [2/3]

Value ( const Field & base )

◆ Value() [3/3]

Value	(	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()と同じ

◆ 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]

Value child ( int index ) const

inline

Since: ver1.11

◆ child() [3/4]

Value child ( std::string_view field ) const

inline

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

◆ child() [4/4]

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

◆ exists()

bool exists ( ) const

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

Since: ver2.1

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

◆ expired()

bool expired ( ) const

inherited

◆ free()

const Value & 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()

double get ( ) const

inline

値を返す

◆ getVec()

std::vector< double > getVec ( ) const

inline

値をvectorで返す

◆ 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/2]

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

const Value & onChange ( F callback ) const

inline

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

Since: ver2.0

Parameters

callback 引数をとらない関数

◆ onChange() [2/2]

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

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

Since: ver2.0

Parameters

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

◆ operator double()

operator double ( ) const

inline

◆ operator std::vector()

operator std::vector ( ) const

inline

◆ 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, Value >, std::nullptr_t > = nullptr>

bool operator!= ( const T & other ) const

inline

◆ operator%=()

const Value & operator%= ( std::int32_t rhs ) const

inline

◆ operator&=()

const Value & operator&= ( std::int32_t rhs ) const

inline

◆ operator*=()

const Value & operator*= ( double rhs ) const

inline

◆ operator++() [1/2]

const Value & operator++ ( ) const

inline

1足したものをsetした後自身を返す

◆ operator++() [2/2]

double operator++ ( int ) const

inline

1足したものをsetし、足す前の値を返す

◆ operator+=()

const Value & operator+= ( double rhs ) const

inline

◆ operator--() [1/2]

const Value & operator-- ( ) const

inline

1引いたものをsetした後自身を返す

◆ operator--() [2/2]

double operator-- ( int ) const

inline

1引いたものをsetし、足す前の値を返す

◆ operator-=()

const Value & operator-= ( double rhs ) const

inline

◆ operator/=()

const Value & operator/= ( double rhs ) const

inline

◆ operator<()

bool operator< ( const Value & ) const

delete

◆ operator<<=()

const Value & operator<<= ( std::int32_t rhs ) const

inline

◆ operator<=()

bool operator<= ( const Value & ) const

delete

◆ operator=() [1/2]

const Value & operator= ( std::vector< double > v ) const

inline

vector型配列をセットする

Since: ver2.0.2

initializer_listを受け取るためのオーバーロード (ver1.11まで VectorOpt<double> として受け取っていたもの)

◆ operator=() [2/2]

template<typename T >

const Value & operator= ( T && v ) 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, Value >, std::nullptr_t > = nullptr>

bool operator== ( const T & other ) const

inline

Valueの参照先を比較

Since: ver1.11

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

◆ operator>()

bool operator> ( const Value & ) const

delete

◆ operator>=()

bool operator>= ( const Value & ) const

delete

◆ operator>>=()

const Value & operator>>= ( std::int32_t rhs ) const

inline

◆ operator[]() [1/5]

Value operator[] ( const char * field ) const

inline

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

Since: ver1.11

◆ operator[]() [2/5]

Value operator[] ( const wchar_t * field ) const

inline

Since: ver2.0

◆ operator[]() [3/5]

Value operator[] ( int index ) const

inline

child()と同じ

Since: ver1.11

◆ operator[]() [4/5]

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

inline

child()と同じ

Since: ver1.11

◆ operator[]() [5/5]

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

inline

child()と同じ

Since: ver2.0

◆ operator^=()

const Value & operator^= ( std::int32_t rhs ) const

inline

◆ operator|=()

const Value & operator|= ( std::int32_t rhs ) const

inline

◆ parent()

Value parent ( ) const

inline

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

Since: ver1.11

◆ push_back()

const Value & push_back ( double v ) const

値をセット、またはすでに配列がsetされていれば末尾に追加

◆ request()

const Value & request ( ) const

値をリクエストする

Since: ver1.7

◆ resize()

const Value & resize ( std::size_t size ) const

配列をセット、またはすでにsetされていればリサイズする

Since: ver1.11

◆ 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]

template<typename R , typename traits::ArrayLikeTrait< R >::ArrayLike = traits::TraitOk>

const Value & set ( const R & range ) const

inline

配列型の値をセットする

Since: ver1.7 (set(VectorOpt(std::vector<T>)) を置き換え)

~~R::value_type がdoubleに変換可能な型Rならなんでもok~~
(ver2.5〜) std::begin(), std::end() が使えてその値がdoubleに変換可能ならなんでもok

◆ set() [2/3]

const Value & set ( double v ) const

値をセットする

ver1.11〜: vが配列でなく、parent()の配列データが利用可能ならその要素をセットする

◆ set() [3/3]

const Value & set ( std::vector< double > v ) const

vector型配列をセットする

Since: ver2.0 (set(VectorOpt<double>) を置き換え)

◆ 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< double > tryGet ( ) const

値を返す

ver1.11〜 parent()の配列データが利用可能ならその要素を返す

◆ tryGetVec()

std::optional< std::vector< double > > tryGetVec ( ) const

値をvectorで返す

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Value() [1/3]

◆ Value() [2/3]

◆ Value() [3/3]

Member Function Documentation

◆ appendListener()

◆ 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()

◆ exists()

◆ expired()

◆ free()

◆ func() [1/2]

◆ func() [2/2]

◆ funcEntries()

◆ funcListener() [1/2]

◆ funcListener() [2/2]

◆ get()

◆ getVec()

◆ image() [1/2]

◆ image() [2/2]

◆ imageEntries()

◆ isSelf()

◆ lastName()

◆ lastName8()

◆ lastNameW()

◆ log() [1/2]

◆ log() [2/2]

◆ logEntries()

◆ member()

◆ name()

◆ nameW()

◆ onChange() [1/2]

◆ onChange() [2/2]

◆ operator double()

◆ operator std::vector()

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator%=()

◆ operator&=()

◆ operator*=()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator/=()

◆ operator<()

◆ operator<<=()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ operator>()

◆ operator>=()

◆ operator>>=()

◆ operator[]() [1/5]

◆ operator[]() [2/5]

◆ operator[]() [3/5]

◆ operator[]() [4/5]

◆ operator[]() [5/5]

◆ operator^=()

◆ operator|=()

◆ parent()