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

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)(const std::string &, const std::string &)
 

Public Member Functions

 IMap2DMsgs_save_map_to_disk_RPC_helper ()=default
 
 IMap2DMsgs_save_map_to_disk_RPC_helper (const std::string &map_name, const std::string &file_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 {"save_map_to_disk_RPC"}
 
static constexpr size_t s_tag_len {5}
 
static constexpr size_t s_cmd_len {7}
 
static constexpr size_t s_reply_len {1}
 
static constexpr const char * s_prototype {"bool IMap2DMsgs::save_map_to_disk_RPC(const std::string& map_name, const std::string& file_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 1980 of file IMap2DMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

using IMap2DMsgs_save_map_to_disk_RPC_helper::funcptr_t = bool (*)(const std::string&, const std::string&)

Definition at line 2029 of file IMap2DMsgs.cpp.

Constructor & Destructor Documentation

◆ IMap2DMsgs_save_map_to_disk_RPC_helper() [1/2]

IMap2DMsgs_save_map_to_disk_RPC_helper::IMap2DMsgs_save_map_to_disk_RPC_helper ( )
default

◆ IMap2DMsgs_save_map_to_disk_RPC_helper() [2/2]

IMap2DMsgs_save_map_to_disk_RPC_helper::IMap2DMsgs_save_map_to_disk_RPC_helper ( const std::string &  map_name,
const std::string &  file_name 
)

Definition at line 6918 of file IMap2DMsgs.cpp.

Member Function Documentation

◆ call()

void IMap2DMsgs_save_map_to_disk_RPC_helper::call ( IMap2DMsgs ptr)

Definition at line 7078 of file IMap2DMsgs.cpp.

◆ read()

bool IMap2DMsgs_save_map_to_disk_RPC_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 6928 of file IMap2DMsgs.cpp.

◆ write()

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

Implements yarp::os::Portable.

Definition at line 6923 of file IMap2DMsgs.cpp.

Member Data Documentation

◆ cmd

Command IMap2DMsgs_save_map_to_disk_RPC_helper::cmd

Definition at line 2032 of file IMap2DMsgs.cpp.

◆ reply

Reply IMap2DMsgs_save_map_to_disk_RPC_helper::reply

Definition at line 2033 of file IMap2DMsgs.cpp.

◆ s_cmd_len

constexpr size_t IMap2DMsgs_save_map_to_disk_RPC_helper::s_cmd_len {7}
staticconstexpr

Definition at line 2037 of file IMap2DMsgs.cpp.

◆ s_help

constexpr const char* IMap2DMsgs_save_map_to_disk_RPC_helper::s_help {""}
staticconstexpr

Definition at line 2040 of file IMap2DMsgs.cpp.

◆ s_prototype

constexpr const char* IMap2DMsgs_save_map_to_disk_RPC_helper::s_prototype {"bool IMap2DMsgs::save_map_to_disk_RPC(const std::string& map_name, const std::string& file_name)"}
staticconstexpr

Definition at line 2039 of file IMap2DMsgs.cpp.

◆ s_reply_len

constexpr size_t IMap2DMsgs_save_map_to_disk_RPC_helper::s_reply_len {1}
staticconstexpr

Definition at line 2038 of file IMap2DMsgs.cpp.

◆ s_tag

constexpr const char* IMap2DMsgs_save_map_to_disk_RPC_helper::s_tag {"save_map_to_disk_RPC"}
staticconstexpr

Definition at line 2035 of file IMap2DMsgs.cpp.

◆ s_tag_len

constexpr size_t IMap2DMsgs_save_map_to_disk_RPC_helper::s_tag_len {5}
staticconstexpr

Definition at line 2036 of file IMap2DMsgs.cpp.


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