Image Class Reference

(ver1.3から追加) 画像の送受信データを表すクラス More...

#include <webcface/image.h>

Inheritance diagram for Image:

Collaboration diagram for Image:

Public Member Functions
	Image ()=default
	Image (const Field &base)
	Image (const Field &base, const SharedString &field)
Image	child (std::string_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField
Image	child (std::wstring_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)
Image	child (int index) const
Image	operator[] (std::string_view field) const
Image	operator[] (std::wstring_view field) const
Image	operator[] (const char *field) const
Image	operator[] (const wchar_t *field) const
Image	operator[] (int index) const
Image	parent () const
	nameの最後のピリオドの前までを新しい名前とするField
const Image &	onChange (std::function< void(Image)> callback) const
	値が変化したときに呼び出されるコールバックを設定
template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Image &	onChange (F callback) const
	値が変化したときに呼び出されるコールバックを設定
template<typename T >
void	appendListener (T &&callback) const
const Image &	set (const ImageFrame &img) const
	画像をセットする
const Image &	operator= (const ImageFrame &img) const
	画像をセットする
const Image &	request (std::optional< int > rows, std::optional< int > cols=std::nullopt, std::optional< ImageColorMode > color_mode=std::nullopt, std::optional< double > frame_rate=std::nullopt) const
	画像を生画像のフォーマットでリクエストする
const Image &	request (std::optional< SizeOption > size=std::nullopt, std::optional< ImageColorMode > color_mode=std::nullopt, std::optional< double > frame_rate=std::nullopt) const
	画像を生画像のフォーマットでリクエストする
const Image &	request (std::optional< int > rows, std::optional< int > cols, ImageCompressMode cmp_mode, int quality, std::optional< double > frame_rate=std::nullopt) const
	画像を圧縮されたフォーマットでリクエストする
const Image &	request (std::optional< SizeOption > size, ImageCompressMode cmp_mode, int quality, std::optional< double > frame_rate=std::nullopt) const
	画像を圧縮されたフォーマットでリクエストする
std::optional< ImageFrame >	tryGet () const
	画像を返す
ImageFrame	get () const
	画像を返す (データがない場合0x0の画像が返る)
bool	exists () const
	このフィールドにデータが存在すればtrue
std::chrono::system_clock::time_point	time () const
	syncの時刻を返す
const Image &	free () const
	値やリクエスト状態をクリア
const Image &	clear () const
	画像をクリア (リクエスト状態は解除しない)
template<typename T , typename std::enable_if_t< std::is_same_v< T, Image >, std::nullptr_t > = nullptr>
bool	operator== (const T &other) const
	Imageの参照先を比較
template<typename T , typename std::enable_if_t< std::is_same_v< T, Image >, std::nullptr_t > = nullptr>
bool	operator!= (const T &other) const
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 Image &	tryRequest () const
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

(ver1.3から追加) 画像の送受信データを表すクラス

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

Constructor & Destructor Documentation

Image() [1/3]

Image ( )

default

Image() [2/3]

Image

(

const Field &

base

)

Image() [3/3]

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

Image child ( int  index ) const

inline

Since

ver1.11

child() [3/4]

Image child ( std::string_view  field ) const

inline

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

child() [4/4]

Image child ( std::wstring_view  field ) const

inline

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

Since

ver2.0

clear()

const Image & clear

(

)

const

画像をクリア (リクエスト状態は解除しない)

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 Image & 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()

ImageFrame get ( ) const

inline

画像を返す (データがない場合0x0の画像が返る)

リクエストしていない場合すべてデフォルトで(元画像のフォーマットで)リクエストする

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 Image & onChange ( F  callback ) const

inline

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

Since

ver2.0

Parameters

callback

引数をとらない関数

onChange() [2/2]

const Image & onChange

(

std::function< void(Image)>

callback

)

const

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

Since

ver2.0

Parameters

callback

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

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

bool operator!= ( const T &  other ) const

inline

operator=()

const Image & operator= ( const ImageFrame &  img ) 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, Image >, std::nullptr_t > = nullptr>

bool operator== ( const T &  other ) const

inline

Imageの参照先を比較

Since

ver1.11

operator[]() [1/5]

Image operator[] ( const char *  field ) const

inline

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

Since

ver1.11

operator[]() [2/5]

Image operator[] ( const wchar_t *  field ) const

inline

Since

ver2.0

operator[]() [3/5]

Image operator[] ( int  index ) const

inline

child()と同じ

Since

ver1.11

operator[]() [4/5]

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

inline

child()と同じ

Since

ver1.11

operator[]() [5/5]

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

inline

child()と同じ

Since

ver2.0

parent()

Image parent ( ) const

inline

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

Since

ver1.11

request() [1/4]

const Image & request ( std::optional< int >  rows, std::optional< int >  cols, ImageCompressMode  cmp_mode, int  quality, std::optional< double >  frame_rate = std::nullopt  ) const

inline

画像を圧縮されたフォーマットでリクエストする

Parameters

rows	画像の高さ
cols	画像の幅 rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
cmp_mode	圧縮モード
quality	圧縮のパラメータ jpeg → 0〜100 (大きいほうが高品質) png → 0〜9 (大きいほうが圧縮後のサイズが小さい) webp → 1〜100 (大きいほうが高品質)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

Deprecated:

ver2.0〜 rows, colsの順番がややこしいので sizeHW() を使ってサイズ指定

request() [2/4]

const Image & request ( std::optional< int >  rows, std::optional< int >  cols = std::nullopt, std::optional< ImageColorMode >  color_mode = std::nullopt, std::optional< double >  frame_rate = std::nullopt  ) const

inline

画像を生画像のフォーマットでリクエストする

Parameters

rows	画像の高さ
cols	画像の幅 rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
color_mode	画像の色フォーマット (nulloptの場合元画像のフォーマット)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

Deprecated:

ver2.0〜 rows, colsの順番がややこしいので sizeHW() を使ってサイズ指定

request() [3/4]

const Image & request ( std::optional< SizeOption >  size, ImageCompressMode  cmp_mode, int  quality, std::optional< double >  frame_rate = std::nullopt  ) const

inline

画像を圧縮されたフォーマットでリクエストする

Since

ver2.0

Parameters

sizeOption	画像のサイズ (sizeWH() または sizeHW(), std::nullopt可) rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
cmp_mode	圧縮モード
quality	圧縮のパラメータ jpeg → 0〜100 (大きいほうが高品質) png → 0〜9 (大きいほうが圧縮後のサイズが小さい) webp → 1〜100 (大きいほうが高品質)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

request() [4/4]

const Image & request ( std::optional< SizeOption >  size = std::nullopt, std::optional< ImageColorMode >  color_mode = std::nullopt, std::optional< double >  frame_rate = std::nullopt  ) const

inline

画像を生画像のフォーマットでリクエストする

Since

ver2.0

Parameters

sizeOption	画像のサイズ (sizeWH() または sizeHW(), std::nullopt可) rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
color_mode	画像の色フォーマット (nulloptの場合元画像のフォーマット)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

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

const Image & set

(

const ImageFrame &

img

)

const

画像をセットする

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< ImageFrame > tryGet

(

)

const

画像を返す

リクエストしていない場合すべてデフォルトで(元画像のフォーマットで)リクエストする

tryRequest()

const Image & tryRequest ( ) const

protected

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