The MagAO-X IrisAO DM Controller. More...

#include <irisaoCtrl.hpp>

Inheritance diagram for MagAOX::app::irisaoCtrl:

Collaboration diagram for MagAOX::app::irisaoCtrl:

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

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

	~irisaoCtrl () noexcept
	D'tor. More...

virtual void	setupConfig ()
	Setup the configuration system. More...

int	loadConfigImpl (mx::app::appConfigurator &_config)
	Implementation of loadConfig logic, separated for testing. More...

virtual void	loadConfig ()
	Load the configuration. More...

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

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

virtual int	appShutdown ()
	Shutdown the app. More...

virtual int	onPowerOff ()
	Cleanup after a power off. More...

virtual int	whilePowerOff ()
	Maintenace while powered off. 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...

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

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

int	findDMChannels ()
	Find the DM comb channels. More...

int	allocate (const dev::shmimT &sp)
	Called after shmimMonitor connects to the dmXXdisp stream. Checks for proper size. More...

int	processImage (void *curr_src, const dev::shmimT &sp)
	Called by shmimMonitor when a new DM command is available. This is just a pass-through to derivedT::commandDM(char*). More...

int	checkFlats ()
	Check the flats directory and update the list of flats if anything changes. More...

int	loadFlat (const std::string &target)
	Load a flat file. More...

int	setFlat (bool update=false)
	Send the current flat command to the DM. More...

int	zeroFlat ()
	Zero the flat command on the DM. More...

int	checkTests ()
	Check the tests directory and update the list of tests if anything changes. More...

int	loadTest (const std::string &target)
	Load a test file. More...

int	setTest ()
	Send the current test command to the DM. More...

int	zeroTest ()
	Zero the test command on the DM. More...

int	zeroAll (bool nosem=false)
	Zero all channels. More...

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

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

DM Base Class Interface
int	initDM ()
	Initialize the DM and prepare for operation. More...

int	zeroDM ()
	Zero all commands on the DM. More...

int	commandDM (void *curr_src)
	Send a command to the DM. More...

int	releaseDM ()
	Release the DM, making it safe to turn off power. More...

Threads
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
int	clearSat ()
	Clear the saturation maps and zero the shared membory. More...

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

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

std::string	m_calibRelDir
	The directory relative to the calibPath. Set this before calling dm<derivedT,realT>::loadConfig(). More...

int	m_channels
	The number of dmcomb channels found as part of allocation. More...

std::map< std::string, std::string >	m_flatCommands
	Map of flat file name to full path. More...

std::string	m_flatCurrent
	The name of the current flat command. More...

mx::improc::eigenImage< float >	m_flatCommand
	Data storage for the flat command. More...

bool	m_flatLoaded
	Flag indicating whether a flat is loaded in memory. More...

IMAGE	m_flatImageStream
	The ImageStreamIO shared memory buffer for the flat. More...

bool	m_flatSet
	Flag indicating whether the flat command has been set. More...

std::map< std::string, std::string >	m_testCommands
	Map of test file name to full path. More...

std::string	m_testCurrent

mx::improc::eigenImage< float >	m_testCommand
	Data storage for the test command. More...

bool	m_testLoaded
	Flag indicating whether a test command is loaded in memory. More...

IMAGE	m_testImageStream
	The ImageStreamIO shared memory buffer for the test. More...

bool	m_testSet
	Flag indicating whether the test command has been set. More...

int	m_overSatAct

int	m_intervalSatExceeds

bool	m_intervalSatTrip

mx::improc::eigenImage< uint8_t >	m_instSatMap
	The instantaneous saturation map, 0/1, set by the commandDM() function of the derived class. More...

mx::improc::eigenImage< uint16_t >	m_accumSatMap
	The accumulated saturation map, which acccumulates for m_satAvgInt then is publised as a 0/1 image. More...

mx::improc::eigenImage< float >	m_satPercMap
	Map of the percentage of time each actator was saturated during the avg. interval. More...

IMAGE	m_satImageStream
	The ImageStreamIO shared memory buffer for the sat map. More...

IMAGE	m_satPercImageStream
	The ImageStreamIO shared memory buffer for the sat percentage map. More...

bool	m_getExistingFirst
	If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore. More...

int	m_semaphoreNumber
	The image structure semaphore index. More...

uint32_t	m_width
	The width of the images in the stream. More...

uint32_t	m_height
	The height of the images in the stream. More...

uint32_t	m_depth
	The depth of the circular buffer in the stream. More...

uint8_t	m_dataType
	The ImageStreamIO type code. More...

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

IMAGE	m_imageStream
	The ImageStreamIO shared memory buffer. More...

ino_t	m_inode
	The inode of the image stream file. More...

Configurable Parameters
std::string	m_mserialNumber
	The IrisAO MIRROR serial number. More...

std::string	m_dserialNumber
	The IrisAO DRIVER serial number. More...

bool	m_hardwareDisable
	Hardware disable flag (set to true to disable sending commands) More...

IrisAO Interface
uint32_t	m_nbAct {0}
	The number of actuators. More...

double *	m_dminputs {nullptr}
	Pre-allocated command vector, used only in commandDM. More...

MirrorHandle	m_dm
	IrisAO SDK handle for the DM. More...

bool	m_dmopen {false}
	Track whether the DM connection has been opened. 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

Configurable Parameters
std::string	m_shmimName
	The name of the shared memory image, is used in `/tmp/<shmimName>.im.shm`. Derived classes should set a default. More...

int	m_smThreadPrio
	Priority of the shmimMonitor thread, should normally be > 00. More...

std::string	m_smCpuset
	The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default). More...

Private Types
typedef float	realT
	This defines the datatype used to signal the DM using the ImageStreamIO library. More...

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

irisaoCtrl &	derived ()

Private Attributes
size_t	m_nsat {0}

Friends
class	irisaoCtrl_test

class	dev::dm< irisaoCtrl, float >

class	dev::shmimMonitor< irisaoCtrl >

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
	The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid). More...

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

Application State
stateCodes::stateCodeT	m_state
	The application's state. Never ever set this directly, use state(const stateCodeT & s). More...

bool	m_stateAlert

bool	m_gitAlert

int	m_stateLogged
	Counter and flag for use to log errors just once. Never ever access directly, use stateLogged(). More...

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

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
	This process's PID. More...

int	lockPID ()
	Attempt to lock the PID by writing it to a file. Fails if a process is already running with the same config name. More...

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

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

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="")
	Create a standard R/W INDI selection (one of many) switch with vector of elements using the element strings as their own labels. More...

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

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

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

indiDriver< MagAOXApp > *	m_indiDriver
	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...

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

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

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

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

