PointGroupHeaderWrapper Class Reference

Wrapper for PointGroupHeader messages. More...

#include <point_group_header_wrapper.hpp>

Inheritance diagram for PointGroupHeaderWrapper:

Public Member Functions
	~PointGroupHeaderWrapper () override
	Destructor.
void	fromProto (PointGroupHeader::Reader reader) override
	Update wrapper fields from a reader.
void	toProto (PointGroupHeader::Builder &builder) const override
	Write wrapper fields to a builder.
void	debugString (std::ostream &os) const override
	Generate a debug string representation.
uint32_t	messageIndex () const
	Get message index counter.
void	setMessageIndex (uint32_t value)
	Set message index counter.
int32_t	nanosecsSinceFrame () const
	Get nanoseconds since frame start.
void	setNanosecsSinceFrame (int32_t value)
	Set nanoseconds since frame start.
uint32_t	validPoints () const
	Get valid points bitfield.
void	setValidPoints (uint32_t value)
	Set valid points bitfield.
void	fromBuffer (const uint8_t *buffer, size_t size)
	Update wrapper fields from a serialized message buffer.
size_t	toBuffer (uint8_t *buffer, size_t buffer_size) const
	Serialize this wrapper to a buffer using Cap'n Proto format.

Private Attributes
uint32_t	messageIndex_
	Counter incremented with each message.
int32_t	nanosecsSinceFrame_
	Nanoseconds since frame start.
uint32_t	validPoints_
	Bitfield describing valid points.

Detailed Description

Wrapper for PointGroupHeader messages.

Contains metadata about a point group including message indexing, timing information, and a bitfield describing which points are valid.

Constructor & Destructor Documentation

~PointGroupHeaderWrapper()

PointGroupHeaderWrapper::~PointGroupHeaderWrapper ( )

override

Destructor.

Member Function Documentation

debugString()

void PointGroupHeaderWrapper::debugString ( std::ostream & os ) const

overridevirtual

Generate a debug string representation.

Parameters

os	The output stream to write to

Implements CapnpWrapper< PointGroupHeader >.

fromBuffer()

void CapnpWrapper< PointGroupHeader >::fromBuffer ( const uint8_t * buffer, size_t size )

inlineinherited

Update wrapper fields from a serialized message buffer.

Parameters

buffer	Pointer to the buffer containing serialized Cap'n Proto data
size	Size of the buffer in bytes

fromProto()

void PointGroupHeaderWrapper::fromProto ( PointGroupHeader::Reader reader )

overridevirtual

Update wrapper fields from a reader.

Parameters

reader

The PointGroupHeader reader to extract data from

Implements CapnpWrapper< PointGroupHeader >.

messageIndex()

uint32_t PointGroupHeaderWrapper::messageIndex ( ) const

inline

Get message index counter.

Returns

Message index value

nanosecsSinceFrame()

int32_t PointGroupHeaderWrapper::nanosecsSinceFrame ( ) const

inline

Get nanoseconds since frame start.

Returns

Nanoseconds value

setMessageIndex()

void PointGroupHeaderWrapper::setMessageIndex ( uint32_t value )

inline

Set message index counter.

Parameters

value

Message index value

setNanosecsSinceFrame()

void PointGroupHeaderWrapper::setNanosecsSinceFrame ( int32_t value )

inline

Set nanoseconds since frame start.

Parameters

value

Nanoseconds value

setValidPoints()

void PointGroupHeaderWrapper::setValidPoints ( uint32_t value )

inline

Set valid points bitfield.

Parameters

value

32-bit field where each bit indicates if a corresponding point is valid

toBuffer()

size_t CapnpWrapper< PointGroupHeader >::toBuffer ( uint8_t * buffer, size_t buffer_size ) const

inlineinherited

Serialize this wrapper to a buffer using Cap'n Proto format.

Parameters

buffer	Pointer to the buffer to write serialized data to
buffer_size	Size of the buffer in bytes

Returns

The number of bytes written to the buffer

Exceptions

std::runtime_error

if the buffer is too small

toProto()

void PointGroupHeaderWrapper::toProto ( PointGroupHeader::Builder & builder ) const

overridevirtual

Write wrapper fields to a builder.

Parameters

builder

The PointGroupHeader builder to write data to

Implements CapnpWrapper< PointGroupHeader >.

validPoints()

uint32_t PointGroupHeaderWrapper::validPoints ( ) const

inline

Get valid points bitfield.

Returns

32-bit field where each bit indicates if a corresponding point is valid

Member Data Documentation

messageIndex_

uint32_t PointGroupHeaderWrapper::messageIndex_

private

Counter incremented with each message.

nanosecsSinceFrame_

int32_t PointGroupHeaderWrapper::nanosecsSinceFrame_

private

Nanoseconds since frame start.

validPoints_

uint32_t PointGroupHeaderWrapper::validPoints_

private

Bitfield describing valid points.

---

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

• /usr/include/voyant_api/proto_wrappers/point_group_header_wrapper.hpp