YARP
Yet Another Robot Platform
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper Class Reference
+ Inheritance diagram for MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)(const double, const double, const double, const double)
 

Public Member Functions

 MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper ()=default
 
 MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper (const double x_vel, const double y_vel, const double theta_vel, const double timeout)
 
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...
 
void call (MobileBaseVelocityControlRPC *ptr)
 
- 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

Command cmd
 
Reply reply
 

Static Public Attributes

static constexpr const char * s_tag {"applyVelocityCommandRPC"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {5}
 
static constexpr size_t s_reply_len {1}
 
static constexpr const char * s_prototype {"bool MobileBaseVelocityControlRPC::applyVelocityCommandRPC(const double x_vel, const double y_vel, const double theta_vel, const double timeout)"}
 
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. More...
 

Detailed Description

Definition at line 18 of file MobileBaseVelocityControlRPC.cpp.

Member Typedef Documentation

◆ funcptr_t

using MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::funcptr_t = bool (*)(const double, const double, const double, const double)

Definition at line 69 of file MobileBaseVelocityControlRPC.cpp.

Constructor & Destructor Documentation

◆ MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper() [1/2]

MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper ( )
default

◆ MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper() [2/2]

MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper ( const double  x_vel,
const double  y_vel,
const double  theta_vel,
const double  timeout 
)

Definition at line 142 of file MobileBaseVelocityControlRPC.cpp.

Member Function Documentation

◆ call()

void MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::call ( MobileBaseVelocityControlRPC *  ptr)

Definition at line 326 of file MobileBaseVelocityControlRPC.cpp.

◆ read()

bool MobileBaseVelocityControlRPC_applyVelocityCommandRPC_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 152 of file MobileBaseVelocityControlRPC.cpp.

◆ write()

bool MobileBaseVelocityControlRPC_applyVelocityCommandRPC_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 147 of file MobileBaseVelocityControlRPC.cpp.

Member Data Documentation

◆ cmd

Command MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::cmd

Definition at line 72 of file MobileBaseVelocityControlRPC.cpp.

◆ reply

Reply MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::reply

Definition at line 73 of file MobileBaseVelocityControlRPC.cpp.

◆ s_cmd_len

constexpr size_t MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::s_cmd_len {5}
staticconstexpr

Definition at line 77 of file MobileBaseVelocityControlRPC.cpp.

◆ s_help

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

Definition at line 80 of file MobileBaseVelocityControlRPC.cpp.

◆ s_prototype

constexpr const char* MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::s_prototype {"bool MobileBaseVelocityControlRPC::applyVelocityCommandRPC(const double x_vel, const double y_vel, const double theta_vel, const double timeout)"}
staticconstexpr

Definition at line 79 of file MobileBaseVelocityControlRPC.cpp.

◆ s_reply_len

constexpr size_t MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::s_reply_len {1}
staticconstexpr

Definition at line 78 of file MobileBaseVelocityControlRPC.cpp.

◆ s_tag

constexpr const char* MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::s_tag {"applyVelocityCommandRPC"}
staticconstexpr

Definition at line 75 of file MobileBaseVelocityControlRPC.cpp.

◆ s_tag_len

constexpr size_t MobileBaseVelocityControlRPC_applyVelocityCommandRPC_helper::s_tag_len {1}
staticconstexpr

Definition at line 76 of file MobileBaseVelocityControlRPC.cpp.

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