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

#include <yarp/rosmsg/nav_msgs/MapMetaData.h>

+ Inheritance diagram for yarp::rosmsg::nav_msgs::MapMetaData:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::nav_msgs::MapMetaData > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::nav_msgs::MapMetaData > bottleStyle
 

Public Member Functions

 MapMetaData ()
 
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
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. 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

yarp::rosmsg::TickTime map_load_time
 
yarp::conf::float32_t resolution
 
std::uint32_t width
 
std::uint32_t height
 
yarp::rosmsg::geometry_msgs::Pose origin
 

Static Public Attributes

static constexpr const char * typeName = "nav_msgs/MapMetaData"
 
static constexpr const char * typeChecksum = "10cfc8a2818024d3248802c00c95f11b"
 
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 42 of file MapMetaData.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::nav_msgs::MapMetaData> yarp::rosmsg::nav_msgs::MapMetaData::bottleStyle

Definition at line 204 of file MapMetaData.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::nav_msgs::MapMetaData> yarp::rosmsg::nav_msgs::MapMetaData::rosStyle

Definition at line 203 of file MapMetaData.h.

Constructor & Destructor Documentation

◆ MapMetaData()

yarp::rosmsg::nav_msgs::MapMetaData::MapMetaData ( )
inline

Definition at line 51 of file MapMetaData.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::nav_msgs::MapMetaData::clear ( )
inline

Definition at line 60 of file MapMetaData.h.

◆ getType()

yarp::os::Type yarp::rosmsg::nav_msgs::MapMetaData::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 250 of file MapMetaData.h.

◆ read()

bool yarp::rosmsg::nav_msgs::MapMetaData::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 133 of file MapMetaData.h.

◆ readBare()

bool yarp::rosmsg::nav_msgs::MapMetaData::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 78 of file MapMetaData.h.

◆ readBottle()

bool yarp::rosmsg::nav_msgs::MapMetaData::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 102 of file MapMetaData.h.

◆ write()

bool yarp::rosmsg::nav_msgs::MapMetaData::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 195 of file MapMetaData.h.

◆ writeBare()

bool yarp::rosmsg::nav_msgs::MapMetaData::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 139 of file MapMetaData.h.

◆ writeBottle()

bool yarp::rosmsg::nav_msgs::MapMetaData::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 163 of file MapMetaData.h.

Member Data Documentation

◆ height

std::uint32_t yarp::rosmsg::nav_msgs::MapMetaData::height

Definition at line 48 of file MapMetaData.h.

◆ map_load_time

yarp::rosmsg::TickTime yarp::rosmsg::nav_msgs::MapMetaData::map_load_time

Definition at line 45 of file MapMetaData.h.

◆ origin

yarp::rosmsg::geometry_msgs::Pose yarp::rosmsg::nav_msgs::MapMetaData::origin

Definition at line 49 of file MapMetaData.h.

◆ resolution

yarp::conf::float32_t yarp::rosmsg::nav_msgs::MapMetaData::resolution

Definition at line 46 of file MapMetaData.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::nav_msgs::MapMetaData::typeChecksum = "10cfc8a2818024d3248802c00c95f11b"
staticconstexpr

Definition at line 210 of file MapMetaData.h.

◆ typeName

constexpr const char* yarp::rosmsg::nav_msgs::MapMetaData::typeName = "nav_msgs/MapMetaData"
staticconstexpr

Definition at line 207 of file MapMetaData.h.

◆ typeText

constexpr const char* yarp::rosmsg::nav_msgs::MapMetaData::typeText
staticconstexpr

Definition at line 213 of file MapMetaData.h.

◆ width

std::uint32_t yarp::rosmsg::nav_msgs::MapMetaData::width

Definition at line 47 of file MapMetaData.h.

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