Holds the result of a query for messages. More...

#include <Batch.hh>

Public Types
using	iterator = MsgIter
	typedef for prettiness More...

Public Member Functions
	Batch ()
	Default constructor. More...

	Batch (Batch &&_old)
	move constructor More...

	~Batch ()
	destructor More...

iterator	begin ()
	Iterator to first message in batch. More...

iterator	end ()
	Iterator to one past the last message in a batch. More...

Batch &	operator= (Batch &&_other)
	Move assignement operator. More...

Detailed Description

Holds the result of a query for messages.

Member Typedef Documentation

◆ iterator

using iterator = MsgIter

typedef for prettiness

Constructor & Destructor Documentation

◆ Batch() [1/2]

Batch ( )

Default constructor.

◆ Batch() [2/2]

Batch ( Batch && _old )

move constructor

Parameters

[in] _old the instance being moved into this one

◆ ~Batch()

~Batch ( )

destructor

Member Function Documentation

◆ begin()

iterator begin ( )

Iterator to first message in batch.

Remarks: the lowercase function name is required to support range-based for loops

Returns: an iterator to the start of the messages

◆ end()

iterator end ( )

Iterator to one past the last message in a batch.

Remarks: the lowercase function name is required to support range-based for loops

Returns: an iterator that is not equal to any iterator that points to a valid message

◆ operator=()

Batch& operator= ( Batch && _other )

Move assignement operator.

Parameters

[in] _other the new Batch replacing the current one

Returns: The updated Batch instance.

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

gz/transport/log/Batch.hh

Gazebo Transport

API Reference

Public Types

Public Member Functions