YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::TerminatorMsgs_quit_helper Class Reference
+ Inheritance diagram for yarp::os::TerminatorMsgs_quit_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)()
 

Public Member Functions

 TerminatorMsgs_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 (TerminatorMsgs *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 {"bool TerminatorMsgs::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 112 of file TerminatorMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

Constructor & Destructor Documentation

◆ TerminatorMsgs_quit_helper()

yarp::os::TerminatorMsgs_quit_helper::TerminatorMsgs_quit_helper ( )
default

Member Function Documentation

◆ call()

void yarp::os::TerminatorMsgs_quit_helper::call ( TerminatorMsgs *  ptr)

Definition at line 300 of file TerminatorMsgs.cpp.

◆ read()

bool yarp::os::TerminatorMsgs_quit_helper::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 178 of file TerminatorMsgs.cpp.

◆ write()

bool yarp::os::TerminatorMsgs_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
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 173 of file TerminatorMsgs.cpp.

Member Data Documentation

◆ cmd

Command yarp::os::TerminatorMsgs_quit_helper::cmd

Definition at line 158 of file TerminatorMsgs.cpp.

◆ reply

Reply yarp::os::TerminatorMsgs_quit_helper::reply

Definition at line 159 of file TerminatorMsgs.cpp.

◆ s_cmd_len

constexpr size_t yarp::os::TerminatorMsgs_quit_helper::s_cmd_len {1}
staticconstexpr

Definition at line 163 of file TerminatorMsgs.cpp.

◆ s_help

constexpr const char* yarp::os::TerminatorMsgs_quit_helper::s_help
staticconstexpr
Initial value:
{
"Ask the process which owns the port to start a graceful quit procedure.\n"
"@return true if the request has been accepted"
}

Definition at line 166 of file TerminatorMsgs.cpp.

◆ s_prototype

constexpr const char* yarp::os::TerminatorMsgs_quit_helper::s_prototype {"bool TerminatorMsgs::quit()"}
staticconstexpr

Definition at line 165 of file TerminatorMsgs.cpp.

◆ s_reply_len

constexpr size_t yarp::os::TerminatorMsgs_quit_helper::s_reply_len {1}
staticconstexpr

Definition at line 164 of file TerminatorMsgs.cpp.

◆ s_tag

constexpr const char* yarp::os::TerminatorMsgs_quit_helper::s_tag {"quit"}
staticconstexpr

Definition at line 161 of file TerminatorMsgs.cpp.

◆ s_tag_len

constexpr size_t yarp::os::TerminatorMsgs_quit_helper::s_tag_len {1}
staticconstexpr

Definition at line 162 of file TerminatorMsgs.cpp.


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