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

#include <yarp/rosmsg/actionlib_msgs/GoalStatus.h>

+ Inheritance diagram for yarp::rosmsg::actionlib_msgs::GoalStatus:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::actionlib_msgs::GoalStatus > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::actionlib_msgs::GoalStatus > bottleStyle
 

Public Member Functions

 GoalStatus ()
 
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::actionlib_msgs::GoalID goal_id
 
std::uint8_t status
 
std::string text
 

Static Public Attributes

static const std::uint8_t PENDING = 0
 
static const std::uint8_t ACTIVE = 1
 
static const std::uint8_t PREEMPTED = 2
 
static const std::uint8_t SUCCEEDED = 3
 
static const std::uint8_t ABORTED = 4
 
static const std::uint8_t REJECTED = 5
 
static const std::uint8_t PREEMPTING = 6
 
static const std::uint8_t RECALLING = 7
 
static const std::uint8_t RECALLED = 8
 
static const std::uint8_t LOST = 9
 
static constexpr const char * typeName = "actionlib_msgs/GoalStatus"
 
static constexpr const char * typeChecksum = "d388f9b87b3c471f784434d671988d4a"
 
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 52 of file GoalStatus.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::actionlib_msgs::GoalStatus> yarp::rosmsg::actionlib_msgs::GoalStatus::bottleStyle

Definition at line 209 of file GoalStatus.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::actionlib_msgs::GoalStatus> yarp::rosmsg::actionlib_msgs::GoalStatus::rosStyle

Definition at line 208 of file GoalStatus.h.

Constructor & Destructor Documentation

◆ GoalStatus()

yarp::rosmsg::actionlib_msgs::GoalStatus::GoalStatus ( )
inline

Definition at line 69 of file GoalStatus.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::actionlib_msgs::GoalStatus::clear ( )
inline

Definition at line 76 of file GoalStatus.h.

◆ getType()

yarp::os::Type yarp::rosmsg::actionlib_msgs::GoalStatus::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 257 of file GoalStatus.h.

◆ read()

bool yarp::rosmsg::actionlib_msgs::GoalStatus::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 153 of file GoalStatus.h.

◆ readBare()

bool yarp::rosmsg::actionlib_msgs::GoalStatus::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 108 of file GoalStatus.h.

◆ readBottle()

bool yarp::rosmsg::actionlib_msgs::GoalStatus::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 128 of file GoalStatus.h.

◆ write()

bool yarp::rosmsg::actionlib_msgs::GoalStatus::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 200 of file GoalStatus.h.

◆ writeBare()

bool yarp::rosmsg::actionlib_msgs::GoalStatus::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 159 of file GoalStatus.h.

◆ writeBottle()

bool yarp::rosmsg::actionlib_msgs::GoalStatus::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 176 of file GoalStatus.h.

Member Data Documentation

◆ ABORTED

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::ABORTED = 4
static

Definition at line 61 of file GoalStatus.h.

◆ ACTIVE

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::ACTIVE = 1
static

Definition at line 58 of file GoalStatus.h.

◆ goal_id

yarp::rosmsg::actionlib_msgs::GoalID yarp::rosmsg::actionlib_msgs::GoalStatus::goal_id

Definition at line 55 of file GoalStatus.h.

◆ LOST

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::LOST = 9
static

Definition at line 66 of file GoalStatus.h.

◆ PENDING

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::PENDING = 0
static

Definition at line 57 of file GoalStatus.h.

◆ PREEMPTED

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::PREEMPTED = 2
static

Definition at line 59 of file GoalStatus.h.

◆ PREEMPTING

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::PREEMPTING = 6
static

Definition at line 63 of file GoalStatus.h.

◆ RECALLED

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::RECALLED = 8
static

Definition at line 65 of file GoalStatus.h.

◆ RECALLING

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::RECALLING = 7
static

Definition at line 64 of file GoalStatus.h.

◆ REJECTED

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::REJECTED = 5
static

Definition at line 62 of file GoalStatus.h.

◆ status

std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::status

Definition at line 56 of file GoalStatus.h.

◆ SUCCEEDED

const std::uint8_t yarp::rosmsg::actionlib_msgs::GoalStatus::SUCCEEDED = 3
static

Definition at line 60 of file GoalStatus.h.

◆ text

std::string yarp::rosmsg::actionlib_msgs::GoalStatus::text

Definition at line 67 of file GoalStatus.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::actionlib_msgs::GoalStatus::typeChecksum = "d388f9b87b3c471f784434d671988d4a"
staticconstexpr

Definition at line 215 of file GoalStatus.h.

◆ typeName

constexpr const char* yarp::rosmsg::actionlib_msgs::GoalStatus::typeName = "actionlib_msgs/GoalStatus"
staticconstexpr

Definition at line 212 of file GoalStatus.h.

◆ typeText

constexpr const char* yarp::rosmsg::actionlib_msgs::GoalStatus::typeText
staticconstexpr

Definition at line 218 of file GoalStatus.h.

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