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

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

+ Inheritance diagram for yarp::os::PortInfoData:

Public Types

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

Public Member Functions

 PortInfoData ()=default
 
 PortInfoData (const bool is_input, const bool is_output, const bool is_rpc, const std::string &type, const std::string &hostname)
 
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 is_input {false}
 
bool is_output {false}
 
bool is_rpc {false}
 
std::string type {}
 
std::string hostname {}
 

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 21 of file PortInfoData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ PortInfoData() [1/2]

yarp::os::PortInfoData::PortInfoData ( )
default

◆ PortInfoData() [2/2]

yarp::os::PortInfoData::PortInfoData ( const bool  is_input,
const bool  is_output,
const bool  is_rpc,
const std::string &  type,
const std::string &  hostname 
)

Definition at line 16 of file PortInfoData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::os::PortInfoData::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 PortInfoData.cpp.

◆ read() [2/2]

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

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

Definition at line 31 of file PortInfoData.cpp.

◆ toString()

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

Definition at line 105 of file PortInfoData.cpp.

◆ write() [1/2]

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

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

Definition at line 68 of file PortInfoData.cpp.

◆ write() [2/2]

bool yarp::os::PortInfoData::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 PortInfoData.cpp.

Member Data Documentation

◆ hostname

std::string yarp::os::PortInfoData::hostname {}

Definition at line 30 of file PortInfoData.h.

◆ is_input

bool yarp::os::PortInfoData::is_input {false}

Definition at line 26 of file PortInfoData.h.

◆ is_output

bool yarp::os::PortInfoData::is_output {false}

Definition at line 27 of file PortInfoData.h.

◆ is_rpc

bool yarp::os::PortInfoData::is_rpc {false}

Definition at line 28 of file PortInfoData.h.

◆ type

std::string yarp::os::PortInfoData::type {}

Definition at line 29 of file PortInfoData.h.


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