MagAO-X application to control writing ImageStreamIO streams to a zeroMQ channel. More...

#include <mzmqServer.hpp>

Inheritance diagram for MagAOX::app::mzmqServer:

Collaboration diagram for MagAOX::app::mzmqServer:

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

Public Member Functions
	mzmqServer ()
	Default c'tor. More...

	~mzmqServer () noexcept
	Destructor. More...

virtual void	setupConfig ()
	Setup the configuration system (called by MagAOXApp::setup()) More...

virtual void	loadConfig ()
	load the configuration system results (called by MagAOXApp::setup()) More...

virtual int	appStartup ()
	Startup functions. More...

virtual int	appLogic ()
	Implementation of the FSM for the Siglent SDG. More...

virtual int	appShutdown ()
	Do any needed shutdown tasks. Currently nothing in this app. More...

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

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

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

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

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

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

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. More...

Member Accessors
std::string	configName ()
	Get the config name. More...

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

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

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

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

Protected Member Functions
milkzmq Status and Error Handling
Implementation of status updates, warnings, and errors from milkzmq using logs.
virtual void	reportInfo (const std::string &msg)
	Log status (with LOG_INFO level of priority). More...

virtual void	reportNotice (const std::string &msg)
	Log status (with LOG_NOTICE level of priority). More...

virtual void	reportWarning (const std::string &msg)
	Log a warning. More...

virtual void	reportError (const std::string &msg, const std::string &file, int line)
	Log an error. More...

Protected Attributes
bool	m_compress {false}

std::vector< std::string >	m_shMemImNames

std::string	MagAOXPath
	The base path of the MagAO-X system. More...

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

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

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

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

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

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

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. More...

cpusets
The path to the cpusets mount is configured by the environment varialbe defined by MAGOX_env_cpuset in environment.hpp. This environment varialbe is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used. This is normally "/opt/MagAOX/cpuset/"
std::string	m_cpusetPath { MAGAOX_cpusetPath }

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

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. More...

pid_t	m_pid { 0 }
	This process's PID. More...

int	lockPID ()

int	unlockPID ()
	Remove the PID file. More...

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. More...

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

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

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

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

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

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

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

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

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. More...

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. More...

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. More...

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

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

void	sendGetPropertySetList (bool all=false)

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

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

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

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

int	createINDIFIFOS ()
	Create the INDI FIFOs. More...

int	startINDI ()
	Start INDI Communications. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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) More...

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

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

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

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. More...

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

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

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

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

std::mutex	m_indiMutex
	Mutex for locking INDI communications. More...

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. More...

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

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

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

unsigned long	m_powerOnWait { 0 }
	Time in sec to wait for device to boot after power on. More...

int	m_powerOnCounter { -1 }

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

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

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

int	powerState ()
	Returns the current power state. More...

int	powerStateTarget ()
	Returns the target power state. More...

	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

virtual int	onPowerOff ()
	This method is called when the change to poweroff is detected. More...

virtual int	whilePowerOff ()
	This method is called while the power is off, once per FSM loop. More...

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

SIGSEGV & SIGBUS signal handling
These signals occur as a result of a ImageStreamIO source server resetting (e.g. changing frame sizes). When they occur a restart of the framegrabber and framewriter thread main loops is triggered.
static mzmqServer *	m_selfWriter = nullptr
	Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler. More...

int	setSigSegvHandler ()
	Sets the handler for SIGSEGV and SIGBUS. More...

void	handlerSigSegv (int signum, siginfo_t siginf, void ucont)
	Handles SIGSEGV and SIGBUS. Sets m_restart to true. More...

static void	_handlerSigSegv (int signum, siginfo_t siginf, void ucont)
	The handler called when SIGSEGV or SIGBUS is received, which will be due to ImageStreamIO server resets. Just a wrapper for handlerSigSegv. More...

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

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

static logManagerT	m_log

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

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

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

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

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

stateCodes::stateCodeT	m_state { stateCodes::UNINITIALIZED }

bool	m_stateAlert { false }

