yarprobotinterfaceRpc_quit_helper Class Reference

Inheritance diagram for yarprobotinterfaceRpc_quit_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = std::string(*)()

Public Member Functions
	yarprobotinterfaceRpc_quit_helper ()=default
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 (yarprobotinterfaceRpc *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 {"quit"}
static constexpr size_t	s_tag_len {1}
static constexpr size_t	s_cmd_len {1}
static constexpr size_t	s_reply_len {1}
static constexpr const char *	s_prototype {"std::string yarprobotinterfaceRpc::quit()"}
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 350 of file yarprobotinterfaceRpc.cpp.

Member Typedef Documentation

funcptr_t

using yarprobotinterfaceRpc_quit_helper::funcptr_t = std::string (*)()

Definition at line 393 of file yarprobotinterfaceRpc.cpp.

Constructor & Destructor Documentation

yarprobotinterfaceRpc_quit_helper()

yarprobotinterfaceRpc_quit_helper::yarprobotinterfaceRpc_quit_helper ( )

default

Member Function Documentation

call()

void yarprobotinterfaceRpc_quit_helper::call

(

yarprobotinterfaceRpc *

ptr

)

Definition at line 1189 of file yarprobotinterfaceRpc.cpp.

read()

bool yarprobotinterfaceRpc_quit_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 1067 of file yarprobotinterfaceRpc.cpp.

write()

bool yarprobotinterfaceRpc_quit_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 1062 of file yarprobotinterfaceRpc.cpp.

Member Data Documentation

cmd

Command yarprobotinterfaceRpc_quit_helper::cmd

Definition at line 396 of file yarprobotinterfaceRpc.cpp.

reply

Reply yarprobotinterfaceRpc_quit_helper::reply

Definition at line 397 of file yarprobotinterfaceRpc.cpp.

s_cmd_len

constexpr size_t yarprobotinterfaceRpc_quit_helper::s_cmd_len {1}

staticconstexpr

Definition at line 401 of file yarprobotinterfaceRpc.cpp.

s_help

constexpr const char* yarprobotinterfaceRpc_quit_helper::s_help

staticconstexpr

Initial value:

{
        "Closes yarprobotinterface."
    }

Definition at line 404 of file yarprobotinterfaceRpc.cpp.

s_prototype

constexpr const char* yarprobotinterfaceRpc_quit_helper::s_prototype {"std::string yarprobotinterfaceRpc::quit()"}

staticconstexpr

Definition at line 403 of file yarprobotinterfaceRpc.cpp.

s_reply_len

constexpr size_t yarprobotinterfaceRpc_quit_helper::s_reply_len {1}

staticconstexpr

Definition at line 402 of file yarprobotinterfaceRpc.cpp.

s_tag

constexpr const char* yarprobotinterfaceRpc_quit_helper::s_tag {"quit"}

staticconstexpr

Definition at line 399 of file yarprobotinterfaceRpc.cpp.

s_tag_len

constexpr size_t yarprobotinterfaceRpc_quit_helper::s_tag_len {1}

staticconstexpr

Definition at line 400 of file yarprobotinterfaceRpc.cpp.

---

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

• src/commands/yarprobotinterface/idl_generated_code/yarprobotinterfaceRpc.cpp