yarp::os::idl::WireReader Class Reference

IDL-friendly connection reader. More...

#include <yarp/os/idl/WireReader.h>

Public Member Functions
	WireReader (ConnectionReader &reader)
	~WireReader ()
void	expectAccept ()
void	accept ()
void	allowGetMode ()
bool	clear ()
void	fail ()
bool	read (WirePortable &obj)
bool	read (yarp::os::PortReader &obj)
bool	readNested (WirePortable &obj)
bool	readNested (yarp::os::PortReader &obj)
bool	readBool (bool &x)
bool	readI8 (std::int8_t &x)
bool	readI16 (std::int16_t &x)
bool	readI32 (std::int32_t &x)
bool	readI64 (std::int64_t &x)
bool	readFloat32 (yarp::conf::float32_t &x)
bool	readFloat64 (yarp::conf::float64_t &x)
bool	readUI8 (std::uint8_t &x)
bool	readUI16 (std::uint16_t &x)
bool	readUI32 (std::uint32_t &x)
bool	readUI64 (std::uint64_t &x)
bool	readVocab32 (yarp::conf::vocab32_t &x)
bool	readSizeT (std::size_t &x)
std::int8_t	expectInt8 ()
std::int16_t	expectInt16 ()
std::int32_t	expectInt32 ()
std::int64_t	expectInt64 ()
yarp::conf::float32_t	expectFloat32 ()
yarp::conf::float64_t	expectFloat64 ()
bool	readString (std::string &str, bool *is_vocab=nullptr)
bool	readBlock (char *const data, size_t len)
bool	readBinary (std::string &str)
template<typename EnumBase , typename ConverterType >
bool	readEnum (EnumBase &x)
bool	readListHeader ()
bool	readListHeader (int len)
bool	readListReturn ()
int	getLength () const
ConnectionReader &	getReader ()
ConnectionWriter &	getWriter ()
bool	isValid ()
bool	isError ()
std::string	readTag (size_t len=static_cast< size_t >(-1))
void	readListBegin (yarp::os::idl::WireState &nstate, size_t &len)
void	readSetBegin (yarp::os::idl::WireState &nstate, size_t &len)
void	readMapBegin (yarp::os::idl::WireState &nstate, yarp::os::idl::WireState &nstate2, size_t &len)
void	readListEnd ()
void	readSetEnd ()
void	readMapEnd ()
bool	noMore ()
bool	getMode () const
bool	getIsVocab32 () const
const std::string &	getString () const

Detailed Description

IDL-friendly connection reader.

Used by YARP IDL tools, not intended for end-user.

Definition at line 26 of file WireReader.h.

Constructor & Destructor Documentation

WireReader()

WireReader::WireReader

(

ConnectionReader &

reader

)

Definition at line 16 of file WireReader.cpp.

~WireReader()

WireReader::~WireReader

(

)

Definition at line 22 of file WireReader.cpp.

Member Function Documentation

accept()

void WireReader::accept

(

)

Definition at line 40 of file WireReader.cpp.

allowGetMode()

void WireReader::allowGetMode

(

)

Definition at line 45 of file WireReader.cpp.

clear()

bool WireReader::clear

(

)

Definition at line 50 of file WireReader.cpp.

expectAccept()

void WireReader::expectAccept

(

)

Definition at line 34 of file WireReader.cpp.

expectFloat32()

yarp::conf::float32_t yarp::os::idl::WireReader::expectFloat32 ( )

inline

Definition at line 103 of file WireReader.h.

expectFloat64()

yarp::conf::float64_t yarp::os::idl::WireReader::expectFloat64 ( )

inline

Definition at line 110 of file WireReader.h.

expectInt16()

std::int16_t yarp::os::idl::WireReader::expectInt16 ( )

inline

Definition at line 83 of file WireReader.h.

expectInt32()

std::int32_t yarp::os::idl::WireReader::expectInt32 ( )

inline

Definition at line 89 of file WireReader.h.

expectInt64()

std::int64_t yarp::os::idl::WireReader::expectInt64 ( )

inline

Definition at line 96 of file WireReader.h.

expectInt8()

std::int8_t yarp::os::idl::WireReader::expectInt8 ( )

inline

Definition at line 77 of file WireReader.h.

fail()

void WireReader::fail

(

)

Definition at line 65 of file WireReader.cpp.

getIsVocab32()

bool WireReader::getIsVocab32

(

)

const

Definition at line 669 of file WireReader.cpp.

getLength()

int yarp::os::idl::WireReader::getLength ( ) const

inline

Definition at line 179 of file WireReader.h.

getMode()

bool WireReader::getMode

(

)

const

Definition at line 664 of file WireReader.cpp.

getReader()

ConnectionReader & WireReader::getReader

(

)

Definition at line 536 of file WireReader.cpp.

getString()

const std::string & WireReader::getString

(

)

const

Definition at line 674 of file WireReader.cpp.

getWriter()