void	updateIfChanged (pcf::IndiProperty &p, const std::vector< std::string > &els, const std::vector< T > &newVals)
	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...

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

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

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

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
	The INDI element name to monitor for this device's power state. More...

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

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

int	m_powerOnCounter
	Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup. More...

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

int	m_powerTargetState
	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)

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

Configurable Parameters
std::string	m_calibPath
	The path to this DM's calibration files. More...

std::string	m_flatPath
	The path to this DM's flat files (usually the same as calibPath) More...

std::string	m_testPath
	The path to this DM's test files (default is calibPath/tests;. More...

std::string	m_flatDefault
	The file name of the this DM's default flat command. Path and extension will be ignored and can be omitted. More...

std::string	m_testDefault
	The file name of the this DM's default test command. Path and extension will be ignored and can be omitted. More...

std::string	m_shmimFlat
	The name of the shmim stream to write the flat to. More...

std::string	m_shmimTest
	The name of the shmim stream to write the test to. More...

std::string	m_shmimSat
	The name of the shmim stream to write the saturation map to. More...

std::string	m_shmimSatPerc
	The name of the shmim stream to write the saturation percentage map to. More...

int	m_satAvgInt
	The time in milliseconds to accumulate saturation over. More...

int	m_satThreadPrio
	Priority of the saturation thread, should normally be > 0. More...

uint32_t	m_dmWidth
	The width of the images in the stream. More...

uint32_t	m_dmHeight
	The height of the images in the stream. More...

float	m_percThreshold

float	m_intervalSatThreshold

int	m_intervalSatCountThreshold

std::vector< std::string >	m_satTriggerDevice

std::vector< std::string >	m_satTriggerProperty

static constexpr uint8_t	m_dmDataType
	The ImageStreamIO type code. More...

Saturation Thread
This thread processes the saturation maps
sem_t	m_satSemaphore
	Semaphore used to tell the saturation thread to run. More...

bool	m_satThreadInit
	Synchronizer for thread startup, to allow priority setting to finish. More...

pid_t	m_satThreadID
	The ID of the saturation thread. More...

pcf::IndiProperty	m_satThreadProp
	The property to hold the saturation thread details. More...

std::thread	m_satThread
	A separate thread for the actual saturation processing. More...

void	satThreadExec ()
	Execute saturation processing. More...

void	intervalSatTrip ()

static void	satThreadStart (dm *d)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls satThreadExec. More...

INDI
pcf::IndiProperty	m_indiP_flat
	Property used to set and report the current flat. More...

pcf::IndiProperty	m_indiP_init

pcf::IndiProperty	m_indiP_zero

pcf::IndiProperty	m_indiP_release

pcf::IndiProperty	m_indiP_flats
	INDI Selection switch containing the flat files. More...

pcf::IndiProperty	m_indiP_flatShmim
	Publish the shmim being used for the flat. More...

pcf::IndiProperty	m_indiP_setFlat
	INDI toggle switch to set the current flat. More...

pcf::IndiProperty	m_indiP_tests
	INDI Selection switch containing the test pattern files. More...

pcf::IndiProperty	m_indiP_testShmim
	Publish the shmim being used for the test command. More...

pcf::IndiProperty	m_indiP_setTest
	INDI toggle switch to set the current test pattern. More...

pcf::IndiProperty	m_indiP_zeroAll

