YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
yarp::rosmsg::tf2_msgs::TF2Error Class Reference

#include <yarp/rosmsg/tf2_msgs/TF2Error.h>

+ Inheritance diagram for yarp::rosmsg::tf2_msgs::TF2Error:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::tf2_msgs::TF2Error > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::tf2_msgs::TF2Error > bottleStyle
 

Public Member Functions

 TF2Error ()
 
void clear ()
 
bool readBare (yarp::os::ConnectionReader &connection) override
 
bool readBottle (yarp::os::ConnectionReader &connection) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool writeBare (yarp::os::ConnectionWriter &connection) const override
 
bool writeBottle (yarp::os::ConnectionWriter &connection) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
yarp::os::Type getType () const override
 
- 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
 
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::uint8_t error
 
std::string error_string
 

Static Public Attributes

static const std::uint8_t NO_ERROR = 0
 
static const std::uint8_t LOOKUP_ERROR = 1
 
static const std::uint8_t CONNECTIVITY_ERROR = 2
 
static const std::uint8_t EXTRAPOLATION_ERROR = 3
 
static const std::uint8_t INVALID_ARGUMENT_ERROR = 4
 
static const std::uint8_t TIMEOUT_ERROR = 5
 
static const std::uint8_t TRANSFORM_ERROR = 6
 
static constexpr const char * typeName = "tf2_msgs/TF2Error"
 
static constexpr const char * typeChecksum = "bc6848fd6fd750c92e38575618a4917d"
 
static constexpr const char * typeText
 

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 35 of file TF2Error.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::tf2_msgs::TF2Error> yarp::rosmsg::tf2_msgs::TF2Error::bottleStyle

Definition at line 158 of file TF2Error.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::tf2_msgs::TF2Error> yarp::rosmsg::tf2_msgs::TF2Error::rosStyle

Definition at line 157 of file TF2Error.h.

Constructor & Destructor Documentation

◆ TF2Error()

yarp::rosmsg::tf2_msgs::TF2Error::TF2Error ( )
inline

Definition at line 48 of file TF2Error.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::tf2_msgs::TF2Error::clear ( )
inline

Definition at line 54 of file TF2Error.h.

◆ getType()

yarp::os::Type yarp::rosmsg::tf2_msgs::TF2Error::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 180 of file TF2Error.h.

◆ read()

bool yarp::rosmsg::tf2_msgs::TF2Error::read ( yarp::os::ConnectionReader &  reader)
inlineoverridevirtual

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 112 of file TF2Error.h.

◆ readBare()

bool yarp::rosmsg::tf2_msgs::TF2Error::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 77 of file TF2Error.h.

◆ readBottle()

bool yarp::rosmsg::tf2_msgs::TF2Error::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 92 of file TF2Error.h.

◆ write()

bool yarp::rosmsg::tf2_msgs::TF2Error::write ( yarp::os::ConnectionWriter &  writer) const
inlineoverridevirtual

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 149 of file TF2Error.h.

◆ writeBare()

bool yarp::rosmsg::tf2_msgs::TF2Error::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 118 of file TF2Error.h.

◆ writeBottle()

bool yarp::rosmsg::tf2_msgs::TF2Error::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 130 of file TF2Error.h.

Member Data Documentation

◆ CONNECTIVITY_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::CONNECTIVITY_ERROR = 2
static

Definition at line 40 of file TF2Error.h.

◆ error

std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::error

Definition at line 45 of file TF2Error.h.

◆ error_string

std::string yarp::rosmsg::tf2_msgs::TF2Error::error_string

Definition at line 46 of file TF2Error.h.

◆ EXTRAPOLATION_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::EXTRAPOLATION_ERROR = 3
static

Definition at line 41 of file TF2Error.h.

◆ INVALID_ARGUMENT_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::INVALID_ARGUMENT_ERROR = 4
static

Definition at line 42 of file TF2Error.h.

◆ LOOKUP_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::LOOKUP_ERROR = 1
static

Definition at line 39 of file TF2Error.h.

◆ NO_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::NO_ERROR = 0
static

Definition at line 38 of file TF2Error.h.

◆ TIMEOUT_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::TIMEOUT_ERROR = 5
static

Definition at line 43 of file TF2Error.h.

◆ TRANSFORM_ERROR

const std::uint8_t yarp::rosmsg::tf2_msgs::TF2Error::TRANSFORM_ERROR = 6
static

Definition at line 44 of file TF2Error.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::tf2_msgs::TF2Error::typeChecksum = "bc6848fd6fd750c92e38575618a4917d"
staticconstexpr

Definition at line 164 of file TF2Error.h.

◆ typeName

constexpr const char* yarp::rosmsg::tf2_msgs::TF2Error::typeName = "tf2_msgs/TF2Error"
staticconstexpr

Definition at line 161 of file TF2Error.h.

◆ typeText

constexpr const char* yarp::rosmsg::tf2_msgs::TF2Error::typeText
staticconstexpr
Initial value:
= "\
uint8 NO_ERROR = 0\n\
uint8 LOOKUP_ERROR = 1\n\
uint8 CONNECTIVITY_ERROR = 2\n\
uint8 EXTRAPOLATION_ERROR = 3\n\
uint8 INVALID_ARGUMENT_ERROR = 4\n\
uint8 TIMEOUT_ERROR = 5\n\
uint8 TRANSFORM_ERROR = 6\n\
\n\
uint8 error\n\
string error_string\n\
"

Definition at line 167 of file TF2Error.h.

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