A 32-bit integer item. More...

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

Inheritance diagram for yarp::os::impl::StoreInt32:

Public Member Functions
	StoreInt32 ()=default

	StoreInt32 (std::int32_t x)

Storable *	createStorable () const override
	Factory method.

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

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::int32_t	getCode () const override
	Get standard type code of value.

bool	readRaw (ConnectionReader &reader) override

bool	writeRaw (ConnectionWriter &writer) const override

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

bool	asBool () const override
	Get boolean value.

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.

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

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

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

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

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	isInt8 () const override
	Checks if value is a 8-bit integer.

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

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

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

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

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

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

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

yarp::os::Bottle *	asList () const override
	Get list 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.

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.

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.

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

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

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

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 = 1

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 32-bit integer item.

Definition at line 507 of file Storable.h.

Constructor & Destructor Documentation

◆ StoreInt32() [1/2]

yarp::os::impl::StoreInt32::StoreInt32 ( )

default

◆ StoreInt32() [2/2]

yarp::os::impl::StoreInt32::StoreInt32 ( std::int32_t x )

inline

Definition at line 516 of file Storable.h.

Member Function Documentation

◆ asBool()

bool yarp::os::impl::StoreInt32::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 548 of file Storable.h.

◆ asFloat32()

yarp::conf::float32_t yarp::os::impl::StoreInt32::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 573 of file Storable.h.

◆ asFloat64()

yarp::conf::float64_t yarp::os::impl::StoreInt32::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 578 of file Storable.h.

◆ asInt16()

std::int16_t yarp::os::impl::StoreInt32::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 553 of file Storable.h.

◆ asInt32()

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

◆ asInt64()

std::int64_t yarp::os::impl::StoreInt32::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 568 of file Storable.h.

◆ asInt8()

std::int8_t yarp::os::impl::StoreInt32::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 543 of file Storable.h.

◆ asVocab32()

yarp::conf::vocab32_t yarp::os::impl::StoreInt32::asVocab32 ( ) const

inlineoverridevirtual

Get vocabulary identifier as an integer.

Returns: integer value of vocabulary identifier.

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

Definition at line 583 of file Storable.h.

◆ copy()

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

inlineoverridevirtual

Become a copy of the passed item.

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

Definition at line 526 of file Storable.h.

◆ createStorable()

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

inlineoverridevirtual

Factory method.

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

Definition at line 521 of file Storable.h.

◆ fromString()

void StoreInt32::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 224 of file Storable.cpp.

◆ getCode()

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

◆ isInt32()

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

Definition at line 558 of file Storable.h.

◆ readRaw()

bool StoreInt32::readRaw ( ConnectionReader & reader )

overridevirtual

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

Definition at line 229 of file Storable.cpp.

◆ toString()

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

◆ writeRaw()

bool StoreInt32::writeRaw ( ConnectionWriter & writer ) const

overridevirtual

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

Definition at line 235 of file Storable.cpp.

Member Data Documentation

◆ code

const int StoreInt32::code = 1

static

Definition at line 534 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

◆ StoreInt32() [1/2]

◆ StoreInt32() [2/2]

Member Function Documentation

◆ asBool()

◆ asFloat32()

◆ asFloat64()

◆ asInt16()

◆ asInt32()

◆ asInt64()

◆ asInt8()

◆ asVocab32()

◆ copy()

◆ createStorable()

◆ fromString()

◆ getCode()

◆ isInt32()

◆ readRaw()

◆ toString()

◆ writeRaw()

Member Data Documentation

◆ code