YARP
Yet Another Robot Platform
SensorMetadata Class Reference

#include <multipleAnalogSensorsMsgs/idl_generated_code/SensorMetadata.h>

+ Inheritance diagram for SensorMetadata:

Public Types

typedef yarp::os::idl::Unwrapped< SensorMetadataunwrapped
 

Public Member Functions

 SensorMetadata ()=default
 
 SensorMetadata (const std::string &name, const std::string &frameName, const std::string &additionalMetadata)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
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. More...
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
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
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

std::string name {}
 
std::string frameName {}
 
std::string additionalMetadata {}
 

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. More...
 

Detailed Description

Definition at line 17 of file SensorMetadata.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ SensorMetadata() [1/2]

SensorMetadata::SensorMetadata ( )
default

◆ SensorMetadata() [2/2]

SensorMetadata::SensorMetadata ( const std::string &  name,
const std::string &  frameName,
const std::string &  additionalMetadata 
)

Definition at line 14 of file SensorMetadata.cpp.

Member Function Documentation

◆ read() [1/2]

bool SensorMetadata::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 43 of file SensorMetadata.cpp.

◆ read() [2/2]

bool SensorMetadata::read ( yarp::os::idl::WireReader reader)
overridevirtual

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

Definition at line 25 of file SensorMetadata.cpp.

◆ toString()

std::string SensorMetadata::toString ( ) const

Definition at line 87 of file SensorMetadata.cpp.

◆ write() [1/2]

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

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

Definition at line 56 of file SensorMetadata.cpp.

◆ write() [2/2]

bool SensorMetadata::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 74 of file SensorMetadata.cpp.

Member Data Documentation

◆ additionalMetadata

std::string SensorMetadata::additionalMetadata {}

Definition at line 24 of file SensorMetadata.h.

◆ frameName

std::string SensorMetadata::frameName {}

Definition at line 23 of file SensorMetadata.h.

◆ name

std::string SensorMetadata::name {}

Definition at line 22 of file SensorMetadata.h.


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