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

#include <yarp/rosmsg/std_msgs/MultiArrayLayout.h>

+ Inheritance diagram for yarp::rosmsg::std_msgs::MultiArrayLayout:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::std_msgs::MultiArrayLayout > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::std_msgs::MultiArrayLayout > bottleStyle
 

Public Member Functions

 MultiArrayLayout ()
 
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::vector< yarp::rosmsg::std_msgs::MultiArrayDimension > dim
 
std::uint32_t data_offset
 

Static Public Attributes

static constexpr const char * typeName = "std_msgs/MultiArrayLayout"
 
static constexpr const char * typeChecksum = "0fed2a11c13e11c5571b4e2a995a91a3"
 
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 55 of file MultiArrayLayout.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::std_msgs::MultiArrayLayout> yarp::rosmsg::std_msgs::MultiArrayLayout::bottleStyle

Definition at line 174 of file MultiArrayLayout.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::std_msgs::MultiArrayLayout> yarp::rosmsg::std_msgs::MultiArrayLayout::rosStyle

Definition at line 173 of file MultiArrayLayout.h.

Constructor & Destructor Documentation

◆ MultiArrayLayout()

yarp::rosmsg::std_msgs::MultiArrayLayout::MultiArrayLayout ( )
inline

Definition at line 61 of file MultiArrayLayout.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::std_msgs::MultiArrayLayout::clear ( )
inline

Definition at line 67 of file MultiArrayLayout.h.

◆ getType()

yarp::os::Type yarp::rosmsg::std_msgs::MultiArrayLayout::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 218 of file MultiArrayLayout.h.

◆ read()

bool yarp::rosmsg::std_msgs::MultiArrayLayout::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 120 of file MultiArrayLayout.h.

◆ readBare()

bool yarp::rosmsg::std_msgs::MultiArrayLayout::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 76 of file MultiArrayLayout.h.

◆ readBottle()

bool yarp::rosmsg::std_msgs::MultiArrayLayout::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 93 of file MultiArrayLayout.h.

◆ write()

bool yarp::rosmsg::std_msgs::MultiArrayLayout::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 165 of file MultiArrayLayout.h.

◆ writeBare()

bool yarp::rosmsg::std_msgs::MultiArrayLayout::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 126 of file MultiArrayLayout.h.

◆ writeBottle()

bool yarp::rosmsg::std_msgs::MultiArrayLayout::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 142 of file MultiArrayLayout.h.

Member Data Documentation

◆ data_offset

std::uint32_t yarp::rosmsg::std_msgs::MultiArrayLayout::data_offset

Definition at line 59 of file MultiArrayLayout.h.

◆ dim

std::vector<yarp::rosmsg::std_msgs::MultiArrayDimension> yarp::rosmsg::std_msgs::MultiArrayLayout::dim

Definition at line 58 of file MultiArrayLayout.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::std_msgs::MultiArrayLayout::typeChecksum = "0fed2a11c13e11c5571b4e2a995a91a3"
staticconstexpr

Definition at line 180 of file MultiArrayLayout.h.

◆ typeName

constexpr const char* yarp::rosmsg::std_msgs::MultiArrayLayout::typeName = "std_msgs/MultiArrayLayout"
staticconstexpr

Definition at line 177 of file MultiArrayLayout.h.

◆ typeText

constexpr const char* yarp::rosmsg::std_msgs::MultiArrayLayout::typeText
staticconstexpr

Definition at line 183 of file MultiArrayLayout.h.

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