MagAO-X application to control the C-RED 2 camera. More...

#include <cred2Ctrl.hpp>

Inheritance diagram for MagAOX::app::cred2Ctrl:

Collaboration diagram for MagAOX::app::cred2Ctrl:

Public Types
typedef XWC_DEFAULT_VERBOSITY	verboseT

typedef logger::logManager< MagAOXApp< _useINDI >, logFileRaw< verboseT > >	logManagerT
	The log manager type.

enum	fgFlip

typedef int32_t	cbIndexT

typedef XWC_DEFAULT_VERBOSITY	verboseT

typedef logger::logManager< cred2Ctrl, logFileRaw< verboseT > >	logManagerT
	The log manager type.

Public Member Functions
	cred2Ctrl ()
	Default c'tor.

	~cred2Ctrl () noexcept
	D'tor, declared and defined for noexcept.

virtual void	setupConfig ()
	Setup the configuration system.

virtual void	loadConfig ()
	Load the configuration system results.

int	loadConfigImpl (mx::app::appConfigurator &config)
	Implementation of loadConfig logic with standard helper-macro error handling.

virtual int	appStartup ()
	Startup function.

virtual int	appLogic ()
	Main FSM logic.

virtual int	onPowerOff ()
	Actions required when the camera power turns off.

virtual int	whilePowerOff ()
	Actions required while the camera remains powered off.

virtual int	appShutdown ()
	Shutdown function.

int	getTemps ()
	Query and update the camera temperature channels.

int	getFPS ()
	Query and update the current camera frame rate.

int	updateFPSLimits ()
	Query and update the current camera FPS limits.

int	getFanSpeed ()
	Query and update the current fan-control state.

int	getAnalogGain ()
	Query and update the current analog-gain state.

int	getLEDState ()
	Query and update the current LED state.

int	syncROIFromCamera ()
	Query the camera for its current ROI and synchronize local state.

virtual void	setDefaults (int argc, char **argv)
	Set the paths for config files.

virtual void	setupBasicConfig ()
	The basic MagAO-X configuration setup method. Should not normally be overridden.

virtual void	loadBasicConfig ()
	The basic MagAO-X configuration processing method. Should not normally be overridden.

virtual void	checkConfig ()
	Check for unused and unrecognized config options and settings.

virtual int	execute ()
	The execute method implementing the standard main loop. Should not normally be overridden.

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

int	pdvSerialWriteRead (std::string &response, const std::string &command, bool logErrors=true)
	Send a serial command over cameralink and retrieve the response.

int	pdvConfig (std::string &cfgname)
	Configure the EDT framegrabber.

void	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

void	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

int	pdvStartAcquisition ()

int	pdvAcquire (timespec &currImageTimestamp)

int	pdvReconfig ()

int	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

int	configCircBuffs ()

int	telem (const typename telT::messageT &msg)
	Make a telemetry recording.

int	setupConfig (appConfigurator &config)
	Setup an application configurator for the device section.

int	loadConfig (appConfigurator &config)
	Load the device section from an application configurator.

int	checkRecordTimes (const telT &tel, telTs... tels)
	Check the time of the last record for each telemetry type and make an entry if needed.

int	checkRecordTimes (timespec &ts, const telT &tel, telTs... tels)
	Worker function to actually perform the record time checking logic.

int	checkRecordTimes (timespec &ts)
	Empty function called at the end of the template list.

stdCamera Interface
int	powerOnDefaults ()
	Set defaults for a power-on state.

int	setTempControl ()
	Implement the C-RED 2 temperature-controller toggle semantics.

int	setTempSetPt ()
	Send the current target detector temperature setpoint to the camera.

int	setFPS ()
	Send the requested frame rate to the camera.

int	setFanSpeed ()
	Send the requested fan-control mode to the camera.

int	setAnalogGain ()
	Send the requested analog-gain mode to the camera.

int	setLED ()
	Send the requested LED state to the camera.

int	setExpTime ()
	Required by `stdCamera`, but unused for C-RED 2.

int	checkNextROI ()
	Validate and normalize the requested ROI.

int	setNextROI ()
	Request that the next valid ROI be applied through reconfiguration.

Framegrabber Interface
int	writeConfig ()
	Write the temporary EDT configuration file for the pending ROI.

int	configureAcquisition ()
	Configure camera-side ROI settings before acquisition starts.

float	fps ()
	Return the currently measured frame rate.

int	startAcquisition ()
	Start frame acquisition on the EDT board.

int	acquireAndCheckValid ()
	Wait for and validate the next acquired image.

int	loadImageIntoStream (void *dest)
	Copy the current EDT image into the output stream.

int	reconfig ()
	Reconfigure the EDT board for the pending ROI.

Telemeter Interface
int	checkRecordTimes ()
	Check the telemetry record timers.

int	recordTelem (const cred2_temps *)
	Record the detailed C-RED 2 temperature telemetry.

int	recordTelem (const telem_stdcam *)
	Record standard camera telemetry.

int	recordTelem (const telem_fgtimings *)
	Record framegrabber timing telemetry.

int	recordTemps (bool force=false)
	Record the detailed C-RED 2 temperature telemetry when values change.

Threads
template<class thisPtr , class Function >
int	threadStart (std::thread &thrd, bool &thrdInit, pid_t &tpid, pcf::IndiProperty &thProp, int thrdPrio, const std::string &cpuset, const std::string &thrdName, thisPtr *thrdThis, Function &&thrdStart)
	Start a thread, using this class's privileges to set priority, etc.

Member Accessors
std::string	basePath ()
	Get the.

std::string	configName ()
	Get the config name.

std::string	configDir ()
	Get the config directory.

std::string	configBase ()
	Get the config base file.

std::string	calibDir ()
	Get the calibration directory.

std::string	sysPath ()
	Get the system path.

std::string	secretsPath ()
	Get the secrets path.

std::string	cpusetPath ()
	Get the cpuset path.

unsigned long	loopPause ()
	Get the loop pause time.

int	shutdown ()
	Get the value of the shutdown flag.

std::string	driverInName ()
	Get the INDI input FIFO file name.

std::string	driverOutName ()
	Get the INDI output FIFO file name.

std::string	driverCtrlName ()
	Get the INDI control FIFO file name.

Focus Control
bool	checkFocusSwitchState ()
	Evaluate the configured focus-state switch helper as an in-focus boolean.

int	sendGotoFocusCommand ()
	Format and send the configured goto-focus switch command.

Telemeter Interface
int	recordCamera (bool force=false)

INDI
int	updateINDI ()
	The static callback function to be registered for the channel properties.

Telemeter Interface
int	recordFGTimings (bool force=false)

Public Attributes
unsigned	m_readTimeout {1000}
	The read timeout [msec].

unsigned	m_writeTimeout {1000}
	The write timeout [msec].

logManagerT	m_tel

double	m_maxInterval
	The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.

Static Public Attributes
app::dev Configurations
static constexpr bool	c_stdCamera_tempControl = true
	Expose temperature setpoint control.

static constexpr bool	c_stdCamera_temp = true
	Expose detector temperature status.

static constexpr bool	c_stdCamera_readoutSpeed = false
	Do not expose readout-speed controls.

static constexpr bool	c_stdCamera_vShiftSpeed = false
	Do not expose vertical-shift controls.

static constexpr bool	c_stdCamera_emGain = false
	Do not expose EM-gain controls.

static constexpr bool	c_stdCamera_exptimeCtrl = false
	Do not expose exposure-time controls.

static constexpr bool	c_stdCamera_fpsCtrl = true
	Expose FPS controls.

static constexpr bool	c_stdCamera_fps = true
	Expose FPS status.

static constexpr bool	c_stdCamera_fanSpeed = true
	Expose fan-speed controls.

static constexpr bool	c_stdCamera_analogGain = true
	Expose discrete analog-gain controls.

static constexpr bool	c_stdCamera_led = true
	Expose status LED controls.

static constexpr bool	c_stdCamera_synchro = false
	Do not expose synchro controls in the first pass.

static constexpr bool	c_stdCamera_usesModes = false
	Use one synthetic runtime mode rather than INDI modes.

static constexpr bool	c_stdCamera_usesROI = true
	Expose ROI controls.

static constexpr bool	c_stdCamera_cropMode = false
	Do not expose crop-mode controls separately.

static constexpr bool	c_stdCamera_hasShutter = false
	Do not expose shutter controls.

static constexpr bool	c_stdCamera_usesStateString = false
	Do not expose a dark-management state string.

static constexpr bool	c_edtCamera_relativeConfigPath = false
	Use an absolute temporary EDT config path.

static constexpr bool	c_frameGrabber_flippable = true
	Expose image flip controls through the framegrabber.

Protected Member Functions
int	setSerialBaud ()
	Apply and verify the configured Camera Link serial baud rate.

int	sendCommand (std::string &response, const std::string &command, bool logFailure=true)
	Send a command over Camera Link serial and clean the response.

int	issueCommand (const std::string &command, bool allowNoResponse=false)
	Send a command that should return a success acknowledgement.

int	createReadoutSpeed (const mx::meta::trueFalseT< true > &t)

int	createReadoutSpeed (const mx::meta::trueFalseT< false > &f)

int	createVShiftSpeed (const mx::meta::trueFalseT< true > &t)

int	createVShiftSpeed (const mx::meta::trueFalseT< false > &f)

int	createFanSpeed (const mx::meta::trueFalseT< true > &t)

int	createFanSpeed (const mx::meta::trueFalseT< false > &f)

void	updateFocusStateProperty ()
	Refresh the published focus.state property from the current helper or derived focus implementation.

void *	loadImageIntoStreamCopy (void dest, void src, size_t width, size_t height, size_t szof)

int	openShmim ()

Protected Attributes
std::string	m_basePath
	The base path of the MagAO-X system.

std::string	m_configName
	The name of the configuration file (minus .conf).

std::string	m_configDir
	The path to configuration files for MagAOX.

std::string	m_configBase
	The name of a base config class for this app (minus .conf).

std::string	m_calibDir
	The path to calibration files for MagAOX.

std::string	m_sysPath
	The path to the system directory, for PID file, etc.

std::string	m_secretsPath
	Path to the secrets directory, where passwords, etc, are stored.

std::string	m_cpusetPath { MAGAOX_cpusetPath }
	Path to the cpusets mount.

unsigned long	m_loopPause { MAGAOX_default_loopPause }

int	m_shutdown { 0 }
	Flag to signal it's time to shutdown. When not 0, the main loop exits.

PdvDev *	m_pdv
	The EDT PDV device handle.

u_char *	m_image_p
	The image data grabbed.

int	m_raw_height
	The height of the frame, according to the framegrabber.

int	m_raw_width
	The width of the frame, according to the framegrabber.

int	m_raw_depth
	The bit-depth of the frame, according to the framegrabber.

std::string	m_cameraType
	The camera type according to the framegrabber.

uint32_t	m_width
	The width of the image, once deinterlaced etc.

uint32_t	m_height
	The height of the image, once deinterlaced etc.

uint8_t	m_dataType
	The ImageStreamIO type code.

size_t	m_typeSize
	The size of the type, in bytes. Result of sizeof.

int	m_xbinning
	The x-binning according to the framegrabber.

int	m_ybinning
	The y-binning according to the framegrabber.

timespec	m_currImageTimestamp
	The timestamp of the current image.

bool	m_reconfig
	Flag to set if a camera reconfiguration requires a framegrabber reset.

IMAGE *	m_imageStream
	The ImageStreamIO shared memory buffer.

bool	m_ownShmim
	Flag controlling if the shmim is owned. If true it will be destroyed as needed.

ino_t	m_inode
	The inode of the image stream file.

float	m_cbFPS
	The FPS used to configure the circular buffers.

mx::sigproc::circularBufferIndex< timespec, cbIndexT >	m_atimes

mx::sigproc::circularBufferIndex< timespec, cbIndexT >	m_wtimes

std::vector< double >	m_atimesD

std::vector< double >	m_wtimesD

std::vector< double >	m_watimesD

timespec	m_dummy_ts

uint64_t	m_dummy_cnt

char	m_dummy_c

double	m_mna

double	m_vara

double	m_mina

double	m_maxa

double	m_mnw

double	m_varw

double	m_minw

double	m_maxw

double	m_mnwa

double	m_varwa

Configurable Parameters - Data
std::string	m_configFile
	Absolute path to the temporary EDT configuration file.

int	m_serialBaud { 115200 }
	Camera Link serial baud rate used for C-RED 2 CLI access.

C-RED 2 State - Data
cred2Temps	m_temps
	Cached camera temperature values used for INDI and telemetry updates.

bool	m_cameraCropEnabled { false }
	Tracks whether this controller has enabled camera-side cropping.

int	m_roiSettleCounter { 0 }
	Number of main-loop cycles to skip serial status polling after ROI changes.

std::recursive_mutex	m_cameraMutex
	Protects serial command traffic and EDT reconfiguration.

INDI - Data
pcf::IndiProperty	m_indiP_temps
	Property reporting the detailed C-RED 2 temperature channels.

pcf::IndiProperty	m_indiP_fpsLimits
	Property reporting the current C-RED 2 minimum and maximum FPS.

Configurable Parameters
cameraConfigMap	m_cameraModes
	Map holding the possible camera mode configurations.

std::string	m_startupMode
	The camera mode to load during first init after a power-on.

float	m_startupTemp
	The temperature to set after a power-on. Set to <= -999 to not use [default].

std::string	m_defaultReadoutSpeed
	The default readout speed of the camera.

std::string	m_defaultVShiftSpeed
	The default readout speed of the camera.

bool	m_fanSpeedControlEnabled
	Whether or not fan-speed control is published through INDI.

std::string	m_defaultFanSpeed
	The default fan speed to apply after power on.

bool	m_defaultLEDState
	The default LED state to apply after power on.

Temperature Control Interface
float	m_minTemp

float	m_maxTemp

float	m_stepTemp

float	m_ccdTemp
	The current temperature, in C.

float	m_ccdTempSetpt
	The desired temperature, in C.

bool	m_tempControlStatus
	Whether or not temperature control is active.

bool	m_tempControlStatusSet
	Desired state of temperature control.

bool	m_tempControlOnTarget
	Whether or not the temperature control system is on its target temperature.

std::string	m_tempControlStatusStr
	Camera specific description of temperature control status.

pcf::IndiProperty	m_indiP_temp

pcf::IndiProperty	m_indiP_tempcont

pcf::IndiProperty	m_indiP_tempstat

Readout Control
std::vector< std::string >	m_readoutSpeedNames

std::vector< std::string >	m_readoutSpeedNameLabels

std::string	m_readoutSpeedName
	The current readout speed name.

std::string	m_readoutSpeedNameSet
	The user requested readout speed name, to be set by derived()

std::vector< std::string >	m_vShiftSpeedNames

std::vector< std::string >	m_vShiftSpeedNameLabels

std::string	m_vShiftSpeedName
	The current vshift speed name.

std::string	m_vShiftSpeedNameSet
	The user requested vshift speed name, to be set by derived()

float	m_adcSpeed

float	m_vshiftSpeed

float	m_emGain
	The camera's current EM gain (if available).

float	m_emGainSet
	The camera's EM gain, as set by the user.

float	m_maxEMGain
	The configurable maximum EM gain. To be enforced in derivedT.

pcf::IndiProperty	m_indiP_readoutSpeed

pcf::IndiProperty	m_indiP_vShiftSpeed

pcf::IndiProperty	m_indiP_emGain

Exposure Control
float	m_minExpTime
	The minimum exposure time, used for INDI attributes.

float	m_maxExpTime
	The maximum exposure time, used for INDI attributes.

float	m_stepExpTime
	The maximum exposure time stepsize, used for INDI attributes.

float	m_expTime
	The current exposure time, in seconds.

float	m_expTimeSet
	The exposure time, in seconds, as set by user.

float	m_minFPS
	The minimum FPS, used for INDI attributes.

float	m_maxFPS
	The maximum FPS, used for INDI attributes.

float	m_stepFPS
	The FPS step size, used for INDI attributes.

float	m_fps
	The current FPS.

float	m_fpsSet
	The commanded fps, as set by user.

pcf::IndiProperty	m_indiP_exptime

pcf::IndiProperty	m_indiP_fps

Fan Control
std::vector< std::string >	m_fanSpeedNames
	Valid fan-control option names for the INDI selection switch.

std::vector< std::string >	m_fanSpeedNameLabels
	Optional GUI labels for the fan-control options.

std::string	m_fanSpeedName
	Current fan-control option name.

std::string	m_fanSpeedNameSet
	Requested fan-control option name.

bool	m_fanSpeedValid
	True once the current fan-control state is known.

pcf::IndiProperty	m_indiP_fanSpeed
	Property used to select the fan-speed mode.

Analog Gain
std::vector< std::string >	m_analogGainNames
	Valid analog-gain option names for the INDI selection switch.

std::vector< std::string >	m_analogGainNameLabels
	Optional GUI labels for the analog-gain options.

std::string	m_analogGainName
	Current analog-gain option name.

std::string	m_analogGainNameSet
	Requested analog-gain option name.

bool	m_analogGainValid
	True once the current analog-gain state is known.

pcf::IndiProperty	m_indiP_analogGain
	Property used to select the analog-gain mode.

LED Control
bool	m_ledState
	Current status LED state.

bool	m_ledStateSet
	Requested status LED state.

bool	m_ledStateValid
	True once the current LED state is known.

pcf::IndiProperty	m_indiP_led
	Property used to control the status LED state.

External Synchronization
bool	m_synchroSet
	Target status of m_synchro.

bool	m_synchro
	Status of synchronization, true is on, false is off.

pcf::IndiProperty	m_indiP_synchro

Modes
std::string	m_modeName
	The current mode name.

std::string	m_nextMode
	The mode to be set by the next reconfiguration.

pcf::IndiProperty	m_indiP_mode
	Property used to report the current mode.

pcf::IndiProperty	m_indiP_reconfig
	Request switch which forces the framegrabber to go through the reconfigure process.

ROIs
ROI controls are exposed if derivedT::c_stdCamera_usesROI==true
roi	m_currentROI

roi	m_nextROI

roi	m_lastROI

float	m_minROIx

float	m_maxROIx

float	m_stepROIx

float	m_minROIy

float	m_maxROIy

float	m_stepROIy

int	m_minROIWidth

int	m_maxROIWidth

int	m_stepROIWidth

int	m_minROIHeight

int	m_maxROIHeight

int	m_stepROIHeight

int	m_minROIBinning_x

int	m_maxROIBinning_x

int	m_stepROIBinning_x

int	m_minROIBinning_y

int	m_maxROIBinning_y

int	m_stepROIBinning_y

float	m_default_x
	Power-on ROI center x coordinate.

float	m_default_y
	Power-on ROI center y coordinate.

int	m_default_w
	Power-on ROI width.

int	m_default_h
	Power-on ROI height.

int	m_default_bin_x
	Power-on ROI x binning.

int	m_default_bin_y
	Power-on ROI y binning.

float	m_full_x
	The full ROI center x coordinate.

float	m_full_y
	The full ROI center y coordinate.

int	m_full_w
	The full ROI width.

int	m_full_h
	The full ROI height.

int	m_full_bin_x
	The x-binning in the full ROI.

int	m_full_bin_y
	The y-binning in the full ROI.

float	m_full_currbin_x
	The current-binning full ROI center x coordinate.

float	m_full_currbin_y
	The current-binning full ROI center y coordinate.

int	m_full_currbin_w
	The current-binning full ROI width.

int	m_full_currbin_h
	The current-binning full ROI height.

pcf::IndiProperty	m_indiP_roi_x
	Property used to set the ROI x center coordinate.

pcf::IndiProperty	m_indiP_roi_y
	Property used to set the ROI x center coordinate.

pcf::IndiProperty	m_indiP_roi_w
	Property used to set the ROI width.

pcf::IndiProperty	m_indiP_roi_h
	Property used to set the ROI height.

pcf::IndiProperty	m_indiP_roi_bin_x
	Property used to set the ROI x binning.

pcf::IndiProperty	m_indiP_roi_bin_y
	Property used to set the ROI y binning.

pcf::IndiProperty	m_indiP_fullROI
	Property used to preset the full ROI dimensions.

pcf::IndiProperty	m_indiP_roi_check
	Property used to trigger checking the target ROI.

pcf::IndiProperty	m_indiP_roi_set
	Property used to trigger setting the ROI.

pcf::IndiProperty	m_indiP_roi_full
	Property used to trigger setting the full ROI.

pcf::IndiProperty	m_indiP_roi_fullbin
	Property used to trigger setting the full in current binning ROI.

pcf::IndiProperty	m_indiP_roi_loadlast
	Property used to trigger loading the last ROI as the target.

