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

#include <yarp/rosmsg/sensor_msgs/JoyFeedback.h>

+ Inheritance diagram for yarp::rosmsg::sensor_msgs::JoyFeedback:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::JoyFeedback > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::JoyFeedback > bottleStyle
 

Public Member Functions

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

std::uint8_t type
 
std::uint8_t id
 
yarp::conf::float32_t intensity
 

Static Public Attributes

static const std::uint8_t TYPE_LED = 0
 
static const std::uint8_t TYPE_RUMBLE = 1
 
static const std::uint8_t TYPE_BUZZER = 2
 
static constexpr const char * typeName = "sensor_msgs/JoyFeedback"
 
static constexpr const char * typeChecksum = "f4dcd73460360d98f36e55ee7f2e46f1"
 
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 43 of file JoyFeedback.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::sensor_msgs::JoyFeedback> yarp::rosmsg::sensor_msgs::JoyFeedback::bottleStyle

Definition at line 164 of file JoyFeedback.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::sensor_msgs::JoyFeedback> yarp::rosmsg::sensor_msgs::JoyFeedback::rosStyle

Definition at line 163 of file JoyFeedback.h.

Constructor & Destructor Documentation

◆ JoyFeedback()

yarp::rosmsg::sensor_msgs::JoyFeedback::JoyFeedback ( )
inline

Definition at line 53 of file JoyFeedback.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::sensor_msgs::JoyFeedback::clear ( )
inline

Definition at line 60 of file JoyFeedback.h.

◆ getType()

yarp::os::Type yarp::rosmsg::sensor_msgs::JoyFeedback::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 191 of file JoyFeedback.h.

◆ read()

bool yarp::rosmsg::sensor_msgs::JoyFeedback::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 113 of file JoyFeedback.h.

◆ readBare()

bool yarp::rosmsg::sensor_msgs::JoyFeedback::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 78 of file JoyFeedback.h.

◆ readBottle()

bool yarp::rosmsg::sensor_msgs::JoyFeedback::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 92 of file JoyFeedback.h.

◆ write()

bool yarp::rosmsg::sensor_msgs::JoyFeedback::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 155 of file JoyFeedback.h.

◆ writeBare()

bool yarp::rosmsg::sensor_msgs::JoyFeedback::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 119 of file JoyFeedback.h.

◆ writeBottle()

bool yarp::rosmsg::sensor_msgs::JoyFeedback::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 133 of file JoyFeedback.h.

Member Data Documentation

◆ id

std::uint8_t yarp::rosmsg::sensor_msgs::JoyFeedback::id

Definition at line 50 of file JoyFeedback.h.

◆ intensity

yarp::conf::float32_t yarp::rosmsg::sensor_msgs::JoyFeedback::intensity

Definition at line 51 of file JoyFeedback.h.

◆ type

std::uint8_t yarp::rosmsg::sensor_msgs::JoyFeedback::type

Definition at line 49 of file JoyFeedback.h.

◆ TYPE_BUZZER

const std::uint8_t yarp::rosmsg::sensor_msgs::JoyFeedback::TYPE_BUZZER = 2
static

Definition at line 48 of file JoyFeedback.h.

◆ TYPE_LED

const std::uint8_t yarp::rosmsg::sensor_msgs::JoyFeedback::TYPE_LED = 0
static

Definition at line 46 of file JoyFeedback.h.

◆ TYPE_RUMBLE

const std::uint8_t yarp::rosmsg::sensor_msgs::JoyFeedback::TYPE_RUMBLE = 1
static

Definition at line 47 of file JoyFeedback.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::sensor_msgs::JoyFeedback::typeChecksum = "f4dcd73460360d98f36e55ee7f2e46f1"
staticconstexpr

Definition at line 170 of file JoyFeedback.h.

◆ typeName

constexpr const char* yarp::rosmsg::sensor_msgs::JoyFeedback::typeName = "sensor_msgs/JoyFeedback"
staticconstexpr

Definition at line 167 of file JoyFeedback.h.

◆ typeText

constexpr const char* yarp::rosmsg::sensor_msgs::JoyFeedback::typeText
staticconstexpr
Initial value:
= "\
# Declare of the type of feedback\n\
uint8 TYPE_LED = 0\n\
uint8 TYPE_RUMBLE = 1\n\
uint8 TYPE_BUZZER = 2\n\
\n\
uint8 type\n\
\n\
# This will hold an id number for each type of each feedback.\n\
# Example, the first led would be id=0, the second would be id=1\n\
uint8 id\n\
\n\
# Intensity of the feedback, from 0.0 to 1.0, inclusive. If device is\n\
# actually binary, driver should treat 0<=x<0.5 as off, 0.5<=x<=1 as on.\n\
float32 intensity\n\
\n\
"

Definition at line 173 of file JoyFeedback.h.

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