yarp::dev::DeviceDescriptionData Class Reference

#include <yarp/dev/DeviceDescriptionData.h>

Inheritance diagram for yarp::dev::DeviceDescriptionData:

Public Types
typedef yarp::os::idl::Unwrapped< DeviceDescriptionData >	unwrapped

Public Member Functions
	DeviceDescriptionData ()=default
	DeviceDescriptionData (const std::string &device_name, const std::string &device_type, const std::string &device_configuration, const std::string &device_extra_info)
bool	read (yarp::os::idl::WireReader &reader) override
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
bool	write (const yarp::os::idl::WireWriter &writer) const override
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
std::string	toString () const
Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool	readBare (yarp::os::ConnectionReader &reader)
virtual bool	writeBare (yarp::os::ConnectionWriter &writer) const
virtual bool	readBottle (yarp::os::ConnectionReader &reader)
virtual bool	writeBottle (yarp::os::ConnectionWriter &writer) const
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 Attributes
std::string	device_name {}
	name of the device
std::string	device_type {}
	type of the device
std::string	device_configuration {}
	configuration parameters of the device
std::string	device_extra_info {}
	user defined extra information

Additional Inherited Members
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

Definition at line 21 of file DeviceDescriptionData.h.

Member Typedef Documentation

unwrapped

typedef yarp::os::idl::Unwrapped<DeviceDescriptionData> yarp::dev::DeviceDescriptionData::unwrapped

Definition at line 68 of file DeviceDescriptionData.h.

Constructor & Destructor Documentation

DeviceDescriptionData() [1/2]

yarp::dev::DeviceDescriptionData::DeviceDescriptionData ( )

default

DeviceDescriptionData() [2/2]

yarp::dev::DeviceDescriptionData::DeviceDescriptionData	(	const std::string &	device_name,
		const std::string &	device_type,
		const std::string &	device_configuration,
		const std::string &	device_extra_info
	)

Definition at line 16 of file DeviceDescriptionData.cpp.

Member Function Documentation

read() [1/2]

bool yarp::dev::DeviceDescriptionData::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 50 of file DeviceDescriptionData.cpp.

read() [2/2]

bool yarp::dev::DeviceDescriptionData::read ( yarp::os::idl::WireReader &  reader )

overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 29 of file DeviceDescriptionData.cpp.

toString()

std::string yarp::dev::DeviceDescriptionData::toString

(

)

const

Definition at line 97 of file DeviceDescriptionData.cpp.

write() [1/2]

bool yarp::dev::DeviceDescriptionData::write ( const yarp::os::idl::WireWriter &  writer ) const

overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 63 of file DeviceDescriptionData.cpp.

write() [2/2]

bool yarp::dev::DeviceDescriptionData::write ( yarp::os::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

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 84 of file DeviceDescriptionData.cpp.

Member Data Documentation

device_configuration

std::string yarp::dev::DeviceDescriptionData::device_configuration {}

configuration parameters of the device

Definition at line 37 of file DeviceDescriptionData.h.

device_extra_info

std::string yarp::dev::DeviceDescriptionData::device_extra_info {}

user defined extra information

Definition at line 41 of file DeviceDescriptionData.h.

device_name

std::string yarp::dev::DeviceDescriptionData::device_name {}

name of the device

Definition at line 29 of file DeviceDescriptionData.h.

device_type

std::string yarp::dev::DeviceDescriptionData::device_type {}

type of the device

Definition at line 33 of file DeviceDescriptionData.h.

---

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

• src/libYARP_dev/src/idl_generated_code/yarp/dev/DeviceDescriptionData.h
• src/libYARP_dev/src/idl_generated_code/yarp/dev/DeviceDescriptionData.cpp