NullBottle Class Reference

Inheritance diagram for NullBottle:

Public Member Functions
	NullBottle ()
bool	isNull () const override
	Checks if the object is invalid.
Public Member Functions inherited from yarp::os::Bottle
	Bottle ()
	Constructor.
	Bottle (const std::string &text)
	Creates a bottle from a string.
	Bottle (const Bottle &rhs)
	Copy constructor.
	Bottle (Bottle &&rhs) noexcept
	Move constructor.
	Bottle (std::initializer_list< yarp::os::Value > values)
	Initializer list constructor.
Bottle &	operator= (const Bottle &rhs)
	Copy assignment operator.
Bottle &	operator= (Bottle &&rhs) noexcept
	Move assignment operator.
	~Bottle () override
	Destructor.
void	clear ()
	Empties the bottle of any objects it contains.
void	addInt8 (std::int8_t x)
	Places a 8-bit integer in the bottle, at the end of the list.
void	addInt16 (std::int16_t x)
	Places a 16-bit integer in the bottle, at the end of the list.
void	addInt32 (std::int32_t x)
	Places a 32-bit integer in the bottle, at the end of the list.
void	addInt64 (std::int64_t x)
	Places a 64-bit integer in the bottle, at the end of the list.
void	addVocab32 (yarp::conf::vocab32_t x)
	Places a vocabulary item in the bottle, at the end of the list.
void	addVocab32 (char a, char b=0, char c=0, char d=0)
	Places a vocabulary item in the bottle, at the end of the list.
void	addVocab32 (const std::string &str)
	Places a vocabulary item in the bottle, at the end of the list.
void	addFloat32 (yarp::conf::float32_t x)
	Places a 32-bit floating point number in the bottle, at the end of the list.
void	addFloat64 (yarp::conf::float64_t x)
	Places a 64-bit floating point number in the bottle, at the end of the list.
void	addString (const char *str)
	Places a string in the bottle, at the end of the list.
void	addString (const std::string &str)
	Places a string in the bottle, at the end of the list.
void	add (const Value &value)
	Add a Value to the bottle, at the end of the list.
void	add (Value *value)
	Add a Value to the bottle, at the end of the list.
Bottle &	addList ()
	Places an empty nested list in the bottle, at the end of the list.
Property &	addDict ()
	Places an empty key/value object in the bottle, at the end of the list.
Value	pop ()
	Removes a Value v from the end of the list and returns this value.
Value &	get (size_type index) const
	Reads a Value v from a certain part of the list.
size_type	size () const
	Gets the number of elements in the bottle.
void	fromString (const std::string &text)
	Initializes bottle from a string.
void	fromBinary (const char *buf, size_t len)
	Initializes bottle from a binary representation.
const char *	toBinary (size_t *size=nullptr)
	Returns binary representation of bottle.
std::string	toString () const override
	Gives a human-readable textual representation of the bottle.
bool	write (ConnectionWriter &writer) const override
	Output a representation of the bottle to a network connection.
bool	read (ConnectionReader &reader) override
	Set the bottle's value based on input from a network connection.
bool	write (PortReader &reader, bool textMode=false)
	Copy the bottle's value to a object that can read a serialization.
bool	read (const PortWriter &writer, bool textMode=false)
	Set the bottle's value based on input from a serializable object.
void	onCommencement () const override
	This is called when the port is about to begin writing operations.
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.
void	copy (const Bottle &alt, size_type first=0, size_type len=npos)
	Copy all or part of another Bottle.
bool	operator== (const Bottle &alt) const
	Equality test.
bool	operator!= (const Bottle &alt) const
	Inequality test.
void	append (const Bottle &alt)
	Append the content of the given bottle to the current list.
Bottle	tail () const
	Get all but the first element of a bottle.
void	hasChanged ()
	Declare that the content of the Bottle has been changed.
int	getSpecialization ()
	Get numeric bottle code for this bottle.
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 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.

Additional Inherited Members
Public Types inherited from yarp::os::Bottle
using	size_type = size_t
Static Public Member Functions inherited from yarp::os::Bottle
static Bottle &	getNullBottle ()
	A special Bottle with no content.
static std::string	toString (int x)
static std::string	describeBottleCode (int code)
	Convert a numeric bottle code to a string.
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.
Static Public Attributes inherited from yarp::os::Bottle
static const size_type	npos = static_cast<Bottle::size_type>(-1)
Protected Member Functions inherited from yarp::os::Bottle
void	setReadOnly (bool readOnly)

Detailed Description

Definition at line 30 of file Bottle.cpp.

Constructor & Destructor Documentation

NullBottle()

NullBottle::NullBottle ( )

inline

Definition at line 33 of file Bottle.cpp.

Member Function Documentation

isNull()

bool NullBottle::isNull ( ) const

inlineoverridevirtual

Checks if the object is invalid.

Returns

True if the object is invalid or "null".

Reimplemented from yarp::os::Bottle.

Definition at line 38 of file Bottle.cpp.

---

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

• src/libYARP_os/src/yarp/os/Bottle.cpp