A nested list of items. More...

#include <yarp/os/impl/Storable.h>

Inheritance diagram for yarp::os::impl::StoreList:

Public Member Functions
	StoreList ()=default

Storable *	createStorable () const override
	Factory method.

void	copy (const Storable &alt) override
	Become a copy of the passed item.

yarp::os::Bottle &	internal ()

std::string	toString () const override
	Return a standard text representation of the content of the object.

void	fromString (const std::string &src) override
	Initialize from a string representation, assuming that any syntax around this representation such as braces or parentheses has already been consumed.

std::string	toStringNested () const override
	Create string representation, including any syntax that should wrap it such as braces or parentheses.

void	fromStringNested (const std::string &src) override
	Initialize from a string representation.

std::int32_t	getCode () const override
	Get standard type code of value.

bool	readRaw (ConnectionReader &reader) override

bool	writeRaw (ConnectionWriter &writer) const override

bool	isList () const override
	Checks if value is a list.

yarp::os::Bottle *	asList () const override
	Get list value.

std::int32_t	subCode () const override
	Return a code describing this item, used in serializing bottles.

yarp::os::Value &	find (const std::string &key) const override
	Gets a value corresponding to a given keyword.

yarp::os::Bottle &	findGroup (const std::string &key) const override
	Gets a list corresponding to a given keyword.

Public Member Functions inherited from yarp::os::impl::Storable
virtual	~Storable ()
	Destructor.

virtual Storable *	cloneStorable () const
	Typed synonym for clone()

bool	operator== (const yarp::os::Value &alt) const

yarp::os::Value *	create () const override
	Create a new value of the same type.

yarp::os::Value *	clone () const override
	Create a copy of the value.

bool	read (ConnectionReader &connection) override
	Read this object from a network connection.

bool	write (ConnectionWriter &connection) const override
	Write this object to a network connection.

bool	isBool () const override
	Checks if value is a boolean.

bool	asBool () const override
	Get boolean value.

bool	isInt8 () const override
	Checks if value is a 8-bit integer.

std::int8_t	asInt8 () const override
	Get 8-bit integer value.

bool	isInt16 () const override
	Checks if value is a 16-bit integer.

std::int16_t	asInt16 () const override
	Get 16-bit integer value.

bool	isInt32 () const override
	Checks if value is a 32-bit integer.

std::int32_t	asInt32 () const override
	Get 32-bit integer value.

bool	isInt64 () const override
	Checks if value is a 64-bit integer.

std::int64_t	asInt64 () const override
	Get 64-bit integer value.

bool	isFloat32 () const override
	Checks if value is a 32-bit floating point number.

yarp::conf::float32_t	asFloat32 () const override
	Get 32-bit floating point value.

bool	isFloat64 () const override
	Checks if value is a 64-bit floating point number.

yarp::conf::float64_t	asFloat64 () const override
	Get 64-bit floating point value.

bool	isString () const override
	Checks if value is a string.

std::string	asString () const override
	Get string value.

bool	isDict () const override
	Checks if value is a dictionary.

yarp::os::Property *	asDict () const override
	Get dictionary (hash table) value.

bool	isVocab32 () const override
	Checks if value is a vocabulary identifier.

yarp::conf::vocab32_t	asVocab32 () const override
	Get vocabulary identifier as an integer.

bool	isBlob () const override
	Checks if value is a binary object.

const char *	asBlob () const override
	Get binary data value.

size_t	asBlobLength () const override
	Get binary data length.

bool	isNull () const override
	Checks if the object is invalid.

Searchable *	asSearchable () const override
	Get dictionary or list value.

bool	check (const std::string &key) const override
	Check if there exists a property of the given name.

bool	isLeaf () const override

Public Member Functions inherited from yarp::os::Value
	Value ()
	Construct a list Value.

	Value (std::int32_t x, bool isVocab32=false)
	Construct an integer Value.

	Value (yarp::conf::float64_t x)
	Construct a floating point Value.

	Value (const std::string &str, bool isVocab32=false)
	Construct a string Value.

	Value (void *data, int length)
	Construct a binary data Value.

	Value (const Value &alt)
	Copy constructor.

const Value &	operator= (const Value &alt)
	Assignment operator.

	~Value () override
	Destructor.

bool	read (ConnectionReader &connection) override
	Read this object from a network connection.

bool	write (ConnectionWriter &connection) const override
	Write this object to a network connection.

