YARP
Yet Another Robot Platform
yarp::rosmsg::sensor_msgs::MagneticField Class Reference

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

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

Detailed Description

Definition at line 51 of file MagneticField.h.

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::sensor_msgs::MagneticFieldrosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::sensor_msgs::MagneticFieldbottleStyle
 

Public Member Functions

 MagneticField ()
 
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...
 
std::string getTypeText () const
 
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
 

Static Public Member Functions

static std::string typeText ()
 
- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading. More...
 

Public Attributes

yarp::rosmsg::std_msgs::Header header
 
yarp::rosmsg::geometry_msgs::Vector3 magnetic_field
 
std::vector< yarp::conf::float64_tmagnetic_field_covariance
 

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ MagneticField()

yarp::rosmsg::sensor_msgs::MagneticField::MagneticField ( )
inline

Definition at line 58 of file MagneticField.h.

Member Function Documentation

◆ clear()

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

Definition at line 66 of file MagneticField.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 237 of file MagneticField.h.

◆ getTypeText()

std::string yarp::rosmsg::sensor_msgs::MagneticField::getTypeText ( ) const
inline

Definition at line 231 of file MagneticField.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 79 of file MagneticField.h.

◆ readBottle()

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

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

Definition at line 101 of file MagneticField.h.

◆ typeText()

static std::string yarp::rosmsg::sensor_msgs::MagneticField::typeText ( )
inlinestatic

Definition at line 198 of file MagneticField.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 139 of file MagneticField.h.

◆ writeBottle()

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

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

Definition at line 159 of file MagneticField.h.

Member Data Documentation

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::sensor_msgs::MagneticField::header

Definition at line 54 of file MagneticField.h.

◆ magnetic_field

yarp::rosmsg::geometry_msgs::Vector3 yarp::rosmsg::sensor_msgs::MagneticField::magnetic_field

Definition at line 55 of file MagneticField.h.

◆ magnetic_field_covariance

std::vector<yarp::conf::float64_t> yarp::rosmsg::sensor_msgs::MagneticField::magnetic_field_covariance

Definition at line 56 of file MagneticField.h.


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