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

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = yarp::dev::ReturnValue(*)(const std::string &)
 

Public Member Functions

 WorldInterfaceServer_deleteObject_helper ()=default
 
 WorldInterfaceServer_deleteObject_helper (const std::string &id)
 
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 (WorldInterfaceServer *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 {"deleteObject"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {2}
 
static constexpr size_t s_reply_len {1}
 
static constexpr const char * s_prototype {"yarp::dev::ReturnValue WorldInterfaceServer::deleteObject(const std::string& id)"}
 
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 838 of file WorldInterfaceServer.cpp.

Member Typedef Documentation

◆ funcptr_t

Constructor & Destructor Documentation

◆ WorldInterfaceServer_deleteObject_helper() [1/2]

WorldInterfaceServer_deleteObject_helper::WorldInterfaceServer_deleteObject_helper ( )
default

◆ WorldInterfaceServer_deleteObject_helper() [2/2]

WorldInterfaceServer_deleteObject_helper::WorldInterfaceServer_deleteObject_helper ( const std::string &  id)
explicit

Definition at line 3173 of file WorldInterfaceServer.cpp.

Member Function Documentation

◆ call()

void WorldInterfaceServer_deleteObject_helper::call ( WorldInterfaceServer *  ptr)

Definition at line 3315 of file WorldInterfaceServer.cpp.

◆ read()

bool WorldInterfaceServer_deleteObject_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 3183 of file WorldInterfaceServer.cpp.

◆ write()

bool WorldInterfaceServer_deleteObject_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 3178 of file WorldInterfaceServer.cpp.

Member Data Documentation

◆ cmd

Command WorldInterfaceServer_deleteObject_helper::cmd

Definition at line 889 of file WorldInterfaceServer.cpp.

◆ reply

Reply WorldInterfaceServer_deleteObject_helper::reply

Definition at line 890 of file WorldInterfaceServer.cpp.

◆ s_cmd_len

constexpr size_t WorldInterfaceServer_deleteObject_helper::s_cmd_len {2}
staticconstexpr

Definition at line 894 of file WorldInterfaceServer.cpp.

◆ s_help

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

Definition at line 897 of file WorldInterfaceServer.cpp.

◆ s_prototype

constexpr const char* WorldInterfaceServer_deleteObject_helper::s_prototype {"yarp::dev::ReturnValue WorldInterfaceServer::deleteObject(const std::string& id)"}
staticconstexpr

Definition at line 896 of file WorldInterfaceServer.cpp.

◆ s_reply_len

constexpr size_t WorldInterfaceServer_deleteObject_helper::s_reply_len {1}
staticconstexpr

Definition at line 895 of file WorldInterfaceServer.cpp.

◆ s_tag

constexpr const char* WorldInterfaceServer_deleteObject_helper::s_tag {"deleteObject"}
staticconstexpr

Definition at line 892 of file WorldInterfaceServer.cpp.

◆ s_tag_len

constexpr size_t WorldInterfaceServer_deleteObject_helper::s_tag_len {1}
staticconstexpr

Definition at line 893 of file WorldInterfaceServer.cpp.


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