YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
IRobotDescriptionMsgs_registerDeviceRPC_helper Class Reference
+ Inheritance diagram for IRobotDescriptionMsgs_registerDeviceRPC_helper:

Classes

class  Command
 
class  Reply
 

Public Types

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

Public Member Functions

 IRobotDescriptionMsgs_registerDeviceRPC_helper ()=default
 
 IRobotDescriptionMsgs_registerDeviceRPC_helper (const yarp::dev::DeviceDescription &dev)
 
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 (IRobotDescriptionMsgs *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 {"registerDeviceRPC"}
 
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 IRobotDescriptionMsgs::registerDeviceRPC(const yarp::dev::DeviceDescription& dev)"}
 
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 230 of file IRobotDescriptionMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

using IRobotDescriptionMsgs_registerDeviceRPC_helper::funcptr_t = yarp::dev::ReturnValue (*)(const yarp::dev::DeviceDescription&)

Definition at line 278 of file IRobotDescriptionMsgs.cpp.

Constructor & Destructor Documentation

◆ IRobotDescriptionMsgs_registerDeviceRPC_helper() [1/2]

IRobotDescriptionMsgs_registerDeviceRPC_helper::IRobotDescriptionMsgs_registerDeviceRPC_helper ( )
default

◆ IRobotDescriptionMsgs_registerDeviceRPC_helper() [2/2]

IRobotDescriptionMsgs_registerDeviceRPC_helper::IRobotDescriptionMsgs_registerDeviceRPC_helper ( const yarp::dev::DeviceDescription &  dev)
explicit

Definition at line 701 of file IRobotDescriptionMsgs.cpp.

Member Function Documentation

◆ call()

void IRobotDescriptionMsgs_registerDeviceRPC_helper::call ( IRobotDescriptionMsgs *  ptr)

Definition at line 843 of file IRobotDescriptionMsgs.cpp.

◆ read()

bool IRobotDescriptionMsgs_registerDeviceRPC_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 711 of file IRobotDescriptionMsgs.cpp.

◆ write()

bool IRobotDescriptionMsgs_registerDeviceRPC_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 706 of file IRobotDescriptionMsgs.cpp.

Member Data Documentation

◆ cmd

Command IRobotDescriptionMsgs_registerDeviceRPC_helper::cmd

Definition at line 281 of file IRobotDescriptionMsgs.cpp.

◆ reply

Reply IRobotDescriptionMsgs_registerDeviceRPC_helper::reply

Definition at line 282 of file IRobotDescriptionMsgs.cpp.

◆ s_cmd_len

constexpr size_t IRobotDescriptionMsgs_registerDeviceRPC_helper::s_cmd_len {2}
staticconstexpr

Definition at line 286 of file IRobotDescriptionMsgs.cpp.

◆ s_help

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

Definition at line 289 of file IRobotDescriptionMsgs.cpp.

◆ s_prototype

constexpr const char* IRobotDescriptionMsgs_registerDeviceRPC_helper::s_prototype {"yarp::dev::ReturnValue IRobotDescriptionMsgs::registerDeviceRPC(const yarp::dev::DeviceDescription& dev)"}
staticconstexpr

Definition at line 288 of file IRobotDescriptionMsgs.cpp.

◆ s_reply_len

constexpr size_t IRobotDescriptionMsgs_registerDeviceRPC_helper::s_reply_len {1}
staticconstexpr

Definition at line 287 of file IRobotDescriptionMsgs.cpp.

◆ s_tag

constexpr const char* IRobotDescriptionMsgs_registerDeviceRPC_helper::s_tag {"registerDeviceRPC"}
staticconstexpr

Definition at line 284 of file IRobotDescriptionMsgs.cpp.

◆ s_tag_len

constexpr size_t IRobotDescriptionMsgs_registerDeviceRPC_helper::s_tag_len {1}
staticconstexpr

Definition at line 285 of file IRobotDescriptionMsgs.cpp.

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