camcom::common::ParameterMetadata Struct Reference

Parameter metadata containing constraints and descriptive information. More...

#include <parameterMetadata.hpp>

Public Member Functions
bool	HasData () const
	Check if any metadata is populated.
std::string	ToString () const
	Convert to string for debugging.

Public Attributes
std::string	camera_name
	Original camera-native parameter name (before mapping to generic name)
std::optional< double >	min
	Minimum value (for numeric types)
std::optional< double >	max
	Maximum value (for numeric types)
std::optional< double >	increment
	Increment/step size (for slider UI controls)
std::vector< std::string >	allowed
	Allowed values (for enumeration types)
std::string	unit
	Unit of measurement (e.g., "microseconds", "Hz", "dB")
std::string	description
	Human-readable description of the parameter.
bool	readable {true}
	Whether the parameter can be read.
bool	writable {true}
	Whether the parameter can be written.
std::optional< Value >	default_value
	Default value (if known)

Detailed Description

Parameter metadata containing constraints and descriptive information.

This struct holds optional metadata that adapters can populate when scanning parameters from the camera. Not all fields are available for all protocols:

• GenICam adapters can populate all fields from the camera's XML description
• Simpler protocols may only provide readable/writable flags
• Config files can override or supplement adapter-provided metadata

All fields are optional or have sensible defaults. Adapters populate what they can; the rest stays empty/default.

Member Function Documentation

HasData()

bool camcom::common::ParameterMetadata::HasData ( ) const

inline

Check if any metadata is populated.

ToString()

std::string camcom::common::ParameterMetadata::ToString

(

)

const

Convert to string for debugging.

Member Data Documentation

allowed

std::vector<std::string> camcom::common::ParameterMetadata::allowed

Allowed values (for enumeration types)

camera_name

std::string camcom::common::ParameterMetadata::camera_name

Original camera-native parameter name (before mapping to generic name)

default_value

std::optional<Value> camcom::common::ParameterMetadata::default_value

Default value (if known)

description

std::string camcom::common::ParameterMetadata::description

Human-readable description of the parameter.

increment

std::optional<double> camcom::common::ParameterMetadata::increment

Increment/step size (for slider UI controls)

max

std::optional<double> camcom::common::ParameterMetadata::max

Maximum value (for numeric types)

min

std::optional<double> camcom::common::ParameterMetadata::min

Minimum value (for numeric types)

readable

bool camcom::common::ParameterMetadata::readable {true}

Whether the parameter can be read.

unit

std::string camcom::common::ParameterMetadata::unit

Unit of measurement (e.g., "microseconds", "Hz", "dB")

writable

bool camcom::common::ParameterMetadata::writable {true}

Whether the parameter can be written.

---

The documentation for this struct was generated from the following files:

• common/src/include/camcom/common/parameterMetadata.hpp
• common/src/parameter.cpp