YARP
Yet Another Robot Platform
yarp::os::impl::StoreInt64 Class Reference

A 64-bit integer item. More...

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

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

Public Member Functions

 StoreInt64 ()=default
 
 StoreInt64 (std::int64_t x)
 
StorablecreateStorable () const override
 Factory method. More...
 
void copy (const Storable &alt) override
 Become a copy of the passed item. More...
 
std::string toString () const override
 Return a standard text representation of the content of the object. More...
 
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. More...
 
std::int32_t getCode () const override
 Get standard type code of value. More...
 
bool readRaw (ConnectionReader &reader) override
 
bool writeRaw (ConnectionWriter &writer) const override
 
bool isInt64 () const override
 Checks if value is a 64-bit integer. More...
 
bool asBool () const override
 Get boolean value. More...
 
std::int8_t asInt8 () const override
 Get 8-bit integer value. More...
 
std::int16_t asInt16 () const override
 Get 16-bit integer value. More...
 
std::int32_t asInt32 () const override
 Get 32-bit integer value. More...
 
std::int64_t asInt64 () const override
 Get 64-bit integer value. More...
 
yarp::conf::float32_t asFloat32 () const override
 Get 32-bit floating point value. More...
 
yarp::conf::float64_t asFloat64 () const override
 Get 64-bit floating point value. More...
 
yarp::conf::vocab32_t asVocab32 () const override
 Get vocabulary identifier as an integer. More...
 
- Public Member Functions inherited from yarp::os::impl::Storable
virtual ~Storable ()
 Destructor. More...
 
virtual StorablecloneStorable () const
 Typed synonym for clone() 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...
 
bool isBool () const override
 Checks if value is a boolean. More...
 
bool isInt8 () const override
 Checks if value is a 8-bit integer. More...
 
bool isInt16 () const override
 Checks if value is a 16-bit integer. More...
 
bool isInt32 () const override
 Checks if value is a 32-bit integer. More...
 
bool isFloat32 () const override
 Checks if value is a 32-bit floating point number. More...
 
bool isFloat64 () const override
 Checks if value is a 64-bit floating point number. 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...
 
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 fromStringNested (const std::string &src)
 Initialize from a string representation. 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 isInt () const final
 Checks if value is an integer. More...
 
virtual bool isDouble () const final
 Checks if value is a floating point number. More...
 
virtual bool isVocab () const
 Checks if value is a vocabulary identifier. More...
 
virtual int asInt () const final
 Get integer value. More...
 
virtual double asDouble () const final
 Get floating point value. More...
 
virtual yarp::conf::vocab32_t asVocab () const
 Get vocabulary identifier as an integer. 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...
 
bool isNull () const override
 Checks if the object is invalid. 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 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
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. 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 std::string &comment) const
 Check if there exists a property of the given name. 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...
 

Static Public Attributes

static const std::int32_t code = (1 + 16)
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::impl::Storable
static StorablecreateByCode (std::int32_t id)
 
- Static Public Member Functions inherited from yarp::os::Value
static ValuemakeInt (int x)
 Create an integer Value. More...
 
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 ValuemakeDouble (double x)
 Create a floating point 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 ValuemakeVocab (yarp::conf::vocab32_t v)
 Create a vocabulary identifier Value. More...
 
static ValuemakeVocab (const std::string &str)
 Create a vocabulary identifier Value. 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 64-bit integer item.

Definition at line 594 of file Storable.h.

Constructor & Destructor Documentation

◆ StoreInt64() [1/2]

yarp::os::impl::StoreInt64::StoreInt64 ( )
default

◆ StoreInt64() [2/2]

yarp::os::impl::StoreInt64::StoreInt64 ( std::int64_t  x)
inline

Definition at line 603 of file Storable.h.

Member Function Documentation

◆ asBool()

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

Definition at line 635 of file Storable.h.

◆ asFloat32()

yarp::conf::float32_t yarp::os::impl::StoreInt64::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::impl::Storable.

Definition at line 660 of file Storable.h.

◆ asFloat64()

yarp::conf::float64_t yarp::os::impl::StoreInt64::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::impl::Storable.

Definition at line 665 of file Storable.h.

◆ asInt16()

std::int16_t yarp::os::impl::StoreInt64::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::impl::Storable.

Definition at line 645 of file Storable.h.

◆ asInt32()

std::int32_t yarp::os::impl::StoreInt64::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::impl::Storable.

Definition at line 650 of file Storable.h.

◆ asInt64()

std::int64_t yarp::os::impl::StoreInt64::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::impl::Storable.

Definition at line 655 of file Storable.h.

◆ asInt8()

std::int8_t yarp::os::impl::StoreInt64::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::impl::Storable.

Definition at line 640 of file Storable.h.

◆ asVocab32()

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

Get vocabulary identifier as an integer.

Returns
integer value of vocabulary identifier.

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

Definition at line 670 of file Storable.h.

◆ copy()

void yarp::os::impl::StoreInt64::copy ( const Storable alt)
inlineoverridevirtual

Become a copy of the passed item.

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

Definition at line 613 of file Storable.h.

◆ createStorable()

Storable* yarp::os::impl::StoreInt64::createStorable ( ) const
inlineoverridevirtual

Factory method.

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

Definition at line 608 of file Storable.h.

◆ fromString()

void StoreInt64::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 250 of file Storable.cpp.

◆ getCode()

std::int32_t yarp::os::impl::StoreInt64::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 622 of file Storable.h.

◆ isInt64()

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

Definition at line 630 of file Storable.h.

◆ readRaw()

bool StoreInt64::readRaw ( ConnectionReader reader)
overridevirtual

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

Definition at line 255 of file Storable.cpp.

◆ toString()

std::string StoreInt64::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 245 of file Storable.cpp.

◆ writeRaw()

bool StoreInt64::writeRaw ( ConnectionWriter writer) const
overridevirtual

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

Definition at line 261 of file Storable.cpp.

Member Data Documentation

◆ code

const int StoreInt64::code = (1 + 16)
static

Definition at line 621 of file Storable.h.


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