bool	m_gitAlert { false }

int	m_stateLogged { 0 }

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

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

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

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. More...

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

uid_t	m_euidCalled

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

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

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

Detailed Description

MagAO-X application to control writing ImageStreamIO streams to a zeroMQ channel.

Todo:

document this better

implement thread-kills for shutdown. Maybe switch to USR1, with library wide empty handler, so it isn't logged.

Definition at line 49 of file mzmqServer.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 567 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 564 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 561 of file MagAOXApp.hpp.

◆ logManagerT

template<bool _useINDI = true>

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

inherited

The log manager type.

Definition at line 78 of file MagAOXApp.hpp.

Constructor & Destructor Documentation

◆ mzmqServer()

MagAOX::app::mzmqServer::mzmqServer ( )

inline

Default c'tor.

Definition at line 140 of file mzmqServer.hpp.

◆ ~mzmqServer()

MagAOX::app::mzmqServer::~mzmqServer ( )

inlinenoexcept

Destructor.

Definition at line 148 of file mzmqServer.hpp.

Member Function Documentation

◆ _handlerSigSegv()

void MagAOX::app::mzmqServer::_handlerSigSegv	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

inlinestaticprotected

The handler called when SIGSEGV or SIGBUS is received, which will be due to ImageStreamIO server resets. Just a wrapper for handlerSigSegv.

Definition at line 326 of file mzmqServer.hpp.

Referenced by setSigSegvHandler().

◆ _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 1921 of file MagAOXApp.hpp.

◆ appLogic()

int MagAOX::app::mzmqServer::appLogic ( )

inlinevirtual

Implementation of the FSM for the Siglent SDG.

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

Definition at line 240 of file mzmqServer.hpp.

◆ appShutdown()

int MagAOX::app::mzmqServer::appShutdown ( )

inlinevirtual

Do any needed shutdown tasks. Currently nothing in this app.

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

Definition at line 267 of file mzmqServer.hpp.

◆ appStartup()

int MagAOX::app::mzmqServer::appStartup ( )

inlinevirtual

Startup functions.

Sets up the INDI vars.

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

Definition at line 194 of file mzmqServer.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 1441 of file MagAOXApp.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 2376 of file MagAOXApp.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 3483 of file MagAOXApp.hpp.

◆ 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 1863 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 3477 of file MagAOXApp.hpp.

Referenced by MagAOXApp_tests::MagAOXApp_test::configName(), MagAOX::app::andorCtrl::loadConfig(), and MagAOX::app::andorCtrl::writeConfig().

◆ 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 2828 of file MagAOXApp.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 2517 of file MagAOXApp.hpp.

Referenced by 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 2434 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 2470 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 2573 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 2645 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 2603 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 2406 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 2543 of file MagAOXApp.hpp.

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

◆ 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 3501 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 3489 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 3495 of file MagAOXApp.hpp.

◆ execute()

template<bool _useINDI>

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

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 1508 of file MagAOXApp.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 2989 of file MagAOXApp.hpp.

◆ 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 2995 of file MagAOXApp.hpp.

◆ 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 3064 of file MagAOXApp.hpp.

Referenced by MagAOXApp_tests::SCENARIO().

◆ handlerSigSegv()

void MagAOX::app::mzmqServer::handlerSigSegv	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

inlineprotected

Handles SIGSEGV and SIGBUS. Sets m_restart to true.

Definition at line 335 of file mzmqServer.hpp.

Referenced by _handlerSigSegv().

◆ 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 1927 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 3089 of file MagAOXApp.hpp.

◆ INDI_SETCALLBACK_DECL()

template<bool _useINDI = true>

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

inherited

◆ 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 3197 of file MagAOXApp.hpp.

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

◆ 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 1383 of file MagAOXApp.hpp.

◆ loadConfig()

void MagAOX::app::mzmqServer::loadConfig ( )

inlinevirtual

load the configuration system results (called by MagAOXApp::setup())

Definition at line 173 of file mzmqServer.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 1999 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 1804 of file MagAOXApp.hpp.

