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

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

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

Public Types

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

Public Member Functions

 MultiArrayDimension ()
 
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::string label
 
std::uint32_t size
 
std::uint32_t stride
 

Static Public Attributes

static constexpr const char * typeName = "std_msgs/MultiArrayDimension"
 
static constexpr const char * typeChecksum = "4cd0c83a8683deae40ecdac60e53bfa8"
 
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 30 of file MultiArrayDimension.h.

Member Typedef Documentation

◆ bottleStyle

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

Definition at line 150 of file MultiArrayDimension.h.

◆ rosStyle

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

Definition at line 149 of file MultiArrayDimension.h.

Constructor & Destructor Documentation

◆ MultiArrayDimension()

yarp::rosmsg::std_msgs::MultiArrayDimension::MultiArrayDimension ( )
inline

Definition at line 37 of file MultiArrayDimension.h.

Member Function Documentation

◆ clear()

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

Definition at line 44 of file MultiArrayDimension.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 165 of file MultiArrayDimension.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 56 of file MultiArrayDimension.h.

◆ readBottle()

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

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

Definition at line 74 of file MultiArrayDimension.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 103 of file MultiArrayDimension.h.

◆ writeBottle()

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

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

Definition at line 118 of file MultiArrayDimension.h.

Member Data Documentation

◆ label

std::string yarp::rosmsg::std_msgs::MultiArrayDimension::label

Definition at line 33 of file MultiArrayDimension.h.

◆ size

std::uint32_t yarp::rosmsg::std_msgs::MultiArrayDimension::size

Definition at line 34 of file MultiArrayDimension.h.

◆ stride

std::uint32_t yarp::rosmsg::std_msgs::MultiArrayDimension::stride

Definition at line 35 of file MultiArrayDimension.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::std_msgs::MultiArrayDimension::typeChecksum = "4cd0c83a8683deae40ecdac60e53bfa8"
staticconstexpr

Definition at line 156 of file MultiArrayDimension.h.

◆ typeName

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

Definition at line 153 of file MultiArrayDimension.h.

◆ typeText

constexpr const char* yarp::rosmsg::std_msgs::MultiArrayDimension::typeText
staticconstexpr
Initial value:
= "\
string label # label of given dimension\n\
uint32 size # size of given dimension (in type units)\n\
uint32 stride # stride of given dimension\n\
"

Definition at line 159 of file MultiArrayDimension.h.

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