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

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = void(*)(const double)
 

Public Member Functions

 FakeBatteryService_setBatteryVoltage_helper ()=default
 
 FakeBatteryService_setBatteryVoltage_helper (const double voltage)
 
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 (FakeBatteryService *ptr) 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

Command cmd
 
Reply reply
 

Static Public Attributes

static constexpr const char * s_tag {"setBatteryVoltage"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {2}
 
static constexpr size_t s_reply_len {0}
 
static constexpr const char * s_prototype {"void FakeBatteryService::setBatteryVoltage(const double voltage)"}
 
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 FakeBatteryService.cpp.

Member Typedef Documentation

◆ funcptr_t

using FakeBatteryService_setBatteryVoltage_helper::funcptr_t = void (*)(const double)

Definition at line 64 of file FakeBatteryService.cpp.

Constructor & Destructor Documentation

◆ FakeBatteryService_setBatteryVoltage_helper() [1/2]

FakeBatteryService_setBatteryVoltage_helper::FakeBatteryService_setBatteryVoltage_helper ( )
default

◆ FakeBatteryService_setBatteryVoltage_helper() [2/2]

FakeBatteryService_setBatteryVoltage_helper::FakeBatteryService_setBatteryVoltage_helper ( const double  voltage)
explicit

Definition at line 790 of file FakeBatteryService.cpp.

Member Function Documentation

◆ call()

void FakeBatteryService_setBatteryVoltage_helper::call ( FakeBatteryService *  ptr) const

Definition at line 924 of file FakeBatteryService.cpp.

◆ read()

bool FakeBatteryService_setBatteryVoltage_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 800 of file FakeBatteryService.cpp.

◆ write()

bool FakeBatteryService_setBatteryVoltage_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 795 of file FakeBatteryService.cpp.

Member Data Documentation

◆ cmd

Command FakeBatteryService_setBatteryVoltage_helper::cmd

Definition at line 67 of file FakeBatteryService.cpp.

◆ reply

Reply FakeBatteryService_setBatteryVoltage_helper::reply

Definition at line 68 of file FakeBatteryService.cpp.

◆ s_cmd_len

constexpr size_t FakeBatteryService_setBatteryVoltage_helper::s_cmd_len {2}
staticconstexpr

Definition at line 72 of file FakeBatteryService.cpp.

◆ s_help

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

Definition at line 75 of file FakeBatteryService.cpp.

◆ s_prototype

constexpr const char* FakeBatteryService_setBatteryVoltage_helper::s_prototype {"void FakeBatteryService::setBatteryVoltage(const double voltage)"}
staticconstexpr

Definition at line 74 of file FakeBatteryService.cpp.

◆ s_reply_len

constexpr size_t FakeBatteryService_setBatteryVoltage_helper::s_reply_len {0}
staticconstexpr

Definition at line 73 of file FakeBatteryService.cpp.

◆ s_tag

constexpr const char* FakeBatteryService_setBatteryVoltage_helper::s_tag {"setBatteryVoltage"}
staticconstexpr

Definition at line 70 of file FakeBatteryService.cpp.

◆ s_tag_len

constexpr size_t FakeBatteryService_setBatteryVoltage_helper::s_tag_len {1}
staticconstexpr

Definition at line 71 of file FakeBatteryService.cpp.

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