◆ 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 1812 of file MagAOXApp.hpp.

Referenced by visxCtrl.xapp.VisX::cancel_exposure(), visxCtrl.xapp.VisX::finalize_exposure(), visxCtrl.xapp.VisX::handle_expose(), visxCtrl.xapp.VisX::handle_exptime(), visxCtrl.xapp.VisX::handle_gain(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), visxCtrl.xapp.VisX::handle_temp_ccd(), dbIngest.dbIngest::ingest_line(), dbIngest.dbIngest::launch_followers(), audibleAlerts.core.AudibleAlerts::loop(), visxCtrl.xapp.VisX::loop(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), dbIngest.dbIngest::rescan_files(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), visxCtrl.xapp.VisX::setup(), and visxCtrl.xapp.VisX::subscribe_to_other_devices().

◆ 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 1819 of file MagAOXApp.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 3364 of file MagAOXApp.hpp.

◆ onPowerOff()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::onPowerOff

protectedvirtualinherited

This method is called when the change to poweroff is detected.

Returns: 0 on success.; -1 on any error which means the app should exit.

Reimplemented in MagAOX::app::zylaCtrl, MagAOX::app::zaberLowLevel, MagAOX::app::xt1121Ctrl, MagAOX::app::smc100ccCtrl, MagAOX::app::siglentSDG, MagAOX::app::picoMotorCtrl, MagAOX::app::picamCtrl, MagAOX::app::ocam2KCtrl, MagAOX::app::irisaoCtrl, MagAOX::app::hsfwCtrl, MagAOX::app::filterWheelCtrl, MagAOX::app::bmcCtrl, MagAOX::app::andorCtrl, MagAOX::app::alpaoCtrl, and MagAOX::app::acronameUsbHub.

Definition at line 3385 of file MagAOXApp.hpp.

◆ 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 3397 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::appLogic(), and MagAOX::app::smc100ccCtrl::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 3414 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 3423 of file MagAOXApp.hpp.

◆ 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 MagAOXApp_tests::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 2655 of file MagAOXApp.hpp.

Referenced by 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 2684 of file MagAOXApp.hpp.

◆ 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 2792 of file MagAOXApp.hpp.

◆ reportError()

void MagAOX::app::mzmqServer::reportError	(	const std::string &	msg,
		const std::string &	file,
		int	line
	)

inlineprotectedvirtual

Log an error.

Parameters

[in]	msg	the error message
[in]	file	the name of the file where the error occurred
[in]	line	the line number of the error

Definition at line 368 of file mzmqServer.hpp.

◆ reportInfo()

void MagAOX::app::mzmqServer::reportInfo ( const std::string & msg )

inlineprotectedvirtual

Log status (with LOG_INFO level of priority).

Parameters

[in] msg the status message

Definition at line 350 of file mzmqServer.hpp.

◆ reportNotice()

void MagAOX::app::mzmqServer::reportNotice ( const std::string & msg )

inlineprotectedvirtual

Log status (with LOG_NOTICE level of priority).

Parameters

[in] msg the status message

Definition at line 356 of file mzmqServer.hpp.

◆ reportWarning()

void MagAOX::app::mzmqServer::reportWarning ( const std::string & msg )

inlineprotectedvirtual

Log a warning.

Parameters

[in] msg the warning message

Definition at line 362 of file mzmqServer.hpp.

◆ sendGetPropertySetList()

template<bool _useINDI>

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

inherited

