YARP
Yet Another Robot Platform
yarp::rosmsg::nav_msgs::GetMap Class Reference

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::nav_msgs::GetMaprosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::nav_msgs::GetMapbottleStyle
 

Public Member Functions

 GetMap ()
 
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
 

Static Public Attributes

static constexpr const char * typeName = "nav_msgs/GetMap"
 
static constexpr const char * typeChecksum = "d41d8cd98f00b204e9800998ecf8427e"
 
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 28 of file GetMap.h.

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ GetMap()

yarp::rosmsg::nav_msgs::GetMap::GetMap ( )
inline

Definition at line 32 of file GetMap.h.

Member Function Documentation

◆ clear()

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

Definition at line 36 of file GetMap.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 106 of file GetMap.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 40 of file GetMap.h.

◆ readBottle()

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

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

Definition at line 46 of file GetMap.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 65 of file GetMap.h.

◆ writeBottle()

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

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

Definition at line 71 of file GetMap.h.

Member Data Documentation

◆ typeChecksum

constexpr const char* yarp::rosmsg::nav_msgs::GetMap::typeChecksum = "d41d8cd98f00b204e9800998ecf8427e"
staticconstexpr

Definition at line 97 of file GetMap.h.

◆ typeName

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

Definition at line 94 of file GetMap.h.

◆ typeText

constexpr const char* yarp::rosmsg::nav_msgs::GetMap::typeText
staticconstexpr
Initial value:
= "\
# Get the map as a nav_msgs/OccupancyGrid\n\
---\n\
nav_msgs/OccupancyGrid map\n\
"

Definition at line 100 of file GetMap.h.


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