The MagAO-X pvcam controller header file. More...

#include <string.h>
#include <master.h>
#include <pvcam.h>
#include "../../libMagAOX/libMagAOX.hpp"
#include "../../magaox_git_version.h"

Include dependency graph for pvcamCtrl.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	MagAOX::app::pvcamCtrl
	The MagAO-X pvcam controller. More...

struct	MagAOX::app::pvcamCtrl::gain

struct	MagAOX::app::pvcamCtrl::speed

struct	MagAOX::app::pvcamCtrl::port

Namespaces
	MagAOX

	MagAOX::app

Macros
#define	PL_ERR_LIBRARY_NOT_INITIALIZED (157)

#define	log_pvcam_software_error(func, more)
	Helper for logging an error from pvcam. More...

Functions
std::string	pvcamErrMessage (const std::string &func, int pec, const std::string &more)
	Format an error message using pvcam facilities. More...

Detailed Description

The MagAO-X pvcam controller header file.

Definition in file pvcamCtrl.hpp.

Class Documentation

◆ MagAOX::app::pvcamCtrl::gain

struct MagAOX::app::pvcamCtrl::gain

Definition at line 149 of file pvcamCtrl.hpp.

Collaboration diagram for MagAOX::app::pvcamCtrl::gain:

Class Members
int	bitDepth
int	index
string	name

◆ MagAOX::app::pvcamCtrl::speed

struct MagAOX::app::pvcamCtrl::speed

Definition at line 157 of file pvcamCtrl.hpp.

Collaboration diagram for MagAOX::app::pvcamCtrl::speed:

Class Members
vector< gain >	gains
int	index
int	maxG
int	minG
int	pixTime

◆ MagAOX::app::pvcamCtrl::port

struct MagAOX::app::pvcamCtrl::port

Definition at line 166 of file pvcamCtrl.hpp.

Collaboration diagram for MagAOX::app::pvcamCtrl::port:

Class Members
int	index
string	name
vector< speed >	speeds
int	value

Macro Definition Documentation

◆ log_pvcam_software_error

#define log_pvcam_software_error	(	func,
		more
	)

Value:

{                                                                                              \
    int pec = pl_error_code();                                                                 \
    log<software_error>({__FILE__, __LINE__, 0, pec , pvcamErrMessage(func, pec, more)});      \
}

Helper for logging an error from pvcam.

< [in] the pvcam function which failed < [in] extra information to include

Definition at line 51 of file pvcamCtrl.hpp.

◆ PL_ERR_LIBRARY_NOT_INITIALIZED

#define PL_ERR_LIBRARY_NOT_INITIALIZED (157)

Definition at line 29 of file pvcamCtrl.hpp.

Function Documentation

◆ pvcamErrMessage()

std::string pvcamErrMessage	(	const std::string &	func,
		int	pec,
		const std::string &	more
	)

Format an error message using pvcam facilities.

Returns: a string of format "<func> failed: <pl_error_message>. <more>"

Parameters

[in]	func	the pvcam function which failed
[in]	pec	the code from pl_error_code
[in]	more	extra information to include

Definition at line 36 of file pvcamCtrl.hpp.

Classes

Namespaces

Macros

Functions