bool	check (const std::string &key) const override
	Check if there exists a property of the given name.

Value &	find (const std::string &key) const override
	Gets a value corresponding to a given keyword.

Bottle &	findGroup (const std::string &key) const override
	Gets a list corresponding to a given keyword.

bool	operator== (const Value &alt) const
	Equality test.

bool	operator!= (const Value &alt) const
	Inequality test.

void	fromString (const char *str)
	Set value to correspond to a textual representation.

std::string	toString () const override
	Return a standard text representation of the content of the object.

bool	isNull () const override
	Checks if the object is invalid.

virtual bool	check (const std::string &key) const=0
	Check if there exists a property of the given name.

virtual bool	check (const std::string &key, const std::string &comment) const
	Check if there exists a property of the given name.

virtual bool	check (const std::string &key, Value *&result, const std::string &comment="") const
	Gets a value corresponding to a given keyword.

virtual Value	check (const std::string &key, const Value &fallback, const std::string &comment="") const
	Gets a value corresponding to a given keyword.

virtual Bottle &	findGroup (const std::string &key) const=0
	Gets a list corresponding to a given keyword.

Bottle &	findGroup (const std::string &key, const std::string &comment) const
	Gets a list corresponding to a given keyword.

Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const

Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.

virtual Type	getReadType () const

Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.

virtual void	onCompletion () const
	This is called when the port has finished all writing operations.

virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.

virtual yarp::os::Type	getWriteType () const

Public Member Functions inherited from yarp::os::Searchable
	Searchable ()
	Default constructor.

	Searchable (const Searchable &rhs)=default
	Copy constructor.

	Searchable (Searchable &&rhs) noexcept=default
	Move constructor.

virtual	~Searchable ()
	Destructor.

Searchable &	operator= (const Searchable &rhs)=default
	Copy assignment operator.

Searchable &	operator= (Searchable &&rhs) noexcept=default
	Move assignment operator.

Bottle &	findGroup (const std::string &key, const std::string &comment) const
	Gets a list corresponding to a given keyword.

Static Public Attributes
static const std::int32_t	code = 256

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::impl::Storable
static Storable *	createByCode (std::int32_t id)

Static Public Member Functions inherited from yarp::os::Value
static Value *	makeInt8 (std::int8_t x)
	Create a 8-bit integer Value.

static Value *	makeInt16 (std::int16_t x)
	Create a 16-bit integer Value.

static Value *	makeInt32 (std::int32_t x)
	Create a 32-bit integer Value.

static Value *	makeInt64 (std::int64_t x)
	Create a 64-bit integer Value.

static Value *	makeFloat32 (yarp::conf::float32_t x)
	Create a 32-bit floating point Value.

static Value *	makeFloat64 (yarp::conf::float64_t x)
	Create a 64-bit floating point Value.

static Value *	makeString (const std::string &str)
	Create a string Value.

static Value *	makeVocab32 (yarp::conf::vocab32_t v)
	Create a vocabulary identifier Value.

static Value *	makeVocab32 (char a, char b=0, char c=0, char d=0)
	Create a vocabulary identifier Value.

static Value *	makeVocab32 (const std::string &str)
	Create a vocabulary identifier Value If the string is longer than 4 characters, only the first 4 are used.

static Value *	makeBlob (void *data, int length)
	Create a Value containing binary data.

static Value *	makeList ()
	Create a list Value.

static Value *	makeList (const char *txt)
	Create a list Value and initialize it.

static Value *	makeValue (const std::string &txt)
	Create a Value from a text description.

static Value &	getNullValue ()
	Return an invalid, "null" Value.

Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

A nested list of items.

Definition at line 1036 of file Storable.h.

Constructor & Destructor Documentation

◆ StoreList()

yarp::os::impl::StoreList::StoreList ( )

default

Member Function Documentation

◆ asList()

yarp::os::Bottle * yarp::os::impl::StoreList::asList ( ) const

inlineoverridevirtual

Get list value.

Returns: pointer to list if value is indeed a list. Otherwise returns nullptr

Reimplemented from yarp::os::impl::Storable.

Definition at line 1079 of file Storable.h.

◆ copy()

void yarp::os::impl::StoreList::copy ( const Storable & alt )

inlineoverridevirtual

Become a copy of the passed item.

Implements yarp::os::impl::Storable.

Definition at line 1050 of file Storable.h.

◆ createStorable()

