VoyantFrameWrapper Class Reference

Wrapper for VoyantFrame messages. More...

#include <voyant_frame_wrapper.hpp>

Inheritance diagram for VoyantFrameWrapper:

Public Member Functions
	~VoyantFrameWrapper () override
	Destructor.
void	fromProto (VoyantFrame::Reader reader) override
	Update wrapper fields from a reader.
void	toProto (VoyantFrame::Builder &builder) const override
	Write wrapper fields to a builder.
void	debugString (std::ostream &os) const override
	Generate a debug string representation.
const VoyantHeaderWrapper &	header () const
	Get the common header.
VoyantHeaderWrapper &	headerMut ()
	Get mutable access to the common header.
const VoyantSdlConfigWrapper &	config () const
	Get the configuration.
VoyantSdlConfigWrapper &	configMut ()
	Get mutable access to the configuration.
const std::vector< PointDataWrapper > &	points () const
	Get the vector of points.
std::vector< PointDataWrapper > &	pointsMut ()
	Get mutable access to the vector of points.
virtual void	fromProto (typename T::Reader reader)=0
	Update wrapper fields from a Cap'n Proto reader.
virtual void	toProto (typename T::Builder &builder) const=0
	Write wrapper fields to a Cap'n Proto builder.
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.

Detailed Description

Wrapper for VoyantFrame messages.

Contains a complete frame of point data with a dynamic number of points, along with header information and configuration.

Constructor & Destructor Documentation

~VoyantFrameWrapper()

VoyantFrameWrapper::~VoyantFrameWrapper ( )

override

Destructor.

Member Function Documentation

config()

const VoyantSdlConfigWrapper & VoyantFrameWrapper::config ( ) const

inline

Get the configuration.

Returns

Const reference to the configuration

Note

The configuration field may be empty in the current implementation

configMut()

VoyantSdlConfigWrapper & VoyantFrameWrapper::configMut ( )

inline

Get mutable access to the configuration.

Returns

Reference to the configuration

Note

The configuration field may be empty in the current implementation

debugString()

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

overridevirtual

Generate a debug string representation.

Parameters

os	The output stream to write to

Implements CapnpWrapper< VoyantFrame >.

fromBuffer()

void CapnpWrapper< VoyantFrame >::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() [1/2]

virtual void CapnpWrapper< VoyantFrame >::fromProto ( typename T::Reader  reader )

pure virtualinherited

Update wrapper fields from a Cap'n Proto reader.

Parameters

reader

The Cap'n Proto reader to extract data from

fromProto() [2/2]

void VoyantFrameWrapper::fromProto ( VoyantFrame::Reader  reader )

override

Update wrapper fields from a reader.

Parameters

reader

The VoyantFrame reader to extract data from

header()

const VoyantHeaderWrapper & VoyantFrameWrapper::header ( ) const

inline

Get the common header.

Returns

Const reference to the Voyant header

headerMut()

VoyantHeaderWrapper & VoyantFrameWrapper::headerMut ( )

inline

Get mutable access to the common header.

Returns

Reference to the Voyant header

points()

const std::vector< PointDataWrapper > & VoyantFrameWrapper::points ( ) const

inline

Get the vector of points.

Returns

Const reference to the vector of point data

pointsMut()

std::vector< PointDataWrapper > & VoyantFrameWrapper::pointsMut ( )

inline

Get mutable access to the vector of points.

Returns

Reference to the vector of point data

toBuffer()

size_t CapnpWrapper< VoyantFrame >::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() [1/2]

virtual void CapnpWrapper< VoyantFrame >::toProto ( typename T::Builder &  builder ) const

pure virtualinherited

Write wrapper fields to a Cap'n Proto builder.

Parameters

builder

The Cap'n Proto builder to write data to

toProto() [2/2]

void VoyantFrameWrapper::toProto ( VoyantFrame::Builder &  builder ) const

override

Write wrapper fields to a builder.

Parameters

builder

The VoyantFrame builder to write data to

---

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

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