ConnectionWriter & WireReader::getWriter

(

)

Definition at line 541 of file WireReader.cpp.

isError()

bool WireReader::isError

(

)

Definition at line 556 of file WireReader.cpp.

isValid()

bool WireReader::isValid

(

)

Definition at line 551 of file WireReader.cpp.

noMore()

bool WireReader::noMore

(

)

Definition at line 637 of file WireReader.cpp.

read() [1/2]

bool WireReader::read

(

WirePortable &

obj

)

Definition at line 72 of file WireReader.cpp.

read() [2/2]

bool WireReader::read

(

yarp::os::PortReader &

obj

)

Definition at line 77 of file WireReader.cpp.

readBinary()

bool WireReader::readBinary

(

std::string &

str

)

Definition at line 437 of file WireReader.cpp.

readBlock()

bool WireReader::readBlock	(	char *const	data,
		size_t	len
	)

Definition at line 424 of file WireReader.cpp.

readBool()

bool WireReader::readBool

(

bool &

x

)

Definition at line 92 of file WireReader.cpp.

readEnum()

template<typename EnumBase , typename ConverterType >

bool yarp::os::idl::WireReader::readEnum ( EnumBase &  x )

inline

Definition at line 124 of file WireReader.h.

readFloat32()

bool WireReader::readFloat32

(

yarp::conf::float32_t &

x

)

Definition at line 232 of file WireReader.cpp.

readFloat64()

bool WireReader::readFloat64

(

yarp::conf::float64_t &

x

)

Definition at line 271 of file WireReader.cpp.

readI16()

bool WireReader::readI16

(

std::int16_t &

x

)

Definition at line 139 of file WireReader.cpp.

readI32()

bool WireReader::readI32

(

std::int32_t &

x

)

Definition at line 169 of file WireReader.cpp.

readI64()

bool WireReader::readI64

(

std::int64_t &

x

)

Definition at line 199 of file WireReader.cpp.

readI8()

bool WireReader::readI8

(

std::int8_t &

x

)

Definition at line 112 of file WireReader.cpp.

readListBegin()

void WireReader::readListBegin	(	yarp::os::idl::WireState &	nstate,
		size_t &	len
	)

Definition at line 598 of file WireReader.cpp.

readListEnd()

void WireReader::readListEnd

(

)

Definition at line 622 of file WireReader.cpp.

readListHeader() [1/2]

bool WireReader::readListHeader

(

)

Definition at line 474 of file WireReader.cpp.

readListHeader() [2/2]

bool WireReader::readListHeader

(

int

len

)

Definition at line 497 of file WireReader.cpp.

readListReturn()

bool WireReader::readListReturn

(

)

Definition at line 505 of file WireReader.cpp.

readMapBegin()

void WireReader::readMapBegin	(	yarp::os::idl::WireState &	nstate,
		yarp::os::idl::WireState &	nstate2,
		size_t &	len
	)

Definition at line 614 of file WireReader.cpp.

readMapEnd()

void WireReader::readMapEnd

(

)

Definition at line 632 of file WireReader.cpp.

readNested() [1/2]

bool WireReader::readNested

(

WirePortable &

obj

)

Definition at line 82 of file WireReader.cpp.

readNested() [2/2]

bool WireReader::readNested

(

yarp::os::PortReader &

obj

)

Definition at line 87 of file WireReader.cpp.

readSetBegin()

void WireReader::readSetBegin	(	yarp::os::idl::WireState &	nstate,
		size_t &	len
	)

Definition at line 609 of file WireReader.cpp.

readSetEnd()

void WireReader::readSetEnd

(

)

Definition at line 627 of file WireReader.cpp.

readSizeT()

bool WireReader::readSizeT

(

std::size_t &

x

)

Definition at line 351 of file WireReader.cpp.

readString()

bool WireReader::readString	(	std::string &	str,
		bool *	is_vocab = nullptr
	)

Definition at line 376 of file WireReader.cpp.

readTag()

std::string WireReader::readTag

(

size_t

len = static_cast<size_t>(-1)

)

Definition at line 561 of file WireReader.cpp.

readUI16()

bool WireReader::readUI16

(

std::uint16_t &

x

)

Definition at line 315 of file WireReader.cpp.

readUI32()

bool WireReader::readUI32

(

std::uint32_t &

x

)

Definition at line 320 of file WireReader.cpp.

readUI64()

bool WireReader::readUI64

(

std::uint64_t &

x

)

Definition at line 325 of file WireReader.cpp.

readUI8()

bool WireReader::readUI8

(

std::uint8_t &

x

)

Definition at line 310 of file WireReader.cpp.

readVocab32()

bool WireReader::readVocab32

(

yarp::conf::vocab32_t &

x

)

Definition at line 330 of file WireReader.cpp.

---

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

• src/libYARP_os/src/yarp/os/idl/WireReader.h
• src/libYARP_os/src/yarp/os/idl/WireReader.cpp