yarp::os::Searchable Class Reference

A base class for nested structures that can be searched. More...

#include <yarp/os/Searchable.h>

Inheritance diagram for yarp::os::Searchable:

Public Member Functions
	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.
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 Value &	find (const std::string &key) const =0
	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.
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 bool	isNull () const
	Checks if the object is invalid.
virtual std::string	toString () const =0
	Return a standard text representation of the content of the object.

Detailed Description

A base class for nested structures that can be searched.

A Searchable object promises that you can look inside it with the find() and findGroup() methods to get values and lists corresponding to keywords.

See also

Property Bottle Value

Examples

dev/fake_motor/fake_motor.cpp.

Definition at line 30 of file Searchable.h.

Constructor & Destructor Documentation

Searchable() [1/3]

yarp::os::Searchable::Searchable ( )

explicit

Default constructor.

Definition at line 14 of file Searchable.cpp.

Searchable() [2/3]

yarp::os::Searchable::Searchable ( const Searchable &  rhs )

default

Copy constructor.

Searchable() [3/3]

yarp::os::Searchable::Searchable ( Searchable &&  rhs )

defaultnoexcept

Move constructor.

~Searchable()

yarp::os::Searchable::~Searchable ( )

virtualdefault

Destructor.

Member Function Documentation

check() [1/4]

virtual bool yarp::os::Searchable::check ( const std::string &  key ) const

pure virtual

Check if there exists a property of the given name.

Parameters

key	the 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

Implemented in yarp::os::Bottle, yarp::os::impl::Storable, yarp::os::Property, yarp::os::ResourceFinder, yarp::os::Value, yarp::os::Bottle, yarp::os::Property, yarp::os::ResourceFinder, and yarp::os::Value.

check() [2/4]

bool yarp::os::Searchable::check ( const std::string &  key, const std::string &  comment  ) const

virtual

Check if there exists a property of the given name.

Parameters

key	the name to check for
comment	Human-readable explanation

Returns

true iff a property of the given name exists, even if it doesn't have a value associated with it

Reimplemented in yarp::os::Bottle, yarp::os::Property, yarp::os::ResourceFinder, and yarp::os::Value.

Definition at line 44 of file Searchable.cpp.

check() [3/4]

yarp::os::Value yarp::os::Searchable::check ( const std::string &  key, const Value &  fallback, const std::string &  comment = ""  ) const

virtual

Gets a value corresponding to a given keyword.

Parameters

key	The keyword to look for
fallback	A default value to return if nothing found
comment	Optional human-readable explanation

Returns

A value corresponding to a given keyword, or the default if nothing is found. See the find() method for interpreting the value found.

Reimplemented in yarp::os::Bottle, yarp::os::Property, yarp::os::ResourceFinder, and yarp::os::Value.

Definition at line 32 of file Searchable.cpp.

check() [4/4]

bool yarp::os::Searchable::check ( const std::string &  key, Value *&  result, const std::string &  comment = ""  ) const

virtual

Gets a value corresponding to a given keyword.

If a property does not exist, this returns false and does not modify the result pointer. If a property exists but does not have a value, this again returns false and does not modify the result pointer.

Property p;
p.fromString("(width 10) (height 15) (help)");
p.check("help")  // this is true
p.check("width") // this is true
p.check("foo")   // this is false
Value *v;
p.check("help", v)  // this is false, there is no value associated
p.check("width", v) // this is true, and v->asInt32() is 10

Parameters

key	The keyword to look for
result	A pointer to store the address of the result in
comment	Optional human-readable explanation

Returns

True if there is a value corresponding to a given keyword, false otherwise. See the find() method for interpreting the value found.

Reimplemented in yarp::os::Bottle, yarp::os::Property, yarp::os::ResourceFinder, and yarp::os::Value.

Definition at line 20 of file Searchable.cpp.

find()

virtual Value & yarp::os::Searchable::find ( const std::string &  key ) const

pure virtual

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.

Implemented in yarp::os::Bottle, yarp::os::impl::Storable, yarp::os::impl::StoreList, yarp::os::impl::StoreDict, yarp::os::Property, yarp::os::ResourceFinder, and yarp::os::Value.

findGroup() [1/2]

virtual Bottle & yarp::os::Searchable::findGroup ( const std::string &  key ) const

pure virtual

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.

Implemented in yarp::os::Bottle, yarp::os::impl::Storable, yarp::os::impl::StoreList, yarp::os::impl::StoreDict, yarp::os::Property, yarp::os::ResourceFinder, yarp::os::Value, yarp::os::Bottle, yarp::os::Property, yarp::os::ResourceFinder, and yarp::os::Value.

findGroup() [2/2]

yarp::os::Bottle & yarp::os::Searchable::findGroup	(	const std::string &	key,
		const std::string &	comment
	)		const

Gets a list corresponding to a given keyword.

Parameters

key	The keyword to look for
comment	Human-readable explanation

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.

Definition at line 50 of file Searchable.cpp.

isNull()

bool yarp::os::Searchable::isNull ( ) const

virtual

Checks if the object is invalid.

Returns

True if the object is invalid or "null".

Reimplemented in NullBottle, yarp::os::Bottle, yarp::os::impl::Storable, yarp::os::impl::StoreNull, yarp::os::ResourceFinder, and yarp::os::Value.

Definition at line 56 of file Searchable.cpp.

operator=() [1/2]

Searchable & yarp::os::Searchable::operator= ( const Searchable &  rhs )

default

Copy assignment operator.

operator=() [2/2]

Searchable & yarp::os::Searchable::operator= ( Searchable &&  rhs )

defaultnoexcept

Move assignment operator.

toString()

virtual std::string yarp::os::Searchable::toString ( ) const

pure 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.

Implemented in yarp::os::Bottle, 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, yarp::os::impl::StoreDict, yarp::os::Property, yarp::os::ResourceFinder, yarp::os::Value, and yarp::os::impl::Storable.

---

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

• src/libYARP_os/src/yarp/os/Searchable.h
• src/libYARP_os/src/yarp/os/Searchable.cpp