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

Classes

class  Command
 
class  Reply
 

Public Types

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

Public Member Functions

 ISimulatedWorldMsgs_deleteObject_helper ()=default
 
 ISimulatedWorldMsgs_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 (ISimulatedWorldMsgs *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 ISimulatedWorldMsgs::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 844 of file ISimulatedWorldMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

Constructor & Destructor Documentation

◆ ISimulatedWorldMsgs_deleteObject_helper() [1/2]

ISimulatedWorldMsgs_deleteObject_helper::ISimulatedWorldMsgs_deleteObject_helper ( )
default

◆ ISimulatedWorldMsgs_deleteObject_helper() [2/2]

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

Definition at line 3340 of file ISimulatedWorldMsgs.cpp.

Member Function Documentation

◆ call()

void ISimulatedWorldMsgs_deleteObject_helper::call ( ISimulatedWorldMsgs *  ptr)

Definition at line 3482 of file ISimulatedWorldMsgs.cpp.

◆ read()

bool ISimulatedWorldMsgs_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 3350 of file ISimulatedWorldMsgs.cpp.

◆ write()

bool ISimulatedWorldMsgs_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 3345 of file ISimulatedWorldMsgs.cpp.

Member Data Documentation

◆ cmd

Command ISimulatedWorldMsgs_deleteObject_helper::cmd

Definition at line 895 of file ISimulatedWorldMsgs.cpp.

◆ reply

Reply ISimulatedWorldMsgs_deleteObject_helper::reply

Definition at line 896 of file ISimulatedWorldMsgs.cpp.

◆ s_cmd_len

constexpr size_t ISimulatedWorldMsgs_deleteObject_helper::s_cmd_len {2}
staticconstexpr

Definition at line 900 of file ISimulatedWorldMsgs.cpp.

◆ s_help

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

Definition at line 903 of file ISimulatedWorldMsgs.cpp.

◆ s_prototype

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

Definition at line 902 of file ISimulatedWorldMsgs.cpp.

◆ s_reply_len

constexpr size_t ISimulatedWorldMsgs_deleteObject_helper::s_reply_len {1}
staticconstexpr

Definition at line 901 of file ISimulatedWorldMsgs.cpp.

◆ s_tag

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

Definition at line 898 of file ISimulatedWorldMsgs.cpp.

◆ s_tag_len

constexpr size_t ISimulatedWorldMsgs_deleteObject_helper::s_tag_len {1}
staticconstexpr

Definition at line 899 of file ISimulatedWorldMsgs.cpp.


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