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

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)(const bool)
 

Public Member Functions

 ISerialMsgs_setDTR_helper ()=default
 
 ISerialMsgs_setDTR_helper (const bool enable)
 
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 (ISerialMsgs *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 {"setDTR"}
 
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 {"bool ISerialMsgs::setDTR(const bool enable)"}
 
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 18 of file ISerialMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

using ISerialMsgs_setDTR_helper::funcptr_t = bool (*)(const bool)

Definition at line 66 of file ISerialMsgs.cpp.

Constructor & Destructor Documentation

◆ ISerialMsgs_setDTR_helper() [1/2]

ISerialMsgs_setDTR_helper::ISerialMsgs_setDTR_helper ( )
default

◆ ISerialMsgs_setDTR_helper() [2/2]

ISerialMsgs_setDTR_helper::ISerialMsgs_setDTR_helper ( const bool  enable)
explicit

Definition at line 139 of file ISerialMsgs.cpp.

Member Function Documentation

◆ call()

void ISerialMsgs_setDTR_helper::call ( ISerialMsgs ptr)

Definition at line 287 of file ISerialMsgs.cpp.

◆ read()

bool ISerialMsgs_setDTR_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 149 of file ISerialMsgs.cpp.

◆ write()

bool ISerialMsgs_setDTR_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 144 of file ISerialMsgs.cpp.

Member Data Documentation

◆ cmd

Command ISerialMsgs_setDTR_helper::cmd

Definition at line 69 of file ISerialMsgs.cpp.

◆ reply

Reply ISerialMsgs_setDTR_helper::reply

Definition at line 70 of file ISerialMsgs.cpp.

◆ s_cmd_len

constexpr size_t ISerialMsgs_setDTR_helper::s_cmd_len {2}
staticconstexpr

Definition at line 74 of file ISerialMsgs.cpp.

◆ s_help

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

Definition at line 77 of file ISerialMsgs.cpp.

◆ s_prototype

constexpr const char* ISerialMsgs_setDTR_helper::s_prototype {"bool ISerialMsgs::setDTR(const bool enable)"}
staticconstexpr

Definition at line 76 of file ISerialMsgs.cpp.

◆ s_reply_len

constexpr size_t ISerialMsgs_setDTR_helper::s_reply_len {1}
staticconstexpr

Definition at line 75 of file ISerialMsgs.cpp.

◆ s_tag

constexpr const char* ISerialMsgs_setDTR_helper::s_tag {"setDTR"}
staticconstexpr

Definition at line 72 of file ISerialMsgs.cpp.

◆ s_tag_len

constexpr size_t ISerialMsgs_setDTR_helper::s_tag_len {1}
staticconstexpr

Definition at line 73 of file ISerialMsgs.cpp.


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