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

Public Member Functions

 Command ()=default
 
 Command (const std::int32_t frameNum)
 
 ~Command () override=default
 
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.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool writeTag (const yarp::os::idl::WireWriter &writer) const
 
bool writeArgs (const yarp::os::idl::WireWriter &writer) const
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool readTag (yarp::os::idl::WireReader &reader)
 
bool readArgs (yarp::os::idl::WireReader &reader)
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- 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

std::int32_t frameNum {0}
 

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 180 of file yarpdataplayer_console_IDL.cpp.

Constructor & Destructor Documentation

◆ Command() [1/2]

yarpdataplayer_console_IDL_setFrame_helper::Command::Command ( )
default

◆ Command() [2/2]

yarpdataplayer_console_IDL_setFrame_helper::Command::Command ( const std::int32_t  frameNum)
explicit

Definition at line 1675 of file yarpdataplayer_console_IDL.cpp.

◆ ~Command()

yarpdataplayer_console_IDL_setFrame_helper::Command::~Command ( )
overridedefault

Member Function Documentation

◆ read() [1/2]

bool yarpdataplayer_console_IDL_setFrame_helper::Command::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 1689 of file yarpdataplayer_console_IDL.cpp.

◆ read() [2/2]

bool yarpdataplayer_console_IDL_setFrame_helper::Command::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 1726 of file yarpdataplayer_console_IDL.cpp.

◆ readArgs()

bool yarpdataplayer_console_IDL_setFrame_helper::Command::readArgs ( yarp::os::idl::WireReader &  reader)

Definition at line 1750 of file yarpdataplayer_console_IDL.cpp.

◆ readTag()

bool yarpdataplayer_console_IDL_setFrame_helper::Command::readTag ( yarp::os::idl::WireReader &  reader)

Definition at line 1737 of file yarpdataplayer_console_IDL.cpp.

◆ write() [1/2]

bool yarpdataplayer_console_IDL_setFrame_helper::Command::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 1699 of file yarpdataplayer_console_IDL.cpp.

◆ write() [2/2]

bool yarpdataplayer_console_IDL_setFrame_helper::Command::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 1680 of file yarpdataplayer_console_IDL.cpp.

◆ writeArgs()

bool yarpdataplayer_console_IDL_setFrame_helper::Command::writeArgs ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 1718 of file yarpdataplayer_console_IDL.cpp.

◆ writeTag()

bool yarpdataplayer_console_IDL_setFrame_helper::Command::writeTag ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 1710 of file yarpdataplayer_console_IDL.cpp.

Member Data Documentation

◆ frameNum

std::int32_t yarpdataplayer_console_IDL_setFrame_helper::Command::frameNum {0}

Definition at line 200 of file yarpdataplayer_console_IDL.cpp.

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