IMap2DMsgs_get_area_RPC_helper Class Reference

Inheritance diagram for IMap2DMsgs_get_area_RPC_helper:

Classes
class	Command
class	Reply

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

Public Member Functions
	IMap2DMsgs_get_area_RPC_helper ()=default
	IMap2DMsgs_get_area_RPC_helper (const std::string &area_name)
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 (IMap2DMsgs *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 {"get_area_RPC"}
static constexpr size_t	s_tag_len {3}
static constexpr size_t	s_cmd_len {4}
static constexpr size_t	s_reply_len {2}
static constexpr const char *	s_prototype {"return_get_area IMap2DMsgs::get_area_RPC(const std::string& area_name)"}
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 578 of file IMap2DMsgs.cpp.

Member Typedef Documentation

funcptr_t

using IMap2DMsgs_get_area_RPC_helper::funcptr_t = return_get_area (*)(const std::string&)

Definition at line 626 of file IMap2DMsgs.cpp.

Constructor & Destructor Documentation

IMap2DMsgs_get_area_RPC_helper() [1/2]

IMap2DMsgs_get_area_RPC_helper::IMap2DMsgs_get_area_RPC_helper ( )

default

IMap2DMsgs_get_area_RPC_helper() [2/2]

IMap2DMsgs_get_area_RPC_helper::IMap2DMsgs_get_area_RPC_helper ( const std::string &  area_name )

explicit

Definition at line 3550 of file IMap2DMsgs.cpp.

Member Function Documentation

call()

void IMap2DMsgs_get_area_RPC_helper::call

(

IMap2DMsgs *

ptr

)

Definition at line 3698 of file IMap2DMsgs.cpp.

read()

bool IMap2DMsgs_get_area_RPC_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 3560 of file IMap2DMsgs.cpp.

write()

bool IMap2DMsgs_get_area_RPC_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 3555 of file IMap2DMsgs.cpp.

Member Data Documentation

cmd

Command IMap2DMsgs_get_area_RPC_helper::cmd

Definition at line 629 of file IMap2DMsgs.cpp.

reply

Reply IMap2DMsgs_get_area_RPC_helper::reply

Definition at line 630 of file IMap2DMsgs.cpp.

s_cmd_len

constexpr size_t IMap2DMsgs_get_area_RPC_helper::s_cmd_len {4}

staticconstexpr

Definition at line 634 of file IMap2DMsgs.cpp.

s_help

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

staticconstexpr

Definition at line 637 of file IMap2DMsgs.cpp.

s_prototype

constexpr const char* IMap2DMsgs_get_area_RPC_helper::s_prototype {"return_get_area IMap2DMsgs::get_area_RPC(const std::string& area_name)"}

staticconstexpr

Definition at line 636 of file IMap2DMsgs.cpp.

s_reply_len

constexpr size_t IMap2DMsgs_get_area_RPC_helper::s_reply_len {2}

staticconstexpr

Definition at line 635 of file IMap2DMsgs.cpp.

s_tag

constexpr const char* IMap2DMsgs_get_area_RPC_helper::s_tag {"get_area_RPC"}

staticconstexpr

Definition at line 632 of file IMap2DMsgs.cpp.

s_tag_len

constexpr size_t IMap2DMsgs_get_area_RPC_helper::s_tag_len {3}

staticconstexpr

Definition at line 633 of file IMap2DMsgs.cpp.

---

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

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