std_msgs::msg::Header Class Reference

Detailed Description

This class represents the structure Header defined by the user in the IDL file.

Definition at line 5 of file Header.idl.

import <Header.idl;

Public Member Functions
eProsima_user_DllExport	Header ()
	Default constructor.
eProsima_user_DllExport	~Header ()
	Default destructor.
eProsima_user_DllExport	Header (const Header &x)
	Copy constructor.
eProsima_user_DllExport	Header (Header &&x) noexcept
	Move constructor.
eProsima_user_DllExport Header &	operator= (const Header &x)
	Copy assignment.
eProsima_user_DllExport Header &	operator= (Header &&x) noexcept
	Move assignment.
eProsima_user_DllExport bool	operator== (const Header &x) const
	Comparison operator.
eProsima_user_DllExport bool	operator!= (const Header &x) const
	Comparison operator.
eProsima_user_DllExport void	stamp (const builtin_interfaces::msg::Time &_stamp)
	This function copies the value in member stamp.
eProsima_user_DllExport void	stamp (builtin_interfaces::msg::Time &&_stamp)
	This function moves the value in member stamp.
eProsima_user_DllExport const builtin_interfaces::msg::Time &	stamp () const
	This function returns a constant reference to member stamp.
eProsima_user_DllExport builtin_interfaces::msg::Time &	stamp ()
	This function returns a reference to member stamp.
eProsima_user_DllExport void	frame_id (const std::string &_frame_id)
	This function copies the value in member frame_id.
eProsima_user_DllExport void	frame_id (std::string &&_frame_id)
	This function moves the value in member frame_id.
eProsima_user_DllExport const std::string &	frame_id () const
	This function returns a constant reference to member frame_id.
eProsima_user_DllExport std::string &	frame_id ()
	This function returns a reference to member frame_id.

Public Attributes
builtin_interfaces::msg::Time	stamp
string	frame_id

Private Attributes
builtin_interfaces::msg::Time	m_stamp
std::string	m_frame_id

Constructor & Destructor Documentation

Header() [1/3]

eProsima_user_DllExport std_msgs::msg::Header::Header ( )

inline

Default constructor.

Definition at line 69 of file Header.hpp.

~Header()

eProsima_user_DllExport std_msgs::msg::Header::~Header ( )

inline

Default destructor.

Definition at line 76 of file Header.hpp.

Header() [2/3]

eProsima_user_DllExport std_msgs::msg::Header::Header ( const Header &  x )

inline

Copy constructor.

Parameters

x	Reference to the object Header that will be copied.

Definition at line 84 of file Header.hpp.

Header() [3/3]

eProsima_user_DllExport std_msgs::msg::Header::Header ( Header &&  x )

inlinenoexcept

Move constructor.

Parameters

x	Reference to the object Header that will be copied.

Definition at line 97 of file Header.hpp.

Member Function Documentation

frame_id() [1/4]

eProsima_user_DllExport std::string & std_msgs::msg::Header::frame_id ( )

inline

This function returns a reference to member frame_id.

Returns

Reference to member frame_id

Definition at line 225 of file Header.hpp.

frame_id() [2/4]

eProsima_user_DllExport const std::string & std_msgs::msg::Header::frame_id ( ) const

inline

This function returns a constant reference to member frame_id.

Returns

Constant reference to member frame_id

Definition at line 216 of file Header.hpp.

frame_id() [3/4]

eProsima_user_DllExport void std_msgs::msg::Header::frame_id ( const std::string &  _frame_id )

inline

This function copies the value in member frame_id.

Parameters

_frame_id

New value to be copied in member frame_id

Definition at line 196 of file Header.hpp.

frame_id() [4/4]

eProsima_user_DllExport void std_msgs::msg::Header::frame_id ( std::string &&  _frame_id )

inline

This function moves the value in member frame_id.

Parameters

_frame_id

New value to be moved in member frame_id

Definition at line 206 of file Header.hpp.

operator!=()

eProsima_user_DllExport bool std_msgs::msg::Header::operator!= ( const Header &  x ) const

inline

Comparison operator.

Parameters

x	Header object to compare.

Definition at line 147 of file Header.hpp.

operator=() [1/2]

eProsima_user_DllExport Header & std_msgs::msg::Header::operator= ( const Header &  x )

inline

Copy assignment.

Parameters

x	Reference to the object Header that will be copied.

Definition at line 108 of file Header.hpp.

operator=() [2/2]

eProsima_user_DllExport Header & std_msgs::msg::Header::operator= ( Header &&  x )

inlinenoexcept

Move assignment.

Parameters

x	Reference to the object Header that will be copied.

Definition at line 123 of file Header.hpp.

operator==()

eProsima_user_DllExport bool std_msgs::msg::Header::operator== ( const Header &  x ) const

inline

Comparison operator.

Parameters

x	Header object to compare.

Definition at line 136 of file Header.hpp.

stamp() [1/4]

eProsima_user_DllExport builtin_interfaces::msg::Time & std_msgs::msg::Header::stamp ( )

inline

This function returns a reference to member stamp.

Returns

Reference to member stamp

Definition at line 186 of file Header.hpp.

stamp() [2/4]

eProsima_user_DllExport const builtin_interfaces::msg::Time & std_msgs::msg::Header::stamp ( ) const

inline

This function returns a constant reference to member stamp.

Returns

Constant reference to member stamp

Definition at line 177 of file Header.hpp.

stamp() [3/4]

eProsima_user_DllExport void std_msgs::msg::Header::stamp ( builtin_interfaces::msg::Time &&  _stamp )

inline

This function moves the value in member stamp.

Parameters

_stamp

New value to be moved in member stamp

Definition at line 167 of file Header.hpp.

stamp() [4/4]

eProsima_user_DllExport void std_msgs::msg::Header::stamp ( const builtin_interfaces::msg::Time &  _stamp )

inline

This function copies the value in member stamp.

Parameters

_stamp

New value to be copied in member stamp

Definition at line 157 of file Header.hpp.

Member Data Documentation

frame_id

string std_msgs::msg::Header::frame_id

Definition at line 7 of file Header.idl.

m_frame_id

std::string std_msgs::msg::Header::m_frame_id

private

Definition at line 235 of file Header.hpp.

m_stamp

builtin_interfaces::msg::Time std_msgs::msg::Header::m_stamp

private

Definition at line 234 of file Header.hpp.

stamp

builtin_interfaces::msg::Time std_msgs::msg::Header::stamp

Definition at line 6 of file Header.idl.

---

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

• Header.idl
• Header.hpp