int	newCallBack_init (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_zero (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_release (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_flats (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_setFlat (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_tests (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_setTest (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request. More...

int	newCallBack_zeroAll (const pcf::IndiProperty &ipRecv)
	The callback for the zeroAll toggle switch, called by the static version. More...

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

static int	st_newCallBack_init (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for initializing the DM. More...

static int	st_newCallBack_zero (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for initializing the DM. More...

static int	st_newCallBack_release (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for initializing the DM. More...

static int	st_newCallBack_flats (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for selecting the flat file. More...

static int	st_newCallBack_setFlat (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for setting the flat. More...

static int	st_newCallBack_tests (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for selecting the test file. More...

static int	st_newCallBack_setTest (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for setting the test shape. More...

static int	st_newCallBack_zeroAll (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for zeroing all channels. 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 shmim monitor thread main loops is triggered.
bool	m_restart
	Flag indicating tha the shared memory should be reinitialized. More...

static shmimMonitor *	m_selfMonitor
	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...

shmimmonitor Thread
This thread actually monitors the shared memory buffer
bool	m_smThreadInit
	Synchronizer for thread startup, to allow priority setting to finish. More...

pid_t	m_smThreadID
	The s.m. thread PID. More...

pcf::IndiProperty	m_smThreadProp
	The property to hold the s.m. thread details. More...

std::thread	m_smThread
	A separate thread for the actual monitoring. More...

void	smThreadExec ()
	Execute the monitoring thread. More...

static void	smThreadStart (shmimMonitor *s)
	Thread starter, called by MagAOXApp::threadStart on thread construction. Calls smThreadExec. More...

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

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

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

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

static logManagerT	m_log

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

static int	log (logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry. 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...

Signal Handling
libMagAOX/logger/types/software_log.hpp
static MagAOXApp *	m_self
	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. 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...

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

Detailed Description

The MagAO-X IrisAO DM Controller.

Definition at line 58 of file irisaoCtrl.hpp.

Member Typedef Documentation

◆ callBackInsertResult

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

inherited

Return type of insert on the indiCallBack map.

Definition at line 561 of file MagAOXApp.hpp.

◆ callBackIterator

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

inherited

Iterator type of the indiCallBack map.

Definition at line 558 of file MagAOXApp.hpp.

◆ callBackValueType

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

inherited

Value type of the indiCallBack map.

Definition at line 555 of file MagAOXApp.hpp.

◆ logManagerT

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

inherited

The log manager type.

Definition at line 82 of file MagAOXApp.hpp.

◆ realT

typedef float MagAOX::app::irisaoCtrl::realT

private

This defines the datatype used to signal the DM using the ImageStreamIO library.

Definition at line 68 of file irisaoCtrl.hpp.

Constructor & Destructor Documentation

◆ irisaoCtrl()

MagAOX::app::irisaoCtrl::irisaoCtrl ( )

Default c'tor.

Definition at line 188 of file irisaoCtrl.hpp.

◆ ~irisaoCtrl()

MagAOX::app::irisaoCtrl::~irisaoCtrl ( )

noexcept

D'tor.

Definition at line 194 of file irisaoCtrl.hpp.

Member Function Documentation

◆ _handlerSigSegv()

void MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::_handlerSigSegv	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

staticprotectedinherited

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 185 of file shmimMonitor.hpp.

◆ _handlerSigTerm()

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

◆ allocate()

int MagAOX::app::dev::dm< irisaoCtrl , float >::allocate ( const dev::shmimT & sp )

inherited

Called after shmimMonitor connects to the dmXXdisp stream. Checks for proper size.

Returns: 0 on success; -1 if incorrect size or data type in stream.

Definition at line 230 of file dm.hpp.

◆ appLogic()

int MagAOX::app::irisaoCtrl::appLogic ( )

virtual

Implementation of the FSM for irisaoCtrl.

Returns: 0 on no critical error; -1 on an error requiring shutdown

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

Definition at line 238 of file irisaoCtrl.hpp.

◆ appShutdown()

int MagAOX::app::irisaoCtrl::appShutdown ( )

virtual

Shutdown the app.

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

Definition at line 261 of file irisaoCtrl.hpp.

◆ appStartup()

int MagAOX::app::irisaoCtrl::appStartup ( )

virtual

Startup function.

Sets up INDI, and starts the shmim thread.

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

Definition at line 229 of file irisaoCtrl.hpp.

◆ checkConfig()

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

◆ checkFlats()

int MagAOX::app::dev::dm< irisaoCtrl , float >::checkFlats

inherited

Check the flats directory and update the list of flats if anything changes.

This is called once per appLogic and whilePowerOff loops.

Returns: 0 on success; -1 on error

Definition at line 251 of file dm.hpp.

◆ checkTests()

int MagAOX::app::dev::dm< irisaoCtrl , float >::checkTests

inherited

Check the tests directory and update the list of tests if anything changes.

This is called once per appLogic and whilePowerOff loops.

Returns: 0 on success; -1 on error

Definition at line 285 of file dm.hpp.

◆ clearFSMAlert()

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

◆ clearSat()

int MagAOX::app::dev::dm< irisaoCtrl , float >::clearSat

protectedinherited

Clear the saturation maps and zero the shared membory.

Returns: 0 on success; -1 on error

Definition at line 331 of file dm.hpp.

◆ commandDM()

int MagAOX::app::irisaoCtrl::commandDM ( void * curr_src )

Send a command to the DM.

This is called by the shmim monitoring thread in response to a semaphore trigger.

Returns: 0 on success; -1 on error

Definition at line 381 of file irisaoCtrl.hpp.

◆ configDir()

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

inherited

Get the config directory.

Returns: the current value of m_configDir

Definition at line 1064 of file MagAOXApp.hpp.

◆ configLog()

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

staticprivateinherited

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

◆ configName()

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

inherited

Get the config name.

Returns: the current value of m_configName

Definition at line 1058 of file MagAOXApp.hpp.

◆ createINDIFIFOS()

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

◆ createROIndiNumber()

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

◆ createROIndiText()

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

◆ createStandardIndiNumber()

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

◆ createStandardIndiRequestSw()

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

◆ createStandardIndiSelectionSw() [1/2]

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

◆ createStandardIndiSelectionSw() [2/2]

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

◆ createStandardIndiText()

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

◆ createStandardIndiToggleSw()

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

◆ derived()

irisaoCtrl & MagAOX::app::dev::dm< irisaoCtrl , float >::derived ( )

inlineprivateinherited

Definition at line 562 of file dm.hpp.

◆ driverCtrlName()

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

◆ driverInName()

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

◆ driverOutName()

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

◆ execute()

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

◆ findDMChannels()

int MagAOX::app::dev::dm< irisaoCtrl , float >::findDMChannels

inherited

Find the DM comb channels.

Introspectively finds all dmXXdispYY channels, zeroes them, and raises the semapahore on the last to cause dmcomb to update.

Definition at line 223 of file dm.hpp.

◆ handleDefProperty()

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

◆ handleGetProperties()

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

◆ handleNewProperty()

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

◆ handlerSigSegv()

void MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::handlerSigSegv	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

protectedinherited

Handles SIGSEGV and SIGBUS. Sets m_restart to true.

Definition at line 191 of file shmimMonitor.hpp.

◆ handlerSigTerm()

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

◆ handleSetProperty()

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

◆ INDI_SETCALLBACK_DECL()

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

inherited

◆ indiTargetUpdate()

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

◆ initDM()

int MagAOX::app::irisaoCtrl::initDM ( )

Initialize the DM and prepare for operation.

Application is in state OPERATING upon successful conclusion.

Returns: 0 on success; -1 on error

Definition at line 281 of file irisaoCtrl.hpp.

Referenced by appLogic().

◆ intervalSatTrip()

void MagAOX::app::dev::dm< irisaoCtrl , float >::intervalSatTrip ( )

inlineprotectedinherited

Definition at line 354 of file dm.hpp.

◆ loadBasicConfig()

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

◆ loadConfig() [1/3]

void MagAOX::app::irisaoCtrl::loadConfig ( )

virtual

Load the configuration.

Definition at line 223 of file irisaoCtrl.hpp.

◆ loadConfig() [2/3]

void MagAOX::app::dev::dm< irisaoCtrl , float >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

dm<derivedT,realT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 156 of file dm.hpp.

◆ loadConfig() [3/3]

void MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::loadConfig ( mx::app::appConfigurator & config )

inherited

load the configuration system results

This should be called in derivedT::loadConfig as

shmimMonitor<derivedT, specificT>::loadConfig(config);

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 128 of file shmimMonitor.hpp.

◆ loadConfigImpl()

int MagAOX::app::irisaoCtrl::loadConfigImpl ( mx::app::appConfigurator & _config )

Implementation of loadConfig logic, separated for testing.

This is called by loadConfig().

Parameters

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

Definition at line 211 of file irisaoCtrl.hpp.

Referenced by loadConfig().

◆ loadFlat()

int MagAOX::app::dev::dm< irisaoCtrl , float >::loadFlat ( const std::string & target )

inherited

Load a flat file.

Uses the target argument for lookup in m_flatCommands to find the path and loads the command in the local memory. Calls setFlat if the flat is currently set.

Returns: 0 on success; -1 on error

Parameters

[in] target the name of the flat to load

Definition at line 261 of file dm.hpp.

◆ loadTest()

int MagAOX::app::dev::dm< irisaoCtrl , float >::loadTest ( const std::string & target )

inherited

Load a test file.

Uses the target argument for lookup in m_testCommands to find the path and loads the command in the local memory. Calls setTest if the test is currently set.

Definition at line 292 of file dm.hpp.

◆ lockPID()

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

◆ log() [1/2]

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

◆ log() [2/2]

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

◆ logMessage()

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

◆ newCallBack_clearFSMAlert()

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 the new property request.

Definition at line 964 of file MagAOXApp.hpp.

◆ newCallBack_flats()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_flats ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 476 of file dm.hpp.

◆ newCallBack_init()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_init ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 425 of file dm.hpp.

◆ newCallBack_release()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_release ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 459 of file dm.hpp.

◆ newCallBack_setFlat()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_setFlat ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 492 of file dm.hpp.

◆ newCallBack_setTest()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_setTest ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 530 of file dm.hpp.

◆ newCallBack_tests()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_tests ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 513 of file dm.hpp.

◆ newCallBack_zero()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_zero ( const pcf::IndiProperty & ipRecv )

inherited

The callback called by the static version, to actually process the new request.

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

Parameters

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

Definition at line 442 of file dm.hpp.

◆ newCallBack_zeroAll()

int MagAOX::app::dev::dm< irisaoCtrl , float >::newCallBack_zeroAll ( const pcf::IndiProperty & ipRecv )

inherited

The callback for the zeroAll toggle switch, called by the static version.

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

Parameters

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

Definition at line 546 of file dm.hpp.

◆ onPowerOff()

int MagAOX::app::irisaoCtrl::onPowerOff ( )

virtual

Cleanup after a power off.

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

Definition at line 271 of file irisaoCtrl.hpp.

◆ powerOnWaitElapsed()

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

◆ powerState()

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

◆ powerStateTarget()

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

◆ processImage()

int MagAOX::app::dev::dm< irisaoCtrl , float >::processImage	(	void *	curr_src,
		const dev::shmimT &	sp
	)

inherited

Called by shmimMonitor when a new DM command is available. This is just a pass-through to derivedT::commandDM(char*).

Definition at line 233 of file dm.hpp.

◆ registerIndiPropertyNew() [1/3]

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]

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]

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

◆ registerIndiPropertyReadOnly() [1/2]

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

◆ registerIndiPropertyReadOnly() [2/2]

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

◆ registerIndiPropertySet()

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

◆ releaseDM()

int MagAOX::app::irisaoCtrl::releaseDM ( )

Release the DM, making it safe to turn off power.

The application will be state READY at the conclusion of this.

Returns: 0 on success; -1 on error

Todo:: need to trigger shmimMonitor loop to pause it.

Definition at line 419 of file irisaoCtrl.hpp.

Referenced by appShutdown().

◆ satThreadExec()

void MagAOX::app::dev::dm< irisaoCtrl , float >::satThreadExec

protectedinherited

Execute saturation processing.

Definition at line 352 of file dm.hpp.

◆ satThreadStart()

void MagAOX::app::dev::dm< irisaoCtrl , float >::satThreadStart ( dm< irisaoCtrl, float > * d )

staticprotectedinherited

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

Parameters

[in] d a pointer to a dm instance (normally this)

Definition at line 349 of file dm.hpp.

◆ sendGetPropertySetList()

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

inherited

Definition at line 787 of file MagAOXApp.hpp.

◆ sendNewProperty() [1/2]

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

◆ sendNewProperty() [2/2]

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

◆ sendNewStandardIndiToggle()

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

◆ setDefaults()

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

◆ setEuidCalled()

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

◆ setEuidReal()

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

◆ setFlat()

int MagAOX::app::dev::dm< irisaoCtrl , float >::setFlat ( bool update = false )

inherited

Send the current flat command to the DM.

Writes the command to the designated shmim.

Returns: 0 on success; -1 on error

Todo:: we are assuming that dmXXcomYY is not a cube. This might be true, but we should add cnt1 handling here anyway. With bounds checks b/c not everyone handles cnt1 properly.

Parameters

[in] update If true, this is an update rather than a new set

Definition at line 269 of file dm.hpp.

◆ setSigSegvHandler()

int MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::setSigSegvHandler

protectedinherited

Sets the handler for SIGSEGV and SIGBUS.

These are caused by ImageStreamIO server resets.

Definition at line 182 of file shmimMonitor.hpp.

◆ setSigTermHandler()

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

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 294 of file MagAOXApp.hpp.

◆ setTest()

int MagAOX::app::dev::dm< irisaoCtrl , float >::setTest

inherited

Send the current test command to the DM.

Writes the command to the designated shmim.

Returns: 0 on success; -1 on error

Todo:: we are assuming that dmXXcomYY is not a cube. This might be true, but we should add cnt1 handling here anyway. With bounds checks b/c not everyone handles cnt1 properly.

Definition at line 300 of file dm.hpp.

◆ setupBasicConfig()

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

◆ setupConfig() [1/3]

void MagAOX::app::irisaoCtrl::setupConfig ( )

virtual

Setup the configuration system.

Definition at line 201 of file irisaoCtrl.hpp.

◆ setupConfig() [2/3]

void MagAOX::app::dev::dm< irisaoCtrl , float >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

dm<derivedT,realT>::setupConfig(config);

with appropriate error checking.

Todo:: we shmimMonitor now has configSection so this isn't necessary.

Parameters

[out] config the derived classes configurator

Definition at line 146 of file dm.hpp.

◆ setupConfig() [3/3]

void MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

shmimMonitor<derivedT, specificT>::setupConfig(config);

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 118 of file shmimMonitor.hpp.

◆ shutdown()

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

inherited

Get the value of the shutdown flag.

Returns: the current value of m_shutdown

Definition at line 136 of file MagAOXApp.hpp.

◆ smThreadExec()

void MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::smThreadExec

protectedinherited

Execute the monitoring thread.

<

Todo:: this isn't right--> isn't there a define in cacao to use?

< The semaphore to monitor for new image data

Todo:: change to naxis?

Todo:: change to naxis?

Definition at line 214 of file shmimMonitor.hpp.

◆ smThreadStart()

void MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::smThreadStart ( shmimMonitor< irisaoCtrl > * s )

staticprotectedinherited

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

Parameters

[in] s a pointer to a shmimMonitor instance (normally this)

Definition at line 211 of file shmimMonitor.hpp.

◆ st_newCallBack_clearFSMAlert()

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 the new property request.

Definition at line 955 of file MagAOXApp.hpp.

◆ st_newCallBack_flats()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_flats	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for selecting the flat file.

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 467 of file dm.hpp.

◆ st_newCallBack_init()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_init	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for initializing the DM.

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 416 of file dm.hpp.

◆ st_newCallBack_release()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_release	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for initializing the DM.

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 450 of file dm.hpp.

◆ st_newCallBack_setFlat()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_setFlat	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for setting the flat.

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 483 of file dm.hpp.

◆ st_newCallBack_setTest()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_setTest	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for setting the test shape.

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 521 of file dm.hpp.

◆ st_newCallBack_tests()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_tests	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for selecting the test file.

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 504 of file dm.hpp.

◆ st_newCallBack_zero()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_zero	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for initializing the DM.

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 433 of file dm.hpp.

◆ st_newCallBack_zeroAll()

int MagAOX::app::dev::dm< irisaoCtrl , float >::st_newCallBack_zeroAll	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticinherited

The static callback function to be registered for zeroing all channels.

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 537 of file dm.hpp.

◆ startINDI()

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

protectedinherited

Start INDI Communications.

Returns: 0 on success; -1 on error. This is fatal.

Definition at line 783 of file MagAOXApp.hpp.

◆ state() [1/2]

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::state

inherited

Get the current state code.

Returns: m_state

Definition at line 480 of file MagAOXApp.hpp.

◆ state() [2/2]

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

◆ stateLogged()

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

◆ threadStart()

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

◆ unlockPID()

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

protectedinherited

Remove the PID file.

Definition at line 410 of file MagAOXApp.hpp.

◆ updateIfChanged() [1/4]

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

◆ updateIfChanged() [2/4]

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

◆ updateIfChanged() [3/4]

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

◆ updateIfChanged() [4/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< std::string > &	els,
		const std::vector< T > &	newVals
	)

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

Definition at line 897 of file MagAOXApp.hpp.

◆ updateINDI() [1/2]

int MagAOX::app::dev::dm< irisaoCtrl , float >::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 557 of file dm.hpp.

◆ updateINDI() [2/2]

int MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::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 241 of file shmimMonitor.hpp.

◆ updateSwitchIfChanged()

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

◆ whilePowerOff()

int MagAOX::app::irisaoCtrl::whilePowerOff ( )

virtual

Maintenace while powered off.

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

Definition at line 276 of file irisaoCtrl.hpp.

◆ zeroAll()

int MagAOX::app::dev::dm< irisaoCtrl , float >::zeroAll ( bool nosem = false )

inherited

Zero all channels.

Returns: 0 on sucess; <0 on an error

Parameters

[in] nosem [optional] if true then the semaphore is not raised after zeroing all channels

Definition at line 315 of file dm.hpp.

◆ zeroDM()

int MagAOX::app::irisaoCtrl::zeroDM ( )

Zero all commands on the DM.

This does not update the shared memory buffer.

Returns: 0 on success; -1 on error

Definition at line 355 of file irisaoCtrl.hpp.

Referenced by initDM(), and releaseDM().

◆ zeroFlat()

int MagAOX::app::dev::dm< irisaoCtrl , float >::zeroFlat

inherited

Zero the flat command on the DM.

Writes a 0 array the designated shmim.

Returns: 0 on success; -1 on error

Todo:: we are assuming that dmXXcomYY is not a cube. This might be true, but we should add cnt1 handling here anyway. With bounds checks b/c not everyone handles cnt1 properly.

Definition at line 277 of file dm.hpp.

◆ zeroTest()

int MagAOX::app::dev::dm< irisaoCtrl , float >::zeroTest

inherited

Zero the test command on the DM.

Writes a 0 array the designated shmim.

Returns: 0 on success; -1 on error

Todo:: we are assuming that dmXXcomYY is not a cube. This might be true, but we should add cnt1 handling here anyway. With bounds checks b/c not everyone handles cnt1 properly.

Definition at line 308 of file dm.hpp.

Friends And Related Function Documentation

◆ dev::dm< irisaoCtrl, float >

friend class dev::dm< irisaoCtrl, float >

friend

Definition at line 62 of file irisaoCtrl.hpp.

◆ dev::shmimMonitor< irisaoCtrl >

friend class dev::shmimMonitor< irisaoCtrl >

friend

Definition at line 62 of file irisaoCtrl.hpp.

◆ irisaoCtrl_test

friend class irisaoCtrl_test

friend

Definition at line 62 of file irisaoCtrl.hpp.

Member Data Documentation

◆ m_accumSatMap

mx::improc::eigenImage<uint16_t> MagAOX::app::dev::dm< irisaoCtrl , float >::m_accumSatMap

protectedinherited

The accumulated saturation map, which acccumulates for m_satAvgInt then is publised as a 0/1 image.

Definition at line 320 of file dm.hpp.

◆ m_allDefsReceived

bool MagAOX::app::MagAOXApp< _useINDI >::m_allDefsReceived

protectedinherited

Flag indicating that all registered Set properties have been updated since last Get.

Definition at line 576 of file MagAOXApp.hpp.

◆ m_calibDir

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

protectedinherited

The path to calibration files for MagAOX.

Definition at line 94 of file MagAOXApp.hpp.

◆ m_calibPath

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_calibPath

protectedinherited

The path to this DM's calibration files.

Definition at line 77 of file dm.hpp.

◆ m_calibRelDir

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_calibRelDir

protectedinherited

The directory relative to the calibPath. Set this before calling dm<derivedT,realT>::loadConfig().

Definition at line 109 of file dm.hpp.

◆ m_channels

int MagAOX::app::dev::dm< irisaoCtrl , float >::m_channels

protectedinherited

The number of dmcomb channels found as part of allocation.

Definition at line 111 of file dm.hpp.

◆ m_configBase

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

protectedinherited

The name of a base config class for this app (minus .conf).

Definition at line 92 of file MagAOXApp.hpp.

◆ m_configDir

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

protectedinherited

The path to configuration files for MagAOX.

Definition at line 90 of file MagAOXApp.hpp.

◆ m_configName

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

protectedinherited

The name of the configuration file (minus .conf).

Definition at line 88 of file MagAOXApp.hpp.

◆ m_cpusetPath

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

protectedinherited

Definition at line 421 of file MagAOXApp.hpp.

◆ m_dataType

uint8_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_dataType

protectedinherited

The ImageStreamIO type code.

Definition at line 101 of file shmimMonitor.hpp.

◆ m_depth

uint32_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_depth

protectedinherited

The depth of the circular buffer in the stream.

Definition at line 99 of file shmimMonitor.hpp.

◆ m_dm

MirrorHandle MagAOX::app::irisaoCtrl::m_dm

protected

IrisAO SDK handle for the DM.

Definition at line 180 of file irisaoCtrl.hpp.

Referenced by commandDM(), initDM(), releaseDM(), and zeroDM().

◆ m_dmDataType

constexpr uint8_t MagAOX::app::dev::dm< irisaoCtrl , float >::m_dmDataType

staticconstexprprotectedinherited

The ImageStreamIO type code.

Definition at line 97 of file dm.hpp.

◆ m_dmHeight

uint32_t MagAOX::app::dev::dm< irisaoCtrl , float >::m_dmHeight

protectedinherited

The height of the images in the stream.

Definition at line 95 of file dm.hpp.

◆ m_dminputs

double* MagAOX::app::irisaoCtrl::m_dminputs {nullptr}

protected

Pre-allocated command vector, used only in commandDM.

Definition at line 178 of file irisaoCtrl.hpp.

Referenced by ~irisaoCtrl(), and initDM().

◆ m_dmopen

bool MagAOX::app::irisaoCtrl::m_dmopen {false}

protected

Track whether the DM connection has been opened.

Definition at line 182 of file irisaoCtrl.hpp.

Referenced by appShutdown(), initDM(), releaseDM(), and zeroDM().

◆ m_dmWidth

uint32_t MagAOX::app::dev::dm< irisaoCtrl , float >::m_dmWidth

protectedinherited

The width of the images in the stream.

Definition at line 94 of file dm.hpp.

◆ m_driverCtrlName

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

◆ m_driverInName

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

protectedinherited

Full path name of the INDI driver input FIFO.

Definition at line 579 of file MagAOXApp.hpp.

◆ m_driverOutName

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

protectedinherited

Full path name of the INDI driver output FIFO.

Definition at line 582 of file MagAOXApp.hpp.

◆ m_dserialNumber

std::string MagAOX::app::irisaoCtrl::m_dserialNumber

protected

The IrisAO DRIVER serial number.

Definition at line 79 of file irisaoCtrl.hpp.

Referenced by initDM(), loadConfigImpl(), and releaseDM().

◆ m_euidCalled

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

◆ m_euidReal

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

◆ m_flatCommand

mx::improc::eigenImage<float > MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatCommand

protectedinherited

Data storage for the flat command.

Definition at line 116 of file dm.hpp.

◆ m_flatCommands

std::map<std::string, std::string> MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatCommands

protectedinherited

Map of flat file name to full path.

Definition at line 113 of file dm.hpp.

◆ m_flatCurrent

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatCurrent

protectedinherited

The name of the current flat command.

Definition at line 114 of file dm.hpp.

◆ m_flatDefault

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatDefault

protectedinherited

The file name of the this DM's default flat command. Path and extension will be ignored and can be omitted.

Definition at line 81 of file dm.hpp.

◆ m_flatImageStream

IMAGE MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatImageStream

protectedinherited

The ImageStreamIO shared memory buffer for the flat.

Definition at line 119 of file dm.hpp.

◆ m_flatLoaded

bool MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatLoaded

protectedinherited

Flag indicating whether a flat is loaded in memory.

Definition at line 117 of file dm.hpp.

◆ m_flatPath

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatPath

protectedinherited

The path to this DM's flat files (usually the same as calibPath)

Definition at line 78 of file dm.hpp.

◆ m_flatSet

bool MagAOX::app::dev::dm< irisaoCtrl , float >::m_flatSet

protectedinherited

Flag indicating whether the flat command has been set.

Definition at line 120 of file dm.hpp.

◆ m_getExistingFirst

bool MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_getExistingFirst

protectedinherited

If set to true by derivedT, any existing image will be grabbed and sent to processImage before waiting on the semaphore.

Definition at line 93 of file shmimMonitor.hpp.

◆ m_gitAlert

bool MagAOX::app::MagAOXApp< _useINDI >::m_gitAlert

privateinherited

Definition at line 472 of file MagAOXApp.hpp.

◆ m_hardwareDisable

bool MagAOX::app::irisaoCtrl::m_hardwareDisable

protected

Hardware disable flag (set to true to disable sending commands)

Definition at line 80 of file irisaoCtrl.hpp.

Referenced by initDM(), and loadConfigImpl().

◆ m_height

uint32_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_height

protectedinherited

The height of the images in the stream.

Definition at line 98 of file shmimMonitor.hpp.

◆ m_imageStream

IMAGE MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_imageStream

protectedinherited

The ImageStreamIO shared memory buffer.

Definition at line 104 of file shmimMonitor.hpp.

◆ m_indiDriver

indiDriver<MagAOXApp>* MagAOX::app::MagAOXApp< _useINDI >::m_indiDriver

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

◆ m_indiMutex

std::mutex MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex

inherited

Mutex for locking INDI communications.

Definition at line 540 of file MagAOXApp.hpp.

◆ m_indiNewCallBacks

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

◆ m_indiP_clearFSMAlert

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_clearFSMAlert

protectedinherited

indi Property to clear an FSM alert.

Definition at line 948 of file MagAOXApp.hpp.

◆ m_indiP_flat

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_flat

protectedinherited

Property used to set and report the current flat.

Definition at line 392 of file dm.hpp.

◆ m_indiP_flats

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_flats

protectedinherited

INDI Selection switch containing the flat files.

Definition at line 398 of file dm.hpp.

◆ m_indiP_flatShmim

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_flatShmim

protectedinherited

Publish the shmim being used for the flat.

Definition at line 399 of file dm.hpp.

◆ m_indiP_frameSize

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_indiP_frameSize

protectedinherited

Property used to report the current frame size.

Definition at line 230 of file shmimMonitor.hpp.

◆ m_indiP_init

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_init

protectedinherited

Definition at line 394 of file dm.hpp.

◆ m_indiP_powerChannel

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_powerChannel

protectedinherited

INDI property used to communicate power state.

Definition at line 998 of file MagAOXApp.hpp.

◆ m_indiP_release

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_release

protectedinherited

Definition at line 396 of file dm.hpp.

◆ m_indiP_setFlat

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_setFlat

protectedinherited

INDI toggle switch to set the current flat.

Definition at line 400 of file dm.hpp.

◆ m_indiP_setTest

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_setTest

protectedinherited

INDI toggle switch to set the current test pattern.

Definition at line 405 of file dm.hpp.

◆ m_indiP_shmimName

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_indiP_shmimName

protectedinherited

Property used to report the shmim buffer name.

Definition at line 228 of file shmimMonitor.hpp.

◆ m_indiP_state

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_state

protectedinherited

indi Property to report the application state.

Definition at line 945 of file MagAOXApp.hpp.

◆ m_indiP_tests

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_tests

protectedinherited

INDI Selection switch containing the test pattern files.

Definition at line 403 of file dm.hpp.

◆ m_indiP_testShmim

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_testShmim

protectedinherited

Publish the shmim being used for the test command.

Definition at line 404 of file dm.hpp.

◆ m_indiP_zero

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_zero

protectedinherited

Definition at line 395 of file dm.hpp.

◆ m_indiP_zeroAll

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_indiP_zeroAll

protectedinherited

Definition at line 407 of file dm.hpp.

◆ m_indiSetCallBacks

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

◆ m_inode

ino_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_inode

protectedinherited

The inode of the image stream file.

Definition at line 106 of file shmimMonitor.hpp.

◆ m_instSatMap

mx::improc::eigenImage<uint8_t> MagAOX::app::dev::dm< irisaoCtrl , float >::m_instSatMap

protectedinherited

The instantaneous saturation map, 0/1, set by the commandDM() function of the derived class.

Definition at line 319 of file dm.hpp.

◆ m_intervalSatCountThreshold

int MagAOX::app::dev::dm< irisaoCtrl , float >::m_intervalSatCountThreshold

protectedinherited

Definition at line 101 of file dm.hpp.

◆ m_intervalSatExceeds

int MagAOX::app::dev::dm< irisaoCtrl , float >::m_intervalSatExceeds

protectedinherited

Definition at line 133 of file dm.hpp.

◆ m_intervalSatThreshold

float MagAOX::app::dev::dm< irisaoCtrl , float >::m_intervalSatThreshold

protectedinherited

Definition at line 100 of file dm.hpp.

◆ m_intervalSatTrip

bool MagAOX::app::dev::dm< irisaoCtrl , float >::m_intervalSatTrip

protectedinherited

Definition at line 134 of file dm.hpp.

◆ m_log

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

staticinherited

Definition at line 242 of file MagAOXApp.hpp.

◆ m_loopPause

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_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 100 of file MagAOXApp.hpp.

◆ m_mserialNumber

std::string MagAOX::app::irisaoCtrl::m_mserialNumber

protected

The IrisAO MIRROR serial number.

Definition at line 78 of file irisaoCtrl.hpp.

Referenced by initDM(), loadConfigImpl(), and releaseDM().

◆ m_nbAct

uint32_t MagAOX::app::irisaoCtrl::m_nbAct {0}

protected

The number of actuators.

Definition at line 176 of file irisaoCtrl.hpp.

Referenced by initDM(), and zeroDM().

◆ m_nsat

size_t MagAOX::app::irisaoCtrl::m_nsat {0}

private

Definition at line 70 of file irisaoCtrl.hpp.

Referenced by appLogic().

◆ m_overSatAct

int MagAOX::app::dev::dm< irisaoCtrl , float >::m_overSatAct

protectedinherited

Definition at line 132 of file dm.hpp.

◆ m_percThreshold

float MagAOX::app::dev::dm< irisaoCtrl , float >::m_percThreshold

protectedinherited

Definition at line 99 of file dm.hpp.

◆ m_pid

pid_t MagAOX::app::MagAOXApp< _useINDI >::m_pid

protectedinherited

This process's PID.

Definition at line 394 of file MagAOXApp.hpp.

◆ m_powerChannel

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

protectedinherited

The INDI property name of the channel controlling this device's power.

Definition at line 985 of file MagAOXApp.hpp.

◆ m_powerDevice

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

protectedinherited

The INDI device name of the power controller.

Definition at line 984 of file MagAOXApp.hpp.

◆ m_powerElement

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

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 986 of file MagAOXApp.hpp.

◆ m_powerMgtEnabled

bool MagAOX::app::MagAOXApp< _useINDI >::m_powerMgtEnabled

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

◆ m_powerOnCounter

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

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

◆ m_powerOnWait

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_powerOnWait

protectedinherited

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

Definition at line 989 of file MagAOXApp.hpp.

◆ m_powerState

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

protectedinherited

Current power state, 1=On, 0=Off, -1=Unk.

Definition at line 995 of file MagAOXApp.hpp.

◆ m_powerTargetElement

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

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 987 of file MagAOXApp.hpp.

◆ m_powerTargetState

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

protectedinherited

Current target power state, 1=On, 0=Off, -1=Unk.

Definition at line 996 of file MagAOXApp.hpp.

◆ m_restart

bool MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_restart

protectedinherited

Flag indicating tha the shared memory should be reinitialized.

Definition at line 175 of file shmimMonitor.hpp.

◆ m_satAvgInt

int MagAOX::app::dev::dm< irisaoCtrl , float >::m_satAvgInt

protectedinherited

The time in milliseconds to accumulate saturation over.

Definition at line 89 of file dm.hpp.

◆ m_satImageStream

IMAGE MagAOX::app::dev::dm< irisaoCtrl , float >::m_satImageStream

protectedinherited

The ImageStreamIO shared memory buffer for the sat map.

Definition at line 323 of file dm.hpp.

◆ m_satPercImageStream

IMAGE MagAOX::app::dev::dm< irisaoCtrl , float >::m_satPercImageStream

protectedinherited

The ImageStreamIO shared memory buffer for the sat percentage map.

Definition at line 324 of file dm.hpp.

◆ m_satPercMap

mx::improc::eigenImage<float> MagAOX::app::dev::dm< irisaoCtrl , float >::m_satPercMap

protectedinherited

Map of the percentage of time each actator was saturated during the avg. interval.

Definition at line 321 of file dm.hpp.

◆ m_satSemaphore

sem_t MagAOX::app::dev::dm< irisaoCtrl , float >::m_satSemaphore

protectedinherited

Semaphore used to tell the saturation thread to run.

Definition at line 338 of file dm.hpp.

◆ m_satThread

std::thread MagAOX::app::dev::dm< irisaoCtrl , float >::m_satThread

protectedinherited

A separate thread for the actual saturation processing.

Definition at line 346 of file dm.hpp.

◆ m_satThreadID

pid_t MagAOX::app::dev::dm< irisaoCtrl , float >::m_satThreadID

protectedinherited

The ID of the saturation thread.

Definition at line 342 of file dm.hpp.

◆ m_satThreadInit

bool MagAOX::app::dev::dm< irisaoCtrl , float >::m_satThreadInit

protectedinherited

Synchronizer for thread startup, to allow priority setting to finish.

Definition at line 340 of file dm.hpp.

◆ m_satThreadPrio

int MagAOX::app::dev::dm< irisaoCtrl , float >::m_satThreadPrio

protectedinherited

Priority of the saturation thread, should normally be > 0.

Todo:: satThreadPrio configuration is not actually implemented.

Definition at line 92 of file dm.hpp.

◆ m_satThreadProp

pcf::IndiProperty MagAOX::app::dev::dm< irisaoCtrl , float >::m_satThreadProp

protectedinherited

The property to hold the saturation thread details.

Definition at line 344 of file dm.hpp.

◆ m_satTriggerDevice

std::vector<std::string> MagAOX::app::dev::dm< irisaoCtrl , float >::m_satTriggerDevice

protectedinherited

Definition at line 103 of file dm.hpp.

◆ m_satTriggerProperty

std::vector<std::string> MagAOX::app::dev::dm< irisaoCtrl , float >::m_satTriggerProperty

protectedinherited

Definition at line 104 of file dm.hpp.

◆ m_self

MagAOXApp< _useINDI > * MagAOX::app::MagAOXApp< _useINDI >::m_self

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

◆ m_selfMonitor

shmimMonitor< irisaoCtrl , shmimT > * MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_selfMonitor

staticprotectedinherited

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

Definition at line 177 of file shmimMonitor.hpp.

◆ m_semaphoreNumber

int MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_semaphoreNumber

protectedinherited

The image structure semaphore index.

Definition at line 95 of file shmimMonitor.hpp.

◆ m_shmimFlat

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_shmimFlat

protectedinherited

The name of the shmim stream to write the flat to.

Definition at line 84 of file dm.hpp.

◆ m_shmimName

std::string MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::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 85 of file shmimMonitor.hpp.

◆ m_shmimSat

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_shmimSat

protectedinherited

The name of the shmim stream to write the saturation map to.

Definition at line 86 of file dm.hpp.

◆ m_shmimSatPerc

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_shmimSatPerc

protectedinherited

The name of the shmim stream to write the saturation percentage map to.

Definition at line 87 of file dm.hpp.

◆ m_shmimTest

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_shmimTest

protectedinherited

The name of the shmim stream to write the test to.

Definition at line 85 of file dm.hpp.

◆ m_shutdown

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

protectedinherited

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

Definition at line 102 of file MagAOXApp.hpp.

◆ m_smCpuset

std::string MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_smCpuset

protectedinherited

The cpuset to assign the shmimMonitor thread to. Ignored if empty (the default).

Definition at line 89 of file shmimMonitor.hpp.

◆ m_smThread

std::thread MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_smThread

protectedinherited

A separate thread for the actual monitoring.

Definition at line 208 of file shmimMonitor.hpp.

◆ m_smThreadID

pid_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_smThreadID

protectedinherited

The s.m. thread PID.

Definition at line 204 of file shmimMonitor.hpp.

◆ m_smThreadInit

bool MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_smThreadInit

protectedinherited

Synchronizer for thread startup, to allow priority setting to finish.

Definition at line 202 of file shmimMonitor.hpp.

◆ m_smThreadPrio

int MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_smThreadPrio

protectedinherited

Priority of the shmimMonitor thread, should normally be > 00.

Definition at line 87 of file shmimMonitor.hpp.

◆ m_smThreadProp

pcf::IndiProperty MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_smThreadProp

protectedinherited

The property to hold the s.m. thread details.

Definition at line 206 of file shmimMonitor.hpp.

◆ m_state

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::m_state

privateinherited

The application's state. Never ever set this directly, use state(const stateCodeT & s).

Definition at line 468 of file MagAOXApp.hpp.

◆ m_stateAlert

bool MagAOX::app::MagAOXApp< _useINDI >::m_stateAlert

privateinherited

Definition at line 470 of file MagAOXApp.hpp.

◆ m_stateLogged

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

privateinherited

Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().

Definition at line 474 of file MagAOXApp.hpp.

◆ m_suid

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_testCommand

mx::improc::eigenImage<float > MagAOX::app::dev::dm< irisaoCtrl , float >::m_testCommand

protectedinherited

Data storage for the test command.

Definition at line 126 of file dm.hpp.

◆ m_testCommands

std::map<std::string, std::string> MagAOX::app::dev::dm< irisaoCtrl , float >::m_testCommands

protectedinherited

Map of test file name to full path.

Definition at line 123 of file dm.hpp.

◆ m_testCurrent

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_testCurrent

protectedinherited

Definition at line 124 of file dm.hpp.

◆ m_testDefault

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_testDefault

protectedinherited

The file name of the this DM's default test command. Path and extension will be ignored and can be omitted.

Definition at line 82 of file dm.hpp.

◆ m_testImageStream

IMAGE MagAOX::app::dev::dm< irisaoCtrl , float >::m_testImageStream

protectedinherited

The ImageStreamIO shared memory buffer for the test.

Definition at line 129 of file dm.hpp.

◆ m_testLoaded

bool MagAOX::app::dev::dm< irisaoCtrl , float >::m_testLoaded

protectedinherited

Flag indicating whether a test command is loaded in memory.

Definition at line 127 of file dm.hpp.

◆ m_testPath

std::string MagAOX::app::dev::dm< irisaoCtrl , float >::m_testPath

protectedinherited

The path to this DM's test files (default is calibPath/tests;.

Definition at line 79 of file dm.hpp.

◆ m_testSet

bool MagAOX::app::dev::dm< irisaoCtrl , float >::m_testSet

protectedinherited

Flag indicating whether the test command has been set.

Definition at line 130 of file dm.hpp.

◆ m_typeSize

size_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_typeSize

protectedinherited

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

Definition at line 102 of file shmimMonitor.hpp.

◆ m_useINDI

constexpr static bool MagAOX::app::MagAOXApp< _useINDI >::m_useINDI

staticconstexprprotectedinherited

Flag controlling whether INDI is used. If false, then no INDI code executes.

Definition at line 532 of file MagAOXApp.hpp.

◆ m_width

uint32_t MagAOX::app::dev::shmimMonitor< irisaoCtrl , shmimT >::m_width

protectedinherited

The width of the images in the stream.

Definition at line 97 of file shmimMonitor.hpp.

◆ MagAOXPath

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

protectedinherited

The base path of the MagAO-X system.

Definition at line 86 of file MagAOXApp.hpp.

◆ pidFileName

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

protectedinherited

The name of the PID file.

Definition at line 392 of file MagAOXApp.hpp.

◆ secretsPath

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

protectedinherited

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

Definition at line 98 of file MagAOXApp.hpp.

◆ sysPath

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

protectedinherited

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

Definition at line 96 of file MagAOXApp.hpp.

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

apps/irisaoCtrl/irisaoCtrl.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Privilege Management

Application State

PID Locking

INDI Interface

Power Management

Configurable Parameters

Saturation Thread

INDI

SIGSEGV & SIGBUS signal handling

shmimmonitor Thread

INDI

Logging

Signal Handling

Detailed Description

Member Typedef Documentation

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ logManagerT

◆ realT

Constructor & Destructor Documentation

◆ irisaoCtrl()

◆ ~irisaoCtrl()

Member Function Documentation

◆ _handlerSigSegv()

◆ _handlerSigTerm()

◆ allocate()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ checkConfig()

◆ checkFlats()

◆ checkTests()

◆ clearFSMAlert()

◆ clearSat()

◆ commandDM()

◆ configDir()

◆ configLog()

◆ configName()

◆ createINDIFIFOS()

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()

◆ derived()

◆ driverCtrlName()

◆ driverInName()

◆ driverOutName()

◆ execute()

◆ findDMChannels()

◆ handleDefProperty()

◆ handleGetProperties()

◆ handleNewProperty()

◆ handlerSigSegv()

◆ handlerSigTerm()

◆ handleSetProperty()

◆ INDI_SETCALLBACK_DECL()

◆ indiTargetUpdate()

◆ initDM()

◆ intervalSatTrip()

◆ loadBasicConfig()

◆ loadConfig() [1/3]

◆ loadConfig() [2/3]

◆ loadConfig() [3/3]

◆ loadConfigImpl()

◆ loadFlat()

◆ loadTest()

◆ lockPID()