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

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

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

Public Types

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

Public Member Functions

 GoalID ()
 
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 stamp
 
std::string id
 

Static Public Attributes

static constexpr const char * typeName = "actionlib_msgs/GoalID"
 
static constexpr const char * typeChecksum = "302881f31927c1df708a2dbab0e80ee8"
 
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 39 of file GoalID.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 148 of file GoalID.h.

◆ rosStyle

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

Definition at line 147 of file GoalID.h.

Constructor & Destructor Documentation

◆ GoalID()

yarp::rosmsg::actionlib_msgs::GoalID::GoalID ( )
inline

Definition at line 45 of file GoalID.h.

Member Function Documentation

◆ clear()

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

Definition at line 51 of file GoalID.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 170 of file GoalID.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 60 of file GoalID.h.

◆ readBottle()

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

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

Definition at line 77 of file GoalID.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 105 of file GoalID.h.

◆ writeBottle()

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

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

Definition at line 119 of file GoalID.h.

Member Data Documentation

◆ id

std::string yarp::rosmsg::actionlib_msgs::GoalID::id

Definition at line 43 of file GoalID.h.

◆ stamp

yarp::rosmsg::TickTime yarp::rosmsg::actionlib_msgs::GoalID::stamp

Definition at line 42 of file GoalID.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::actionlib_msgs::GoalID::typeChecksum = "302881f31927c1df708a2dbab0e80ee8"
staticconstexpr

Definition at line 154 of file GoalID.h.

◆ typeName

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

Definition at line 151 of file GoalID.h.

◆ typeText

constexpr const char* yarp::rosmsg::actionlib_msgs::GoalID::typeText
staticconstexpr
Initial value:
= "\
# The stamp should store the time at which this goal was requested.\n\
# It is used by an action server when it tries to preempt all\n\
# goals that were requested before a certain time\n\
time stamp\n\
\n\
# The id provides a way to associate feedback and\n\
# result message with specific goal requests. The id\n\
# specified must be unique.\n\
string id\n\
\n\
"

Definition at line 157 of file GoalID.h.

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