Definition at line 2949 of file MagAOXApp.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 3302 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 3268 of file MagAOXApp.hpp.

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::ocam2KCtrl::setFPS(), MagAOX::app::ttmModulator::setTTM(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::zaberCtrl::stop(), MagAOX::app::xt1121DCDU::turnOutletOff(), and MagAOX::app::xt1121DCDU::turnOutletOn().

◆ 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 3321 of file MagAOXApp.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 1188 of file MagAOXApp.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 1961 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 1980 of file MagAOXApp.hpp.

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

◆ setSigSegvHandler()

int MagAOX::app::mzmqServer::setSigSegvHandler ( )

inlineprotected

Sets the handler for SIGSEGV and SIGBUS.

These are caused by ImageStreamIO server resets.

Definition at line 288 of file mzmqServer.hpp.

Referenced by appStartup().

◆ setSigTermHandler()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::setSigTermHandler

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 1872 of file MagAOXApp.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 1294 of file MagAOXApp.hpp.

◆ setupConfig()

void MagAOX::app::mzmqServer::setupConfig ( )

inlinevirtual

Setup the configuration system (called by MagAOXApp::setup())

Definition at line 154 of file mzmqServer.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 1182 of file MagAOXApp.hpp.

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

◆ 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 3358 of file MagAOXApp.hpp.

◆ 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 2892 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 2297 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 2303 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 2361 of file MagAOXApp.hpp.

Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::andorCtrl::cameraSelect(), MagAOX::app::picamCtrl::connect(), and MagAOX::app::qhyCtrl::connect().

◆ 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 2157 of file MagAOXApp.hpp.

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 2133 of file MagAOXApp.hpp.

◆ 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 3135 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 3160 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 3120 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::cameraSim::checkNextROI(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::acronameUsbHub::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(), 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 3181 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 3144 of file MagAOXApp.hpp.

Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::cameraSim::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()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::whilePowerOff

protectedvirtualinherited

This method is called while the power is off, once per FSM loop.

Returns: 0 on success.; -1 on any error which means the app should exit.

Reimplemented in MagAOX::app::zylaCtrl, MagAOX::app::zaberLowLevel, MagAOX::app::xt1121Ctrl, MagAOX::app::siglentSDG, MagAOX::app::picoMotorCtrl, MagAOX::app::picamCtrl, MagAOX::app::ocam2KCtrl, MagAOX::app::irisaoCtrl, MagAOX::app::hsfwCtrl, MagAOX::app::filterWheelCtrl, MagAOX::app::bmcCtrl, MagAOX::app::andorCtrl, MagAOX::app::alpaoCtrl, and MagAOX::app::acronameUsbHub.

Definition at line 3391 of file MagAOXApp.hpp.

Member Data Documentation

◆ 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 582 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 89 of file MagAOXApp.hpp.

◆ m_compress

bool MagAOX::app::mzmqServer::m_compress {false}

protected

Definition at line 82 of file mzmqServer.hpp.

Referenced by appStartup(), and loadConfig().

◆ 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 87 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 85 of file MagAOXApp.hpp.

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

◆ 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 83 of file MagAOXApp.hpp.

Referenced by MagAOX::app::mzmqClient::loadConfig(), 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

Definition at line 424 of file MagAOXApp.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 593 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 585 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 588 of file MagAOXApp.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 314 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 313 of file MagAOXApp.hpp.

◆ m_gitAlert

template<bool _useINDI = true>

bool MagAOX::app::MagAOXApp< _useINDI >::m_gitAlert { false }

privateinherited

Definition at line 478 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 542 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 545 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 573 of file MagAOXApp.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 980 of file MagAOXApp.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 1036 of file MagAOXApp.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 977 of file MagAOXApp.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 578 of file MagAOXApp.hpp.

◆ m_log

template<bool _useINDI>

MagAOXApp< _useINDI >::logManagerT MagAOX::app::MagAOXApp< _useINDI >::m_log

staticinherited

Definition at line 237 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 95 of file MagAOXApp.hpp.

Referenced by MagAOX::app::trippLitePDU::trippLitePDU(), MagAOX::app::siglentSDG::appLogic(), and MagAOX::app::xt1121Ctrl::appLogic().

◆ m_pid

template<bool _useINDI = true>

pid_t MagAOX::app::MagAOXApp< _useINDI >::m_pid { 0 }

protectedinherited

This process's PID.

Definition at line 394 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 1022 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 1021 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 1023 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 1016 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 1029 of file MagAOXApp.hpp.

Referenced by MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), and MagAOX::app::zylaCtrl::onPowerOff().

◆ m_powerOnWait

template<bool _useINDI = true>

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_powerOnWait { 0 }

protectedinherited

Time in sec to wait for device to boot after power on.

Definition at line 1026 of file MagAOXApp.hpp.

Referenced by MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), 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 1033 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 1024 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 1034 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 289 of file MagAOXApp.hpp.

