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

#include <yarp/os/ApplicationNetworkProtocolVersion.h>

+ Inheritance diagram for yarp::os::ApplicationNetworkProtocolVersion:

Public Member Functions

 ApplicationNetworkProtocolVersion ()
 
 ~ApplicationNetworkProtocolVersion ()=default
 
std::string toString ()
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
- 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

short int protocol_version = -1
 
short int yarp_major = -1
 
short int yarp_minor = -1
 
short int yarp_patch = -1
 

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 15 of file ApplicationNetworkProtocolVersion.h.

Constructor & Destructor Documentation

◆ ApplicationNetworkProtocolVersion()

ApplicationNetworkProtocolVersion::ApplicationNetworkProtocolVersion ( )

Definition at line 12 of file ApplicationNetworkProtocolVersion.cpp.

◆ ~ApplicationNetworkProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion::~ApplicationNetworkProtocolVersion ( )
default

Member Function Documentation

◆ read()

bool ApplicationNetworkProtocolVersion::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 26 of file ApplicationNetworkProtocolVersion.cpp.

◆ toString()

std::string ApplicationNetworkProtocolVersion::toString ( )

Definition at line 16 of file ApplicationNetworkProtocolVersion.cpp.

◆ write()

bool ApplicationNetworkProtocolVersion::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 36 of file ApplicationNetworkProtocolVersion.cpp.

Member Data Documentation

◆ protocol_version

short int yarp::os::ApplicationNetworkProtocolVersion::protocol_version = -1

Definition at line 18 of file ApplicationNetworkProtocolVersion.h.

◆ yarp_major

short int yarp::os::ApplicationNetworkProtocolVersion::yarp_major = -1

Definition at line 19 of file ApplicationNetworkProtocolVersion.h.

◆ yarp_minor

short int yarp::os::ApplicationNetworkProtocolVersion::yarp_minor = -1

Definition at line 20 of file ApplicationNetworkProtocolVersion.h.

◆ yarp_patch

short int yarp::os::ApplicationNetworkProtocolVersion::yarp_patch = -1

Definition at line 21 of file ApplicationNetworkProtocolVersion.h.


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