camcom::common Namespace Reference

Classes
struct	AcquisitionState
	Current acquisition state information. More...
class	AdapterBase
struct	BasicParamNames
struct	BasicParams
	Standardized basic camera parameters in common units. More...
struct	CheckResult
	Connection health check result. More...
class	Error
class	FrameGenerator
	Generates synthetic image frames for simulated cameras. More...
class	FrameInfo
struct	NativeDocument
	Native parameter document from camera (protocol-specific) More...
class	Parameter
struct	ParameterMetadata
	Parameter metadata containing constraints and descriptive information. More...
struct	PatternConfig
	Configuration for frame pattern generation. More...
class	Queue
class	ReceiveCfg
class	TestAdapter

Typedefs
using	DataType = ifw::fnd::datatype::DataType
using	Value = std::variant<int, float, double, std::string, bool>

Enumerations
enum class	AcqMode { Inactive , Continuous , Finite }
	Acquisition mode states. More...
enum class	PatternType {   Gaussian , MultiGaussian , Flat , Grid ,   Gradient , Ring , Checkerboard , Noise ,   Grating }
enum class	GradientDirection { Horizontal , Vertical , Radial }
enum class	NoiseDistribution { Gaussian , Poisson , Uniform }

Functions
std::string	ExpandPath (const std::string &path)
	Expand environment variables ($VAR, ${VAR}) and ~ in a path string.
std::string	FindFile (const std::string &path, const std::string &referrer)
size_t	bytesPerPixelForType (DataType type)
	Get bytes per pixel for a given DataType.
PatternType	parsePatternType (const std::string &type_str)
	Parse a pattern type string (case-insensitive) to PatternType enum.
GradientDirection	parseGradientDirection (const std::string &dir_str)
	Parse a gradient direction string to GradientDirection enum.
NoiseDistribution	parseNoiseDistribution (const std::string &dist_str)
	Parse a noise distribution string to NoiseDistribution enum.
std::string	DataTypeString (DataType type)
template<>
void	Parameter::Store< std::string > (const std::string &name, const std::string &value)
std::chrono::time_point< std::chrono::system_clock >	TimeNow ()
std::string	IsoTimestampNow (std::chrono::system_clock::time_point time=std::chrono::system_clock::now())
std::string	ProcName ()
std::string	TrimString (const std::string &str)
std::string	ResolveHostAddress ()
void	PrintCallStack (int skip=1, int max_frames=64)
std::string_view	ValueTypeString (const Value &v) noexcept

Variables
const std::string	MOD_NAME {"camcom"}

Typedef Documentation

DataType

using camcom::common::DataType = ifw::fnd::datatype::DataType

The CamCom data type IS the IFW (ifw-fnd) data type — single source of truth. Alias kept so existing call sites read as common::DataType.

Value

using camcom::common::Value = std::variant<int, float, double, std::string, bool>

Enumeration Type Documentation

AcqMode

enum class camcom::common::AcqMode

strong

Acquisition mode states.

Enumerator
Inactive	No acquisition in progress.
Continuous	Continuous acquisition (no frame limit)
Finite	Finite acquisition (specific frame count)

GradientDirection

enum class camcom::common::GradientDirection

strong

Enumerator
Horizontal
Vertical
Radial

NoiseDistribution

enum class camcom::common::NoiseDistribution

strong

Enumerator
Gaussian
Poisson
Uniform

PatternType

enum class camcom::common::PatternType

strong

Enumerator
Gaussian
MultiGaussian
Flat
Grid
Gradient
Ring
Checkerboard
Noise
Grating

Function Documentation

bytesPerPixelForType()

size_t camcom::common::bytesPerPixelForType

(

DataType

type

)

Get bytes per pixel for a given DataType.

DataTypeString()

std::string camcom::common::DataTypeString ( DataType type )

inline

Enum -> string (e.g. DataType::INT32 -> "Int32"). Forwards to ifw-fnd. Returns "Invalid" for unmapped values (ifw-fnd GetDataTypeStr2 semantics).

ExpandPath()

std::string camcom::common::ExpandPath

(

const std::string &

path

)

Expand environment variables ($VAR, ${VAR}) and ~ in a path string.

FindFile()

std::string camcom::common::FindFile	(	const std::string &	path,
		const std::string &	referrer = "" )

Locate a file using the CamCom resolution rules.

Parameters

path	File path — relative or absolute, may contain $ENV or ~.
referrer	Optional absolute path of the file that referenced this one (enables relative-to-parent resolution as fallback).

Returns

Resolved absolute path, or empty string if not found.

Resolution order:

• If path is absolute after env expansion → use directly if it exists.
• If path is relative:
  1. Search CFGPATH entries (each entry + "/" + path).
  2. If CFGPATH is unset, search $INTROOT/resource and $PREFIX/resource.
  3. If referrer is given, try referrer's directory + path.
• Returns "" if the file cannot be found anywhere.

IsoTimestampNow()

std::string camcom::common::IsoTimestampNow

(

std::chrono::system_clock::time_point

time = std::chrono::system_clock::now()

)

Parameter::Store< std::string >()

template<>

void camcom::common::Parameter::Store< std::string > ( const std::string & name, const std::string & value )

inline

parseGradientDirection()

GradientDirection camcom::common::parseGradientDirection

(

const std::string &

s

)

Parse a gradient direction string to GradientDirection enum.

parseNoiseDistribution()

NoiseDistribution camcom::common::parseNoiseDistribution

(

const std::string &

s

)

Parse a noise distribution string to NoiseDistribution enum.

parsePatternType()

PatternType camcom::common::parsePatternType

(

const std::string &

s

)

Parse a pattern type string (case-insensitive) to PatternType enum.

PrintCallStack()

void camcom::common::PrintCallStack ( int skip = 1, int max_frames = 64 )

inline

ProcName()

std::string camcom::common::ProcName

(

)

ResolveHostAddress()

std::string camcom::common::ResolveHostAddress

(

)

TimeNow()

std::chrono::time_point< std::chrono::system_clock > camcom::common::TimeNow

(

)

TrimString()

std::string camcom::common::TrimString

(

const std::string &

str

)

ValueTypeString()

std::string_view camcom::common::ValueTypeString ( const Value & v )

inlinenoexcept

Variable Documentation

MOD_NAME

const std::string camcom::common::MOD_NAME {"camcom"}