Class CameraFamily

CBase class used to identify camera families, e.g. xiQ, xiSpec, etc.

#include <camera.h>

Inherited by the following classes: XiCFamily, XiQFamily, XiSpecFamily

Public Attributes

Type	Name
std::shared_ptr< XiAPIWrapper >	m_apiWrapper
QMap< QString, float >	m_cameraTemperature = `/* multi line expression /` The camera temperature data structure.*

Public Functions

Type	Name
	CameraFamily (HANDLE * handle)
QMap< QString, float >	GetCameraTemperature ()
virtual void	UpdateCameraTemperature () This function updates the recorded temperature of a camera.
virtual	~CameraFamily () = default

Protected Attributes

Type	Name
HANDLE *	m_cameraHandle
boost::mutex	m_mutexCameraTemperature

Public Attributes Documentation

variable m_apiWrapper

std::shared_ptr<XiAPIWrapper> CameraFamily::m_apiWrapper;

Wrapper to xiAPI, useful for mocking the aPI during testing

variable m_cameraTemperature

The camera temperature data structure.

QMap<QString, float> CameraFamily::m_cameraTemperature;

This structure stores temperature values for various camera components. It uses a nested pair structure, where each element consists of a temperature type and its corresponding temperature value.

The temperature types are defined as follows: * CHIP_TEMP: Temperature of the camera chip * HOUSE_TEMP: Temperature inside the camera housing * HOUSE_BACK_TEMP: Temperature at the back of the camera housing * SENSOR_BOARD_TEMP: Temperature of the camera sensor board

The temperature values are of type double and represent the temperature in degrees Celsius.

Example usage:

// Accessing temperature values
double chipTemp = m_cameraTemperature[CHIP_TEMP];
double houseTemp = m_cameraTemperature[HOUSE_TEMP];

// Updating temperature values
m_cameraTemperature[CHIP_TEMP] = 35.7;
m_cameraTemperature[HOUSE_TEMP] = 28.2;

Public Functions Documentation

function CameraFamily

inline explicit CameraFamily::CameraFamily (
    HANDLE * handle
)

function GetCameraTemperature

QMap< QString, float > CameraFamily::GetCameraTemperature ()

function UpdateCameraTemperature

This function updates the recorded temperature of a camera.

virtual void CameraFamily::UpdateCameraTemperature ()

This function is responsible for updating the recorded temperature of a camera.

This function does not return any value. However, it modifies the state of the camera's recorded temperature.

Note:

This function assumes that the camera object has already been instantiated and the necessary data has been set.

function ~CameraFamily

virtual CameraFamily::~CameraFamily () = default

Protected Attributes Documentation

variable m_cameraHandle

HANDLE* CameraFamily::m_cameraHandle;

Camera identifier used by API to communicate with camera

variable m_mutexCameraTemperature

boost::mutex CameraFamily::m_mutexCameraTemperature;

Mutex used to lock access to variables like the camera temperature, this allows updating temperature from multiple threads.

The documentation for this class was generated from the following file src/camera.h