yarp::rosmsg::geometry_msgs::Quaternion Class Reference

#include <yarp/rosmsg/geometry_msgs/Quaternion.h>

Inheritance diagram for yarp::rosmsg::geometry_msgs::Quaternion:

Public Types
typedef yarp::os::idl::BareStyle< yarp::rosmsg::geometry_msgs::Quaternion >	rosStyle
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::geometry_msgs::Quaternion >	bottleStyle

Public Member Functions
	Quaternion ()
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::conf::float64_t	x
yarp::conf::float64_t	y
yarp::conf::float64_t	z
yarp::conf::float64_t	w

Static Public Attributes
static constexpr const char *	typeName = "geometry_msgs/Quaternion"
static constexpr const char *	typeChecksum = "a779879fadf0160734f906b8c19c7004"
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 34 of file Quaternion.h.

Member Typedef Documentation

bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::geometry_msgs::Quaternion> yarp::rosmsg::geometry_msgs::Quaternion::bottleStyle

Definition at line 164 of file Quaternion.h.

rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::geometry_msgs::Quaternion> yarp::rosmsg::geometry_msgs::Quaternion::rosStyle

Definition at line 163 of file Quaternion.h.

Constructor & Destructor Documentation

Quaternion()

yarp::rosmsg::geometry_msgs::Quaternion::Quaternion ( )

inline

Definition at line 42 of file Quaternion.h.

Member Function Documentation

clear()

void yarp::rosmsg::geometry_msgs::Quaternion::clear ( )

inline

Definition at line 50 of file Quaternion.h.

getType()

yarp::os::Type yarp::rosmsg::geometry_msgs::Quaternion::getType ( ) const

inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 182 of file Quaternion.h.

read()

bool yarp::rosmsg::geometry_msgs::Quaternion::read ( yarp::os::ConnectionReader &  reader )

inlineoverridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 106 of file Quaternion.h.

readBare()

bool yarp::rosmsg::geometry_msgs::Quaternion::readBare ( yarp::os::ConnectionReader &  connection )

inlineoverridevirtual

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

Definition at line 65 of file Quaternion.h.

readBottle()

bool yarp::rosmsg::geometry_msgs::Quaternion::readBottle ( yarp::os::ConnectionReader &  connection )

inlineoverridevirtual

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

Definition at line 82 of file Quaternion.h.

write()

bool yarp::rosmsg::geometry_msgs::Quaternion::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

writer

an 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 Quaternion.h.

writeBare()

bool yarp::rosmsg::geometry_msgs::Quaternion::writeBare ( yarp::os::ConnectionWriter &  connection ) const

inlineoverridevirtual

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

Definition at line 112 of file Quaternion.h.

writeBottle()

bool yarp::rosmsg::geometry_msgs::Quaternion::writeBottle ( yarp::os::ConnectionWriter &  connection ) const

inlineoverridevirtual

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

Definition at line 129 of file Quaternion.h.

Member Data Documentation

typeChecksum

constexpr const char* yarp::rosmsg::geometry_msgs::Quaternion::typeChecksum = "a779879fadf0160734f906b8c19c7004"

staticconstexpr

Definition at line 170 of file Quaternion.h.

typeName

constexpr const char* yarp::rosmsg::geometry_msgs::Quaternion::typeName = "geometry_msgs/Quaternion"

staticconstexpr

Definition at line 167 of file Quaternion.h.

typeText

constexpr const char* yarp::rosmsg::geometry_msgs::Quaternion::typeText

staticconstexpr

Initial value:

= "\
# This represents an orientation in free space in quaternion form.\n\
\n\
float64 x\n\
float64 y\n\
float64 z\n\
float64 w\n\
"

Definition at line 173 of file Quaternion.h.

w

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::w

Definition at line 40 of file Quaternion.h.

x

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::x

Definition at line 37 of file Quaternion.h.

y

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::y

Definition at line 38 of file Quaternion.h.

z

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::z

Definition at line 39 of file Quaternion.h.

---

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

• src/libYARP_rosmsg/src/idl_generated_code/yarp/rosmsg/geometry_msgs/Quaternion.h