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

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

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

Public Types

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

Public Member Functions

 GetPlan ()
 
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::geometry_msgs::PoseStamped start
 
yarp::rosmsg::geometry_msgs::PoseStamped goal
 
yarp::conf::float32_t tolerance
 

Static Public Attributes

static constexpr const char * typeName = "nav_msgs/GetPlan"
 
static constexpr const char * typeChecksum = "e25a43e0752bcca599a8c2eef8282df8"
 
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 GetPlan.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 168 of file GetPlan.h.

◆ rosStyle

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

Definition at line 167 of file GetPlan.h.

Constructor & Destructor Documentation

◆ GetPlan()

yarp::rosmsg::nav_msgs::GetPlan::GetPlan ( )
inline

Definition at line 49 of file GetPlan.h.

Member Function Documentation

◆ clear()

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

Definition at line 56 of file GetPlan.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 239 of file GetPlan.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 68 of file GetPlan.h.

◆ readBottle()

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

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

Definition at line 86 of file GetPlan.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 117 of file GetPlan.h.

◆ writeBottle()

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

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

Definition at line 135 of file GetPlan.h.

Member Data Documentation

◆ goal

yarp::rosmsg::geometry_msgs::PoseStamped yarp::rosmsg::nav_msgs::GetPlan::goal

Definition at line 46 of file GetPlan.h.

◆ start

yarp::rosmsg::geometry_msgs::PoseStamped yarp::rosmsg::nav_msgs::GetPlan::start

Definition at line 45 of file GetPlan.h.

◆ tolerance

yarp::conf::float32_t yarp::rosmsg::nav_msgs::GetPlan::tolerance

Definition at line 47 of file GetPlan.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::nav_msgs::GetPlan::typeChecksum = "e25a43e0752bcca599a8c2eef8282df8"
staticconstexpr

Definition at line 174 of file GetPlan.h.

◆ typeName

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

Definition at line 171 of file GetPlan.h.

◆ typeText

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

Definition at line 177 of file GetPlan.h.

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