CarbonConfig Class Reference

Configuration for the Carbon LiDAR pipeline. More...

#include <carbon_config.hpp>

Public Member Functions
	CarbonConfig ()
	~CarbonConfig ()
	CarbonConfig (const CarbonConfig &)=delete
CarbonConfig &	operator= (const CarbonConfig &)=delete
	CarbonConfig (CarbonConfig &&)=delete
CarbonConfig &	operator= (CarbonConfig &&)=delete
CarbonConfig &	setBindAddr (const std::string &v)
CarbonConfig &	setGroupAddr (const std::string &v)
CarbonConfig &	setInterfaceAddr (const std::string &v)
CarbonConfig &	setUseMsgTimestamp (bool v)
CarbonConfig &	setBatchSize (size_t v)
CarbonConfig &	setRecvBufferSize (size_t v)
CarbonConfig &	setReceiverChannelCapacity (size_t v)
CarbonConfig &	setPfa (float v)
CarbonConfig &	setVelCorrFactor (float v)
CarbonConfig &	setBandwidthHz (float v)
CarbonConfig &	setElevationFovDeg (float v)
CarbonConfig &	setKeepInvalidPoints (bool v)
CarbonConfig &	setRangeMin (float v)
CarbonConfig &	setRangeMax (float v)
CarbonConfig &	setDopplerMin (float v)
CarbonConfig &	setDopplerMax (float v)
CarbonConfig &	setAzimuthDegMin (float v)
CarbonConfig &	setAzimuthDegMax (float v)
CarbonConfig &	setElevationDegMin (float v)
CarbonConfig &	setElevationDegMax (float v)
CarbonConfig &	setSpatialRangeThreshold (float v)
CarbonConfig &	setSpatialDopplerThreshold (float v)
CarbonConfig &	setSpatialMinNeighbors (uint8_t v)
CarbonConfig &	setInterpRangeThreshold (float v)
CarbonConfig &	setInterpDopplerThreshold (float v)
CarbonConfig &	setMissingElevations (const std::vector< uint8_t > &elevations)
CarbonConfig &	setMirrorPeaks (bool v)
CarbonConfig &	setMirrorGroupAddr (const std::string &v)
CarbonConfig &	setMirrorBindAddr (const std::string &v)
CarbonConfig &	setEvalMode (bool v)
CarbonConfig &	setReportDir (const std::string &v)

Static Public Member Functions
static std::unique_ptr< CarbonConfig >	fromJson (const std::string &path)

Private Member Functions
	CarbonConfig (CarbonConfigC *raw)

Private Attributes
CarbonConfigC *	cfg_

Friends
class	CarbonClient

Detailed Description

Configuration for the Carbon LiDAR pipeline.

Construct with default values, then use setters to override what you need. Pass to CarbonClient constructor — the client clones it internally.

Setters return *this for optional chaining:

CarbonConfig config;
config.setBindAddr("0.0.0.0:5678")
      .setGroupAddr("224.0.0.0")
      .setInterfaceAddr("0.0.0.0")
      .setRangeMax(50.0f);

Constructor & Destructor Documentation

CarbonConfig() [1/4]

CarbonConfig::CarbonConfig

(

)

~CarbonConfig()

CarbonConfig::~CarbonConfig

(

)

CarbonConfig() [2/4]

CarbonConfig::CarbonConfig ( const CarbonConfig &  )

delete

CarbonConfig() [3/4]

CarbonConfig::CarbonConfig ( CarbonConfig &&  )

delete

CarbonConfig() [4/4]

CarbonConfig::CarbonConfig ( CarbonConfigC *  raw )

explicitprivate

Member Function Documentation

fromJson()

static std::unique_ptr< CarbonConfig > CarbonConfig::fromJson ( const std::string &  path )

static

Load a CarbonConfig from a JSON file. Missing fields default to their standard values. Returns nullptr on failure (file not found, parse error, or validation failure).

