YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::return_getPortInfo Class Reference

Reply of PortCoreMsgs::getPortInfo(). More...

#include <idl_generated_code/yarp/os/return_getPortInfo.h>

+ Inheritance diagram for yarp::os::return_getPortInfo:

Public Types

typedef yarp::os::idl::Unwrapped< return_getPortInfo > unwrapped
 

Public Member Functions

 return_getPortInfo ()=default
 
 return_getPortInfo (const bool ret, const yarp::os::ProcessInfoData &process, const yarp::os::PlatformInfoData &platform, const yarp::os::ThreadInfoData &thread, const yarp::os::PortInfoData &port)
 
bool read (yarp::os::idl::WireReader &reader) override
 
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 write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
std::string toString () const
 
- 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

bool ret {false}
 
yarp::os::ProcessInfoData process {}
 
yarp::os::PlatformInfoData platform {}
 
yarp::os::ThreadInfoData thread {}
 
yarp::os::PortInfoData port {}
 

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

Reply of PortCoreMsgs::getPortInfo().

Definition at line 28 of file return_getPortInfo.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ return_getPortInfo() [1/2]

yarp::os::return_getPortInfo::return_getPortInfo ( )
default

◆ return_getPortInfo() [2/2]

yarp::os::return_getPortInfo::return_getPortInfo ( const bool  ret,
const yarp::os::ProcessInfoData &  process,
const yarp::os::PlatformInfoData &  platform,
const yarp::os::ThreadInfoData &  thread,
const yarp::os::PortInfoData &  port 
)

Definition at line 16 of file return_getPortInfo.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::os::return_getPortInfo::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 55 of file return_getPortInfo.cpp.

◆ read() [2/2]

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

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

Definition at line 31 of file return_getPortInfo.cpp.

◆ toString()

std::string yarp::os::return_getPortInfo::toString ( ) const

Definition at line 105 of file return_getPortInfo.cpp.

◆ write() [1/2]

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

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

Definition at line 68 of file return_getPortInfo.cpp.

◆ write() [2/2]

bool yarp::os::return_getPortInfo::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 92 of file return_getPortInfo.cpp.

Member Data Documentation

◆ platform

yarp::os::PlatformInfoData yarp::os::return_getPortInfo::platform {}

Definition at line 35 of file return_getPortInfo.h.

◆ port

yarp::os::PortInfoData yarp::os::return_getPortInfo::port {}

Definition at line 37 of file return_getPortInfo.h.

◆ process

yarp::os::ProcessInfoData yarp::os::return_getPortInfo::process {}

Definition at line 34 of file return_getPortInfo.h.

◆ ret

bool yarp::os::return_getPortInfo::ret {false}

Definition at line 33 of file return_getPortInfo.h.

◆ thread

yarp::os::ThreadInfoData yarp::os::return_getPortInfo::thread {}

Definition at line 36 of file return_getPortInfo.h.


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