Storable * yarp::os::impl::StoreList::createStorable ( ) const

inlineoverridevirtual

Factory method.

Implements yarp::os::impl::Storable.

Definition at line 1045 of file Storable.h.

◆ find()

yarp::os::Value & yarp::os::impl::StoreList::find ( const std::string & key ) const

inlineoverridevirtual

Gets a value corresponding to a given keyword.

Parameters

key	The keyword to look for

Returns: A value corresponding to a given keyword. If there is no such value, then the isNull() method called on the result will be true. Otherwise, the value can be read by calling result.asInt32(), result.asString(), etc. as appropriate.

Reimplemented from yarp::os::impl::Storable.

Definition at line 1086 of file Storable.h.

◆ findGroup()

yarp::os::Bottle & yarp::os::impl::StoreList::findGroup ( const std::string & key ) const

inlineoverridevirtual

Gets a list corresponding to a given keyword.

Parameters

key	The keyword to look for

Returns: A list corresponding to a given keyword. If there is no such list, then the isNull() method called on the result will be true. Otherwise, the elements of the list can be read through result.get(index) where result.get(0) is the keyword, and result.get(i) for i>=1 are the "real" elements of the list.

Reimplemented from yarp::os::impl::Storable.

Definition at line 1091 of file Storable.h.

◆ fromString()

void StoreList::fromString ( const std::string & src )

overridevirtual

Initialize from a string representation, assuming that any syntax around this representation such as braces or parentheses has already been consumed.

Implements yarp::os::impl::Storable.

Definition at line 583 of file Storable.cpp.

◆ fromStringNested()

void StoreList::fromStringNested ( const std::string & src )

overridevirtual

Initialize from a string representation.

This should consume any syntax around that representation such as braces or parentheses.

Reimplemented from yarp::os::impl::Storable.

Definition at line 588 of file Storable.cpp.

◆ getCode()

std::int32_t yarp::os::impl::StoreList::getCode ( ) const

inlineoverridevirtual

Get standard type code of value.

Returns: the standard type code of the value.

Reimplemented from yarp::os::Value.

Definition at line 1066 of file Storable.h.

◆ internal()

yarp::os::Bottle & yarp::os::impl::StoreList::internal ( )

inline

Definition at line 1055 of file Storable.h.

◆ isList()

bool yarp::os::impl::StoreList::isList ( ) const

inlineoverridevirtual

Checks if value is a list.

If so, asList() will return that list.

Returns: true iff value is a list

Reimplemented from yarp::os::impl::Storable.

Definition at line 1074 of file Storable.h.

◆ readRaw()

bool StoreList::readRaw ( ConnectionReader & reader )

overridevirtual

Implements yarp::os::impl::Storable.

Definition at line 599 of file Storable.cpp.

◆ subCode()

std::int32_t StoreList::subCode ( ) const

overridevirtual

Return a code describing this item, used in serializing bottles.

Reimplemented from yarp::os::impl::Storable.

Definition at line 613 of file Storable.cpp.

◆ toString()

std::string StoreList::toString ( ) const

overridevirtual

Return a standard text representation of the content of the object.

The representation is readable by the Bottle and Property classes.

Returns: A standard text representation of the content of the object.

Implements yarp::os::impl::Storable.

Definition at line 573 of file Storable.cpp.

◆ toStringNested()

std::string StoreList::toStringNested ( ) const

overridevirtual

Create string representation, including any syntax that should wrap it such as braces or parentheses.

Reimplemented from yarp::os::impl::Storable.

Definition at line 578 of file Storable.cpp.

◆ writeRaw()

bool StoreList::writeRaw ( ConnectionWriter & writer ) const

overridevirtual

Implements yarp::os::impl::Storable.

Definition at line 606 of file Storable.cpp.

Member Data Documentation

◆ code

const int StoreList::code = 256

static

Definition at line 1065 of file Storable.h.

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

src/libYARP_os/src/yarp/os/impl/Storable.h
src/libYARP_os/src/yarp/os/impl/Storable.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StoreList()

Member Function Documentation

◆ asList()

◆ copy()

◆ createStorable()

◆ find()

◆ findGroup()

◆ fromString()

◆ fromStringNested()

◆ getCode()

◆ internal()

◆ isList()

◆ readRaw()

◆ subCode()

◆ toString()

◆ toStringNested()

◆ writeRaw()

Member Data Documentation

◆ code