auto config = CarbonConfig::fromJson("config.json");
if (!config) { // handle error }
CarbonClient client(*config);

operator=() [1/2]

CarbonConfig & CarbonConfig::operator= ( CarbonConfig &&  )

delete

operator=() [2/2]

CarbonConfig & CarbonConfig::operator= ( const CarbonConfig &  )

delete

setAzimuthDegMax()

CarbonConfig & CarbonConfig::setAzimuthDegMax

(

float

v

)

setAzimuthDegMin()

CarbonConfig & CarbonConfig::setAzimuthDegMin

(

float

v

)

setBandwidthHz()

CarbonConfig & CarbonConfig::setBandwidthHz

(

float

v

)

setBatchSize()

CarbonConfig & CarbonConfig::setBatchSize

(

size_t

v

)

setBindAddr()

CarbonConfig & CarbonConfig::setBindAddr

(

const std::string &

v

)

setDopplerMax()

CarbonConfig & CarbonConfig::setDopplerMax

(

float

v

)

setDopplerMin()

CarbonConfig & CarbonConfig::setDopplerMin

(

float

v

)

setElevationDegMax()

CarbonConfig & CarbonConfig::setElevationDegMax

(

float

v

)

setElevationDegMin()

CarbonConfig & CarbonConfig::setElevationDegMin

(

float

v

)

setElevationFovDeg()

CarbonConfig & CarbonConfig::setElevationFovDeg

(

float

v

)

setEvalMode()

CarbonConfig & CarbonConfig::setEvalMode

(

bool

v

)

setGroupAddr()

CarbonConfig & CarbonConfig::setGroupAddr

(

const std::string &

v

)

setInterfaceAddr()

CarbonConfig & CarbonConfig::setInterfaceAddr

(

const std::string &

v

)

setInterpDopplerThreshold()

CarbonConfig & CarbonConfig::setInterpDopplerThreshold

(

float

v

)

setInterpRangeThreshold()

CarbonConfig & CarbonConfig::setInterpRangeThreshold

(

float

v

)

setKeepInvalidPoints()

CarbonConfig & CarbonConfig::setKeepInvalidPoints

(

bool

v

)

setMirrorBindAddr()

CarbonConfig & CarbonConfig::setMirrorBindAddr

(

const std::string &

v

)

setMirrorGroupAddr()

CarbonConfig & CarbonConfig::setMirrorGroupAddr

(

const std::string &

v

)

setMirrorPeaks()

CarbonConfig & CarbonConfig::setMirrorPeaks

(

bool

v

)

setMissingElevations()

CarbonConfig & CarbonConfig::setMissingElevations

(

const std::vector< uint8_t > &

elevations

)

setPfa()

CarbonConfig & CarbonConfig::setPfa

(

float

v

)

setRangeMax()

CarbonConfig & CarbonConfig::setRangeMax

(

float

v

)

setRangeMin()

CarbonConfig & CarbonConfig::setRangeMin

(

float

v

)

setReceiverChannelCapacity()

CarbonConfig & CarbonConfig::setReceiverChannelCapacity

(

size_t

v

)

setRecvBufferSize()

CarbonConfig & CarbonConfig::setRecvBufferSize

(

size_t

v

)

setReportDir()

CarbonConfig & CarbonConfig::setReportDir

(

const std::string &

v

)

setSpatialDopplerThreshold()

CarbonConfig & CarbonConfig::setSpatialDopplerThreshold

(

float

v

)

setSpatialMinNeighbors()

CarbonConfig & CarbonConfig::setSpatialMinNeighbors

(

uint8_t

v

)

setSpatialRangeThreshold()

CarbonConfig & CarbonConfig::setSpatialRangeThreshold

(

float

v

)

setUseMsgTimestamp()

CarbonConfig & CarbonConfig::setUseMsgTimestamp

(

bool

v

)

setVelCorrFactor()

CarbonConfig & CarbonConfig::setVelCorrFactor

(

float

v

)

Friends And Related Symbol Documentation

CarbonClient

friend class CarbonClient

friend

Member Data Documentation

cfg_

CarbonConfigC* CarbonConfig::cfg_

private

---

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

• /usr/include/voyant_api/carbon_config.hpp