YARP
Yet Another Robot Platform
IMap2DMsgs_remove_map_RPC_helper::Command Class Reference
+ Inheritance diagram for IMap2DMsgs_remove_map_RPC_helper::Command:

Public Member Functions

 Command ()=default
 
 Command (const std::string &map_name)
 
 ~Command () override=default
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool writeTag (const yarp::os::idl::WireWriter &writer) const
 
bool writeArgs (const yarp::os::idl::WireWriter &writer) const
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool readTag (yarp::os::idl::WireReader &reader)
 
bool readArgs (yarp::os::idl::WireReader &reader)
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

std::string map_name {}
 

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. More...
 

Detailed Description

Definition at line 269 of file IMap2DMsgs.cpp.

Constructor & Destructor Documentation

◆ Command() [1/2]

IMap2DMsgs_remove_map_RPC_helper::Command::Command ( )
default

◆ Command() [2/2]

IMap2DMsgs_remove_map_RPC_helper::Command::Command ( const std::string &  map_name)
explicit

Definition at line 2759 of file IMap2DMsgs.cpp.

◆ ~Command()

IMap2DMsgs_remove_map_RPC_helper::Command::~Command ( )
overridedefault

Member Function Documentation

◆ read() [1/2]

bool IMap2DMsgs_remove_map_RPC_helper::Command::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 2773 of file IMap2DMsgs.cpp.

◆ read() [2/2]

bool IMap2DMsgs_remove_map_RPC_helper::Command::read ( yarp::os::idl::WireReader reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 2810 of file IMap2DMsgs.cpp.

◆ readArgs()

bool IMap2DMsgs_remove_map_RPC_helper::Command::readArgs ( yarp::os::idl::WireReader reader)

Definition at line 2834 of file IMap2DMsgs.cpp.

◆ readTag()

bool IMap2DMsgs_remove_map_RPC_helper::Command::readTag ( yarp::os::idl::WireReader reader)

Definition at line 2821 of file IMap2DMsgs.cpp.

◆ write() [1/2]

bool IMap2DMsgs_remove_map_RPC_helper::Command::write ( const yarp::os::idl::WireWriter writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 2783 of file IMap2DMsgs.cpp.

◆ write() [2/2]

bool IMap2DMsgs_remove_map_RPC_helper::Command::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 2764 of file IMap2DMsgs.cpp.

◆ writeArgs()

bool IMap2DMsgs_remove_map_RPC_helper::Command::writeArgs ( const yarp::os::idl::WireWriter writer) const

Definition at line 2802 of file IMap2DMsgs.cpp.

◆ writeTag()

bool IMap2DMsgs_remove_map_RPC_helper::Command::writeTag ( const yarp::os::idl::WireWriter writer) const

Definition at line 2794 of file IMap2DMsgs.cpp.

Member Data Documentation

◆ map_name

std::string IMap2DMsgs_remove_map_RPC_helper::Command::map_name {}

Definition at line 289 of file IMap2DMsgs.cpp.


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