pcf::IndiProperty	m_indiP_roi_last
	Property used to trigger setting the last ROI.

pcf::IndiProperty	m_indiP_roi_default
	Property used to trigger setting the default and startup ROI.

Crop Mode
Crop mode controls are exposed if derivedT::c_stdCamera_cropMode==true
bool	m_cropMode
	Status of crop mode ROIs, if enabled for this camera.

bool	m_cropModeSet
	Desired status of crop mode ROIs, if enabled for this camera.

pcf::IndiProperty	m_indiP_cropMode
	Property used to toggle crop mode on and off.

Shutter Control
Shutter controls are exposed if derivedT::c_stdCamera_hasShutter == true.
std::string	m_shutterStatus

int	m_shutterState

pcf::IndiProperty	m_indiP_shutterStatus
	State of the shutter. 0 = shut, 1 = open, -1 = unknown.

pcf::IndiProperty	m_indiP_shutter
	Property used to control the shutter, a switch.

Focus Control - Data
Focus controls are exposed if the derived camera supports focus and m_hasFocus is true.
bool	m_hasFocus
	Runtime flag enabling focus-state reporting and goto-focus control publication.

bool	m_focusStateHelperConfigured
	True when stdCamera should evaluate focus state from an external switch property.

std::string	m_focusStateSource
	INDI key (`device.property`) of the switch property used by checkFocusSwitchState.

std::string	m_focusStateElement

bool	m_focusStateOnMeansInFocus

int	m_focusStateSourceIndex
	Index of m_focusStateSource within m_indiP_focusMonitoredProperties, or `-1` when unused.

bool	m_focusGotoHelperConfigured
	True when stdCamera should derive goto-focus commands from external switch properties.

std::vector< std::string >	m_focusGotoSourceProperties

std::vector< int >	m_focusGotoSourceIndices
	Indices of m_focusGotoSourceProperties within m_indiP_focusMonitoredProperties.

std::string	m_focusGotoFormat
	Literal `{}` placeholder format used to build the goto-focus preset name.

std::string	m_focusGotoTargetProperty
	INDI key (`device.property`) of the switch property commanded by gotoFocus().

std::string	m_focusGotoTargetDevice
	Device portion parsed from m_focusGotoTargetProperty.

std::string	m_focusGotoTargetName
	Property-name portion parsed from m_focusGotoTargetProperty.

std::vector< std::string >	m_focusMonitoredPropertyKeys
	Unique INDI keys monitored for the focus-state and goto-focus helpers.

std::vector< pcf::IndiProperty >	m_indiP_focusMonitoredProperties
	Cached external switch properties monitored for the focus helpers.

pcf::IndiProperty	m_indiP_focus
	Read-only switch property reporting whether the current state is in focus.

pcf::IndiProperty	m_indiP_gotoFocus
	Request switch property used to command the current focus target.

State String
The State string is exposed if derivedT::c_stdCamera_usesStateString is true.
pcf::IndiProperty	m_indiP_stateString

Configurable Parameters
int	m_unit
	EDT PDV board unit number.

int	m_channel
	EDT PDV board channel number.

int	m_numBuffs
	EDT PDV DMA buffer size, indicating number of images.

Configurable Parameters
std::string	m_shmimName

int	m_fgThreadPrio
	Priority of the framegrabber thread, should normally be > 00.

std::string	m_fgCpuset
	The cpuset to assign the framegrabber thread to. Not used if empty, the default.

uint32_t	m_circBuffLength
	Length of the circular buffer, in frames.

cbIndexT	m_latencyCircBuffMaxLength
	Maximum length of the latency measurement circular buffers.

float	m_latencyCircBuffMaxTime
	Maximum time of the latency meaurement circular buffers.

int	m_defaultFlip

Static Protected Attributes
static constexpr bool	c_hasFanSpeed
	True when the derived camera exposes fan-speed control.

static constexpr bool	c_hasLED
	True when the derived camera exposes LED control.

static constexpr bool	c_hasAnalogGain
	True when the derived camera exposes analog-gain control.

static constexpr bool	c_hasFocus

Private Types
typedef MagAOXApp	MagAOXAppT

typedef dev::stdCamera< cred2Ctrl >	stdCameraT

typedef dev::frameGrabber< cred2Ctrl >	frameGrabberT

typedef dev::telemeter< cred2Ctrl >	telemeterT

Private Member Functions
int	clearFSMAlert ()
	Clear the FSM alert state.

cred2Ctrl &	derived ()

Static Private Member Functions
static auto	postPublishHook (hookT &hookOwner, IMAGE *imageStream, int callPriorityTag) -> decltype(hookOwner.frameGrabberPostPublish(imageStream))
	Call an optional derived-class hook after the main stream publication completes.

static int	postPublishHook (cred2Ctrl &hookOwner, IMAGE *imageStream, long callPriorityTag)
	Return success when the derived class does not expose a post-publication hook.

Friends
class	dev::stdCamera< cred2Ctrl >

class	dev::edtCamera< cred2Ctrl >

class	dev::frameGrabber< cred2Ctrl >

class	dev::telemeter< cred2Ctrl >

Logging
static logManagerT	m_log

void	logMessage (bufferPtrT &b)
	Handle a log message from the logging system.

template<typename logT , int retval = 0>
static int	log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.

template<typename logT , int retval = 0>
static int	log (logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.

static void	configLog (const std::string &name, const int &code, const std::string &value, const std::string &source)
	Callback for config system logging.

PID Locking
Each MagAOXApp has a PID lock file in the system directory. The app will not startup if it detects that the PID is already locked, preventing duplicates. This is based on the configured name, not the invoked name (argv[0]).
std::string	pidFileName
	The name of the PID file.

pid_t	m_pid { 0 }
	This process's PID.

int	lockPID ()

int	unlockPID ()
	Remove the PID file.

INDI Interface
For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property.
std::unordered_map< std::string, indiCallBack >	m_indiNewCallBacks
	Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

std::unordered_map< std::string, indiCallBack >	m_indiSetCallBacks
	Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.

bool	m_allDefsReceived { false }
	Flag indicating that all registered Set properties have been updated since last Get.

std::string	m_driverInName
	Full path name of the INDI driver input FIFO.

std::string	m_driverOutName
	Full path name of the INDI driver output FIFO.

std::string	m_driverCtrlName
	Full path name of the INDI driver control FIFO.

pcf::IndiProperty	m_indiP_state
	indi Property to report the application state.

pcf::IndiProperty	m_indiP_clearFSMAlert
	indi Property to clear an FSM alert.

int	createStandardIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Text property with target and current elements.

int	createROIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &elName, const std::string &propLabel="", const std::string &propGroup="", const std::string &elLabel="")
	Create a standard ReadOnly INDI Text property, with at least one element.

template<typename T >
int	createStandardIndiNumber (pcf::IndiProperty &prop, const std::string &name, const T &min, const T &max, const T &step, const std::string &format, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Number property with target and current elements.

int	createROIndiNumber (pcf::IndiProperty &prop, const std::string &propName, const std::string &propLabel="", const std::string &propGroup="")
	Create a ReadOnly INDI Number property.

int	createStandardIndiToggleSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single toggle element.

int	createStandardIndiRequestSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single request element.

int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::vector< std::string > &elementLabels, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.

int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::string &label="", const std::string &group="")

int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop)
	Register an INDI property which is read only.

int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState)
	Register an INDI property which is read only.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, const pcf::IndiProperty::SwitchRuleType &propRule, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for, with a switch rule.

