YARP
Yet Another Robot Platform
yarp::os::impl::Storable Class Referenceabstract

A single item in a Bottle. More...

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

+ Inheritance diagram for yarp::os::impl::Storable:

Public Member Functions

virtual ~Storable ()
 Destructor. More...
 
virtual StorablecreateStorable () const =0
 Factory method. More...
 
virtual StorablecloneStorable () const
 Typed synonym for clone() More...
 
virtual void copy (const Storable &alt)=0
 Become a copy of the passed item. More...
 
bool operator== (const yarp::os::Value &alt) const
 
yarp::os::Valuecreate () const override
 Create a new value of the same type. More...
 
yarp::os::Valueclone () const override
 Create a copy of the value. More...
 
bool read (ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
virtual bool readRaw (ConnectionReader &connection)=0
 
virtual bool writeRaw (ConnectionWriter &connection) const =0
 
bool isBool () const override
 Checks if value is a boolean. More...
 
bool asBool () const override
 Get boolean value. More...
 
bool isInt8 () const override
 Checks if value is a 8-bit integer. More...
 
std::int8_t asInt8 () const override
 Get 8-bit integer value. More...
 
bool isInt16 () const override
 Checks if value is a 16-bit integer. More...
 
std::int16_t asInt16 () const override
 Get 16-bit integer value. More...
 
bool isInt32 () const override
 Checks if value is a 32-bit integer. More...
 
std::int32_t asInt32 () const override
 Get 32-bit integer value. More...
 
bool isInt64 () const override
 Checks if value is a 64-bit integer. More...
 
std::int64_t asInt64 () const override
 Get 64-bit integer value. More...
 
bool isFloat32 () const override
 Checks if value is a 32-bit floating point number. More...
 
yarp::conf::float32_t asFloat32 () const override
 Get 32-bit floating point value. More...
 
bool isFloat64 () const override
 Checks if value is a 64-bit floating point number. More...
 
yarp::conf::float64_t asFloat64 () const override
 Get 64-bit floating point value. More...
 
bool isString () const override
 Checks if value is a string. More...
 
std::string asString () const override
 Get string value. More...
 
bool isList () const override
 Checks if value is a list. More...
 
yarp::os::BottleasList () const override
 Get list value. More...
 
bool isDict () const override
 Checks if value is a dictionary. More...
 
yarp::os::PropertyasDict () const override
 Get dictionary (hash table) value. More...
 
bool isVocab32 () const override
 Checks if value is a vocabulary identifier. More...
 
yarp::conf::vocab32_t asVocab32 () const override
 Get vocabulary identifier as an integer. More...
 
bool isBlob () const override
 Checks if value is a binary object. More...
 
const char * asBlob () const override
 Get binary data value. More...
 
size_t asBlobLength () const override
 Get binary data length. More...
 
bool isNull () const override
 Checks if the object is invalid. More...
 
SearchableasSearchable () const override
 Get dictionary or list value. More...
 
bool check (const std::string &key) const override
 Check if there exists a property of the given name. More...
 
yarp::os::Valuefind (const std::string &key) const override
 Gets a value corresponding to a given keyword. More...
 
yarp::os::BottlefindGroup (const std::string &key) const override
 Gets a list corresponding to a given keyword. More...
 
virtual void fromString (const std::string &src)=0
 Initialize from a string representation, assuming that any syntax around this representation such as braces or parentheses has already been consumed. More...
 
virtual void fromStringNested (const std::string &src)
 Initialize from a string representation. More...
 
std::string toString () const override=0
 Return a standard text representation of the content of the object. More...
 
virtual std::string toStringNested () const
 Create string representation, including any syntax that should wrap it such as braces or parentheses. More...
 
virtual std::int32_t subCode () const
 Return a code describing this item, used in serializing bottles. More...
 
bool isLeaf () const override
 
- Public Member Functions inherited from yarp::os::Value
 Value ()
 Construct a list Value. More...
 
 Value (std::int32_t x, bool isVocab32=false)
 Construct an integer Value. More...
 
 Value (yarp::conf::float64_t x)
 Construct a floating point Value. More...
 
 Value (const std::string &str, bool isVocab32=false)
 Construct a string Value. More...
 
 Value (void *data, int length)
 Construct a binary data Value. More...
 
 Value (const Value &alt)
 Copy constructor. More...
 
const Valueoperator= (const Value &alt)
 Assignment operator. More...
 
 ~Value () override
 Destructor. More...
 
virtual bool isBool () const
 Checks if value is a boolean. More...
 
virtual bool isInt8 () const
 Checks if value is a 8-bit integer. More...
 
virtual bool isInt16 () const
 Checks if value is a 16-bit integer. More...
 
virtual bool isInt32 () const
 Checks if value is a 32-bit integer. More...
 
virtual bool isInt64 () const
 Checks if value is a 64-bit integer. More...
 
virtual bool isFloat32 () const
 Checks if value is a 32-bit floating point number. More...
 
virtual bool isFloat64 () const
 Checks if value is a 64-bit floating point number. More...
 
virtual bool isString () const
 Checks if value is a string. More...
 
virtual bool isList () const
 Checks if value is a list. More...
 
virtual bool isDict () const
 Checks if value is a dictionary. More...
 
virtual bool isVocab32 () const
 Checks if value is a vocabulary identifier. More...
 
virtual bool isBlob () const
 Checks if value is a binary object. More...
 
virtual bool asBool () const
 Get boolean value. More...
 
virtual std::int8_t asInt8 () const
 Get 8-bit integer value. More...
 
virtual std::int16_t asInt16 () const
 Get 16-bit integer value. More...
 
virtual std::int32_t asInt32 () const
 Get 32-bit integer value. More...
 
virtual std::int64_t asInt64 () const
 Get 64-bit integer value. More...
 
virtual yarp::conf::float32_t asFloat32 () const
 Get 32-bit floating point value. More...
 
virtual yarp::conf::float64_t asFloat64 () const
 Get 64-bit floating point value. More...
 
virtual yarp::conf::vocab32_t asVocab32 () const
 Get vocabulary identifier as an integer. More...
 
virtual std::string asString () const
 Get string value. More...
 
virtual BottleasList () const
 Get list value. More...
 
virtual PropertyasDict () const
 Get dictionary (hash table) value. More...
 
virtual SearchableasSearchable () const
 Get dictionary or list value. More...
 
virtual const char * asBlob () const
 Get binary data value. More...
 
virtual size_t asBlobLength () const
 Get binary data length. More...
 
bool read (ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
bool check (const std::string &key) const override
 Check if there exists a property of the given name. More...
 
Valuefind (const std::string &key) const override
 Gets a value corresponding to a given keyword. More...
 
BottlefindGroup (const std::string &key) const override
 Gets a list corresponding to a given keyword. More...
 
bool operator== (const Value &alt) const
 Equality test. More...
 
bool operator!= (const Value &alt) const
 Inequality test. More...
 
void fromString (const char *str)
 Set value to correspond to a textual representation. More...
 
std::string toString () const override
 Return a standard text representation of the content of the object. More...
 
virtual Valuecreate () const
 Create a new value of the same type. More...
 
virtual Valueclone () const
 Create a copy of the value. More...
 
virtual std::int32_t getCode () const
 Get standard type code of value. More...
 
bool isNull () const override
 Checks if the object is invalid. More...
 
virtual bool isLeaf () const
 
virtual bool check (const std::string &key) const=0
 Check if there exists a property of the given name. More...
 
virtual bool check (const std::string &key, const std::string &comment) const
 Check if there exists a property of the given name. More...
 
virtual bool check (const std::string &key, Value *&result, const std::string &comment="") const
 Gets a value corresponding to a given keyword. More...
 
virtual Value check (const std::string &key, const Value &fallback, const std::string &comment="") const
 Gets a value corresponding to a given keyword. More...
 
virtual BottlefindGroup (const std::string &key) const=0
 Gets a list corresponding to a given keyword. More...
 
BottlefindGroup (const std::string &key, const std::string &comment) const
 Gets a list corresponding to a given keyword. More...
 
- Public Member Functions inherited from yarp::os::Portable
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 
- Public Member Functions inherited from yarp::os::Searchable
 Searchable ()
 Default constructor. More...
 
 Searchable (const Searchable &rhs)=default
 Copy constructor. More...
 
 Searchable (Searchable &&rhs) noexcept=default
 Move constructor. More...
 
virtual ~Searchable ()
 Destructor. More...
 
Searchableoperator= (const Searchable &rhs)=default
 Copy assignment operator. More...
 
Searchableoperator= (Searchable &&rhs) noexcept=default
 Move assignment operator. More...
 
virtual bool check (const std::string &key) const =0
 Check if there exists a property of the given name. More...
 
virtual bool check (const std::string &key, const std::string &comment) const
 Check if there exists a property of the given name. More...
 
virtual Valuefind (const std::string &key) const =0
 Gets a value corresponding to a given keyword. More...
 
virtual BottlefindGroup (const std::string &key) const =0
 Gets a list corresponding to a given keyword. More...
 
BottlefindGroup (const std::string &key, const std::string &comment) const
 Gets a list corresponding to a given keyword. More...
 
virtual bool check (const std::string &key, Value *&result, const std::string &comment="") const
 Gets a value corresponding to a given keyword. More...
 
virtual Value check (const std::string &key, const Value &fallback, const std::string &comment="") const
 Gets a value corresponding to a given keyword. More...
 
virtual bool isNull () const
 Checks if the object is invalid. More...
 
virtual std::string toString () const =0
 Return a standard text representation of the content of the object. More...
 

Static Public Member Functions

static StorablecreateByCode (std::int32_t id)
 
- Static Public Member Functions inherited from yarp::os::Value
static ValuemakeInt8 (std::int8_t x)
 Create a 8-bit integer Value. More...
 
static ValuemakeInt16 (std::int16_t x)
 Create a 16-bit integer Value. More...
 
static ValuemakeInt32 (std::int32_t x)
 Create a 32-bit integer Value. More...
 
static ValuemakeInt64 (std::int64_t x)
 Create a 64-bit integer Value. More...
 
static ValuemakeFloat32 (yarp::conf::float32_t x)
 Create a 32-bit floating point Value. More...
 
static ValuemakeFloat64 (yarp::conf::float64_t x)
 Create a 64-bit floating point Value. More...
 
static ValuemakeString (const std::string &str)
 Create a string Value. More...
 
static ValuemakeVocab32 (yarp::conf::vocab32_t v)
 Create a vocabulary identifier Value. More...
 
static ValuemakeVocab32 (char a, char b=0, char c=0, char d=0)
 Create a vocabulary identifier Value. More...
 
static ValuemakeVocab32 (const std::string &str)
 Create a vocabulary identifier Value If the string is longer than 4 characters, only the first 4 are used. More...
 
static ValuemakeBlob (void *data, int length)
 Create a Value containing binary data. More...
 
static ValuemakeList ()
 Create a list Value. More...
 
static ValuemakeList (const char *txt)
 Create a list Value and initialize it. More...
 
static ValuemakeValue (const std::string &txt)
 Create a Value from a text description. More...
 
static ValuegetNullValue ()
 Return an invalid, "null" Value. More...
 
- 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. More...
 

Detailed Description

A single item in a Bottle.

This extends the public yarp::os::Value interface with some implementation-specific details.

Definition at line 41 of file Storable.h.

Constructor & Destructor Documentation

◆ ~Storable()

Storable::~Storable ( )
virtualdefault

Destructor.

Member Function Documentation

◆ asBlob()

const char * yarp::os::impl::Storable::asBlob ( ) const
inlineoverridevirtual

Get binary data value.

Returns
pointer to binary data if value is indeed binary data. Otherwise returns nullptr

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreBlob.

Definition at line 206 of file Storable.h.

◆ asBlobLength()

size_t yarp::os::impl::Storable::asBlobLength ( ) const
inlineoverridevirtual

Get binary data length.

Returns
length of binary data if value is indeed binary data. Otherwise returns 0

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreBlob.

Definition at line 211 of file Storable.h.

◆ asBool()

bool yarp::os::impl::Storable::asBool ( ) const
inlineoverridevirtual

Get boolean value.

Returns
boolean value if value is indeed a boolean. If it is another type, the appropriate cast value is returned. Otherwise returns false.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, and yarp::os::impl::StoreVocab32.

Definition at line 96 of file Storable.h.

◆ asDict()

yarp::os::Property * yarp::os::impl::Storable::asDict ( ) const
inlineoverridevirtual

Get dictionary (hash table) value.

Returns
pointer to dictionary if value is indeed of the right type. Otherwise returns nullptr

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreDict.

Definition at line 186 of file Storable.h.

◆ asFloat32()

yarp::conf::float32_t yarp::os::impl::Storable::asFloat32 ( ) const
inlineoverridevirtual

Get 32-bit floating point value.

Returns
floating point value if value is indeed a 32-bit floating point. If it is another numeric type, the appropriate cast value is returned. Otherwise returns 0.
Warning
This method performs casts if the Value is not a Float32 value, therefore it might lead to unexpected behaviours if the type is not properly checked.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, yarp::os::impl::StoreFloat64, and yarp::os::impl::StoreVocab32.

Definition at line 146 of file Storable.h.

◆ asFloat64()

yarp::conf::float64_t yarp::os::impl::Storable::asFloat64 ( ) const
inlineoverridevirtual

Get 64-bit floating point value.

Returns
floating point value if value is indeed a 64-bit floating point. If it is another numeric type, the appropriate cast value is returned. Otherwise returns 0.
Warning
This method performs casts if the Value is not a Float32 value, therefore it might lead to unexpected behaviours if the type is not properly checked.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, yarp::os::impl::StoreFloat64, and yarp::os::impl::StoreVocab32.

Definition at line 156 of file Storable.h.

◆ asInt16()

std::int16_t yarp::os::impl::Storable::asInt16 ( ) const
inlineoverridevirtual

Get 16-bit integer value.

Returns
16-bit integer value if value is indeed an integer. If it is another numeric type, the appropriate cast value is returned. Otherwise returns 0.
Warning
This method performs casts if the Value is not a Float32 value, therefore it might lead to unexpected behaviours if the type is not properly checked.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, and yarp::os::impl::StoreFloat64.

Definition at line 116 of file Storable.h.

◆ asInt32()

std::int32_t yarp::os::impl::Storable::asInt32 ( ) const
inlineoverridevirtual

Get 32-bit integer value.

Returns
32-bit integer value if value is indeed an integer. If it is another numeric type, the appropriate cast value is returned. Otherwise returns 0.
Warning
This method performs casts if the Value is not a Float32 value, therefore it might lead to unexpected behaviours if the type is not properly checked.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, yarp::os::impl::StoreFloat64, and yarp::os::impl::StoreVocab32.

Definition at line 126 of file Storable.h.

◆ asInt64()

std::int64_t yarp::os::impl::Storable::asInt64 ( ) const
inlineoverridevirtual

Get 64-bit integer value.

Returns
64-bit integer value if value is indeed an integer. If it is another numeric type, the appropriate cast value is returned. Otherwise returns 0.
Warning
This method performs casts if the Value is not a Float32 value, therefore it might lead to unexpected behaviours if the type is not properly checked.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, yarp::os::impl::StoreFloat64, and yarp::os::impl::StoreVocab32.

Definition at line 136 of file Storable.h.

◆ asInt8()

std::int8_t yarp::os::impl::Storable::asInt8 ( ) const
inlineoverridevirtual

Get 8-bit integer value.

Returns
8-bit integer value if value is indeed an integer. If it is another numeric type, the appropriate cast value is returned. Otherwise returns 0.
Warning
This method performs casts if the Value is not a Float32 value, therefore it might lead to unexpected behaviours if the type is not properly checked.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, and yarp::os::impl::StoreFloat64.

Definition at line 106 of file Storable.h.

◆ asList()

yarp::os::Bottle * yarp::os::impl::Storable::asList ( ) const
inlineoverridevirtual

Get list value.

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

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreList.

Definition at line 176 of file Storable.h.

◆ asSearchable()

Searchable * yarp::os::impl::Storable::asSearchable ( ) const
inlineoverridevirtual

Get dictionary or list value.

Returns
pointer to dictionary or list value if present. Otherwise returns nullptr

Reimplemented from yarp::os::Value.

Definition at line 222 of file Storable.h.

◆ asString()

std::string yarp::os::impl::Storable::asString ( ) const
inlineoverridevirtual

Get string value.

Returns
string value if value is indeed a string. Otherwise returns empty string.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreVocab32, and yarp::os::impl::StoreString.

Definition at line 166 of file Storable.h.

◆ asVocab32()

yarp::conf::vocab32_t yarp::os::impl::Storable::asVocab32 ( ) const
inlineoverridevirtual

Get vocabulary identifier as an integer.

Returns
integer value of vocabulary identifier.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreVocab32, and yarp::os::impl::StoreString.

Definition at line 196 of file Storable.h.

◆ check()

bool Storable::check ( const std::string &  key) const
overridevirtual

Check if there exists a property of the given name.

Parameters
keythe name to check for
Returns
true iff a property of the given name exists, even if it doesn't have a value associated with it

Implements yarp::os::Searchable.

Definition at line 132 of file Storable.cpp.

◆ clone()

yarp::os::Value * yarp::os::impl::Storable::clone ( ) const
inlineoverridevirtual

Create a copy of the value.

Returns
the new value, which will equal this.

Reimplemented from yarp::os::Value.

Definition at line 77 of file Storable.h.

◆ cloneStorable()

virtual Storable * yarp::os::impl::Storable::cloneStorable ( ) const
inlinevirtual

Typed synonym for clone()

Definition at line 57 of file Storable.h.

◆ copy()

◆ create()

yarp::os::Value * yarp::os::impl::Storable::create ( ) const
inlineoverridevirtual

Create a new value of the same type.

Returns
the new value.

Reimplemented from yarp::os::Value.

Definition at line 72 of file Storable.h.

◆ createByCode()

Storable * Storable::createByCode ( std::int32_t  id)
static

Definition at line 64 of file Storable.cpp.

◆ createStorable()

◆ find()

Value & Storable::find ( const std::string &  key) const
overridevirtual

Gets a value corresponding to a given keyword.

Parameters
keyThe 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.

Implements yarp::os::Searchable.

Reimplemented in yarp::os::impl::StoreList, and yarp::os::impl::StoreDict.

Definition at line 120 of file Storable.cpp.

◆ findGroup()

Bottle & Storable::findGroup ( const std::string &  key) const
overridevirtual

Gets a list corresponding to a given keyword.

Parameters
keyThe 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.

Implements yarp::os::Searchable.

Reimplemented in yarp::os::impl::StoreList, and yarp::os::impl::StoreDict.

Definition at line 126 of file Storable.cpp.

◆ fromString()

virtual void yarp::os::impl::Storable::fromString ( const std::string &  src)
pure virtual

◆ fromStringNested()

virtual void yarp::os::impl::Storable::fromStringNested ( const std::string &  src)
inlinevirtual

Initialize from a string representation.

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

Reimplemented in yarp::os::impl::StoreVocab32, yarp::os::impl::StoreString, yarp::os::impl::StoreBlob, yarp::os::impl::StoreList, and yarp::os::impl::StoreDict.

Definition at line 248 of file Storable.h.

◆ isBlob()

bool yarp::os::impl::Storable::isBlob ( ) const
inlineoverridevirtual

Checks if value is a binary object.

If so, asBlob() and asBlobLength() will return it.

Returns
true iff value is a binary object.

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreBlob.

Definition at line 201 of file Storable.h.

◆ isBool()

bool yarp::os::impl::Storable::isBool ( ) const
inlineoverridevirtual

Checks if value is a boolean.

If so, asBool() will return that boolean.

Returns
true iff value is a boolean

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreVocab32.

Definition at line 91 of file Storable.h.

◆ isDict()

bool yarp::os::impl::Storable::isDict ( ) const
inlineoverridevirtual

Checks if value is a dictionary.

If so, asDict() will return that dictionary.

Returns
true iff value is a dictionary

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreDict.

Definition at line 181 of file Storable.h.

◆ isFloat32()

bool yarp::os::impl::Storable::isFloat32 ( ) const
inlineoverridevirtual

Checks if value is a 32-bit floating point number.

If so, asFloat32() will return that number.

Returns
true iff value is a 32-bit floating point number

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreFloat32.

Definition at line 141 of file Storable.h.

◆ isFloat64()

bool yarp::os::impl::Storable::isFloat64 ( ) const
inlineoverridevirtual

Checks if value is a 64-bit floating point number.

If so, asFloat64() will return that number.

Returns
true iff value is a 64-bit floating point number

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreFloat64.

Definition at line 151 of file Storable.h.

◆ isInt16()

bool yarp::os::impl::Storable::isInt16 ( ) const
inlineoverridevirtual

Checks if value is a 16-bit integer.

If so, asInt16() will return that integer.

Returns
true iff value is a 16-bit integer

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt16.

Definition at line 111 of file Storable.h.

◆ isInt32()

bool yarp::os::impl::Storable::isInt32 ( ) const
inlineoverridevirtual

Checks if value is a 32-bit integer.

If so, asInt32() will return that integer.

Returns
true iff value is a 32-bit integer

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt32.

Definition at line 121 of file Storable.h.

◆ isInt64()

bool yarp::os::impl::Storable::isInt64 ( ) const
inlineoverridevirtual

Checks if value is a 64-bit integer.

If so, asInt64() will return that integer.

Returns
true iff value is a 64-bit integer

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt64.

Definition at line 131 of file Storable.h.

◆ isInt8()

bool yarp::os::impl::Storable::isInt8 ( ) const
inlineoverridevirtual

Checks if value is a 8-bit integer.

If so, asInt8() will return that integer.

Returns
true iff value is a 8-bit integer

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreInt8.

Definition at line 101 of file Storable.h.

◆ isLeaf()

bool yarp::os::impl::Storable::isLeaf ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Value.

Definition at line 272 of file Storable.h.

◆ isList()

bool yarp::os::impl::Storable::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::Value.

Reimplemented in yarp::os::impl::StoreList.

Definition at line 171 of file Storable.h.

◆ isNull()

bool yarp::os::impl::Storable::isNull ( ) const
inlineoverridevirtual

Checks if the object is invalid.

Returns
True if the object is invalid or "null".

Reimplemented from yarp::os::Searchable.

Reimplemented in yarp::os::impl::StoreNull.

Definition at line 216 of file Storable.h.

◆ isString()

bool yarp::os::impl::Storable::isString ( ) const
inlineoverridevirtual

Checks if value is a string.

If so, asString() will return that string.

Returns
true iff value is a string

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreString.

Definition at line 161 of file Storable.h.

◆ isVocab32()

bool yarp::os::impl::Storable::isVocab32 ( ) const
inlineoverridevirtual

Checks if value is a vocabulary identifier.

If so, asVocab32() will return it.

Returns
true iff value is a vocabulary identifier

Reimplemented from yarp::os::Value.

Reimplemented in yarp::os::impl::StoreVocab32.

Definition at line 191 of file Storable.h.

◆ operator==()

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

Definition at line 142 of file Storable.cpp.

◆ read()

bool Storable::read ( ConnectionReader reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 148 of file Storable.cpp.

◆ readRaw()

◆ subCode()

virtual std::int32_t yarp::os::impl::Storable::subCode ( ) const
inlinevirtual

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

Reimplemented in yarp::os::impl::StoreList.

Definition at line 267 of file Storable.h.

◆ toString()

std::string yarp::os::impl::Storable::toString ( ) const
overridepure virtual

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::Searchable.

Implemented in yarp::os::impl::StoreNull, yarp::os::impl::StoreInt8, yarp::os::impl::StoreInt16, yarp::os::impl::StoreInt32, yarp::os::impl::StoreInt64, yarp::os::impl::StoreFloat32, yarp::os::impl::StoreFloat64, yarp::os::impl::StoreVocab32, yarp::os::impl::StoreString, yarp::os::impl::StoreBlob, yarp::os::impl::StoreList, and yarp::os::impl::StoreDict.

◆ toStringNested()

virtual std::string yarp::os::impl::Storable::toStringNested ( ) const
inlinevirtual

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

Reimplemented in yarp::os::impl::StoreVocab32, yarp::os::impl::StoreString, yarp::os::impl::StoreBlob, yarp::os::impl::StoreList, and yarp::os::impl::StoreDict.

Definition at line 259 of file Storable.h.

◆ write()

bool Storable::write ( ConnectionWriter writer) const
overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 157 of file Storable.cpp.

◆ writeRaw()


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