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

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

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

Public Types

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

Public Member Functions

 OccupancyGrid ()
 
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::std_msgs::Header header
 
yarp::rosmsg::nav_msgs::MapMetaData info
 
std::vector< std::int8_t > data
 

Static Public Attributes

static constexpr const char * typeName = "nav_msgs/OccupancyGrid"
 
static constexpr const char * typeChecksum = "3381f2d731d4076ec5c71b0759edbe4e"
 
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 41 of file OccupancyGrid.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 184 of file OccupancyGrid.h.

◆ rosStyle

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

Definition at line 183 of file OccupancyGrid.h.

Constructor & Destructor Documentation

◆ OccupancyGrid()

yarp::rosmsg::nav_msgs::OccupancyGrid::OccupancyGrid ( )
inline

Definition at line 48 of file OccupancyGrid.h.

Member Function Documentation

◆ clear()

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

Definition at line 55 of file OccupancyGrid.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 262 of file OccupancyGrid.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 67 of file OccupancyGrid.h.

◆ readBottle()

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

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

Definition at line 89 of file OccupancyGrid.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 127 of file OccupancyGrid.h.

◆ writeBottle()

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

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

Definition at line 148 of file OccupancyGrid.h.

Member Data Documentation

◆ data

std::vector<std::int8_t> yarp::rosmsg::nav_msgs::OccupancyGrid::data

Definition at line 46 of file OccupancyGrid.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::nav_msgs::OccupancyGrid::header

Definition at line 44 of file OccupancyGrid.h.

◆ info

yarp::rosmsg::nav_msgs::MapMetaData yarp::rosmsg::nav_msgs::OccupancyGrid::info

Definition at line 45 of file OccupancyGrid.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::nav_msgs::OccupancyGrid::typeChecksum = "3381f2d731d4076ec5c71b0759edbe4e"
staticconstexpr

Definition at line 190 of file OccupancyGrid.h.

◆ typeName

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

Definition at line 187 of file OccupancyGrid.h.

◆ typeText

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

Definition at line 193 of file OccupancyGrid.h.

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