int	registerIndiPropertySet (pcf::IndiProperty &prop, const std::string &devName, const std::string &propName, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is monitored for updates from others.

void	resetIndiSetPropertyRetry (indiCallBack &callBack)
	Reset retry tracking for a monitored INDI Set-property subscription.

bool	indiSetPropertyShouldRequest (const indiCallBack &callBack, bool all, const std::chrono::steady_clock::time_point &now) const
	Determine whether an unresolved Set-property subscription should be requested now.

void	noteIndiSetPropertyRequested (indiCallBack &callBack, const std::chrono::steady_clock::time_point &now)
	Update retry tracking after sending a GetProperties request for a monitored Set-property.

void	sendGetPropertySetList (bool all=false)

void	handleDefProperty (const pcf::IndiProperty &ipRecv)
	Handler for the DEF INDI properties notification.

void	handleGetProperties (const pcf::IndiProperty &ipRecv)
	Handler for the get INDI properties request.

void	handleNewProperty (const pcf::IndiProperty &ipRecv)
	Handler for the new INDI property request.

void	handleSetProperty (const pcf::IndiProperty &ipRecv)
	Handler for the set INDI property request.

int	createINDIFIFOS ()
	Create the INDI FIFOs.

int	startINDI ()
	Start INDI Communications.

template<typename T >
void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const T &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const char *newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.

template<typename T >
void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.

template<typename T >
void	updateIfChanged (pcf::IndiProperty &p, const std::vector< std::string > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.

void	updateSwitchIfChanged (pcf::IndiProperty &p, const std::string &el, const pcf::IndiElement::SwitchStateType &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI switch element value if it has changed.

template<typename T >
void	updatesIfChanged (pcf::IndiProperty &p, const std::vector< const char * > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)

template<typename T >
int	indiTargetUpdate (pcf::IndiProperty &localProperty, T &localTarget, const pcf::IndiProperty &remoteProperty, bool setBusy=true)
	Get the target element value from an new property.

template<typename T >
int	sendNewProperty (const pcf::IndiProperty &ipSend, const std::string &el, const T &newVal)
	Send a newProperty command to another device (using the INDI Client interface)

int	sendNewProperty (const pcf::IndiProperty &ipSend)
	Send a newProperty command to another device (using the INDI Client interface)

int	sendNewStandardIndiToggle (const std::string &device, const std::string &property, bool onoff)
	Send a new property commmand for a standard toggle switch.

int	newCallBack_clearFSMAlert (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the FSM Alert Clear request.

typedef std::pair< std::string, indiCallBack >	callBackValueType
	Value type of the indiCallBack map.

typedef std::unordered_map< std::string, indiCallBack >::iterator	callBackIterator
	Iterator type of the indiCallBack map.

typedef std::pair< callBackIterator, bool >	callBackInsertResult
	Return type of insert on the indiCallBack map.

static constexpr bool	m_useINDI = _useINDI
	Flag controlling whether INDI is used. If false, then no INDI code executes.

indiDriver< MagAOXApp > *	m_indiDriver { nullptr }
	The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

std::mutex	m_indiMutex
	Mutex for locking INDI communications.

std::mutex	m_indiCallBackMutex
	Mutex for locking INDI callback maps and per-entry callback state.

static int	st_newCallBack_clearFSMAlert (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for requesting to clear the FSM alert.

Power Management
For devices which have remote power management (e.g. from one of the PDUs) we implement a standard power state monitoring and management component for the FSM. This needs to be enabled in the derived app constructor. To stay enabled, m_powerDevice and m_powerChannel must be not empty strings after the configuration. These could be set in the derived app defaults. If power management is enabled, then while power is off, appLogic will not be called. Instead a parrallel set of virtual functions is called, onPowerOff (to allow apps to perform cleanup) and whilePowerOff (to allow apps to keep variables updated, etc). Note that these could merely call appLogic if desired.
bool	m_powerMgtEnabled { false }

std::string	m_powerDevice
	The INDI device name of the power controller.

std::string	m_powerChannel
	The INDI property name of the channel controlling this device's power.

std::string	m_powerElement { "state" }
	The INDI element name to monitor for this device's power state.

std::string	m_powerTargetElement { "target" }
	The INDI element name to monitor for this device's power state.

unsigned long	m_powerOnWait { 55 }
	Default time in sec to wait for device to boot after power on.

int	m_powerOnCounter { -1 }

int	m_powerState { -1 }
	Current power state, 1=On, 0=Off, -1=Unk.

int	m_powerTargetState { -1 }
	Current target power state, 1=On, 0=Off, -1=Unk.

pcf::IndiProperty	m_indiP_powerChannel
	INDI property used to communicate power state.

int	powerState ()
	Returns the current power state.

int	powerStateTarget ()
	Returns the target power state.

	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

bool	powerOnWaitElapsed ()
	This method tests whether the power on wait time has elapsed.

Framegrabber Thread
This thread actually manages the framegrabbing hardware
bool	m_fgThreadInit
	Synchronizer for thread startup, to allow priority setting to finish.

pid_t	m_fgThreadID
	The ID of the framegrabber thread.

pcf::IndiProperty	m_fgThreadProp
	The property to hold the f.g. thread details.

std::thread	m_fgThread
	A separate thread for the actual framegrabbings.

void	fgThreadExec ()
	Execute framegrabbing.

static void	fgThreadStart (frameGrabber *o)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls fgThreadExec.

INDI
pcf::IndiProperty	m_indiP_shmimName
	Property used to report the shmim buffer name.

pcf::IndiProperty	m_indiP_frameSize
	Property used to report the current frame size.

pcf::IndiProperty	m_indiP_timing

int	updateINDI ()
	Update the INDI properties for this device controller.

Application State
stateCodes::stateCodeT	state ()
	Get the current state code.

void	state (const stateCodes::stateCodeT &s, bool stateAlert=false)
	Set the current state code.

bool	stateAlert ()
	Get the value of the state alert flag.

bool	gitAlert ()
	Get the value of the git alert flag.

int	stateLogged ()
	Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

stateCodes::stateCodeT	m_state { stateCodes::UNINITIALIZED }

bool	m_stateAlert { false }

bool	m_gitAlert { false }

int	m_stateLogged { 0 }

INDI
int	newCallBack_stdCamera (const pcf::IndiProperty &ipRecv)
	The callback function for stdCamera properties.

int	setTempSetPt (const mx::meta::trueFalseT< true > &t)
	Interface to setTempSetPt when the derivedT has temperature control.

int	setTempSetPt (const mx::meta::trueFalseT< false > &f)
	Interface to setTempSetPt when the derivedT does not have temperature control.

int	newCallBack_temp (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW CCD temp request.

int	setTempControl (const mx::meta::trueFalseT< true > &t)
	Interface to setTempControl when the derivedT has temperature control.

int	setTempControl (const mx::meta::trueFalseT< false > &f)
	Interface to setTempControl when the derivedT does not have temperature control.

int	newCallBack_temp_controller (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW CCD temp control request.

int	setReadoutSpeed (const mx::meta::trueFalseT< true > &t)
	Interface to setReadoutSpeed when the derivedT has readout speed control.

int	setReadoutSpeed (const mx::meta::trueFalseT< false > &f)
	Interface to setReadoutSpeed when the derivedT does not have readout speed control.

int	newCallBack_readoutSpeed (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW readout speed request.

int	setVShiftSpeed (const mx::meta::trueFalseT< true > &t)
	Interface to setVShiftSpeed when the derivedT has vshift speed control.

int	setVShiftSpeed (const mx::meta::trueFalseT< false > &f)
	Interface to setVShiftSpeed when the derivedT does not have vshift speed control.

int	newCallBack_vShiftSpeed (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW vshift speed request.

int	setEMGain (const mx::meta::trueFalseT< true > &t)
	Interface to setEMGain when the derivedT has EM Gain.

int	setEMGain (const mx::meta::trueFalseT< false > &f)
	Interface to setEMGain when the derivedT does not have EM Gain.

int	newCallBack_emgain (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW EM gain request.

int	setExpTime (const mx::meta::trueFalseT< true > &t)
	Interface to setExpTime when the derivedT uses exposure time controls.

int	setExpTime (const mx::meta::trueFalseT< false > &f)
	Interface to setExptime when the derivedT does not use exposure time controls.

int	newCallBack_exptime (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW exposure time request.

int	setFPS (const mx::meta::trueFalseT< true > &t)
	Interface to setFPS when the derivedT uses FPS controls.

int	setFPS (const mx::meta::trueFalseT< false > &f)
	Interface to setFPS when the derivedT does not use FPS controls.

int	newCallBack_fps (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW fps request.

int	setFanSpeed (const mx::meta::trueFalseT< true > &t)
	Interface to setFanSpeed when the derivedT exposes fan controls.

int	setFanSpeed (const mx::meta::trueFalseT< false > &f)
	Interface to setFanSpeed when the derivedT does not expose fan controls.

int	newCallBack_fanSpeed (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW fan speed request.

int	setAnalogGain (const mx::meta::trueFalseT< true > &t)
	Interface to setAnalogGain when the derivedT exposes analog-gain controls.

int	setAnalogGain (const mx::meta::trueFalseT< false > &f)
	Interface to setAnalogGain when the derivedT does not expose analog-gain controls.

int	newCallBack_analogGain (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW analog-gain request.

int	setLED (const mx::meta::trueFalseT< true > &t)
	Interface to setLED when the derivedT exposes LED controls.

int	setLED (const mx::meta::trueFalseT< false > &f)
	Interface to setLED when the derivedT does not expose LED controls.

int	newCallBack_led (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW LED request.

int	setSynchro (const mx::meta::trueFalseT< true > &t)
	Interface to setSynchro when the derivedT has synchronization.

int	setSynchro (const mx::meta::trueFalseT< false > &f)
	Interface to setSynchro when the derivedT does not have synchronization.

int	newCallBack_synchro (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW synchro request.

int	newCallBack_mode (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW mode request.

int	newCallBack_reconfigure (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW reconfigure request.

int	setCropMode (const mx::meta::trueFalseT< true > &t)
	Interface to setCropMode when the derivedT has crop mode.

int	setCropMode (const mx::meta::trueFalseT< false > &f)
	Interface to setCropMode when the derivedT does not have crop mode.

int	newCallBack_cropMode (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW cropMode request.

int	newCallBack_roi_x (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_x request.

int	newCallBack_roi_y (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_y request.

int	newCallBack_roi_w (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_w request.

int	newCallBack_roi_h (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_h request.

int	newCallBack_roi_bin_x (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW bin_x request.

int	newCallBack_roi_bin_y (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW bin_y request.

int	checkNextROI (const mx::meta::trueFalseT< true > &t)
	Interface to checkNextROI when the derivedT uses ROIs.

int	checkNextROI (const mx::meta::trueFalseT< false > &f)
	Interface to checkNextROI when the derivedT does not use ROIs.

int	newCallBack_roi_check (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_check request.

int	setNextROI (const mx::meta::trueFalseT< true > &t)
	Interface to setNextROI when the derivedT uses ROIs.

int	setNextROI (const mx::meta::trueFalseT< false > &f)
	Interface to setNextROI when the derivedT does not use ROIs.

int	newCallBack_roi_set (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_set request.

int	newCallBack_roi_full (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_full request.

int	newCallBack_roi_fullbin (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_fullbin request.

int	newCallBack_roi_loadlast (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_loadlast request.

int	newCallBack_roi_last (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_last request.

int	newCallBack_roi_default (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW roi_default request.

int	setShutter (int ss, const mx::meta::trueFalseT< true > &t)
	Interface to setShutter when the derivedT has a shutter.

int	setShutter (int ss, const mx::meta::trueFalseT< false > &f)
	Interface to setShutter when the derivedT does not have a shutter.

int	newCallBack_shutter (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW shutter request.

bool	checkFocus (const mx::meta::trueFalseT< true > &t)
	Interface to checkFocus when the derivedT exposes focus support.

bool	checkFocus (const mx::meta::trueFalseT< false > &f)
	Interface to checkFocus when the derivedT does not expose focus support.

int	gotoFocus (const mx::meta::trueFalseT< true > &t)
	Interface to gotoFocus when the derivedT exposes focus support.

int	gotoFocus (const mx::meta::trueFalseT< false > &f)
	Interface to gotoFocus when the derivedT does not expose focus support.

int	newCallBack_gotoFocus (const pcf::IndiProperty &ipRecv)
	Callback to process a NEW goto-focus request.

int	setCallBack_focusMonitored (const pcf::IndiProperty &ipRecv)
	The callback which caches external focus-helper switch-property updates.

std::string	stateString (const mx::meta::trueFalseT< true > &t)
	Interface to stateString when the derivedT provides it.

std::string	stateString (const mx::meta::trueFalseT< false > &f)
	Interface to stateString when the derivedT does not provide it.

bool	stateStringValid (const mx::meta::trueFalseT< true > &t)
	Interface to stateStringValid when the derivedT provides it.

bool	stateStringValid (const mx::meta::trueFalseT< false > &f)
	Interface to stateStringValid when the derivedT does not provide it.

int	updateINDI ()
	Update the INDI properties for this device controller.

static int	st_newCallBack_stdCamera (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for stdCamera properties.

static int	st_setCallBack_focusMonitored (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function registered for external focus-helper switch properties.

Signal Handling
libMagAOX/logger/types/software_log.hpp
static MagAOXApp *	m_self = nullptr

int	setSigTermHandler ()
	Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

void	handlerSigTerm (int signum, siginfo_t siginf, void ucont)
	Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.

static void	_handlerSigTerm (int signum, siginfo_t siginf, void ucont)
	The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

Privilege Management
uid_t	m_euidReal
	The real user id of the proces (i.e. the lower privileged id of the user)

uid_t	m_euidCalled

uid_t	m_suid
	The save-set user id of the process.

int	setEuidCalled ()
	Set the effective user ID to the called value, i.e. the highest possible.

int	setEuidReal ()
	Set the effective user ID to the real value, i.e. the file owner.

Detailed Description

MagAO-X application to control the C-RED 2 camera.

Definition at line 46 of file cred2Ctrl.hpp.

Member Typedef Documentation

◆ callBackInsertResult

template<bool _useINDI = true>

typedef std::pair<callBackIterator, bool> MagAOX::app::MagAOXApp< _useINDI >::callBackInsertResult

inherited

Return type of insert on the indiCallBack map.

Definition at line 694 of file MagAOXApp.hpp.

◆ callBackIterator

template<bool _useINDI = true>

typedef std::unordered_map<std::string,indiCallBack>::iterator MagAOX::app::MagAOXApp< _useINDI >::callBackIterator

inherited

Iterator type of the indiCallBack map.

Definition at line 691 of file MagAOXApp.hpp.

◆ callBackValueType

template<bool _useINDI = true>

typedef std::pair<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::callBackValueType

inherited

Value type of the indiCallBack map.

Definition at line 688 of file MagAOXApp.hpp.

◆ cbIndexT

typedef int32_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::cbIndexT

inherited

Definition at line 116 of file frameGrabber.hpp.

◆ frameGrabberT

typedef dev::frameGrabber<cred2Ctrl> MagAOX::app::cred2Ctrl::frameGrabberT

private

Definition at line 59 of file cred2Ctrl.hpp.

◆ logManagerT [1/2]

typedef logger::logManager<cred2Ctrl , logFileRaw<verboseT> > MagAOX::app::dev::telemeter< cred2Ctrl >::logManagerT

inherited

The log manager type.

Definition at line 79 of file telemeter.hpp.

◆ logManagerT [2/2]

template<bool _useINDI = true>

typedef logger::logManager<MagAOXApp<_useINDI>, logFileRaw<verboseT> > MagAOX::app::MagAOXApp< _useINDI >::logManagerT

inherited

The log manager type.

Definition at line 178 of file MagAOXApp.hpp.

◆ MagAOXAppT

typedef MagAOXApp MagAOX::app::cred2Ctrl::MagAOXAppT

private

Definition at line 57 of file cred2Ctrl.hpp.

◆ stdCameraT

typedef dev::stdCamera<cred2Ctrl> MagAOX::app::cred2Ctrl::stdCameraT

private

Definition at line 58 of file cred2Ctrl.hpp.

◆ telemeterT

typedef dev::telemeter<cred2Ctrl> MagAOX::app::cred2Ctrl::telemeterT

private

Definition at line 60 of file cred2Ctrl.hpp.

◆ verboseT [1/2]

typedef XWC_DEFAULT_VERBOSITY MagAOX::app::dev::telemeter< cred2Ctrl >::verboseT

inherited

Definition at line 76 of file telemeter.hpp.

◆ verboseT [2/2]

template<bool _useINDI = true>

typedef XWC_DEFAULT_VERBOSITY MagAOX::app::MagAOXApp< _useINDI >::verboseT

inherited

Definition at line 175 of file MagAOXApp.hpp.

Member Enumeration Documentation

◆ fgFlip

enum MagAOX::app::dev::frameGrabber::fgFlip

inherited

Definition at line 108 of file frameGrabber.hpp.

Constructor & Destructor Documentation

◆ cred2Ctrl()

MagAOX::app::cred2Ctrl::cred2Ctrl ( )

inline

Default c'tor.

Definition at line 403 of file cred2Ctrl.hpp.

◆ ~cred2Ctrl()

MagAOX::app::cred2Ctrl::~cred2Ctrl ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 472 of file cred2Ctrl.hpp.

Member Function Documentation

◆ _handlerSigTerm()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::_handlerSigTerm	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

staticprivateinherited

The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

Parameters

[in]	signum	specifies the signal.
[in]	siginf	ignored by MagAOXApp
[in]	ucont	ignored by MagAOXApp

Definition at line 2212 of file MagAOXApp.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::handlerSigTerm().

◆ acquireAndCheckValid()

int MagAOX::app::cred2Ctrl::acquireAndCheckValid ( )

inline

Wait for and validate the next acquired image.

Definition at line 1699 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), and MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_currImageTimestamp.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ appLogic()

int MagAOX::app::cred2Ctrl::appLogic ( )

inlinevirtual

Main FSM logic.

Implements MagAOX::app::MagAOXApp< _useINDI >.

Definition at line 591 of file cred2Ctrl.hpp.

References MagAOX::app::stateCodes::CONNECTED, MagAOX::app::cred2ParseFloat(), MagAOX::app::stateCodes::ERROR, FRAMEGRABBER_APP_LOGIC, getAnalogGain(), getFanSpeed(), getFPS(), getLEDState(), getTemps(), MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ccdTempSetpt, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_defaultFanSpeed, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_defaultLEDState, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedName, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedNameSet, MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledState, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledStateSet, m_roiSettleCounter, MagAOX::app::stateCodes::NODEVICE, MagAOX::app::stateCodes::NOTCONNECTED, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::POWERON, MagAOX::app::MagAOXApp< _useINDI >::powerState(), MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget(), MagAOX::app::stateCodes::READY, sendCommand(), setFanSpeed(), setLED(), setTempSetPt(), MagAOX::app::MagAOXApp< _useINDI >::state(), STDCAMERA_APP_LOGIC, syncROIFromCamera(), and updateFPSLimits().

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ appShutdown()

int MagAOX::app::cred2Ctrl::appShutdown ( )

inlinevirtual

Shutdown function.

Implements MagAOX::app::MagAOXApp< _useINDI >.

Definition at line 875 of file cred2Ctrl.hpp.

References MagAOX::app::dev::edtCamera< derivedT >::appShutdown(), FRAMEGRABBER_APP_SHUTDOWN, STDCAMERA_APP_SHUTDOWN, and TELEMETER_APP_SHUTDOWN.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ appStartup()

int MagAOX::app::cred2Ctrl::appStartup ( )

inlinevirtual

Startup function.

Implements MagAOX::app::MagAOXApp< _useINDI >.

Definition at line 541 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::createROIndiNumber(), FRAMEGRABBER_APP_STARTUP, MagAOX::app::MagAOXApp< _useINDI >::log(), m_indiP_fpsLimits, m_indiP_temps, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxFPS, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minFPS, REG_INDI_NEWPROP_NOCB, MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly(), setSerialBaud(), STDCAMERA_APP_STARTUP, and TELEMETER_APP_STARTUP.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ basePath()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::basePath ( )

inherited

Get the.

Returns: the value of m_ *

Definition at line 3969 of file MagAOXApp.hpp.

Referenced by MagAOX::app::streamWriter::loadConfig().

◆ calibDir()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::calibDir ( )

inherited

Get the calibration directory.

Returns: the value of m_calibDir

Definition at line 3993 of file MagAOXApp.hpp.

◆ checkConfig()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::checkConfig ( )

virtualinherited

Check for unused and unrecognized config options and settings.

Logs the unused targets as warnings. Unrecognized and unused options are logged as critical, and m_shutdown is set. Any command line argument (not an option) will also be critical and cause shutdown.

Definition at line 1651 of file MagAOXApp.hpp.

References MagAOX::app::it, flatlogs::logPrio::LOG_CRITICAL, flatlogs::logPrio::LOG_WARNING, and MagAOX::app::msg.

◆ checkFocus() [1/2]

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::checkFocus ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to checkFocus when the derivedT does not expose focus support.

Definition at line 1351 of file stdCamera.hpp.

◆ checkFocus() [2/2]

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::checkFocus ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to checkFocus when the derivedT exposes focus support.

Definition at line 1348 of file stdCamera.hpp.

◆ checkFocusSwitchState()

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::checkFocusSwitchState ( )

inherited

Evaluate the configured focus-state switch helper as an in-focus boolean.

Definition at line 817 of file stdCamera.hpp.

◆ checkNextROI() [1/3]

int MagAOX::app::cred2Ctrl::checkNextROI ( )

inline

Validate and normalize the requested ROI.

Definition at line 1520 of file cred2Ctrl.hpp.

Referenced by setNextROI(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ checkNextROI() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::checkNextROI ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to checkNextROI when the derivedT does not use ROIs.

Tag-dispatch resolution of c_stdCamera_usesROI==false will call this function. This prevents requiring derivedT to have its own checkNextROI().

Definition at line 1257 of file stdCamera.hpp.

◆ checkNextROI() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::checkNextROI ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to checkNextROI when the derivedT uses ROIs.

Tag-dispatch resolution of c_stdCamera_usesROI==true will call this function. Calls derivedT::checkNextROI.

Definition at line 1251 of file stdCamera.hpp.

◆ checkRecordTimes() [1/4]

int MagAOX::app::cred2Ctrl::checkRecordTimes ( )

inline

Check the telemetry record timers.

Definition at line 1742 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log().

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ checkRecordTimes() [2/4]

int MagAOX::app::dev::telemeter< cred2Ctrl >::checkRecordTimes	(	const telT &	tel,
		telTs...	tels
	)

inherited

Check the time of the last record for each telemetry type and make an entry if needed.

This must be called from derivedT::checkRecordTimes(), with one template parameter for ach telemetry log type being recorded.

Returns: 0 on succcess; -1 on error

Parameters

[in]	tel	[unused] object of the telemetry type to record
[in]	tels	[unused] objects of the additional telemetry types to record

Definition at line 156 of file telemeter.hpp.

◆ checkRecordTimes() [3/4]

int MagAOX::app::dev::telemeter< cred2Ctrl >::checkRecordTimes ( timespec & ts )

inherited

Empty function called at the end of the template list.

Returns: 0 on succcess; -1 on error

Parameters

[in] ts [unused] the timestamp that records are compared to

Definition at line 177 of file telemeter.hpp.

◆ checkRecordTimes() [4/4]

int MagAOX::app::dev::telemeter< cred2Ctrl >::checkRecordTimes	(	timespec &	ts,
		const telT &	tel,
		telTs...	tels
	)

inherited

Worker function to actually perform the record time checking logic.

Recursively calls itself until the variadic template list is exhausted.

Returns: 0 on succcess; -1 on error

Parameters

[in]	ts	[unused] the timestamp that records are compared to
[in]	tel	[unused] objects of the telemetry type to record
[in]	tels	[unused] objects of the additional telemetry types to record

Definition at line 167 of file telemeter.hpp.

◆ clearFSMAlert()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::clearFSMAlert ( )

privateinherited

Clear the FSM alert state.

This can only be done from within this class, and this should only be possible via user action via INDI.

Definition at line 2685 of file MagAOXApp.hpp.

References INDI_ALERT, INDI_BUSY, INDI_IDLE, INDI_OK, and flatlogs::logPrio::LOG_WARNING.

◆ configBase()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::configBase ( )

inherited

Get the config base file.

Returns: the value of m_confgBase

Definition at line 3987 of file MagAOXApp.hpp.

◆ configCircBuffs()

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::configCircBuffs ( )

inherited

Definition at line 253 of file frameGrabber.hpp.

◆ configDir()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::configDir ( )

inherited

Get the config directory.

Returns: the current value of m_configDir

Definition at line 3981 of file MagAOXApp.hpp.

Referenced by libXWCTest::xInstGraphTest::TEST_CASE().

◆ configLog()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::configLog	(	const std::string &	name,
		const int &	code,
		const std::string &	value,
		const std::string &	source
	)

staticprotectedinherited

Callback for config system logging.

Called by appConfigurator each time a value is set using the config() operator. You never need to call this directly.

Parameters

[in]	name	The name of the config value
[in]	code	numeric code specifying the type
[in]	value	the value read by the config system
[in]	source	the source of the value.

Definition at line 2132 of file MagAOXApp.hpp.

◆ configName()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::configName ( )

inherited

Get the config name.

Returns: the current value of m_configName

Definition at line 3975 of file MagAOXApp.hpp.

Referenced by MagAOX::app::andorCtrl::loadConfig(), loadConfigImpl(), libXWCTest::appTest::MagAOXAppTest::SCENARIO(), TEST_CASE(), and MagAOX::app::andorCtrl::writeConfig().

◆ configureAcquisition()

int MagAOX::app::cred2Ctrl::configureAcquisition ( )

inline

Configure camera-side ROI settings before acquisition starts.

Definition at line 1612 of file cred2Ctrl.hpp.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ cpusetPath()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::cpusetPath ( )

inherited

Get the cpuset path.

Returns: the value of m_cpusetPath

Definition at line 4011 of file MagAOXApp.hpp.

◆ createFanSpeed() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::createFanSpeed ( const mx::meta::trueFalseT< false > & f )

protectedinherited

◆ createFanSpeed() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::createFanSpeed ( const mx::meta::trueFalseT< true > & t )

protectedinherited

Definition at line 837 of file stdCamera.hpp.

◆ createINDIFIFOS()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createINDIFIFOS ( )

protectedinherited

Create the INDI FIFOs.

Changes permissions to max available and creates the FIFOs at the configured path.

Todo:: make driver FIFO path full configurable.

Definition at line 3222 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_CRITICAL, and MAGAOX_driverFIFORelPath.

◆ createReadoutSpeed() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::createReadoutSpeed ( const mx::meta::trueFalseT< false > & f )

protectedinherited

◆ createReadoutSpeed() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::createReadoutSpeed ( const mx::meta::trueFalseT< true > & t )

protectedinherited

Definition at line 829 of file stdCamera.hpp.

◆ createROIndiNumber()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createROIndiNumber	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	propLabel = `""`,
		const std::string &	propGroup = `""`
	)

inherited

Create a ReadOnly INDI Number property.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	propLabel	[optional] the GUI label suggestion for this property
[in]	propGroup	[optional] the group for this property

Definition at line 2840 of file MagAOXApp.hpp.

Referenced by appStartup(), MagAOX::app::picamCtrl::appStartup(), and MagAOX::app::zaberCtrl::appStartup().

◆ createROIndiText()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createROIndiText	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	elName,
		const std::string &	propLabel = `""`,
		const std::string &	propGroup = `""`,
		const std::string &	elLabel = `""`
	)

inherited

Create a standard ReadOnly INDI Text property, with at least one element.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	elName	the name of the element
[in]	propLabel	[optional] the GUI label suggestion for this property
[in]	propGroup	[optional] the group for this property
[in]	elLabel	[optional] the GUI label suggestion for the element

Definition at line 2757 of file MagAOXApp.hpp.

◆ createStandardIndiNumber()

template<bool _useINDI>

template<typename T >

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiNumber	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const T &	min,
		const T &	max,
		const T &	step,
		const std::string &	format,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI Number property with target and current elements.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	min	the minimum value for the elements, applied to both target and current
[in]	max	the minimum value for the elements, applied to both target and current
[in]	step	the step size for the elements, applied to both target and current
[in]	format	the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type.
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 2793 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::appStartup().

◆ createStandardIndiRequestSw()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiRequestSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI switch with a single request element.

This switch is intended to function like a momentary switch.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 2896 of file MagAOXApp.hpp.

Referenced by MagAOX::app::ocam2KCtrl::appStartup().

◆ createStandardIndiSelectionSw() [1/2]

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::vector< std::string > &	elements,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI selection (one of many) switch with vector of elements using the element strings as their own labels This switch is intended to function like drop down menu.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property,
[in]	elements	the element names to give to the switches
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 2971 of file MagAOXApp.hpp.

◆ createStandardIndiSelectionSw() [2/2]

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::vector< std::string > &	elements,
		const std::vector< std::string > &	elementLabels,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.

This switch is intended to function like drop down menu.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property,
[in]	elements	the element names to give to the switches
[in]	elementLabels	the element labels to give to the switches
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 2926 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::appStartup().

◆ createStandardIndiText()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiText	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI Text property with target and current elements.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 2729 of file MagAOXApp.hpp.

◆ createStandardIndiToggleSw()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiToggleSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI switch with a single toggle element.

This switch is intended to function like an on/off toggle switch.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 2866 of file MagAOXApp.hpp.

Referenced by MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().

◆ createVShiftSpeed() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::createVShiftSpeed ( const mx::meta::trueFalseT< false > & f )

protectedinherited

◆ createVShiftSpeed() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::createVShiftSpeed ( const mx::meta::trueFalseT< true > & t )

protectedinherited

Definition at line 833 of file stdCamera.hpp.

◆ derived()

cred2Ctrl & MagAOX::app::dev::stdCamera< cred2Ctrl >::derived ( )

inlineprivateinherited

Definition at line 1417 of file stdCamera.hpp.

◆ driverCtrlName()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::driverCtrlName ( )

inherited

Get the INDI control FIFO file name.

Returns: the current value of m_driverCtrlName

Definition at line 4041 of file MagAOXApp.hpp.

◆ driverInName()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::driverInName ( )

inherited

Get the INDI input FIFO file name.

Returns: the current value of m_driverInName

Definition at line 4029 of file MagAOXApp.hpp.

◆ driverOutName()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::driverOutName ( )

inherited

Get the INDI output FIFO file name.

Returns: the current value of m_driverOutName

Definition at line 4035 of file MagAOXApp.hpp.

◆ execute()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::execute ( )

virtualinherited

The execute method implementing the standard main loop. Should not normally be overridden.

Performs final startup steps. That is:

Verifies correct effective user-id by comparison to logs directory.
PID locking lockPID()
log thread startup by logThreadStart()
signal handling installation by setSigTermHandler()
appStartup() is called
INDI communications started by startINDI()
power state is checked, pausing if unknown (if being managed)

Errors in the above steps will cause a process exit.

Then commences the main event loop. Conditions on entry to the main loop:

PID locked
Log thread running
Signal handling installed
appStartup successful
INDI communications started successfully (if being used)
power state known (if being managed)

In the event loop, the power state is checked (if being managed). If power is off, then onPowerOff is called. If power is on, or power is not managed, appLogic is called. These methods are implemented in derived classes, and are called every m_loopPause interval.

If an error is returned by either onPowerOff or appLogic, or a signal is handled, then the shutdown is managed. This includes shutting down INDI, calling appShutdown, and unlocking the PID. The log thread will shutdown.

Todo:: Need a heartbeat update here.

Definition at line 1718 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_CRITICAL.

◆ fgThreadExec()

void MagAOX::app::dev::frameGrabber< cred2Ctrl >::fgThreadExec ( )

protectedinherited

Execute framegrabbing.

Todo:: this ought to wait until OPERATING, using READY as a sign of "not integrating"

Definition at line 273 of file frameGrabber.hpp.

◆ fgThreadStart()

void MagAOX::app::dev::frameGrabber< cred2Ctrl >::fgThreadStart ( frameGrabber< cred2Ctrl > * o )

staticprotectedinherited

Thread starter, called by MagAOXApp::threadStart on thread construction. Calls fgThreadExec.

Parameters

[in] o a pointer to a frameGrabber instance (normally this)

Definition at line 270 of file frameGrabber.hpp.

◆ fps()

float MagAOX::app::cred2Ctrl::fps ( )

inline

Return the currently measured frame rate.

Definition at line 1687 of file cred2Ctrl.hpp.

References MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fps.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ getAnalogGain()

int MagAOX::app::cred2Ctrl::getAnalogGain ( )

inline

Query and update the current analog-gain state.

Definition at line 1249 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainName, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainNameSet, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainValid, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), and sendCommand().

Referenced by appLogic(), setAnalogGain(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ getFanSpeed()

int MagAOX::app::cred2Ctrl::getFanSpeed ( )

inline

Query and update the current fan-control state.

Definition at line 1193 of file cred2Ctrl.hpp.

References MagAOX::app::cred2ParseFloat(), MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedName, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedNameSet, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedValid, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), and sendCommand().

Referenced by appLogic(), setFanSpeed(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ getFPS()

int MagAOX::app::cred2Ctrl::getFPS ( )

inline

Query and update the current camera frame rate.

Definition at line 1172 of file cred2Ctrl.hpp.

References MagAOX::app::cred2ParseFloat(), MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fps, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), and sendCommand().

Referenced by appLogic(), setFPS(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ getLEDState()

int MagAOX::app::cred2Ctrl::getLEDState ( )

inline

Query and update the current LED state.

Definition at line 1272 of file cred2Ctrl.hpp.

References MagAOX::app::cred2ParseBool(), MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledState, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledStateSet, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledStateValid, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), and sendCommand().

Referenced by appLogic(), setLED(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ getTemps()

int MagAOX::app::cred2Ctrl::getTemps ( )

inline

Query and update the camera temperature channels.

Definition at line 1084 of file cred2Ctrl.hpp.

Referenced by appLogic(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ gitAlert()

template<bool _useINDI>

bool MagAOX::app::MagAOXApp< _useINDI >::gitAlert ( )

inherited

Get the value of the git alert flag.

Returns: the current value of m_gitAlert

Definition at line 2664 of file MagAOXApp.hpp.

◆ gotoFocus() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::gotoFocus ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to gotoFocus when the derivedT does not expose focus support.

Definition at line 1357 of file stdCamera.hpp.

◆ gotoFocus() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::gotoFocus ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to gotoFocus when the derivedT exposes focus support.

Definition at line 1354 of file stdCamera.hpp.

◆ handleDefProperty()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::handleDefProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the DEF INDI properties notification.

Uses the properties registered in m_indiSetCallBacks to process the notification. This is called by m_indiDriver's indiDriver::handleDefProperties.

Parameters

[in] ipRecv The property being sent.

Definition at line 3430 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv.

◆ handleGetProperties()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::handleGetProperties ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the get INDI properties request.

Uses the properties registered in m_indiCallBacks to respond to the request. This is called by m_indiDriver's indiDriver::handleGetProperties.

Parameters

[in] ipRecv The property being requested.

Definition at line 3436 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv, MagAOX::app::it, and MagAOX::app::lock().

◆ handleNewProperty()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::handleNewProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the new INDI property request.

Uses the properties registered in m_indiCallBacks to respond to the request, looking up the callback for this property and calling it.

This is called by m_indiDriver's indiDriver::handleGetProperties.

Todo:: handle errors, are they FATAL?

Parameters

[in] ipRecv The property being changed.

Definition at line 3523 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv, MagAOX::app::it, and MagAOX::app::lock().

Referenced by libXWCTest::appTest::MagAOXAppTest::SCENARIO().

◆ handlerSigTerm()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::handlerSigTerm	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

privateinherited

Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.

Parameters

[in]	signum	specifies the signal.
[in]	siginf	ignored by MagAOXApp
[in]	ucont	ignored by MagAOXApp

Definition at line 2218 of file MagAOXApp.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::_handlerSigTerm().

◆ handleSetProperty()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::handleSetProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the set INDI property request.

This is called by m_indiDriver's indiDriver::handleSetProperties.

Todo:: handle errors, are they FATAL?

Todo:: log an error here because callBack should not be null

Todo:: log invalid SetProperty request.

Parameters

[in] ipRecv The property being changed.

Definition at line 3555 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv, MagAOX::app::it, and MagAOX::app::lock().

Referenced by MagAOX::app::xInstGraph::igHandleSetProperty().

◆ INDI_SETCALLBACK_DECL()

template<bool _useINDI = true>

MagAOX::app::MagAOXApp< _useINDI >::INDI_SETCALLBACK_DECL	(	MagAOXApp< _useINDI >	,
		m_indiP_powerChannel
	)

inherited

◆ indiSetPropertyShouldRequest()

template<bool _useINDI>

bool MagAOX::app::MagAOXApp< _useINDI >::indiSetPropertyShouldRequest	(	const indiCallBack &	callBack,
		bool	all,
		const std::chrono::steady_clock::time_point &	now
	)		const

inlineinherited

Determine whether an unresolved Set-property subscription should be requested now.

Parameters

[in]	callBack	the subscription retry state to evaluate
[in]	all	if true, force an immediate refresh regardless of retry timing
[in]	now	the current monotonic time for scheduling

Definition at line 3175 of file MagAOXApp.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_defReceived, and MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_nextRetry.

◆ indiTargetUpdate()

template<bool _useINDI>

template<typename T >

int MagAOX::app::MagAOXApp< _useINDI >::indiTargetUpdate	(	pcf::IndiProperty &	localProperty,
		T &	localTarget,
		const pcf::IndiProperty &	remoteProperty,
		bool	setBusy = `true`
	)

protectedinherited

Get the target element value from an new property.

Returns: 0 on success; -1 on error

Parameters

[out]	localProperty	The local property to update
[out]	localTarget	The local value to update
[in]	remoteProperty	the new property received
[in]	setBusy	[optional] set property to busy if true

Definition at line 3700 of file MagAOXApp.hpp.

References INDI_BUSY, and flatlogs::logPrio::LOG_ERROR.

Referenced by MagAOX::app::picoMotorCtrl::newCallBack_picopos().

◆ issueCommand()

int MagAOX::app::cred2Ctrl::issueCommand	(	const std::string &	command,
		bool	allowNoResponse = `false`
	)

inlineprotected

Send a command that should return a success acknowledgement.

Parameters

[in]	command	CLI command to send
[in]	allowNoResponse	treat a missing response as acceptable

Definition at line 917 of file cred2Ctrl.hpp.

References MagAOX::app::cred2ResponseOK(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, and sendCommand().

Referenced by configureAcquisition(), setAnalogGain(), setFanSpeed(), setFPS(), setLED(), setTempSetPt(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ loadBasicConfig()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::loadBasicConfig ( )

virtualinherited

The basic MagAO-X configuration processing method. Should not normally be overridden.

This method processes the standard MagAO-X key=value pairs.

Though it is virtual, it should not normally be overridden unless you need to depart from the MagAO-X standard.

Processing of app specific config goes in loadConfig() implemented by the derived class.

Definition at line 1588 of file MagAOXApp.hpp.

References INDI_SETCALLBACK, flatlogs::logPrio::LOG_CRITICAL, and flatlogs::logPrio::LOG_ERROR.

◆ loadConfig() [1/5]

void MagAOX::app::cred2Ctrl::loadConfig ( )

inlinevirtual

Load the configuration system results.

Definition at line 532 of file cred2Ctrl.hpp.

References loadConfigImpl(), MagAOX::app::MagAOXApp< _useINDI >::log(), and MagAOX::app::MagAOXApp< _useINDI >::m_shutdown.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ loadConfig() [2/5]

int MagAOX::app::dev::telemeter< cred2Ctrl >::loadConfig ( appConfigurator & config )

inherited

Load the device section from an application configurator.

Returns: 0 on success; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration from which to load values

Definition at line 120 of file telemeter.hpp.

◆ loadConfig() [3/5]

void MagAOX::app::dev::edtCamera< cred2Ctrl >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

edtCamera<derivedT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 120 of file edtCamera.hpp.

◆ loadConfig() [4/5]

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

framegrabber<derivedT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 202 of file frameGrabber.hpp.

◆ loadConfig() [5/5]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

stdCamera<derivedT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 810 of file stdCamera.hpp.

◆ loadConfigImpl()

int MagAOX::app::cred2Ctrl::loadConfigImpl ( mx::app::appConfigurator & config )

inline

Implementation of loadConfig logic with standard helper-macro error handling.

Parameters

[in] config application configurator with loaded values

Definition at line 497 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::configName(), FRAMEGRABBER_LOAD_CONFIG, MagAOX::app::dev::edtCamera< derivedT >::loadConfig(), MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_cameraModes, m_configFile, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_nextROI, m_serialBaud, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_startupMode, STDCAMERA_LOAD_CONFIG, TELEMETER_LOAD_CONFIG, and writeConfig().

Referenced by loadConfig().

◆ loadImageIntoStream()

int MagAOX::app::cred2Ctrl::loadImageIntoStream ( void * dest )

inline

Copy the current EDT image into the output stream.

Parameters

[in] dest destination frame buffer

Definition at line 1704 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_height, MagAOX::app::dev::edtCamera< cred2Ctrl >::m_image_p, MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_typeSize, and MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_width.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ loadImageIntoStreamCopy()

void * MagAOX::app::dev::frameGrabber< cred2Ctrl >::loadImageIntoStreamCopy	(	void *	dest,
		void *	src,
		size_t	width,
		size_t	height,
		size_t	szof
	)

protectedinherited

Definition at line 277 of file frameGrabber.hpp.

◆ lockPID()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::lockPID ( )

protectedinherited

Attempt to lock the PID by writing it to a file. Fails if a process is already running with the same config name. First checks the PID file for an existing PID. If found, interrogates /proc to determine if that process is running and if so if the command line matches. If a matching process is currently running, then this returns an error.

Will not fail if a PID file exists but the stored PID does not correspond to a running process with the same command line name.

Reference: https://linux.die.net/man/3/getpid

Returns: 0 on success.; -1 on any error, including creating the PID file or if this app is already running.

Definition at line 2289 of file MagAOXApp.hpp.

◆ log() [1/2]

template<bool _useINDI>

template<typename logT , int retval>

int MagAOX::app::MagAOXApp< _useINDI >::log	(	const typename logT::messageT &	msg,
		logPrioT	level = `logPrio::LOG_DEFAULT`
	)

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in]	msg	the message to log
[in]	level	[optional] the log level. The default is used if not specified.

Definition at line 2074 of file MagAOXApp.hpp.

References MagAOX::app::msg.

◆ log() [2/2]

template<bool _useINDI>

template<typename logT , int retval>

int MagAOX::app::MagAOXApp< _useINDI >::log ( logPrioT level = logPrio::LOG_DEFAULT )

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in] level [optional] the log level. The default is used if not specified.

Definition at line 2082 of file MagAOXApp.hpp.

◆ logMessage()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::logMessage ( bufferPtrT & b )

inherited

Handle a log message from the logging system.

This is a callback from the logManager, and is called when the log thread is processing log entries.

Decides whether to display to stderr and whether to send via INDI.

Definition at line 2089 of file MagAOXApp.hpp.

References b(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_NOTICE, flatlogs::logHeader::logLevel(), MagAOX::logger::logMinStdFormat(), MagAOX::logger::logStdFormat(), MagAOX::app::msg, flatlogs::timespecX::time_ns, flatlogs::timespecX::time_s, and flatlogs::logHeader::timespec().

◆ loopPause()

template<bool _useINDI>

unsigned long MagAOX::app::MagAOXApp< _useINDI >::loopPause ( )

inherited

Get the loop pause time.

Returns: the value of m_loopPause

Definition at line 4017 of file MagAOXApp.hpp.

◆ newCallBack_analogGain()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_analogGain ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW analog-gain request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1120 of file stdCamera.hpp.

◆ newCallBack_clearFSMAlert()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::newCallBack_clearFSMAlert ( const pcf::IndiProperty & ipRecv )

protectedinherited

The callback called by the static version, to actually process the FSM Alert Clear request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the new property request.

Definition at line 3851 of file MagAOXApp.hpp.

References INDI_IDLE, and MagAOX::app::ipRecv.

◆ newCallBack_cropMode()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_cropMode ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW cropMode request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1196 of file stdCamera.hpp.

◆ newCallBack_emgain()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_emgain ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW EM gain request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1040 of file stdCamera.hpp.

◆ newCallBack_exptime()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_exptime ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW exposure time request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1060 of file stdCamera.hpp.

◆ newCallBack_fanSpeed()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_fanSpeed ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW fan speed request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1100 of file stdCamera.hpp.

◆ newCallBack_fps()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_fps ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW fps request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1080 of file stdCamera.hpp.

◆ newCallBack_gotoFocus()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_gotoFocus ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW goto-focus request.

Parameters

[in] ipRecv the INDI property sent with the new property request.

Definition at line 1360 of file stdCamera.hpp.

◆ newCallBack_led()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_led ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW LED request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1140 of file stdCamera.hpp.

◆ newCallBack_mode()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_mode ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW mode request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1168 of file stdCamera.hpp.

◆ newCallBack_readoutSpeed()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_readoutSpeed ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW readout speed request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1000 of file stdCamera.hpp.

◆ newCallBack_reconfigure()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_reconfigure ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW reconfigure request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1176 of file stdCamera.hpp.

◆ newCallBack_roi_bin_x()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_bin_x ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW bin_x request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1236 of file stdCamera.hpp.

◆ newCallBack_roi_bin_y()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_bin_y ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW bin_y request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1244 of file stdCamera.hpp.

◆ newCallBack_roi_check()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_check ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_check request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1264 of file stdCamera.hpp.

◆ newCallBack_roi_default()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_default ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_default request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1324 of file stdCamera.hpp.

◆ newCallBack_roi_full()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_full ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_full request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1292 of file stdCamera.hpp.

◆ newCallBack_roi_fullbin()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_fullbin ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_fullbin request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1300 of file stdCamera.hpp.

◆ newCallBack_roi_h()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_h ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_h request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1228 of file stdCamera.hpp.

◆ newCallBack_roi_last()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_last ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_last request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1316 of file stdCamera.hpp.

◆ newCallBack_roi_loadlast()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_loadlast ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_loadlast request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1308 of file stdCamera.hpp.

◆ newCallBack_roi_set()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_set ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_set request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1284 of file stdCamera.hpp.

◆ newCallBack_roi_w()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_w ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_w request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1220 of file stdCamera.hpp.

◆ newCallBack_roi_x()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_x ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_x request.

Returns: 0 on success.; -1 on error.

Todo:: why don't these check if usesROI is true?

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1204 of file stdCamera.hpp.

◆ newCallBack_roi_y()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_roi_y ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW roi_y request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1212 of file stdCamera.hpp.

◆ newCallBack_shutter()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_shutter ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW shutter request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1344 of file stdCamera.hpp.

◆ newCallBack_stdCamera()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_stdCamera ( const pcf::IndiProperty & ipRecv )

inherited

The callback function for stdCamera properties.

Dispatches to the relevant handler

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 940 of file stdCamera.hpp.

◆ newCallBack_synchro()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_synchro ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW synchro request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1160 of file stdCamera.hpp.

◆ newCallBack_temp()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_temp ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW CCD temp request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 960 of file stdCamera.hpp.

◆ newCallBack_temp_controller()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_temp_controller ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW CCD temp control request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 980 of file stdCamera.hpp.

◆ newCallBack_vShiftSpeed()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::newCallBack_vShiftSpeed ( const pcf::IndiProperty & ipRecv )

inherited

Callback to process a NEW vshift speed request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 1020 of file stdCamera.hpp.

◆ noteIndiSetPropertyRequested()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::noteIndiSetPropertyRequested	(	indiCallBack &	callBack,
		const std::chrono::steady_clock::time_point &	now
	)

inlineinherited

Update retry tracking after sending a GetProperties request for a monitored Set-property.

Parameters

	callBack	[in/out] the subscription retry state to update
[in]	now	the current monotonic time for scheduling

Definition at line 3193 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_NOTICE, MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_missingLogged, MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_nextRetry, MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_retryCount, MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_retryDelay, and MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::property.

◆ onPowerOff()

int MagAOX::app::cred2Ctrl::onPowerOff ( )

inlinevirtual

Actions required when the camera power turns off.

Reimplemented from MagAOX::app::MagAOXApp< _useINDI >.

Definition at line 820 of file cred2Ctrl.hpp.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ openShmim()

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::openShmim ( )

protectedinherited

Definition at line 279 of file frameGrabber.hpp.

◆ pdvAcquire()

int MagAOX::app::dev::edtCamera< cred2Ctrl >::pdvAcquire ( timespec & currImageTimestamp )

inherited

Definition at line 190 of file edtCamera.hpp.

◆ pdvConfig()

int MagAOX::app::dev::edtCamera< cred2Ctrl >::pdvConfig ( std::string & cfgname )

inherited

Configure the EDT framegrabber.

Parameters

[in] cfgname The configuration name for the mode to set

Definition at line 100 of file edtCamera.hpp.

◆ pdvReconfig()

int MagAOX::app::dev::edtCamera< cred2Ctrl >::pdvReconfig ( )

inherited

Definition at line 192 of file edtCamera.hpp.

◆ pdvSerialWriteRead()

int MagAOX::app::dev::edtCamera< cred2Ctrl >::pdvSerialWriteRead	(	std::string &	response,
		const std::string &	command,
		bool	logErrors = `true`
	)

inherited

Send a serial command over cameralink and retrieve the response.

Parameters

[out]	response	the response to the command from the device
[in]	command	the command to send to the device
[in]	logErrors	log serial transport failures when true

Definition at line 94 of file edtCamera.hpp.

◆ pdvStartAcquisition()

int MagAOX::app::dev::edtCamera< cred2Ctrl >::pdvStartAcquisition ( )

inherited

Definition at line 188 of file edtCamera.hpp.

◆ postPublishHook() [1/2]

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::postPublishHook	(	cred2Ctrl &	hookOwner,
		IMAGE *	imageStream,
		long	callPriorityTag
	)

staticprivateinherited

Return success when the derived class does not expose a post-publication hook.

Parameters

[in]	hookOwner	derived object lacking the optional hook
[in]	imageStream	published image stream
[in]	callPriorityTag	fallback overload selector

Definition at line 323 of file frameGrabber.hpp.

◆ postPublishHook() [2/2]

auto MagAOX::app::dev::frameGrabber< cred2Ctrl >::postPublishHook	(	hookT &	hookOwner,
		IMAGE *	imageStream,
		int	callPriorityTag
	)		-> decltype( hookOwner.frameGrabberPostPublish( imageStream ) )

staticprivateinherited

Call an optional derived-class hook after the main stream publication completes.

Parameters

[in]	hookOwner	derived object that may expose the hook
[in]	imageStream	published image stream
[in]	callPriorityTag	overload selector preferring the hook

Definition at line 317 of file frameGrabber.hpp.

◆ powerOnDefaults()

int MagAOX::app::cred2Ctrl::powerOnDefaults ( )

inline

Set defaults for a power-on state.

Definition at line 1356 of file cred2Ctrl.hpp.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ powerOnWaitElapsed()

template<bool _useINDI>

bool MagAOX::app::MagAOXApp< _useINDI >::powerOnWaitElapsed ( )

protectedinherited

This method tests whether the power on wait time has elapsed.

You would call this once per appLogic loop while in state POWERON. While false, you would return 0. Once it becomes true, take post-power-on actions and go on with life.

Returns: true if the time since POWERON is greater than the power-on wait, or if power management is not enabled; false otherwise

Definition at line 3884 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), and MagAOX::app::xt1121Ctrl::appLogic().

◆ powerState()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::powerState ( )

inherited

Returns the current power state.

If power management is not enabled, this always returns 1=On.

Returns: -1 if power state is unknown; 0 if power is off; 1 if power is on or m_powerMgtEnabled==false

Definition at line 3903 of file MagAOXApp.hpp.

◆ powerStateTarget()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget ( )

inherited

Returns the target power state.

If power management is not enabled, this always returns 1=On.

Returns: -1 if target power state is unknown; 0 if target power state is off; 1 if target power is on or m_powerMgtEnabled==false

Definition at line 3914 of file MagAOXApp.hpp.

◆ reconfig()

int MagAOX::app::cred2Ctrl::reconfig ( )

inline

Reconfigure the EDT board for the pending ROI.

Definition at line 1714 of file cred2Ctrl.hpp.

References MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::MagAOXApp< _useINDI >::log(), m_cameraMutex, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_modeName, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_nextMode, MagAOX::app::stateCodes::READY, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), setSerialBaud(), MagAOX::app::MagAOXApp< _useINDI >::state(), and writeConfig().

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ recordCamera()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera ( bool force = false )

inherited

Definition at line 1412 of file stdCamera.hpp.

◆ recordFGTimings()

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::recordFGTimings ( bool force = false )

inherited

Definition at line 310 of file frameGrabber.hpp.

◆ recordTelem() [1/3]

int MagAOX::app::cred2Ctrl::recordTelem ( const cred2_temps * )

inline

Record the detailed C-RED 2 temperature telemetry.

Definition at line 1747 of file cred2Ctrl.hpp.

References recordTemps().

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ recordTelem() [2/3]

int MagAOX::app::cred2Ctrl::recordTelem ( const telem_fgtimings * )

inline

Record framegrabber timing telemetry.

Definition at line 1757 of file cred2Ctrl.hpp.

References MagAOX::app::dev::frameGrabber< cred2Ctrl >::recordFGTimings().

◆ recordTelem() [3/3]

int MagAOX::app::cred2Ctrl::recordTelem ( const telem_stdcam * )

inline

Record standard camera telemetry.

Definition at line 1752 of file cred2Ctrl.hpp.

References MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera().

◆ recordTemps()

int MagAOX::app::cred2Ctrl::recordTemps ( bool force = false )

inline

Record the detailed C-RED 2 temperature telemetry when values change.

Parameters

[in] force force a telemetry record even if the cached values match

Definition at line 1762 of file cred2Ctrl.hpp.

Referenced by getTemps(), recordTelem(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ registerIndiPropertyNew() [1/3]

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState,
		const pcf::IndiProperty::SwitchRuleType &	propRule,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for, with a switch rule.

This verison sets up the INDI property according to the arguments.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property
[in]	propRule	the switch rule type

◆ registerIndiPropertyNew() [2/3]

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for.

This verison sets up the INDI property according to the arguments.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property

◆ registerIndiPropertyNew() [3/3]

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for.

In this version the supplied IndiProperty must be fully set up before passing in.

Returns: 0 on success.; -1 on error.

Parameters

[in] prop the property to register, must be fully set up

Referenced by MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::zaberCtrl::appStartup(), and libXWCTest::appTest::MagAOXAppTest::SCENARIO().

◆ registerIndiPropertyReadOnly() [1/2]

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly ( pcf::IndiProperty & prop )

inherited

Register an INDI property which is read only.

This version requires the property be fully set up.

Returns: 0 on success.; -1 on error.

Parameters

[in] prop the property to register, must be completely setup

Definition at line 2981 of file MagAOXApp.hpp.

References MagAOX::app::lock().

Referenced by appStartup(), MagAOX::app::picamCtrl::appStartup(), and MagAOX::app::zaberCtrl::appStartup().

◆ registerIndiPropertyReadOnly() [2/2]

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState
	)

inherited

Register an INDI property which is read only.

This verison sets up the INDI property according to the arguments.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register, will be configured
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property

Definition at line 3013 of file MagAOXApp.hpp.

References MagAOX::app::lock().

◆ registerIndiPropertySet()

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertySet	(	pcf::IndiProperty &	prop,
		const std::string &	devName,
		const std::string &	propName,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is monitored for updates from others.

Returns: 0 on success.; -1 on error.

Parameters

[out]	prop	the property to register
[in]	devName	the device which owns this property
[in]	propName	the name of the property

Definition at line 3128 of file MagAOXApp.hpp.

References MagAOX::app::lock().

◆ resetIndiSetPropertyRetry()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::resetIndiSetPropertyRetry ( indiCallBack & callBack )

inlineinherited

Reset retry tracking for a monitored INDI Set-property subscription.

Parameters

callBack [in/out] the subscription retry state to reset

Definition at line 3166 of file MagAOXApp.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_missingLogged, MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_nextRetry, MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_retryCount, and MagAOX::app::MagAOXApp< _useINDI >::indiCallBack::m_retryDelay.

◆ secretsPath()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::secretsPath ( )

inherited

Get the secrets path.

Returns: the value of m_secretsPath

Definition at line 4005 of file MagAOXApp.hpp.

◆ sendCommand()

int MagAOX::app::cred2Ctrl::sendCommand	(	std::string &	response,
		const std::string &	command,
		bool	logFailure = `true`
	)

inlineprotected

Send a command over Camera Link serial and clean the response.

Parameters

[out]	response	cleaned command response
[in]	command	CLI command to send
[in]	logFailure	log transport failures when true

Definition at line 888 of file cred2Ctrl.hpp.

References MagAOX::app::cred2CleanResponse(), MagAOX::app::MagAOXApp< _useINDI >::log(), m_cameraMutex, MagAOX::app::dev::edtCamera< cred2Ctrl >::pdvSerialWriteRead(), MagAOX::app::MagAOXApp< _useINDI >::powerState(), and MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget().

Referenced by appLogic(), getAnalogGain(), getFanSpeed(), getFPS(), getLEDState(), getTemps(), issueCommand(), syncROIFromCamera(), libXWCTest::cred2CtrlTest::TEST_CASE(), and updateFPSLimits().

◆ sendGetPropertySetList()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::sendGetPropertySetList ( bool all = false )

inherited

Definition at line 3345 of file MagAOXApp.hpp.

References MagAOX::app::it, and MagAOX::app::lock().

◆ sendGotoFocusCommand()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::sendGotoFocusCommand ( )

inherited

Format and send the configured goto-focus switch command.

Returns: 0 on success.; -1 if formatting fails or the command cannot be dispatched.

Definition at line 823 of file stdCamera.hpp.

◆ sendNewProperty() [1/2]

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty ( const pcf::IndiProperty & ipSend )

protectedinherited

Send a newProperty command to another device (using the INDI Client interface)

Returns: 0 on success.; -1 on an error, which will be logged

Parameters

[in] ipSend The property to send a "new" INDI command for

Definition at line 3787 of file MagAOXApp.hpp.

◆ sendNewProperty() [2/2]

template<bool _useINDI>

template<typename T >

int MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty	(	const pcf::IndiProperty &	ipSend,
		const std::string &	el,
		const T &	newVal
	)

protectedinherited

Send a newProperty command to another device (using the INDI Client interface)

Copies the input IndiProperty, then updates the element with the new value.

Returns: 0 on success.; -1 on an errory.

Parameters

[in]	ipSend	The property to send a "new" INDI command for
[in]	el	The element of the property to change
[in]	newVal	The value to request for the element.

Definition at line 3751 of file MagAOXApp.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty().

Referenced by MagAOX::app::ttmModulator::modTTM(), MagAOX::app::zaberCtrl::moveTo(), MagAOX::app::ttmModulator::offset12(), MagAOX::app::ttmModulator::offsetXY(), MagAOX::app::ttmModulator::restTTM(), MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setSynchro(), MagAOX::app::ttmModulator::setTTM(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::zaberCtrl::stop(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOn(), and MagAOX::app::picamCtrl::updateFxnGenSync().

◆ sendNewStandardIndiToggle()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::sendNewStandardIndiToggle	(	const std::string &	device,
		const std::string &	property,
		bool	onoff
	)

protectedinherited

Send a new property commmand for a standard toggle switch.

Returns: 0 on success; -1 on an error, which will be logged.

Parameters

[in]	device	The device name
[in]	property	The property name
[in]	onoff	Switch state to send: true = on, false = off

Definition at line 3808 of file MagAOXApp.hpp.

◆ setAnalogGain() [1/3]

int MagAOX::app::cred2Ctrl::setAnalogGain ( )

inline

Send the requested analog-gain mode to the camera.

Definition at line 1478 of file cred2Ctrl.hpp.

References getAnalogGain(), issueCommand(), MagAOX::app::MagAOXApp< _useINDI >::log(), and MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainNameSet.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setAnalogGain() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setAnalogGain ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setAnalogGain when the derivedT does not expose analog-gain controls.

Tag-dispatch resolution of analog-gain control availability will call this function. This prevents requiring derivedT to have its own setAnalogGain().

Definition at line 1113 of file stdCamera.hpp.

◆ setAnalogGain() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setAnalogGain ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setAnalogGain when the derivedT exposes analog-gain controls.

Tag-dispatch resolution of analog-gain control availability will call this function. Calls derivedT::setAnalogGain.

Definition at line 1107 of file stdCamera.hpp.

◆ setCallBack_focusMonitored()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setCallBack_focusMonitored ( const pcf::IndiProperty & ipRecv )

inherited

The callback which caches external focus-helper switch-property updates.

Parameters

[in] ipRecv the INDI property sent with the set-property update.

Definition at line 1370 of file stdCamera.hpp.

◆ setCropMode() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setCropMode ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setCropMode when the derivedT does not have crop mode.

Tag-dispatch resolution of c_stdCamera_cropMode==false will call this function. This prevents requiring derivedT to have its own setCropMode().

Definition at line 1189 of file stdCamera.hpp.

◆ setCropMode() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setCropMode ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setCropMode when the derivedT has crop mode.

Tag-dispatch resolution of c_stdCamera_cropMode==true will call this function. Calls derivedT::setCropMode.

Definition at line 1183 of file stdCamera.hpp.

◆ setDefaults()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::setDefaults	(	int	argc,
		char **	argv
	)

virtualinherited

Set the paths for config files.

Replaces the mx::application defaults with the MagAO-X config system.

This function parses the CL for "-n" or "--name".

Do not override this unless you intend to depart from the MagAO-X standard.

Parameters

[in]	argc	standard command line result specifying number of arguments in argv
[in]	argv	standard command line result containing the arguments.

Definition at line 1374 of file MagAOXApp.hpp.

References MAGAOX_calibRelPath, MAGAOX_configRelPath, MAGAOX_env_calib, MAGAOX_env_config, MAGAOX_env_cpuset, MAGAOX_env_log, MAGAOX_env_path, MAGAOX_env_secrets, MAGAOX_env_sys, MAGAOX_logRelPath, MAGAOX_path, MAGAOX_secretsRelPath, and MAGAOX_sysRelPath.

◆ setEMGain() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setEMGain ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setEMGain when the derivedT does not have EM Gain.

Tag-dispatch resolution of c_stdCamera_emGain==false will call this function. This prevents requiring derivedT to have its own setEMGain().

Definition at line 1033 of file stdCamera.hpp.

◆ setEMGain() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setEMGain ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setEMGain when the derivedT has EM Gain.

Tag-dispatch resolution of c_stdCamera_emGain==true will call this function. Calls derivedT::setEMGain.

Definition at line 1027 of file stdCamera.hpp.

◆ setEuidCalled()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::setEuidCalled ( )

privateinherited

Set the effective user ID to the called value, i.e. the highest possible.

If setuid is set on the file, this will be super-user privileges.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns: 0 on success; -1 on error from setuid().

Definition at line 2252 of file MagAOXApp.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::elevate().

◆ setEuidReal()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::setEuidReal ( )

privateinherited

Set the effective user ID to the real value, i.e. the file owner.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns: 0 on success; -1 on error from setuid().

Definition at line 2270 of file MagAOXApp.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::restore().

◆ setExpTime() [1/3]

int MagAOX::app::cred2Ctrl::setExpTime ( )

inline

Required by stdCamera, but unused for C-RED 2.

Definition at line 1515 of file cred2Ctrl.hpp.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setExpTime() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setExpTime ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setExptime when the derivedT does not use exposure time controls.

Tag-dispatch resolution of c_stdCamera_exptimeCtrl==false will call this function. This prevents requiring derivedT to have its own setExpTime().

Definition at line 1053 of file stdCamera.hpp.

◆ setExpTime() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setExpTime ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setExpTime when the derivedT uses exposure time controls.

Tag-dispatch resolution of c_stdCamera_exptimeCtrl==true will call this function. Calls derivedT::setExpTime.

Definition at line 1047 of file stdCamera.hpp.

◆ setFanSpeed() [1/3]

int MagAOX::app::cred2Ctrl::setFanSpeed ( )

inline

Send the requested fan-control mode to the camera.

Definition at line 1447 of file cred2Ctrl.hpp.

References getFanSpeed(), issueCommand(), MagAOX::app::MagAOXApp< _useINDI >::log(), and MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedNameSet.

Referenced by appLogic(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setFanSpeed() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setFanSpeed ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setFanSpeed when the derivedT does not expose fan controls.

Tag-dispatch resolution of fan control availability will call this function. This prevents requiring derivedT to have its own setFanSpeed().

Definition at line 1093 of file stdCamera.hpp.

◆ setFanSpeed() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setFanSpeed ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setFanSpeed when the derivedT exposes fan controls.

Tag-dispatch resolution of fan control availability will call this function. Calls derivedT::setFanSpeed.

Definition at line 1087 of file stdCamera.hpp.

◆ setFPS() [1/3]

int MagAOX::app::cred2Ctrl::setFPS ( )

inline

Send the requested frame rate to the camera.

Definition at line 1426 of file cred2Ctrl.hpp.

References getFPS(), issueCommand(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fpsSet, and MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxFPS.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setFPS() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setFPS ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setFPS when the derivedT does not use FPS controls.

Tag-dispatch resolution of c_stdCamera_hasFPS==false will call this function. This prevents requiring derivedT to have its own setFPS().

Definition at line 1073 of file stdCamera.hpp.

◆ setFPS() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setFPS ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setFPS when the derivedT uses FPS controls.

Tag-dispatch resolution of c_stdCamera_fpsCtrl==true will call this function. Calls derivedT::setFPS.

Definition at line 1067 of file stdCamera.hpp.

◆ setLED() [1/3]

int MagAOX::app::cred2Ctrl::setLED ( )

inline

Send the requested LED state to the camera.

Definition at line 1495 of file cred2Ctrl.hpp.

References getLEDState(), issueCommand(), and MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledStateSet.

Referenced by appLogic(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setLED() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setLED ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setLED when the derivedT does not expose LED controls.

Tag-dispatch resolution of LED control availability will call this function. This prevents requiring derivedT to have its own setLED().

Definition at line 1133 of file stdCamera.hpp.

◆ setLED() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setLED ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setLED when the derivedT exposes LED controls.

Tag-dispatch resolution of LED control availability will call this function. Calls derivedT::setLED.

Definition at line 1127 of file stdCamera.hpp.

◆ setNextROI() [1/3]

int MagAOX::app::cred2Ctrl::setNextROI ( )

inline

Request that the next valid ROI be applied through reconfiguration.

Definition at line 1558 of file cred2Ctrl.hpp.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setNextROI() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setNextROI ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setNextROI when the derivedT does not use ROIs.

Tag-dispatch resolution of c_stdCamera_usesROI==false will call this function. This prevents requiring derivedT to have its own setNextROI().

Definition at line 1277 of file stdCamera.hpp.

◆ setNextROI() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setNextROI ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setNextROI when the derivedT uses ROIs.

Tag-dispatch resolution of c_stdCamera_usesROI==true will call this function. Calls derivedT::setNextROI.

Definition at line 1271 of file stdCamera.hpp.

◆ setReadoutSpeed() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setReadoutSpeed ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setReadoutSpeed when the derivedT does not have readout speed control.

Tag-dispatch resolution of c_stdCamera_readoutSpeed==false will call this function. Just returns 0.

Definition at line 993 of file stdCamera.hpp.

◆ setReadoutSpeed() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setReadoutSpeed ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setReadoutSpeed when the derivedT has readout speed control.

Tag-dispatch resolution of c_stdCamera_readoutSpeed==true will call this function. Calls derivedT::setReadoutSpeed.

Definition at line 987 of file stdCamera.hpp.

◆ setSerialBaud()

int MagAOX::app::cred2Ctrl::setSerialBaud ( )

inlineprotected

Apply and verify the configured Camera Link serial baud rate.

Definition at line 1047 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::edtCamera< cred2Ctrl >::m_pdv, and m_serialBaud.

Referenced by appStartup(), reconfig(), and syncROIFromCamera().

◆ setShutter() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setShutter	(	int	ss,
		const mx::meta::trueFalseT< false > &	f
	)

inherited

Interface to setShutter when the derivedT does not have a shutter.

Tag-dispatch resolution of c_stdCamera_hasShutter==false will call this function. This prevents requiring derivedT to have its own setShutter().

Definition at line 1337 of file stdCamera.hpp.

◆ setShutter() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setShutter	(	int	ss,
		const mx::meta::trueFalseT< true > &	t
	)

inherited

Interface to setShutter when the derivedT has a shutter.

Tag-dispatch resolution of c_stdCamera_hasShutter==true will call this function. Calls derivedT::setShutter.

Definition at line 1331 of file stdCamera.hpp.

◆ setSigTermHandler()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::setSigTermHandler ( )

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 2141 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_DEBUG.

◆ setSynchro() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setSynchro ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setSynchro when the derivedT does not have synchronization.

Tag-dispatch resolution of c_stdCamera_ynchro==false will call this function. This prevents requiring derivedT to have its own setSynchro().

Definition at line 1153 of file stdCamera.hpp.

◆ setSynchro() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setSynchro ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setSynchro when the derivedT has synchronization.

Tag-dispatch resolution of c_stdCamera_synchro==true will call this function. Calls derivedT::setSynchro.

Definition at line 1147 of file stdCamera.hpp.

◆ setTempControl() [1/3]

int MagAOX::app::cred2Ctrl::setTempControl ( )

inline

Implement the C-RED 2 temperature-controller toggle semantics.

Definition at line 1382 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ccdTempSetpt, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatusSet, and setTempSetPt().

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setTempControl() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setTempControl ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setTempControl when the derivedT does not have temperature control.

Tag-dispatch resolution of c_stdCamera_tempControl==false will call this function. Prevents requiring derivedT::setTempControl.

Definition at line 973 of file stdCamera.hpp.

◆ setTempControl() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setTempControl ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setTempControl when the derivedT has temperature control.

Tag-dispatch resolution of c_stdCamera_tempControl==true will call this function. Calls derivedT::setTempControl.

Definition at line 967 of file stdCamera.hpp.

◆ setTempSetPt() [1/3]

int MagAOX::app::cred2Ctrl::setTempSetPt ( )

inline

Send the current target detector temperature setpoint to the camera.

Definition at line 1400 of file cred2Ctrl.hpp.

References issueCommand(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ccdTempSetpt, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxTemp, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlOnTarget, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatus, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatusSet, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatusStr, and MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera().

Referenced by appLogic(), setTempControl(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setTempSetPt() [2/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setTempSetPt ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setTempSetPt when the derivedT does not have temperature control.

Tag-dispatch resolution of c_stdCamera_tempControl==false will call this function. Prevents requiring derivedT::setTempSetPt.

Definition at line 953 of file stdCamera.hpp.

◆ setTempSetPt() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setTempSetPt ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setTempSetPt when the derivedT has temperature control.

Tag-dispatch resolution of c_stdCamera_tempControl==true will call this function. Calls derivedT::setTempSetPt.

Definition at line 947 of file stdCamera.hpp.

◆ setupBasicConfig()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::setupBasicConfig ( )

virtualinherited

The basic MagAO-X configuration setup method. Should not normally be overridden.

This method sets up the config system with the standard MagAO-X key=value pairs.

Though it is virtual, it should not normally be overridden unless you need to depart from the MagAO-X standard.

Setting up app specific config goes in setupConfig() implemented in the derived class.

Definition at line 1491 of file MagAOXApp.hpp.

◆ setupConfig() [1/5]

void MagAOX::app::cred2Ctrl::setupConfig ( )

inlinevirtual

Setup the configuration system.

Definition at line 476 of file cred2Ctrl.hpp.

References FRAMEGRABBER_SETUP_CONFIG, MagAOX::app::dev::edtCamera< derivedT >::setupConfig(), STDCAMERA_SETUP_CONFIG, and TELEMETER_SETUP_CONFIG.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ setupConfig() [2/5]

int MagAOX::app::dev::telemeter< cred2Ctrl >::setupConfig ( appConfigurator & config )

inherited

Setup an application configurator for the device section.

Returns: 0 on success.; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration to setup

Definition at line 112 of file telemeter.hpp.

◆ setupConfig() [3/5]

void MagAOX::app::dev::edtCamera< cred2Ctrl >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

edtCamera<derivedT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 110 of file edtCamera.hpp.

◆ setupConfig() [4/5]

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

framegrabber<derivedT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 192 of file frameGrabber.hpp.

◆ setupConfig() [5/5]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

stdCamera<derivedT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 800 of file stdCamera.hpp.

◆ setVShiftSpeed() [1/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setVShiftSpeed ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to setVShiftSpeed when the derivedT does not have vshift speed control.

Tag-dispatch resolution of c_stdCamera_vShiftSpeed==false will call this function. Just returns 0.

Definition at line 1013 of file stdCamera.hpp.

◆ setVShiftSpeed() [2/2]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::setVShiftSpeed ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to setVShiftSpeed when the derivedT has vshift speed control.

Tag-dispatch resolution of c_stdCamera_vShiftSpeed==true will call this function. Calls derivedT::setVShiftSpeed.

Definition at line 1007 of file stdCamera.hpp.

◆ shutdown()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::shutdown ( )

inherited

Get the value of the shutdown flag.

Returns: the current value of m_shutdown

Definition at line 4023 of file MagAOXApp.hpp.

Referenced by MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::streamWriter::swThreadExec(), and libXWCTest::xInstGraphTest::TEST_CASE().

◆ st_newCallBack_clearFSMAlert()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::st_newCallBack_clearFSMAlert	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticprotectedinherited

The static callback function to be registered for requesting to clear the FSM alert.

Returns: 0 on success.; -1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to MagAOXApp.
[in]	ipRecv	the INDI property sent with the new property request.

Definition at line 3845 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv.

◆ st_newCallBack_stdCamera()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::st_newCallBack_stdCamera	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for stdCamera properties.

Calls newCallback_stdCamera

Returns: 0 on success.; -1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to derivedT.
[in]	ipRecv	the INDI property sent with the the new property request.

Definition at line 929 of file stdCamera.hpp.

◆ st_setCallBack_focusMonitored()

int MagAOX::app::dev::stdCamera< cred2Ctrl >::st_setCallBack_focusMonitored	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function registered for external focus-helper switch properties.

Parameters

[in]	app	a pointer to this, which will be static_cast-ed to derivedT
[in]	ipRecv	the INDI property sent with the set-property update

Definition at line 1364 of file stdCamera.hpp.

◆ startAcquisition()

int MagAOX::app::cred2Ctrl::startAcquisition ( )

inline

Start frame acquisition on the EDT board.

Definition at line 1692 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::stateCodes::OPERATING, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), and MagAOX::app::MagAOXApp< _useINDI >::state().

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ startINDI()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::startINDI ( )

protectedinherited

Start INDI Communications.

Returns: 0 on success; -1 on error. This is fatal.

Definition at line 3288 of file MagAOXApp.hpp.

◆ state() [1/2]

template<bool _useINDI>

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::state ( )

inherited

Get the current state code.

Returns: m_state

Definition at line 2594 of file MagAOXApp.hpp.

◆ state() [2/2]

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::state	(	const stateCodes::stateCodeT &	s,
		bool	stateAlert = `false`
	)

inherited

Set the current state code.

Todo:: move this to a function in stateCodes

Parameters

[in]	s	The new application state
[in]	stateAlert	[optional] flag to set the alert state of the FSM property.

Definition at line 2600 of file MagAOXApp.hpp.

References INDI_ALERT, INDI_BUSY, INDI_IDLE, INDI_OK, MagAOX::app::lock(), flatlogs::logPrio::LOG_CRITICAL, flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_INFO, and flatlogs::logPrio::LOG_WARNING.

◆ stateAlert()

template<bool _useINDI>

bool MagAOX::app::MagAOXApp< _useINDI >::stateAlert ( )

inherited

Get the value of the state alert flag.

Returns: the current value of m_stateAlert

Definition at line 2658 of file MagAOXApp.hpp.

◆ stateLogged()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::stateLogged ( )

inherited

Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

This method exists to facilitate logging the reason for a state change once, but not logging it on subsequent event loops. Returns the current value upon entry, but updates before returning so that the next call returns the incremented value. Example usage:

if( connection_failed ) //some condition set this to true
{
   state( stateCodes::NOTCONNECTED );
   if(!stateLogged()) log<text_log>("Not connected");
}

In this example, the log entry is made the first time the state changes. If there are no changes to a different state in the mean time, then when the event loop gets here again and decides it is not connected, the log entry will not be made.

Returns: current value of m_stateLogged, that is the value before it is incremented.

Definition at line 2670 of file MagAOXApp.hpp.

◆ stateString() [1/2]

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::stateString ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to stateString when the derivedT does not provide it.

Tag-dispatch resolution of c_stdCamera_usesStateString==false will call this function. returns "".

Definition at line 1383 of file stdCamera.hpp.

◆ stateString() [2/2]

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::stateString ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to stateString when the derivedT provides it.

Tag-dispatch resolution of c_stdCamera_usesStateString==true will call this function. Calls derivedT::stateString.

Definition at line 1377 of file stdCamera.hpp.

◆ stateStringValid() [1/2]

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::stateStringValid ( const mx::meta::trueFalseT< false > & f )

inherited

Interface to stateStringValid when the derivedT does not provide it.

Tag-dispatch resolution of c_stdCamera_usesStateString==false will call this function. returns false.

Definition at line 1395 of file stdCamera.hpp.

◆ stateStringValid() [2/2]

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::stateStringValid ( const mx::meta::trueFalseT< true > & t )

inherited

Interface to stateStringValid when the derivedT provides it.

Tag-dispatch resolution of c_stdCamera_usesStateString==true will call this function. Calls derivedT::stateStringValid.

Definition at line 1389 of file stdCamera.hpp.

◆ syncROIFromCamera()

int MagAOX::app::cred2Ctrl::syncROIFromCamera ( )

inline

Query the camera for its current ROI and synchronize local state.

Definition at line 939 of file cred2Ctrl.hpp.

Referenced by appLogic(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ sysPath()

template<bool _useINDI>

std::string MagAOX::app::MagAOXApp< _useINDI >::sysPath ( )

inherited

Get the system path.

Returns: the value of m_sysPath

Definition at line 3999 of file MagAOXApp.hpp.

◆ telem()

int MagAOX::app::dev::telemeter< cred2Ctrl >::telem ( const typename telT::messageT & msg )

inherited

Make a telemetry recording.

Wrapper for logManager::log, which updates telT::lastRecord.

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in] msg the data to log

Definition at line 95 of file telemeter.hpp.

◆ threadStart()

template<bool _useINDI>

template<class thisPtr , class Function >

int MagAOX::app::MagAOXApp< _useINDI >::threadStart	(	std::thread &	thrd,
		bool &	thrdInit,
		pid_t &	tpid,
		pcf::IndiProperty &	thProp,
		int	thrdPrio,
		const std::string &	cpuset,
		const std::string &	thrdName,
		thisPtr *	thrdThis,
		Function &&	thrdStart
	)

inherited

Start a thread, using this class's privileges to set priority, etc.

The thread initialization synchronizer bool is set to true at the beginning of this function, then is set to false once all initialization is complete. The thread exec function should wait until this is false before doing anything except setting the pid. This is to avoid privilege escalation bugs.

The interface of the thread start function is:

static void impl::myThreadStart( impl * o )
{
   o->myThreadExec(); //A member function which actually executes the thread
}

where impl is the derived class, and mThreadStart and myThreadExec are members of impl.

Returns: 0 on success; -1 on error

Parameters

[out]	thrd	The thread object to start executing
	thrdInit	[in/out] The thread initilization synchronizer.
	tpid	[in/out] The thread pid to be filled in by thrdStart immediately upon call
	thProp	[in/out] The INDI property to publish the thread details
[in]	thrdPrio	The r/t priority to set for this thread
[in]	cpuset	the cpuset to place this thread on. Ignored if "".
[in]	thrdName	The name of the thread (just for logging)
[in]	thrdThis	The `this` pointer to pass to the thread starter function
[in]	thrdStart	The thread starting function, a static function taking a `this` pointer as argument.

Definition at line 2454 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_NOTICE, and MAGAOX_RT_SCHED_POLICY.

Referenced by MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().

◆ unlockPID()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::unlockPID ( )

protectedinherited

Remove the PID file.

Definition at line 2428 of file MagAOXApp.hpp.

◆ updateFocusStateProperty()

void MagAOX::app::dev::stdCamera< cred2Ctrl >::updateFocusStateProperty ( )

protectedinherited

Refresh the published focus.state property from the current helper or derived focus implementation.

Definition at line 842 of file stdCamera.hpp.

◆ updateFPSLimits()

int MagAOX::app::cred2Ctrl::updateFPSLimits ( )

inline

Query and update the current camera FPS limits.

Definition at line 1328 of file cred2Ctrl.hpp.

References MagAOX::app::cred2ParseFloat(), INDI_IDLE, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fpsSet, m_indiP_fpsLimits, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxFPS, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minFPS, MagAOX::app::dev::stdCamera< cred2Ctrl >::recordCamera(), sendCommand(), and MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged().

Referenced by appLogic(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ updateIfChanged() [1/4]

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const char *	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is a specialization for const char * to std::string.

For a property with multiple elements, you should use the vector version to minimize network traffic. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 3618 of file MagAOXApp.hpp.

◆ updateIfChanged() [2/4]

template<bool _useINDI>

template<typename T >

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

Constructs the element names for each value as elX where X is the index of the vector.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	Beginning of each element name
[in]	newVals	the new values
[in]	ipState	[optional] the new state

Definition at line 3643 of file MagAOXApp.hpp.

◆ updateIfChanged() [3/4]

template<bool _useINDI>

template<typename T >

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const T &	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

For a property with multiple elements, you should use the vector version to minimize network traffic.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 3599 of file MagAOXApp.hpp.

Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::baslerCtrl::checkNextROI(), MagAOX::app::cameraSim::checkNextROI(), checkNextROI(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::xt1121Ctrl::getState(), getTemps(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::acronameUsbHub::onPowerOff(), onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::xt1121Ctrl::onPowerOff(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::picamCtrl::setExpTime(), syncROIFromCamera(), updateFPSLimits(), MagAOX::app::trippLitePDU::updateOutletStates(), MagAOX::app::magAOXMaths::updateVals(), and MagAOX::app::sysMonitor::updateVals().

◆ updateIfChanged() [4/4]

template<bool _useINDI>

template<typename T >

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< std::string > &	els,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 3664 of file MagAOXApp.hpp.

◆ updateINDI() [1/3]

int MagAOX::app::dev::edtCamera< cred2Ctrl >::updateINDI ( )

inherited

The static callback function to be registered for the channel properties.

Returns: 0 on success.; -1 on error. The callback called by the static version, to actually process the new request.; 0 on success.; -1 on error. Update the INDI properties for this device controller You should call this once per main loop. It is not called automatically.; 0 on success.; -1 on error.

Definition at line 228 of file edtCamera.hpp.

◆ updateINDI() [2/3]

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 302 of file frameGrabber.hpp.

◆ updateINDI() [3/3]

int MagAOX::app::dev::stdCamera< cred2Ctrl >::updateINDI ( )

inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns: 0 on success.; -1 on error.

Definition at line 1404 of file stdCamera.hpp.

◆ updatesIfChanged()

template<bool _useINDI>

template<typename T >

void MagAOX::app::MagAOXApp< _useINDI >::updatesIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< const char * > &	els,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 3680 of file MagAOXApp.hpp.

◆ updateSwitchIfChanged()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::updateSwitchIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const pcf::IndiElement::SwitchStateType &	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI switch element value if it has changed.

Will only peform a SetProperty if the new element switch state has changed, or the propery state has changed.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 3627 of file MagAOXApp.hpp.

Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::baslerCtrl::setNextROI(), MagAOX::app::cameraSim::setNextROI(), setNextROI(), MagAOX::app::picamCtrl::setNextROI(), MagAOX::app::qhyCtrl::setNextROI(), MagAOX::app::zylaCtrl::setNextROI(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::picamCtrl::setTempControl(), MagAOX::app::filterWheelCtrl::startHoming(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::hsfwCtrl::stop(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::zaberCtrl::stop(), and MagAOX::app::sysMonitor::updateVals().

◆ whilePowerOff()

int MagAOX::app::cred2Ctrl::whilePowerOff ( )

inlinevirtual

Actions required while the camera remains powered off.

Reimplemented from MagAOX::app::MagAOXApp< _useINDI >.

Definition at line 858 of file cred2Ctrl.hpp.

References MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), and MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex.

Referenced by libXWCTest::cred2CtrlTest::TEST_CASE().

◆ writeConfig()

int MagAOX::app::cred2Ctrl::writeConfig ( )

inline

Write the temporary EDT configuration file for the pending ROI.

Definition at line 1579 of file cred2Ctrl.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), m_configFile, MagAOX::app::dev::stdCamera< cred2Ctrl >::m_nextROI, and m_serialBaud.

Referenced by loadConfigImpl(), reconfig(), syncROIFromCamera(), and libXWCTest::cred2CtrlTest::TEST_CASE().

Friends And Related Symbol Documentation

◆ dev::edtCamera< cred2Ctrl >

friend class dev::edtCamera< cred2Ctrl >

friend

Definition at line 1762 of file cred2Ctrl.hpp.

◆ dev::frameGrabber< cred2Ctrl >

friend class dev::frameGrabber< cred2Ctrl >

friend

Definition at line 1762 of file cred2Ctrl.hpp.

◆ dev::stdCamera< cred2Ctrl >

friend class dev::stdCamera< cred2Ctrl >

friend

Definition at line 1762 of file cred2Ctrl.hpp.

◆ dev::telemeter< cred2Ctrl >

friend class dev::telemeter< cred2Ctrl >

friend

Definition at line 1762 of file cred2Ctrl.hpp.

Member Data Documentation

◆ c_edtCamera_relativeConfigPath

constexpr bool MagAOX::app::cred2Ctrl::c_edtCamera_relativeConfigPath = false

staticconstexpr

Use an absolute temporary EDT config path.

Definition at line 83 of file cred2Ctrl.hpp.

◆ c_frameGrabber_flippable

constexpr bool MagAOX::app::cred2Ctrl::c_frameGrabber_flippable = true

staticconstexpr

Expose image flip controls through the framegrabber.

Definition at line 84 of file cred2Ctrl.hpp.

◆ c_hasAnalogGain

constexpr bool MagAOX::app::dev::stdCamera< cred2Ctrl >::c_hasAnalogGain

staticconstexprprotectedinherited

True when the derived camera exposes analog-gain control.

Definition at line 462 of file stdCamera.hpp.

◆ c_hasFanSpeed

constexpr bool MagAOX::app::dev::stdCamera< cred2Ctrl >::c_hasFanSpeed

staticconstexprprotectedinherited

True when the derived camera exposes fan-speed control.

Definition at line 458 of file stdCamera.hpp.

◆ c_hasFocus

constexpr bool MagAOX::app::dev::stdCamera< cred2Ctrl >::c_hasFocus

staticconstexprprotectedinherited

True when the derived camera exposes focus-state and goto-focus support.

Definition at line 464 of file stdCamera.hpp.

◆ c_hasLED

constexpr bool MagAOX::app::dev::stdCamera< cred2Ctrl >::c_hasLED

staticconstexprprotectedinherited

True when the derived camera exposes LED control.

Definition at line 460 of file stdCamera.hpp.

◆ c_stdCamera_analogGain

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_analogGain = true

staticconstexpr

Expose discrete analog-gain controls.

Definition at line 75 of file cred2Ctrl.hpp.

◆ c_stdCamera_cropMode

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_cropMode = false

staticconstexpr

Do not expose crop-mode controls separately.

Definition at line 80 of file cred2Ctrl.hpp.

◆ c_stdCamera_emGain

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_emGain = false

staticconstexpr

Do not expose EM-gain controls.

Definition at line 70 of file cred2Ctrl.hpp.

◆ c_stdCamera_exptimeCtrl

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_exptimeCtrl = false

staticconstexpr

Do not expose exposure-time controls.

Definition at line 71 of file cred2Ctrl.hpp.

◆ c_stdCamera_fanSpeed

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_fanSpeed = true

staticconstexpr

Expose fan-speed controls.

Definition at line 74 of file cred2Ctrl.hpp.

◆ c_stdCamera_fps

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_fps = true

staticconstexpr

Expose FPS status.

Definition at line 73 of file cred2Ctrl.hpp.

◆ c_stdCamera_fpsCtrl

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_fpsCtrl = true

staticconstexpr

Expose FPS controls.

Definition at line 72 of file cred2Ctrl.hpp.

◆ c_stdCamera_hasShutter

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_hasShutter = false

staticconstexpr

Do not expose shutter controls.

Definition at line 81 of file cred2Ctrl.hpp.

◆ c_stdCamera_led

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_led = true

staticconstexpr

Expose status LED controls.

Definition at line 76 of file cred2Ctrl.hpp.

◆ c_stdCamera_readoutSpeed

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_readoutSpeed = false

staticconstexpr

Do not expose readout-speed controls.

Definition at line 68 of file cred2Ctrl.hpp.

◆ c_stdCamera_synchro

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_synchro = false

staticconstexpr

Do not expose synchro controls in the first pass.

Definition at line 77 of file cred2Ctrl.hpp.

◆ c_stdCamera_temp

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_temp = true

staticconstexpr

Expose detector temperature status.

Definition at line 67 of file cred2Ctrl.hpp.

◆ c_stdCamera_tempControl

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_tempControl = true

staticconstexpr

Expose temperature setpoint control.

Definition at line 66 of file cred2Ctrl.hpp.

◆ c_stdCamera_usesModes

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_usesModes = false

staticconstexpr

Use one synthetic runtime mode rather than INDI modes.

Definition at line 78 of file cred2Ctrl.hpp.

◆ c_stdCamera_usesROI

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_usesROI = true

staticconstexpr

Expose ROI controls.

Definition at line 79 of file cred2Ctrl.hpp.

◆ c_stdCamera_usesStateString

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_usesStateString = false

staticconstexpr

Do not expose a dark-management state string.

Definition at line 82 of file cred2Ctrl.hpp.

◆ c_stdCamera_vShiftSpeed

constexpr bool MagAOX::app::cred2Ctrl::c_stdCamera_vShiftSpeed = false

staticconstexpr

Do not expose vertical-shift controls.

Definition at line 69 of file cred2Ctrl.hpp.

◆ m_adcSpeed

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_adcSpeed

protectedinherited

Definition at line 526 of file stdCamera.hpp.

◆ m_allDefsReceived

template<bool _useINDI = true>

bool MagAOX::app::MagAOXApp< _useINDI >::m_allDefsReceived { false }

protectedinherited

Flag indicating that all registered Set properties have been updated since last Get.

Definition at line 709 of file MagAOXApp.hpp.

◆ m_analogGainName

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainName

protectedinherited

Current analog-gain option name.

Definition at line 581 of file stdCamera.hpp.

◆ m_analogGainNameLabels

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainNameLabels

protectedinherited

Optional GUI labels for the analog-gain options.

Definition at line 580 of file stdCamera.hpp.

◆ m_analogGainNames

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainNames

protectedinherited

Valid analog-gain option names for the INDI selection switch.

Definition at line 579 of file stdCamera.hpp.

◆ m_analogGainNameSet

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainNameSet

protectedinherited

Requested analog-gain option name.

Definition at line 582 of file stdCamera.hpp.

◆ m_analogGainValid

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_analogGainValid

protectedinherited

True once the current analog-gain state is known.

Definition at line 583 of file stdCamera.hpp.

◆ m_atimes

mx::sigproc::circularBufferIndex<timespec, cbIndexT> MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_atimes

protectedinherited

Definition at line 159 of file frameGrabber.hpp.

◆ m_atimesD

std::vector<double> MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_atimesD

protectedinherited

Definition at line 162 of file frameGrabber.hpp.

◆ m_basePath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_basePath

protectedinherited

The base path of the MagAO-X system.

Definition at line 181 of file MagAOXApp.hpp.

◆ m_calibDir

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_calibDir

protectedinherited

The path to calibration files for MagAOX.

Definition at line 189 of file MagAOXApp.hpp.

◆ m_cameraCropEnabled

bool MagAOX::app::cred2Ctrl::m_cameraCropEnabled { false }

protected

Tracks whether this controller has enabled camera-side cropping.

Definition at line 102 of file cred2Ctrl.hpp.

Referenced by configureAcquisition(), powerOnDefaults(), and syncROIFromCamera().

◆ m_cameraModes

cameraConfigMap MagAOX::app::dev::stdCamera< cred2Ctrl >::m_cameraModes

protectedinherited

Map holding the possible camera mode configurations.

Definition at line 471 of file stdCamera.hpp.

◆ m_cameraMutex

std::recursive_mutex MagAOX::app::cred2Ctrl::m_cameraMutex

protected

Protects serial command traffic and EDT reconfiguration.

Definition at line 105 of file cred2Ctrl.hpp.

Referenced by configureAcquisition(), reconfig(), and sendCommand().

◆ m_cameraType

std::string MagAOX::app::dev::edtCamera< cred2Ctrl >::m_cameraType

protectedinherited

The camera type according to the framegrabber.

Definition at line 84 of file edtCamera.hpp.

◆ m_cbFPS

float MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_cbFPS

protectedinherited

The FPS used to configure the circular buffers.

Definition at line 157 of file frameGrabber.hpp.

◆ m_ccdTemp

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ccdTemp

protectedinherited

The current temperature, in C.

Definition at line 493 of file stdCamera.hpp.

◆ m_ccdTempSetpt

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ccdTempSetpt

protectedinherited

The desired temperature, in C.

Definition at line 495 of file stdCamera.hpp.

◆ m_channel

int MagAOX::app::dev::edtCamera< cred2Ctrl >::m_channel

protectedinherited

EDT PDV board channel number.

Definition at line 64 of file edtCamera.hpp.

◆ m_circBuffLength

uint32_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_circBuffLength

protectedinherited

Length of the circular buffer, in frames.

Definition at line 128 of file frameGrabber.hpp.

◆ m_configBase

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configBase

protectedinherited

The name of a base config class for this app (minus .conf).

Definition at line 187 of file MagAOXApp.hpp.

◆ m_configDir

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configDir

protectedinherited

The path to configuration files for MagAOX.

Definition at line 185 of file MagAOXApp.hpp.

Referenced by MagAOX::app::ocam2KCtrl::configureAcquisition().

◆ m_configFile

std::string MagAOX::app::cred2Ctrl::m_configFile

protected

Absolute path to the temporary EDT configuration file.

Definition at line 92 of file cred2Ctrl.hpp.

Referenced by loadConfigImpl(), and writeConfig().

◆ m_configName

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configName

protectedinherited

The name of the configuration file (minus .conf).

Definition at line 183 of file MagAOXApp.hpp.

Referenced by MagAOX::app::mzmqClient::loadConfig(), MagAOX::app::mzmqServer::loadConfig(), MagAOX::app::zaberCtrl::loadConfigImpl(), MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().

◆ m_cpusetPath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_cpusetPath { MAGAOX_cpusetPath }

protectedinherited

Path to the cpusets mount.

The path to the cpusets mount is configured by the environment variable defined by MAGOX_env_cpuset in environment.hpp. This environment variable is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used.

Definition at line 200 of file MagAOXApp.hpp.

◆ m_cropMode

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_cropMode

protectedinherited

Status of crop mode ROIs, if enabled for this camera.

Definition at line 712 of file stdCamera.hpp.

◆ m_cropModeSet

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_cropModeSet

protectedinherited

Desired status of crop mode ROIs, if enabled for this camera.

Definition at line 713 of file stdCamera.hpp.

◆ m_currentROI

roi MagAOX::app::dev::stdCamera< cred2Ctrl >::m_currentROI

protectedinherited

Definition at line 640 of file stdCamera.hpp.

◆ m_currImageTimestamp

timespec MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_currImageTimestamp

protectedinherited

The timestamp of the current image.

Definition at line 147 of file frameGrabber.hpp.

◆ m_dataType

uint8_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_dataType

protectedinherited

The ImageStreamIO type code.

Definition at line 141 of file frameGrabber.hpp.

◆ m_default_bin_x

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_default_bin_x

protectedinherited

Power-on ROI x binning.

Definition at line 672 of file stdCamera.hpp.

◆ m_default_bin_y

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_default_bin_y

protectedinherited

Power-on ROI y binning.

Definition at line 673 of file stdCamera.hpp.

◆ m_default_h

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_default_h

protectedinherited

Power-on ROI height.

Definition at line 671 of file stdCamera.hpp.

◆ m_default_w

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_default_w

protectedinherited

Power-on ROI width.

Definition at line 670 of file stdCamera.hpp.

◆ m_default_x

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_default_x

protectedinherited

Power-on ROI center x coordinate.

Definition at line 668 of file stdCamera.hpp.

◆ m_default_y

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_default_y

protectedinherited

Power-on ROI center y coordinate.

Definition at line 669 of file stdCamera.hpp.

◆ m_defaultFanSpeed

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_defaultFanSpeed

protectedinherited

The default fan speed to apply after power on.

Definition at line 480 of file stdCamera.hpp.

◆ m_defaultFlip

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_defaultFlip

protectedinherited

Definition at line 134 of file frameGrabber.hpp.

◆ m_defaultLEDState

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_defaultLEDState

protectedinherited

The default LED state to apply after power on.

Definition at line 481 of file stdCamera.hpp.

◆ m_defaultReadoutSpeed

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_defaultReadoutSpeed

protectedinherited

The default readout speed of the camera.

Definition at line 477 of file stdCamera.hpp.

◆ m_defaultVShiftSpeed

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_defaultVShiftSpeed

protectedinherited

The default readout speed of the camera.

Definition at line 478 of file stdCamera.hpp.

◆ m_driverCtrlName

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverCtrlName

protectedinherited

Full path name of the INDI driver control FIFO.

This is currently only used to signal restarts.

Definition at line 720 of file MagAOXApp.hpp.

◆ m_driverInName

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverInName

protectedinherited

Full path name of the INDI driver input FIFO.

Definition at line 712 of file MagAOXApp.hpp.

◆ m_driverOutName

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverOutName

protectedinherited

Full path name of the INDI driver output FIFO.

Definition at line 715 of file MagAOXApp.hpp.

◆ m_dummy_c

char MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_dummy_c

protectedinherited

Definition at line 168 of file frameGrabber.hpp.

◆ m_dummy_cnt

uint64_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_dummy_cnt

protectedinherited

Definition at line 167 of file frameGrabber.hpp.

◆ m_dummy_ts

timespec MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_dummy_ts

protectedinherited

Definition at line 166 of file frameGrabber.hpp.

◆ m_emGain

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_emGain

protectedinherited

The camera's current EM gain (if available).

Definition at line 529 of file stdCamera.hpp.

◆ m_emGainSet

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_emGainSet

protectedinherited

The camera's EM gain, as set by the user.

Definition at line 530 of file stdCamera.hpp.

◆ m_euidCalled

template<bool _useINDI = true>

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidCalled

privateinherited

The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid).

Definition at line 415 of file MagAOXApp.hpp.

◆ m_euidReal

template<bool _useINDI = true>

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidReal

privateinherited

The real user id of the proces (i.e. the lower privileged id of the user)

Definition at line 414 of file MagAOXApp.hpp.

◆ m_expTime

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_expTime

protectedinherited

The current exposure time, in seconds.

Definition at line 547 of file stdCamera.hpp.

◆ m_expTimeSet

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_expTimeSet

protectedinherited

The exposure time, in seconds, as set by user.

Definition at line 548 of file stdCamera.hpp.

◆ m_fanSpeedControlEnabled

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedControlEnabled

protectedinherited

Whether or not fan-speed control is published through INDI.

Definition at line 479 of file stdCamera.hpp.

◆ m_fanSpeedName

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedName

protectedinherited

Current fan-control option name.

Definition at line 568 of file stdCamera.hpp.

◆ m_fanSpeedNameLabels

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedNameLabels

protectedinherited

Optional GUI labels for the fan-control options.

Definition at line 567 of file stdCamera.hpp.

◆ m_fanSpeedNames

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedNames

protectedinherited

Valid fan-control option names for the INDI selection switch.

Definition at line 566 of file stdCamera.hpp.

◆ m_fanSpeedNameSet

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedNameSet

protectedinherited

Requested fan-control option name.

Definition at line 569 of file stdCamera.hpp.

◆ m_fanSpeedValid

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fanSpeedValid

protectedinherited

True once the current fan-control state is known.

Definition at line 570 of file stdCamera.hpp.

◆ m_fgCpuset

std::string MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_fgCpuset

protectedinherited

The cpuset to assign the framegrabber thread to. Not used if empty, the default.

Definition at line 126 of file frameGrabber.hpp.

◆ m_fgThread

std::thread MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_fgThread

protectedinherited

A separate thread for the actual framegrabbings.

Definition at line 267 of file frameGrabber.hpp.

◆ m_fgThreadID

pid_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_fgThreadID

protectedinherited

The ID of the framegrabber thread.

Definition at line 263 of file frameGrabber.hpp.

◆ m_fgThreadInit

bool MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_fgThreadInit

protectedinherited

Synchronizer for thread startup, to allow priority setting to finish.

Definition at line 261 of file frameGrabber.hpp.

◆ m_fgThreadPrio

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_fgThreadPrio

protectedinherited

Priority of the framegrabber thread, should normally be > 00.

Definition at line 125 of file frameGrabber.hpp.

◆ m_fgThreadProp

pcf::IndiProperty MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_fgThreadProp

protectedinherited

The property to hold the f.g. thread details.

Definition at line 265 of file frameGrabber.hpp.

◆ m_focusGotoFormat

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoFormat

protectedinherited

Literal {} placeholder format used to build the goto-focus preset name.

Definition at line 760 of file stdCamera.hpp.

◆ m_focusGotoHelperConfigured

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoHelperConfigured

protectedinherited

True when stdCamera should derive goto-focus commands from external switch properties.

Definition at line 751 of file stdCamera.hpp.

◆ m_focusGotoSourceIndices

std::vector<int> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoSourceIndices

protectedinherited

Indices of m_focusGotoSourceProperties within m_indiP_focusMonitoredProperties.

Definition at line 758 of file stdCamera.hpp.

◆ m_focusGotoSourceProperties

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoSourceProperties

protectedinherited

INDI keys (device.property) of the switch properties combined for gotoFocus().

Definition at line 754 of file stdCamera.hpp.

◆ m_focusGotoTargetDevice

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoTargetDevice

protectedinherited

Device portion parsed from m_focusGotoTargetProperty.

Definition at line 765 of file stdCamera.hpp.

◆ m_focusGotoTargetName

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoTargetName

protectedinherited

Property-name portion parsed from m_focusGotoTargetProperty.

Definition at line 767 of file stdCamera.hpp.

◆ m_focusGotoTargetProperty

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusGotoTargetProperty

protectedinherited

INDI key (device.property) of the switch property commanded by gotoFocus().

Definition at line 763 of file stdCamera.hpp.

◆ m_focusMonitoredPropertyKeys

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusMonitoredPropertyKeys

protectedinherited

Unique INDI keys monitored for the focus-state and goto-focus helpers.

Definition at line 770 of file stdCamera.hpp.

◆ m_focusStateElement

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusStateElement

protectedinherited

Element within m_focusStateSource whose On state is interpreted according to m_focusStateOnMeansInFocus.

Definition at line 742 of file stdCamera.hpp.

◆ m_focusStateHelperConfigured

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusStateHelperConfigured

protectedinherited

True when stdCamera should evaluate focus state from an external switch property.

Definition at line 736 of file stdCamera.hpp.

◆ m_focusStateOnMeansInFocus

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusStateOnMeansInFocus

protectedinherited

True when m_focusStateElement being On means "in focus". Default false means On is interpreted as "out of focus".

Definition at line 745 of file stdCamera.hpp.

◆ m_focusStateSource

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusStateSource

protectedinherited

INDI key (device.property) of the switch property used by checkFocusSwitchState.

Definition at line 740 of file stdCamera.hpp.

◆ m_focusStateSourceIndex

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_focusStateSourceIndex

protectedinherited

Index of m_focusStateSource within m_indiP_focusMonitoredProperties, or -1 when unused.

Definition at line 748 of file stdCamera.hpp.

◆ m_fps

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fps

protectedinherited

The current FPS.

Definition at line 554 of file stdCamera.hpp.

◆ m_fpsSet

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_fpsSet

protectedinherited

The commanded fps, as set by user.

Definition at line 555 of file stdCamera.hpp.

◆ m_full_bin_x

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_bin_x

protectedinherited

The x-binning in the full ROI.

Definition at line 679 of file stdCamera.hpp.

◆ m_full_bin_y

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_bin_y

protectedinherited

The y-binning in the full ROI.

Definition at line 680 of file stdCamera.hpp.

◆ m_full_currbin_h

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_currbin_h

protectedinherited

The current-binning full ROI height.

Definition at line 685 of file stdCamera.hpp.

◆ m_full_currbin_w

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_currbin_w

protectedinherited

The current-binning full ROI width.

Definition at line 684 of file stdCamera.hpp.

◆ m_full_currbin_x

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_currbin_x

protectedinherited

The current-binning full ROI center x coordinate.

Definition at line 682 of file stdCamera.hpp.

◆ m_full_currbin_y

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_currbin_y

protectedinherited

The current-binning full ROI center y coordinate.

Definition at line 683 of file stdCamera.hpp.

◆ m_full_h

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_h

protectedinherited

The full ROI height.

Definition at line 678 of file stdCamera.hpp.

◆ m_full_w

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_w

protectedinherited

The full ROI width.

Definition at line 677 of file stdCamera.hpp.

◆ m_full_x

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_x

protectedinherited

The full ROI center x coordinate.

Definition at line 675 of file stdCamera.hpp.

◆ m_full_y

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_full_y

protectedinherited

The full ROI center y coordinate.

Definition at line 676 of file stdCamera.hpp.

◆ m_gitAlert

template<bool _useINDI = true>

bool MagAOX::app::MagAOXApp< _useINDI >::m_gitAlert { false }

privateinherited

Definition at line 575 of file MagAOXApp.hpp.

◆ m_hasFocus

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_hasFocus

protectedinherited

Runtime flag enabling focus-state reporting and goto-focus control publication.

Definition at line 734 of file stdCamera.hpp.

◆ m_height

uint32_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_height

protectedinherited

The height of the image, once deinterlaced etc.

Definition at line 139 of file frameGrabber.hpp.

◆ m_image_p

u_char* MagAOX::app::dev::edtCamera< cred2Ctrl >::m_image_p

protectedinherited

The image data grabbed.

Definition at line 75 of file edtCamera.hpp.

◆ m_imageStream

IMAGE* MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_imageStream

protectedinherited

The ImageStreamIO shared memory buffer.

Definition at line 151 of file frameGrabber.hpp.

◆ m_indiCallBackMutex

template<bool _useINDI = true>

std::mutex MagAOX::app::MagAOXApp< _useINDI >::m_indiCallBackMutex

inherited

Mutex for locking INDI callback maps and per-entry callback state.

Lock ordering policy: 1) Prefer never holding both m_indiMutex and m_indiCallBackMutex at the same time. 2) If both are required in future code, always acquire m_indiMutex before m_indiCallBackMutex.

Definition at line 662 of file MagAOXApp.hpp.

◆ m_indiDriver

template<bool _useINDI = true>

indiDriver<MagAOXApp>* MagAOX::app::MagAOXApp< _useINDI >::m_indiDriver { nullptr }

inherited

The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

Todo:: instead of making this public, provide an accessor.

Definition at line 652 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::streamWriter::updateINDI(), and MagAOX::app::magAOXMaths::updateVals().

◆ m_indiMutex

template<bool _useINDI = true>

std::mutex MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex

inherited

Mutex for locking INDI communications.

Definition at line 655 of file MagAOXApp.hpp.

◆ m_indiNewCallBacks

template<bool _useINDI = true>

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiNewCallBacks

protectedinherited

Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is the property name.

Definition at line 700 of file MagAOXApp.hpp.

◆ m_indiP_analogGain

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_analogGain

protectedinherited

Property used to select the analog-gain mode.

Definition at line 585 of file stdCamera.hpp.

◆ m_indiP_clearFSMAlert

template<bool _useINDI = true>

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_clearFSMAlert

protectedinherited

indi Property to clear an FSM alert.

Definition at line 1130 of file MagAOXApp.hpp.

◆ m_indiP_cropMode

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_cropMode

protectedinherited

Property used to toggle crop mode on and off.

Definition at line 715 of file stdCamera.hpp.

◆ m_indiP_emGain

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_emGain

protectedinherited

Definition at line 536 of file stdCamera.hpp.

◆ m_indiP_exptime

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_exptime

protectedinherited

Definition at line 557 of file stdCamera.hpp.

◆ m_indiP_fanSpeed

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_fanSpeed

protectedinherited

Property used to select the fan-speed mode.

Definition at line 572 of file stdCamera.hpp.

◆ m_indiP_focus

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_focus

protectedinherited

Read-only switch property reporting whether the current state is in focus.

Definition at line 775 of file stdCamera.hpp.

◆ m_indiP_focusMonitoredProperties

std::vector<pcf::IndiProperty> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_focusMonitoredProperties

protectedinherited

Cached external switch properties monitored for the focus helpers.

Definition at line 773 of file stdCamera.hpp.

◆ m_indiP_fps

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_fps

protectedinherited

Definition at line 559 of file stdCamera.hpp.

◆ m_indiP_fpsLimits

pcf::IndiProperty MagAOX::app::cred2Ctrl::m_indiP_fpsLimits

protected

Property reporting the current C-RED 2 minimum and maximum FPS.

Definition at line 112 of file cred2Ctrl.hpp.

Referenced by appStartup(), and updateFPSLimits().

◆ m_indiP_frameSize

pcf::IndiProperty MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_indiP_frameSize

protectedinherited

Property used to report the current frame size.

Definition at line 290 of file frameGrabber.hpp.

◆ m_indiP_fullROI

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_fullROI

protectedinherited

Property used to preset the full ROI dimensions.

Definition at line 694 of file stdCamera.hpp.

◆ m_indiP_gotoFocus

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_gotoFocus

protectedinherited

Request switch property used to command the current focus target.

Definition at line 777 of file stdCamera.hpp.

◆ m_indiP_led

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_led

protectedinherited

Property used to control the status LED state.

Definition at line 596 of file stdCamera.hpp.

◆ m_indiP_mode

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_mode

protectedinherited

Property used to report the current mode.

Definition at line 619 of file stdCamera.hpp.

◆ m_indiP_powerChannel

template<bool _useINDI = true>

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_powerChannel

protectedinherited

INDI property used to communicate power state.

Definition at line 1186 of file MagAOXApp.hpp.

◆ m_indiP_readoutSpeed

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_readoutSpeed

protectedinherited

Definition at line 533 of file stdCamera.hpp.

◆ m_indiP_reconfig

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_reconfig

protectedinherited

Request switch which forces the framegrabber to go through the reconfigure process.

Definition at line 622 of file stdCamera.hpp.

◆ m_indiP_roi_bin_x

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_bin_x

protectedinherited

Property used to set the ROI x binning.

Definition at line 691 of file stdCamera.hpp.

◆ m_indiP_roi_bin_y

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_bin_y

protectedinherited

Property used to set the ROI y binning.

Definition at line 692 of file stdCamera.hpp.

◆ m_indiP_roi_check

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_check

protectedinherited

Property used to trigger checking the target ROI.

Definition at line 696 of file stdCamera.hpp.

◆ m_indiP_roi_default

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_default

protectedinherited

Property used to trigger setting the default and startup ROI.

Definition at line 704 of file stdCamera.hpp.

◆ m_indiP_roi_full

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_full

protectedinherited

Property used to trigger setting the full ROI.

Definition at line 700 of file stdCamera.hpp.

◆ m_indiP_roi_fullbin

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_fullbin

protectedinherited

Property used to trigger setting the full in current binning ROI.

Definition at line 701 of file stdCamera.hpp.

◆ m_indiP_roi_h

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_h

protectedinherited

Property used to set the ROI height.

Definition at line 690 of file stdCamera.hpp.

◆ m_indiP_roi_last

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_last

protectedinherited

Property used to trigger setting the last ROI.

Definition at line 703 of file stdCamera.hpp.

◆ m_indiP_roi_loadlast

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_loadlast

protectedinherited

Property used to trigger loading the last ROI as the target.

Definition at line 702 of file stdCamera.hpp.

◆ m_indiP_roi_set

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_set

protectedinherited

Property used to trigger setting the ROI.

Definition at line 698 of file stdCamera.hpp.

◆ m_indiP_roi_w

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_w

protectedinherited

Property used to set the ROI width.

Definition at line 689 of file stdCamera.hpp.

◆ m_indiP_roi_x

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_x

protectedinherited

Property used to set the ROI x center coordinate.

Definition at line 687 of file stdCamera.hpp.

◆ m_indiP_roi_y

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_roi_y

protectedinherited

Property used to set the ROI x center coordinate.

Definition at line 688 of file stdCamera.hpp.

◆ m_indiP_shmimName

pcf::IndiProperty MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_indiP_shmimName

protectedinherited

Property used to report the shmim buffer name.

Definition at line 288 of file frameGrabber.hpp.

◆ m_indiP_shutter

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_shutter

protectedinherited

Property used to control the shutter, a switch.

Definition at line 726 of file stdCamera.hpp.

◆ m_indiP_shutterStatus

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_shutterStatus

protectedinherited

State of the shutter. 0 = shut, 1 = open, -1 = unknown.

Property to report shutter status

Definition at line 725 of file stdCamera.hpp.

◆ m_indiP_state

template<bool _useINDI = true>

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_state

protectedinherited

indi Property to report the application state.

Definition at line 1127 of file MagAOXApp.hpp.

◆ m_indiP_stateString

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_stateString

protectedinherited

Definition at line 785 of file stdCamera.hpp.

◆ m_indiP_synchro

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_synchro

protectedinherited

Definition at line 607 of file stdCamera.hpp.

◆ m_indiP_temp

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_temp

protectedinherited

Definition at line 504 of file stdCamera.hpp.

◆ m_indiP_tempcont

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_tempcont

protectedinherited

Definition at line 505 of file stdCamera.hpp.

◆ m_indiP_temps

pcf::IndiProperty MagAOX::app::cred2Ctrl::m_indiP_temps

protected

Property reporting the detailed C-RED 2 temperature channels.

Definition at line 111 of file cred2Ctrl.hpp.

Referenced by appStartup(), getTemps(), and onPowerOff().

◆ m_indiP_tempstat

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_tempstat

protectedinherited

Definition at line 506 of file stdCamera.hpp.

◆ m_indiP_timing

pcf::IndiProperty MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_indiP_timing

protectedinherited

Definition at line 292 of file frameGrabber.hpp.

◆ m_indiP_vShiftSpeed

pcf::IndiProperty MagAOX::app::dev::stdCamera< cred2Ctrl >::m_indiP_vShiftSpeed

protectedinherited

Definition at line 534 of file stdCamera.hpp.

◆ m_indiSetCallBacks

template<bool _useINDI = true>

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiSetCallBacks

protectedinherited

Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is device.name

Definition at line 705 of file MagAOXApp.hpp.

◆ m_inode

ino_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_inode

protectedinherited

The inode of the image stream file.

Definition at line 155 of file frameGrabber.hpp.

◆ m_lastROI

roi MagAOX::app::dev::stdCamera< cred2Ctrl >::m_lastROI

protectedinherited

Definition at line 642 of file stdCamera.hpp.

◆ m_latencyCircBuffMaxLength

cbIndexT MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_latencyCircBuffMaxLength

protectedinherited

Maximum length of the latency measurement circular buffers.

Definition at line 130 of file frameGrabber.hpp.

◆ m_latencyCircBuffMaxTime

float MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_latencyCircBuffMaxTime

protectedinherited

Maximum time of the latency meaurement circular buffers.

Definition at line 132 of file frameGrabber.hpp.

◆ m_ledState

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledState

protectedinherited

Current status LED state.

Definition at line 592 of file stdCamera.hpp.

◆ m_ledStateSet

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledStateSet

protectedinherited

Requested status LED state.

Definition at line 593 of file stdCamera.hpp.

◆ m_ledStateValid

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_ledStateValid

protectedinherited

True once the current LED state is known.

Definition at line 594 of file stdCamera.hpp.

◆ m_log

template<bool _useINDI>

MagAOXApp< _useINDI >::logManagerT MagAOX::app::MagAOXApp< _useINDI >::m_log

staticinherited

Definition at line 338 of file MagAOXApp.hpp.

◆ m_loopPause

template<bool _useINDI = true>

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_loopPause { MAGAOX_default_loopPause }

protectedinherited

The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X.

Definition at line 202 of file MagAOXApp.hpp.

Referenced by MagAOX::app::trippLitePDU::trippLitePDU(), and MagAOX::app::siglentSDG::appLogic().

◆ m_maxa

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_maxa

protectedinherited

Definition at line 173 of file frameGrabber.hpp.

◆ m_maxEMGain

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxEMGain

protectedinherited

The configurable maximum EM gain. To be enforced in derivedT.

Definition at line 531 of file stdCamera.hpp.

◆ m_maxExpTime

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxExpTime

protectedinherited

The maximum exposure time, used for INDI attributes.

Definition at line 544 of file stdCamera.hpp.

◆ m_maxFPS

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxFPS

protectedinherited

The maximum FPS, used for INDI attributes.

Definition at line 551 of file stdCamera.hpp.

◆ m_maxInterval

double MagAOX::app::dev::telemeter< cred2Ctrl >::m_maxInterval

inherited

The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.

Definition at line 83 of file telemeter.hpp.

◆ m_maxROIBinning_x

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxROIBinning_x

protectedinherited

Definition at line 661 of file stdCamera.hpp.

◆ m_maxROIBinning_y

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxROIBinning_y

protectedinherited

Definition at line 665 of file stdCamera.hpp.

◆ m_maxROIHeight

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxROIHeight

protectedinherited

Definition at line 657 of file stdCamera.hpp.

◆ m_maxROIWidth

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxROIWidth

protectedinherited

Definition at line 653 of file stdCamera.hpp.

◆ m_maxROIx

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxROIx

protectedinherited

Definition at line 645 of file stdCamera.hpp.

◆ m_maxROIy

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxROIy

protectedinherited

Definition at line 649 of file stdCamera.hpp.

◆ m_maxTemp

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_maxTemp

protectedinherited

Definition at line 490 of file stdCamera.hpp.

◆ m_maxw

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_maxw

protectedinherited

Definition at line 178 of file frameGrabber.hpp.

◆ m_mina

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_mina

protectedinherited

Definition at line 172 of file frameGrabber.hpp.

◆ m_minExpTime

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minExpTime

protectedinherited

The minimum exposure time, used for INDI attributes.

Definition at line 543 of file stdCamera.hpp.

◆ m_minFPS

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minFPS

protectedinherited

The minimum FPS, used for INDI attributes.

Definition at line 550 of file stdCamera.hpp.

◆ m_minROIBinning_x

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minROIBinning_x

protectedinherited

Definition at line 660 of file stdCamera.hpp.

◆ m_minROIBinning_y

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minROIBinning_y

protectedinherited

Definition at line 664 of file stdCamera.hpp.

◆ m_minROIHeight

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minROIHeight

protectedinherited

Definition at line 656 of file stdCamera.hpp.

◆ m_minROIWidth

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minROIWidth

protectedinherited

Definition at line 652 of file stdCamera.hpp.

◆ m_minROIx

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minROIx

protectedinherited

Definition at line 644 of file stdCamera.hpp.

◆ m_minROIy

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minROIy

protectedinherited

Definition at line 648 of file stdCamera.hpp.

◆ m_minTemp

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_minTemp

protectedinherited

Definition at line 489 of file stdCamera.hpp.

◆ m_minw

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_minw

protectedinherited

Definition at line 177 of file frameGrabber.hpp.

◆ m_mna

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_mna

protectedinherited

Definition at line 170 of file frameGrabber.hpp.

◆ m_mnw

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_mnw

protectedinherited

Definition at line 175 of file frameGrabber.hpp.

◆ m_mnwa

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_mnwa

protectedinherited

Definition at line 180 of file frameGrabber.hpp.

◆ m_modeName

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_modeName

protectedinherited

The current mode name.

Definition at line 615 of file stdCamera.hpp.

◆ m_nextMode

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_nextMode

protectedinherited

The mode to be set by the next reconfiguration.

Definition at line 617 of file stdCamera.hpp.

◆ m_nextROI

roi MagAOX::app::dev::stdCamera< cred2Ctrl >::m_nextROI

protectedinherited

Definition at line 641 of file stdCamera.hpp.

◆ m_numBuffs

int MagAOX::app::dev::edtCamera< cred2Ctrl >::m_numBuffs

protectedinherited

EDT PDV DMA buffer size, indicating number of images.

Definition at line 65 of file edtCamera.hpp.

◆ m_ownShmim

bool MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_ownShmim

protectedinherited

Flag controlling if the shmim is owned. If true it will be destroyed as needed.

Definition at line 153 of file frameGrabber.hpp.

◆ m_pdv

PdvDev* MagAOX::app::dev::edtCamera< cred2Ctrl >::m_pdv

protectedinherited

The EDT PDV device handle.

Definition at line 73 of file edtCamera.hpp.

◆ m_pid

template<bool _useINDI = true>

pid_t MagAOX::app::MagAOXApp< _useINDI >::m_pid { 0 }

protectedinherited

This process's PID.

Definition at line 499 of file MagAOXApp.hpp.

◆ m_powerChannel

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerChannel

protectedinherited

The INDI property name of the channel controlling this device's power.

Definition at line 1172 of file MagAOXApp.hpp.

◆ m_powerDevice

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerDevice

protectedinherited

The INDI device name of the power controller.

Definition at line 1171 of file MagAOXApp.hpp.

◆ m_powerElement

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerElement { "state" }

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 1173 of file MagAOXApp.hpp.

◆ m_powerMgtEnabled

template<bool _useINDI = true>

bool MagAOX::app::MagAOXApp< _useINDI >::m_powerMgtEnabled { false }

protectedinherited

Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error.

Definition at line 1166 of file MagAOXApp.hpp.

◆ m_powerOnCounter

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_powerOnCounter { -1 }

protectedinherited

Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup.

Definition at line 1179 of file MagAOXApp.hpp.

Referenced by MagAOX::app::andorCtrl::onPowerOff(), onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), and MagAOX::app::zylaCtrl::onPowerOff().

◆ m_powerOnWait

template<bool _useINDI = true>

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_powerOnWait { 55 }

protectedinherited

Default time in sec to wait for device to boot after power on.

Definition at line 1176 of file MagAOXApp.hpp.

Referenced by MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), MagAOX::app::xt1121Ctrl::xt1121Ctrl(), and MagAOX::app::zylaCtrl::zylaCtrl().

◆ m_powerState

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_powerState { -1 }

protectedinherited

Current power state, 1=On, 0=Off, -1=Unk.

Definition at line 1183 of file MagAOXApp.hpp.

◆ m_powerTargetElement

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetElement { "target" }

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 1174 of file MagAOXApp.hpp.

◆ m_powerTargetState

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState { -1 }

protectedinherited

Current target power state, 1=On, 0=Off, -1=Unk.

Definition at line 1184 of file MagAOXApp.hpp.

◆ m_raw_depth

int MagAOX::app::dev::edtCamera< cred2Ctrl >::m_raw_depth

protectedinherited

The bit-depth of the frame, according to the framegrabber.

Definition at line 83 of file edtCamera.hpp.

◆ m_raw_height

int MagAOX::app::dev::edtCamera< cred2Ctrl >::m_raw_height

protectedinherited

The height of the frame, according to the framegrabber.

Definition at line 81 of file edtCamera.hpp.

◆ m_raw_width

int MagAOX::app::dev::edtCamera< cred2Ctrl >::m_raw_width

protectedinherited

The width of the frame, according to the framegrabber.

Definition at line 82 of file edtCamera.hpp.

◆ m_readoutSpeedName

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_readoutSpeedName

protectedinherited

The current readout speed name.

Definition at line 517 of file stdCamera.hpp.

◆ m_readoutSpeedNameLabels

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_readoutSpeedNameLabels

protectedinherited

Definition at line 515 of file stdCamera.hpp.

◆ m_readoutSpeedNames

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_readoutSpeedNames

protectedinherited

Definition at line 514 of file stdCamera.hpp.

◆ m_readoutSpeedNameSet

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_readoutSpeedNameSet

protectedinherited

The user requested readout speed name, to be set by derived()

Definition at line 518 of file stdCamera.hpp.

◆ m_readTimeout

unsigned MagAOX::app::dev::ioDevice::m_readTimeout {1000}

inherited

The read timeout [msec].

Definition at line 28 of file ioDevice.hpp.

Referenced by MagAOX::app::rhusbMon::rhusbMon(), MagAOX::app::tcsInterface::acquireFromGuider(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::tcsInterface::getMagTelStatus(), MagAOX::app::flipperCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::tcsInterface::sendFoffload(), MagAOX::app::tcsInterface::sendPyrNudge(), MagAOX::app::tcsInterface::sendTToffload(), MagAOX::app::pi335Ctrl::testConnection(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().

◆ m_reconfig

bool MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_reconfig

protectedinherited

Flag to set if a camera reconfiguration requires a framegrabber reset.

Definition at line 149 of file frameGrabber.hpp.

◆ m_roiSettleCounter

int MagAOX::app::cred2Ctrl::m_roiSettleCounter { 0 }

protected

Number of main-loop cycles to skip serial status polling after ROI changes.

Definition at line 103 of file cred2Ctrl.hpp.

Referenced by appLogic(), and configureAcquisition().

◆ m_secretsPath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_secretsPath

protectedinherited

Path to the secrets directory, where passwords, etc, are stored.

Definition at line 193 of file MagAOXApp.hpp.

◆ m_self

template<bool _useINDI>

MagAOXApp< _useINDI > * MagAOX::app::MagAOXApp< _useINDI >::m_self = nullptr

staticprivateinherited

Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers.

Definition at line 390 of file MagAOXApp.hpp.

◆ m_serialBaud

int MagAOX::app::cred2Ctrl::m_serialBaud { 115200 }

protected

Camera Link serial baud rate used for C-RED 2 CLI access.

Definition at line 94 of file cred2Ctrl.hpp.

Referenced by loadConfigImpl(), setSerialBaud(), and writeConfig().

◆ m_shmimName

std::string MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_shmimName

protectedinherited

The name of the shared memory image, is used in /tmp/<shmimName>.im.shm. Derived classes should set a default.

Definition at line 122 of file frameGrabber.hpp.

◆ m_shutdown

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_shutdown { 0 }

protectedinherited

Flag to signal it's time to shutdown. When not 0, the main loop exits.

Definition at line 207 of file MagAOXApp.hpp.

◆ m_shutterState

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_shutterState

protectedinherited

Definition at line 723 of file stdCamera.hpp.

◆ m_shutterStatus

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_shutterStatus

protectedinherited

Definition at line 722 of file stdCamera.hpp.

◆ m_startupMode

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_startupMode

protectedinherited

The camera mode to load during first init after a power-on.

Definition at line 473 of file stdCamera.hpp.

◆ m_startupTemp

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_startupTemp

protectedinherited

The temperature to set after a power-on. Set to <= -999 to not use [default].

Definition at line 475 of file stdCamera.hpp.

◆ m_state

template<bool _useINDI = true>

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::m_state { stateCodes::UNINITIALIZED }

privateinherited

The application's state. Never ever set this directly, use state(const stateCodeT & s).

Definition at line 569 of file MagAOXApp.hpp.

◆ m_stateAlert

template<bool _useINDI = true>

bool MagAOX::app::MagAOXApp< _useINDI >::m_stateAlert { false }

privateinherited

Definition at line 572 of file MagAOXApp.hpp.

◆ m_stateLogged

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_stateLogged { 0 }

privateinherited

Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().

Definition at line 577 of file MagAOXApp.hpp.

◆ m_stepExpTime

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepExpTime

protectedinherited

The maximum exposure time stepsize, used for INDI attributes.

Definition at line 545 of file stdCamera.hpp.

◆ m_stepFPS

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepFPS

protectedinherited

The FPS step size, used for INDI attributes.

Definition at line 552 of file stdCamera.hpp.

◆ m_stepROIBinning_x

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepROIBinning_x

protectedinherited

Definition at line 662 of file stdCamera.hpp.

◆ m_stepROIBinning_y

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepROIBinning_y

protectedinherited

Definition at line 666 of file stdCamera.hpp.

◆ m_stepROIHeight

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepROIHeight

protectedinherited

Definition at line 658 of file stdCamera.hpp.

◆ m_stepROIWidth

int MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepROIWidth

protectedinherited

Definition at line 654 of file stdCamera.hpp.

◆ m_stepROIx

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepROIx

protectedinherited

Definition at line 646 of file stdCamera.hpp.

◆ m_stepROIy

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepROIy

protectedinherited

Definition at line 650 of file stdCamera.hpp.

◆ m_stepTemp

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_stepTemp

protectedinherited

Definition at line 491 of file stdCamera.hpp.

◆ m_suid

template<bool _useINDI = true>

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_suid

privateinherited

The save-set user id of the process.

Definition at line 417 of file MagAOXApp.hpp.

◆ m_synchro

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_synchro

protectedinherited

Status of synchronization, true is on, false is off.

Definition at line 605 of file stdCamera.hpp.

◆ m_synchroSet

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_synchroSet

protectedinherited

Target status of m_synchro.

Definition at line 603 of file stdCamera.hpp.

◆ m_sysPath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_sysPath

protectedinherited

The path to the system directory, for PID file, etc.

Definition at line 191 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().

◆ m_tel

logManagerT MagAOX::app::dev::telemeter< cred2Ctrl >::m_tel

inherited

Definition at line 81 of file telemeter.hpp.

◆ m_tempControlOnTarget

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlOnTarget

protectedinherited

Whether or not the temperature control system is on its target temperature.

Definition at line 500 of file stdCamera.hpp.

◆ m_tempControlStatus

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatus

protectedinherited

Whether or not temperature control is active.

Definition at line 497 of file stdCamera.hpp.

◆ m_tempControlStatusSet

bool MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatusSet

protectedinherited

Desired state of temperature control.

Definition at line 498 of file stdCamera.hpp.

◆ m_tempControlStatusStr

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_tempControlStatusStr

protectedinherited

Camera specific description of temperature control status.

Definition at line 502 of file stdCamera.hpp.

◆ m_temps

cred2Temps MagAOX::app::cred2Ctrl::m_temps

protected

Cached camera temperature values used for INDI and telemetry updates.

Definition at line 100 of file cred2Ctrl.hpp.

Referenced by cred2Ctrl(), getTemps(), and onPowerOff().

◆ m_typeSize

size_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_typeSize

protectedinherited

The size of the type, in bytes. Result of sizeof.

Definition at line 142 of file frameGrabber.hpp.

◆ m_unit

int MagAOX::app::dev::edtCamera< cred2Ctrl >::m_unit

protectedinherited

EDT PDV board unit number.

Definition at line 63 of file edtCamera.hpp.

◆ m_useINDI

template<bool _useINDI = true>

constexpr bool MagAOX::app::MagAOXApp< _useINDI >::m_useINDI = _useINDI

staticconstexprprotectedinherited

Flag controlling whether INDI is used. If false, then no INDI code executes.

Definition at line 647 of file MagAOXApp.hpp.

◆ m_vara

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_vara

protectedinherited

Definition at line 171 of file frameGrabber.hpp.

◆ m_varw

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_varw

protectedinherited

Definition at line 176 of file frameGrabber.hpp.

◆ m_varwa

double MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_varwa

protectedinherited

Definition at line 181 of file frameGrabber.hpp.

◆ m_vshiftSpeed

float MagAOX::app::dev::stdCamera< cred2Ctrl >::m_vshiftSpeed

protectedinherited

Definition at line 527 of file stdCamera.hpp.

◆ m_vShiftSpeedName

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_vShiftSpeedName

protectedinherited

The current vshift speed name.

Definition at line 523 of file stdCamera.hpp.

◆ m_vShiftSpeedNameLabels

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_vShiftSpeedNameLabels

protectedinherited

Definition at line 521 of file stdCamera.hpp.

◆ m_vShiftSpeedNames

std::vector<std::string> MagAOX::app::dev::stdCamera< cred2Ctrl >::m_vShiftSpeedNames

protectedinherited

Definition at line 520 of file stdCamera.hpp.

◆ m_vShiftSpeedNameSet

std::string MagAOX::app::dev::stdCamera< cred2Ctrl >::m_vShiftSpeedNameSet

protectedinherited

The user requested vshift speed name, to be set by derived()

Definition at line 524 of file stdCamera.hpp.

◆ m_watimesD

std::vector<double> MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_watimesD

protectedinherited

Definition at line 164 of file frameGrabber.hpp.

◆ m_width

uint32_t MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_width

protectedinherited

The width of the image, once deinterlaced etc.

Definition at line 138 of file frameGrabber.hpp.

◆ m_writeTimeout

unsigned MagAOX::app::dev::ioDevice::m_writeTimeout {1000}

inherited

The write timeout [msec].

Definition at line 29 of file ioDevice.hpp.

◆ m_wtimes

mx::sigproc::circularBufferIndex<timespec, cbIndexT> MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_wtimes

protectedinherited

Definition at line 160 of file frameGrabber.hpp.

◆ m_wtimesD

std::vector<double> MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_wtimesD

protectedinherited

Definition at line 163 of file frameGrabber.hpp.

◆ m_xbinning

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_xbinning

protectedinherited

The x-binning according to the framegrabber.

Definition at line 144 of file frameGrabber.hpp.

◆ m_ybinning

int MagAOX::app::dev::frameGrabber< cred2Ctrl >::m_ybinning

protectedinherited

The y-binning according to the framegrabber.

Definition at line 145 of file frameGrabber.hpp.

◆ pidFileName

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::pidFileName

protectedinherited

The name of the PID file.

Definition at line 497 of file MagAOXApp.hpp.

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

apps/cred2Ctrl/cred2Ctrl.hpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Friends

Logging

PID Locking

INDI Interface

Power Management

Framegrabber Thread

INDI

Application State

INDI

Signal Handling

Privilege Management

Detailed Description

Member Typedef Documentation

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ cbIndexT

◆ frameGrabberT

◆ logManagerT [1/2]

◆ logManagerT [2/2]

◆ MagAOXAppT

◆ stdCameraT

◆ telemeterT

◆ verboseT [1/2]

◆ verboseT [2/2]

Member Enumeration Documentation

◆ fgFlip

Constructor & Destructor Documentation

◆ cred2Ctrl()

◆ ~cred2Ctrl()

Member Function Documentation

◆ _handlerSigTerm()

◆ acquireAndCheckValid()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ basePath()

◆ calibDir()

◆ checkConfig()

◆ checkFocus() [1/2]

◆ checkFocus() [2/2]

◆ checkFocusSwitchState()

◆ checkNextROI() [1/3]

◆ checkNextROI() [2/3]

◆ checkNextROI() [3/3]

◆ checkRecordTimes() [1/4]

◆ checkRecordTimes() [2/4]

◆ checkRecordTimes() [3/4]

◆ checkRecordTimes() [4/4]

◆ clearFSMAlert()

◆ configBase()

◆ configCircBuffs()

◆ configDir()

◆ configLog()

◆ configName()

◆ configureAcquisition()

◆ cpusetPath()

◆ createFanSpeed() [1/2]

◆ createFanSpeed() [2/2]

◆ createINDIFIFOS()

◆ createReadoutSpeed() [1/2]

◆ createReadoutSpeed() [2/2]

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()