VoyantSdlConfigWrapper Class Reference

Wrapper for VoyantSdlConfig messages. More...

#include <voyant_sdl_config_wrapper.hpp>

Inheritance diagram for VoyantSdlConfigWrapper:

Public Member Functions
	~VoyantSdlConfigWrapper () override
	Destructor.
void	fromProto (VoyantSdlConfig::Reader reader) override
	Update wrapper fields from a reader.
void	toProto (VoyantSdlConfig::Builder &builder) const override
	Write wrapper fields to a builder.
void	debugString (std::ostream &os) const override
	Generate a debug string representation.
const std::string &	fullConfig () const
	Get the full configuration string.
void	setFullConfig (std::string config)
	Set the full configuration string.
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 VoyantSdlConfig messages.

Manages configuration data for Voyant LiDAR systems. Currently stores configuration as a JSON string, potentially to be replaced with a more structured format in the future.

Constructor & Destructor Documentation

~VoyantSdlConfigWrapper()

VoyantSdlConfigWrapper::~VoyantSdlConfigWrapper ( )

override

Destructor.

Member Function Documentation

debugString()

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

overridevirtual

Generate a debug string representation.

Parameters

os	The output stream to write to

Implements CapnpWrapper< VoyantSdlConfig >.

fromBuffer()

void CapnpWrapper< VoyantSdlConfig >::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< VoyantSdlConfig >::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 VoyantSdlConfigWrapper::fromProto ( VoyantSdlConfig::Reader  reader )

override

Update wrapper fields from a reader.

Parameters

reader

The VoyantSdlConfig reader to extract data from

fullConfig()

const std::string & VoyantSdlConfigWrapper::fullConfig ( ) const

inline

Get the full configuration string.

Returns

Const reference to the JSON configuration

setFullConfig()

void VoyantSdlConfigWrapper::setFullConfig ( std::string  config )

inline

Set the full configuration string.

Parameters

config

JSON configuration string

toBuffer()

size_t CapnpWrapper< VoyantSdlConfig >::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< VoyantSdlConfig >::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 VoyantSdlConfigWrapper::toProto ( VoyantSdlConfig::Builder &  builder ) const

override

Write wrapper fields to a builder.

Parameters

builder

The VoyantSdlConfig builder to write data to

---

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

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