◆ m_selfWriter

mzmqServer * MagAOX::app::mzmqServer::m_selfWriter = nullptr

staticprotected

Static pointer to this (set in constructor). Used for getting out of the static SIGSEGV handler.

Definition at line 91 of file mzmqServer.hpp.

Referenced by _handlerSigSegv().

◆ m_shMemImNames

std::vector<std::string> MagAOX::app::mzmqServer::m_shMemImNames

protected

Definition at line 83 of file mzmqServer.hpp.

Referenced by appStartup(), and loadConfig().

◆ 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 100 of file MagAOXApp.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 472 of file MagAOXApp.hpp.

◆ m_stateAlert

template<bool _useINDI = true>

bool MagAOX::app::MagAOXApp< _useINDI >::m_stateAlert { false }

privateinherited

Definition at line 475 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 480 of file MagAOXApp.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 316 of file MagAOXApp.hpp.

◆ m_useINDI

template<bool _useINDI = true>

constexpr static 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 537 of file MagAOXApp.hpp.

◆ MagAOXPath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::MagAOXPath

protectedinherited

The base path of the MagAO-X system.

Definition at line 81 of file MagAOXApp.hpp.

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

◆ pidFileName

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::pidFileName

protectedinherited

The name of the PID file.

Definition at line 392 of file MagAOXApp.hpp.

◆ secretsPath

template<bool _useINDI = true>

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

protectedinherited

Path to the secrets directory, where passwords, etc, are stored.

Definition at line 93 of file MagAOXApp.hpp.

◆ sysPath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::sysPath

protectedinherited

The path to the system directory, for PID file, etc.

Definition at line 91 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().

The documentation for this class was generated from the following file:

apps/mzmqServer/mzmqServer.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

PID Locking

INDI Interface

Power Management

SIGSEGV & SIGBUS signal handling

Logging

Application State

Signal Handling

Privilege Management

Detailed Description

Member Typedef Documentation

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ logManagerT

Constructor & Destructor Documentation

◆ mzmqServer()

◆ ~mzmqServer()

Member Function Documentation

◆ _handlerSigSegv()

◆ _handlerSigTerm()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ checkConfig()

◆ clearFSMAlert()

◆ configDir()

◆ configLog()

◆ configName()

◆ createINDIFIFOS()

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()

◆ driverCtrlName()

◆ driverInName()

◆ driverOutName()

◆ execute()

◆ handleDefProperty()

◆ handleGetProperties()

◆ handleNewProperty()

◆ handlerSigSegv()

◆ handlerSigTerm()

◆ handleSetProperty()

◆ INDI_SETCALLBACK_DECL()

◆ indiTargetUpdate()

◆ loadBasicConfig()

◆ loadConfig()

◆ lockPID()

◆ log() [1/2]

◆ log() [2/2]

◆ logMessage()

◆ newCallBack_clearFSMAlert()

◆ onPowerOff()

◆ powerOnWaitElapsed()

◆ powerState()

◆ powerStateTarget()

◆ registerIndiPropertyNew() [1/3]

◆ registerIndiPropertyNew() [2/3]

◆ registerIndiPropertyNew() [3/3]

◆ registerIndiPropertyReadOnly() [1/2]

◆ registerIndiPropertyReadOnly() [2/2]

◆ registerIndiPropertySet()

◆ reportError()

◆ reportInfo()

◆ reportNotice()

◆ reportWarning()

◆ sendGetPropertySetList()

◆ sendNewProperty() [1/2]

◆ sendNewProperty() [2/2]

◆ sendNewStandardIndiToggle()

◆ setDefaults()