IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper Class Reference

Inheritance diagram for IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = return_getAllDevicesByType(*)(const std::string &)

Public Member Functions
	IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper ()=default
	IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper (const std::string &type)
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
void	call (IRobotDescriptionMsgs *ptr)
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
Command	cmd
Reply	reply

Static Public Attributes
static constexpr const char *	s_tag {"getAllDevicesByTypeRPC"}
static constexpr size_t	s_tag_len {1}
static constexpr size_t	s_cmd_len {2}
static constexpr size_t	s_reply_len {2}
static constexpr const char *	s_prototype {"return_getAllDevicesByType IRobotDescriptionMsgs::getAllDevicesByTypeRPC(const std::string& type)"}
static constexpr const char *	s_help {""}

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 167 of file IRobotDescriptionMsgs.cpp.

Member Typedef Documentation

funcptr_t

using IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::funcptr_t = return_getAllDevicesByType (*)(const std::string&)

Definition at line 215 of file IRobotDescriptionMsgs.cpp.

Constructor & Destructor Documentation

IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper() [1/2]

IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper ( )

default

IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper() [2/2]

IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper ( const std::string &  type )

explicit

Definition at line 547 of file IRobotDescriptionMsgs.cpp.

Member Function Documentation

call()

void IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::call

(

IRobotDescriptionMsgs *

ptr

)

Definition at line 695 of file IRobotDescriptionMsgs.cpp.

read()

bool IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::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 557 of file IRobotDescriptionMsgs.cpp.

write()

bool IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::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 552 of file IRobotDescriptionMsgs.cpp.

Member Data Documentation

cmd

Command IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::cmd

Definition at line 218 of file IRobotDescriptionMsgs.cpp.

reply

Reply IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::reply

Definition at line 219 of file IRobotDescriptionMsgs.cpp.

s_cmd_len

constexpr size_t IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::s_cmd_len {2}

staticconstexpr

Definition at line 223 of file IRobotDescriptionMsgs.cpp.

s_help

constexpr const char* IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::s_help {""}

staticconstexpr

Definition at line 226 of file IRobotDescriptionMsgs.cpp.

s_prototype

constexpr const char* IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::s_prototype {"return_getAllDevicesByType IRobotDescriptionMsgs::getAllDevicesByTypeRPC(const std::string& type)"}

staticconstexpr

Definition at line 225 of file IRobotDescriptionMsgs.cpp.

s_reply_len

constexpr size_t IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::s_reply_len {2}

staticconstexpr

Definition at line 224 of file IRobotDescriptionMsgs.cpp.

s_tag

constexpr const char* IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::s_tag {"getAllDevicesByTypeRPC"}

staticconstexpr

Definition at line 221 of file IRobotDescriptionMsgs.cpp.

s_tag_len

constexpr size_t IRobotDescriptionMsgs_getAllDevicesByTypeRPC_helper::s_tag_len {1}

staticconstexpr

Definition at line 222 of file IRobotDescriptionMsgs.cpp.

---

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

• src/devices/messages/IRobotDescriptionMsgs/idl_generated_code/IRobotDescriptionMsgs.cpp