Class for application to calculate rolling PSDs of modal amplitudes. More...

#include <modalPSDs.hpp>

Inheritance diagram for MagAOX::app::modalPSDs:

Collaboration diagram for MagAOX::app::modalPSDs:

Public Types
typedef float	realT

typedef std::complex< realT >	complexT

typedef dev::shmimMonitor< modalPSDs >	shmimMonitorT
	The base shmimMonitor type. More...

typedef mx::sigproc::circularBufferIndex< float *, unsigned >	ampCircBuffT
	The amplitude circular buffer type. More...

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

Public Member Functions
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...

const std::string &	shmimName () const

const uint32_t &	width () const

const uint32_t &	height () const

const uint32_t &	depth () const

const uint8_t &	dataType () const

const size_t &	typeSize () const

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

int	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results 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 Attributes
int	m_nModes { 0 }
	the number of modes to calculate PSDs for. More...

ampCircBuffT	m_ampCircBuff

realT	m_fps { 0 }

realT	m_df { 1 }

unsigned	m_tsSize { 2000 }
	The length of the time series sample over which the PSD is calculated. More...

unsigned	m_tsOverlapSize { 1000 }
	The number of samples in the overlap. More...

std::vector< realT >	m_win
	The window function. By default this is Hann. More...

realT *	m_tsWork { nullptr }

size_t	m_tsWorkSize { 0 }

std::complex< realT > *	m_fftWork { nullptr }

size_t	m_fftWorkSize { 0 }

std::vector< realT >	m_psd

mx::math::fft::fftT< realT, std::complex< realT >, 1, 0 >	m_fft

mx::math::fft::fftwEnvironment< realT >	m_fftEnv

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

int	m_shutdown
	Flag to signal it's time to shutdown. When not 0, the main loop exits. 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_fpsSource
	Device name for getting fps to set circular buffer length. This device should have *.fps.current. More...

realT	m_psdTime { 1 }
	The length of time over which to calculate PSDs. The default is 1 sec. More...

realT	m_psdAvgTime { 10 }
	The time over which to average PSDs. The default is 10 sec. More...

realT	m_psdOverlapFraction { 0.5 }
	The fraction of the sample time to overlap by. More...

int	m_nPSDHistory { 100 }

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 Member Functions
int	clearFSMAlert ()
	Clear the FSM alert state. More...

modalPSDs &	derived ()

Friends
class	modalPSDs_test

class	dev::shmimMonitor< modalPSDs >

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

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

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

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, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed. More...

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

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

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="")

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

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

PSD Calculation Thread
Handling of offloads from the average woofer shape
int	m_psdThreadPrio { 0 }
	Priority of the PSD Calculation thread. More...

std::string	m_psdThreadCpuset
	The cpuset to use for the PSD Calculation thread. More...

std::thread	m_psdThread
	The PSD Calculation thread. More...

bool	m_psdThreadInit { true }
	Initialization flag for the PSD Calculation thread. More...

bool	m_psdRestarting { true }
	Synchronization flag. This will only become false after a successful call to allocate. More...

bool	m_psdWaiting { false }
	Synchronization flag. This is set to true when the PSD thread is safely waiting for allocation to complete. More...

pid_t	m_psdThreadID { 0 }
	PSD Calculation thread PID. More...

pcf::IndiProperty	m_psdThreadProp
	The property to hold the PSD Calculation thread details. More...

IMAGE *	m_freqStream { nullptr }
	The ImageStreamIO shared memory buffer to hold the frequency scale. More...

mx::improc::eigenImage< realT >	m_psdBuffer

IMAGE *	m_rawpsdStream { nullptr }
	The ImageStreamIO shared memory buffer to hold the raw psds. More...

IMAGE *	m_avgpsdStream { nullptr }
	The ImageStreamIO shared memory buffer to hold the average psds. More...

pcf::IndiProperty	m_indiP_psdTime

pcf::IndiProperty	m_indiP_psdAvgTime

pcf::IndiProperty	m_indiP_overSize

pcf::IndiProperty	m_indiP_fpsSource

pcf::IndiProperty	m_indiP_fps

static void	psdThreadStart (modalPSDs *p)
	PS Calculation thread starter function. More...

void	psdThreadExec ()
	PSD Calculation thread function. More...

int	allocate (const dev::shmimT &dummy)

int	allocatePSDStreams ()

int	processImage (void *curr_src, const dev::shmimT &dummy)

	modalPSDs ()
	Default c'tor. More...

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

virtual void	setupConfig ()

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

virtual void	loadConfig ()

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

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

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

	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_psdTime)

	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_psdAvgTime)

	INDI_NEWCALLBACK_DECL (modalPSDs, m_indiP_overSize)

	INDI_SETCALLBACK_DECL (modalPSDs, m_indiP_fpsSource)

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 ()

int	unlockPID ()
	Remove the PID file. 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

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

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

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

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

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

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

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

	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

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

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

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

void	smThreadExec ()
	Execute the monitoring thread. 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
static void	configLog (const std::string &name, const int &code, const std::string &value, const std::string &source)
	Callback for config system logging. More...

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

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

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

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

stateCodes::stateCodeT	m_state

bool	m_stateAlert

bool	m_gitAlert

int	m_stateLogged

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

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

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

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

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

uid_t	m_euidCalled

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

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

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

Detailed Description

Class for application to calculate rolling PSDs of modal amplitudes.

Definition at line 42 of file modalPSDs.hpp.

Member Typedef Documentation

◆ ampCircBuffT

typedef mx::sigproc::circularBufferIndex<float*, unsigned> MagAOX::app::modalPSDs::ampCircBuffT

The amplitude circular buffer type.

Definition at line 58 of file modalPSDs.hpp.

◆ callBackInsertResult

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

inherited

Return type of insert on the indiCallBack map.

Definition at line 567 of file MagAOXApp.hpp.

◆ callBackIterator

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

inherited

Iterator type of the indiCallBack map.

Definition at line 564 of file MagAOXApp.hpp.

◆ callBackValueType

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

inherited

Value type of the indiCallBack map.

Definition at line 561 of file MagAOXApp.hpp.

◆ complexT

typedef std::complex<realT> MagAOX::app::modalPSDs::complexT

Definition at line 52 of file modalPSDs.hpp.

◆ logManagerT

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

inherited

The log manager type.

Definition at line 78 of file MagAOXApp.hpp.

◆ realT

typedef float MagAOX::app::modalPSDs::realT

Definition at line 51 of file modalPSDs.hpp.

◆ shmimMonitorT

typedef dev::shmimMonitor<modalPSDs> MagAOX::app::modalPSDs::shmimMonitorT

The base shmimMonitor type.

Definition at line 55 of file modalPSDs.hpp.

Constructor & Destructor Documentation

◆ modalPSDs()

MagAOX::app::modalPSDs::modalPSDs ( )

Default c'tor.

Definition at line 207 of file modalPSDs.hpp.

◆ ~modalPSDs()

MagAOX::app::modalPSDs::~modalPSDs ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 146 of file modalPSDs.hpp.

Member Function Documentation

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

◆ allocate()

int MagAOX::app::modalPSDs::allocate ( const dev::shmimT & dummy )

protected

Parameters

[in] dummy tag to differentiate shmimMonitor parents.

Definition at line 309 of file modalPSDs.hpp.

◆ allocatePSDStreams()

int MagAOX::app::modalPSDs::allocatePSDStreams ( )

protected

Definition at line 423 of file modalPSDs.hpp.

Referenced by allocate().

◆ appLogic()

int MagAOX::app::modalPSDs::appLogic ( )

virtual

Implementation of the FSM for modalPSDs.

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

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

Definition at line 266 of file modalPSDs.hpp.

◆ appShutdown()

int MagAOX::app::modalPSDs::appShutdown ( )

virtual

Shutdown the app.

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

Definition at line 279 of file modalPSDs.hpp.

◆ appStartup()

int MagAOX::app::modalPSDs::appStartup ( )

virtual

Startup function.

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

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

◆ configDir()

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

inherited

Get the config directory.

Returns: the current value of m_configDir

Definition at line 1100 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
	)

staticprotectedinherited

Callback for config system logging.

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

Parameters

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

Definition at line 276 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 1094 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 811 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 649 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 614 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 628 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 675 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 706 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 688 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 601 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 662 of file MagAOXApp.hpp.

◆ dataType()

const uint8_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::dataType

inherited

Definition at line 137 of file shmimMonitor.hpp.

◆ depth()

const uint32_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::depth

inherited

Definition at line 135 of file shmimMonitor.hpp.

◆ derived()

modalPSDs & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::derived ( )

inlineprivateinherited

Definition at line 254 of file shmimMonitor.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 1118 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 1106 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 1112 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 200 of file MagAOXApp.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 827 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 833 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 843 of file MagAOXApp.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 302 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 852 of file MagAOXApp.hpp.

◆ height()

const uint32_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::height

inherited

Definition at line 133 of file shmimMonitor.hpp.

◆ INDI_NEWCALLBACK_DECL() [1/3]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_overSize
	)

◆ INDI_NEWCALLBACK_DECL() [2/3]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_psdAvgTime
	)

◆ INDI_NEWCALLBACK_DECL() [3/3]

MagAOX::app::modalPSDs::INDI_NEWCALLBACK_DECL	(	modalPSDs	,
		m_indiP_psdTime
	)

◆ INDI_SETCALLBACK_DECL() [1/2]

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

inherited

◆ INDI_SETCALLBACK_DECL() [2/2]

MagAOX::app::modalPSDs::INDI_SETCALLBACK_DECL	(	modalPSDs	,
		m_indiP_fpsSource
	)

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

◆ loadConfig() [1/2]

void MagAOX::app::modalPSDs::loadConfig ( )

virtual

Definition at line 232 of file modalPSDs.hpp.

◆ loadConfig() [2/2]

int MagAOX::app::dev::shmimMonitor< modalPSDs , 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 159 of file shmimMonitor.hpp.

◆ loadConfigImpl()

int MagAOX::app::modalPSDs::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 221 of file modalPSDs.hpp.

Referenced by loadConfig().

◆ 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 410 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 247 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 260 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 269 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 new property request.

Definition at line 998 of file MagAOXApp.hpp.

◆ onPowerOff()

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

protectedvirtualinherited

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

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

Reimplemented in MagAOX::app::zaberLowLevel, MagAOX::app::irisaoCtrl, MagAOX::app::bmcCtrl, and MagAOX::app::alpaoCtrl.

Definition at line 1043 of file MagAOXApp.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 1059 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 1069 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 1078 of file MagAOXApp.hpp.

◆ processImage()

int MagAOX::app::modalPSDs::processImage	(	void *	curr_src,
		const dev::shmimT &	dummy
	)

protected

Parameters

[in]	curr_src	pointer to start of current frame.
[in]	dummy	tag to differentiate shmimMonitor parents.

Definition at line 458 of file modalPSDs.hpp.

◆ psdThreadExec()

void MagAOX::app::modalPSDs::psdThreadExec ( )

protected

PSD Calculation thread function.

Runs until m_shutdown is true.

Definition at line 477 of file modalPSDs.hpp.

Referenced by psdThreadStart().

◆ psdThreadStart()

void MagAOX::app::modalPSDs::psdThreadStart ( modalPSDs * p )

staticprotected

PS Calculation thread starter function.

Parameters

[in] p pointer to this

Definition at line 471 of file modalPSDs.hpp.

Referenced by appStartup().

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

◆ sendGetPropertySetList()

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

inherited

Definition at line 821 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 964 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 954 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 971 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 142 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 369 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 378 of file MagAOXApp.hpp.

◆ setSigTermHandler()

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

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

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

◆ setupConfig() [1/2]

void MagAOX::app::modalPSDs::setupConfig ( )

virtual

Definition at line 212 of file modalPSDs.hpp.

◆ setupConfig() [2/2]

int MagAOX::app::dev::shmimMonitor< modalPSDs , 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 149 of file shmimMonitor.hpp.

◆ shmimName()

const std::string & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::shmimName

inherited

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

◆ smThreadExec()

void MagAOX::app::dev::shmimMonitor< modalPSDs , 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 226 of file shmimMonitor.hpp.

◆ smThreadStart()

void MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::smThreadStart ( shmimMonitor< modalPSDs > * 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 223 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 new property request.

Definition at line 987 of file MagAOXApp.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 818 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 487 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 495 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 516 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 452 of file MagAOXApp.hpp.

◆ typeSize()

const size_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::typeSize

inherited

Definition at line 139 of file shmimMonitor.hpp.

◆ unlockPID()

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

protectedinherited

Remove the PID file.

Definition at line 413 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 882 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 911 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 865 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,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 928 of file MagAOXApp.hpp.

◆ updateINDI()

int MagAOX::app::dev::shmimMonitor< modalPSDs , 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 249 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 893 of file MagAOXApp.hpp.

◆ whilePowerOff()

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

protectedvirtualinherited

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

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

Reimplemented in MagAOX::app::zaberLowLevel, MagAOX::app::irisaoCtrl, MagAOX::app::bmcCtrl, and MagAOX::app::alpaoCtrl.

Definition at line 1050 of file MagAOXApp.hpp.

◆ width()

const uint32_t & MagAOX::app::dev::shmimMonitor< modalPSDs , shmimT >::width

inherited

Definition at line 131 of file shmimMonitor.hpp.

Friends And Related Function Documentation

◆ dev::shmimMonitor< modalPSDs >

friend class dev::shmimMonitor< modalPSDs >

friend

Definition at line 45 of file modalPSDs.hpp.

◆ modalPSDs_test

friend class modalPSDs_test

friend

Definition at line 45 of file modalPSDs.hpp.

Member Data Documentation

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

◆ m_ampCircBuff

ampCircBuffT MagAOX::app::modalPSDs::m_ampCircBuff

protected

Definition at line 82 of file modalPSDs.hpp.

Referenced by allocate(), processImage(), and psdThreadExec().

◆ m_avgpsdStream

IMAGE* MagAOX::app::modalPSDs::m_avgpsdStream { nullptr }

protected

The ImageStreamIO shared memory buffer to hold the average psds.

Definition at line 139 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), appShutdown(), and psdThreadExec().

◆ m_calibDir

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

protectedinherited

The path to calibration files for MagAOX.

Definition at line 89 of file MagAOXApp.hpp.

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

◆ m_cpusetPath

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

protectedinherited

Definition at line 424 of file MagAOXApp.hpp.

◆ m_dataType

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

protectedinherited

The ImageStreamIO type code.

Definition at line 120 of file shmimMonitor.hpp.

◆ m_depth

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

protectedinherited

The depth of the circular buffer in the stream.

Definition at line 118 of file shmimMonitor.hpp.

◆ m_df

realT MagAOX::app::modalPSDs::m_df { 1 }

protected

Definition at line 87 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ 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 593 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 585 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 588 of file MagAOXApp.hpp.

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

◆ m_fft

mx::math::fft::fftT< realT, std::complex<realT>, 1, 0> MagAOX::app::modalPSDs::m_fft

protected

Definition at line 104 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ m_fftEnv

mx::math::fft::fftwEnvironment<realT> MagAOX::app::modalPSDs::m_fftEnv

protected

Definition at line 105 of file modalPSDs.hpp.

◆ m_fftWork

std::complex<realT>* MagAOX::app::modalPSDs::m_fftWork { nullptr }

protected

Definition at line 99 of file modalPSDs.hpp.

Referenced by allocate(), appShutdown(), and psdThreadExec().

◆ m_fftWorkSize

size_t MagAOX::app::modalPSDs::m_fftWorkSize { 0 }

protected

Definition at line 100 of file modalPSDs.hpp.

◆ m_fps

realT MagAOX::app::modalPSDs::m_fps { 0 }

protected

Definition at line 86 of file modalPSDs.hpp.

Referenced by allocate(), appStartup(), loadConfigImpl(), and psdThreadExec().

◆ m_fpsSource

std::string MagAOX::app::modalPSDs::m_fpsSource

protected

Device name for getting fps to set circular buffer length. This device should have *.fps.current.

Definition at line 66 of file modalPSDs.hpp.

Referenced by appStartup(), and loadConfigImpl().

◆ m_freqStream

IMAGE* MagAOX::app::modalPSDs::m_freqStream { nullptr }

protected

The ImageStreamIO shared memory buffer to hold the frequency scale.

Definition at line 133 of file modalPSDs.hpp.

Referenced by allocate(), and appShutdown().

◆ m_getExistingFirst

bool MagAOX::app::dev::shmimMonitor< modalPSDs , 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 112 of file shmimMonitor.hpp.

◆ m_gitAlert

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

privateinherited

Definition at line 478 of file MagAOXApp.hpp.

◆ m_height

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

protectedinherited

The height of the images in the stream.

Definition at line 117 of file shmimMonitor.hpp.

◆ m_imageStream

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

protectedinherited

The ImageStreamIO shared memory buffer.

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

◆ m_indiMutex

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

inherited

Mutex for locking INDI communications.

Definition at line 545 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 573 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 980 of file MagAOXApp.hpp.

◆ m_indiP_fps

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_fps

protected

Definition at line 196 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_indiP_fpsSource

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_fpsSource

protected

Definition at line 195 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_indiP_frameSize

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

protectedinherited

Property used to report the current frame size.

Definition at line 239 of file shmimMonitor.hpp.

◆ m_indiP_overSize

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_overSize

protected

Definition at line 194 of file modalPSDs.hpp.

◆ m_indiP_powerChannel

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

protectedinherited

INDI property used to communicate power state.

Definition at line 1036 of file MagAOXApp.hpp.

◆ m_indiP_psdAvgTime

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_psdAvgTime

protected

Definition at line 193 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_indiP_psdTime

pcf::IndiProperty MagAOX::app::modalPSDs::m_indiP_psdTime

protected

Definition at line 192 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_indiP_shmimName

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

protectedinherited

Property used to report the shmim buffer name.

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

◆ m_inode

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

protectedinherited

The inode of the image stream file.

Definition at line 125 of file shmimMonitor.hpp.

◆ m_log

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

staticinherited

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

◆ m_nModes

int MagAOX::app::modalPSDs::m_nModes { 0 }

protected

the number of modes to calculate PSDs for.

Definition at line 80 of file modalPSDs.hpp.

Referenced by allocate(), and allocatePSDStreams().

◆ m_nPSDHistory

int MagAOX::app::modalPSDs::m_nPSDHistory { 100 }

protected

Definition at line 75 of file modalPSDs.hpp.

Referenced by allocatePSDStreams().

◆ 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 1022 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 1021 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 1023 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 1016 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 1029 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 1026 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 1033 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 1024 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 1034 of file MagAOXApp.hpp.

◆ m_psd

std::vector<realT> MagAOX::app::modalPSDs::m_psd

protected

Definition at line 102 of file modalPSDs.hpp.

Referenced by allocate(), allocatePSDStreams(), and psdThreadExec().

◆ m_psdAvgTime

realT MagAOX::app::modalPSDs::m_psdAvgTime { 10 }

protected

The time over which to average PSDs. The default is 10 sec.

Definition at line 69 of file modalPSDs.hpp.

Referenced by appStartup(), and psdThreadExec().

◆ m_psdBuffer

mx::improc::eigenImage<realT> MagAOX::app::modalPSDs::m_psdBuffer

protected

Definition at line 135 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), and psdThreadExec().

◆ m_psdOverlapFraction

realT MagAOX::app::modalPSDs::m_psdOverlapFraction { 0.5 }

protected

The fraction of the sample time to overlap by.

Definition at line 73 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ m_psdRestarting

bool MagAOX::app::modalPSDs::m_psdRestarting { true }

protected

Synchronization flag. This will only become false after a successful call to allocate.

Definition at line 118 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ m_psdThread

std::thread MagAOX::app::modalPSDs::m_psdThread

protected

The PSD Calculation thread.

Definition at line 114 of file modalPSDs.hpp.

Referenced by appLogic(), appShutdown(), and appStartup().

◆ m_psdThreadCpuset

std::string MagAOX::app::modalPSDs::m_psdThreadCpuset

protected

The cpuset to use for the PSD Calculation thread.

Definition at line 112 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_psdThreadID

pid_t MagAOX::app::modalPSDs::m_psdThreadID { 0 }

protected

PSD Calculation thread PID.

Definition at line 121 of file modalPSDs.hpp.

Referenced by appStartup(), and psdThreadExec().

◆ m_psdThreadInit

bool MagAOX::app::modalPSDs::m_psdThreadInit { true }

protected

Initialization flag for the PSD Calculation thread.

Definition at line 116 of file modalPSDs.hpp.

Referenced by appStartup(), and psdThreadExec().

◆ m_psdThreadPrio

int MagAOX::app::modalPSDs::m_psdThreadPrio { 0 }

protected

Priority of the PSD Calculation thread.

Definition at line 111 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_psdThreadProp

pcf::IndiProperty MagAOX::app::modalPSDs::m_psdThreadProp

protected

The property to hold the PSD Calculation thread details.

Definition at line 123 of file modalPSDs.hpp.

Referenced by appStartup().

◆ m_psdTime

realT MagAOX::app::modalPSDs::m_psdTime { 1 }

protected

The length of time over which to calculate PSDs. The default is 1 sec.

Definition at line 68 of file modalPSDs.hpp.

Referenced by allocate(), appStartup(), loadConfigImpl(), and psdThreadExec().

◆ m_psdWaiting

bool MagAOX::app::modalPSDs::m_psdWaiting { false }

protected

Synchronization flag. This is set to true when the PSD thread is safely waiting for allocation to complete.

Definition at line 119 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ m_rawpsdStream

IMAGE* MagAOX::app::modalPSDs::m_rawpsdStream { nullptr }

protected

The ImageStreamIO shared memory buffer to hold the raw psds.

Definition at line 137 of file modalPSDs.hpp.

Referenced by allocatePSDStreams(), appShutdown(), and psdThreadExec().

◆ m_restart

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

protectedinherited

Flag indicating tha the shared memory should be reinitialized.

Definition at line 205 of file shmimMonitor.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 289 of file MagAOXApp.hpp.

◆ m_selfMonitor

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

staticprotectedinherited

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

Definition at line 207 of file shmimMonitor.hpp.

◆ m_semaphoreNumber

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

protectedinherited

The image structure semaphore index.

Definition at line 114 of file shmimMonitor.hpp.

◆ m_shmimName

std::string MagAOX::app::dev::shmimMonitor< modalPSDs , 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 104 of file shmimMonitor.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 100 of file MagAOXApp.hpp.

◆ m_smCpuset

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

protectedinherited

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

Definition at line 108 of file shmimMonitor.hpp.

◆ m_smThread

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

protectedinherited

A separate thread for the actual monitoring.

Definition at line 220 of file shmimMonitor.hpp.

◆ m_smThreadID

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

protectedinherited

The s.m. thread PID.

Definition at line 216 of file shmimMonitor.hpp.

◆ m_smThreadInit

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

protectedinherited

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

Definition at line 214 of file shmimMonitor.hpp.

◆ m_smThreadPrio

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

protectedinherited

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

Definition at line 106 of file shmimMonitor.hpp.

◆ m_smThreadProp

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

protectedinherited

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

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

◆ m_stateAlert

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

privateinherited

Definition at line 475 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 480 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_tsOverlapSize

unsigned MagAOX::app::modalPSDs::m_tsOverlapSize { 1000 }

protected

The number of samples in the overlap.

Definition at line 92 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ m_tsSize

unsigned MagAOX::app::modalPSDs::m_tsSize { 2000 }

protected

The length of the time series sample over which the PSD is calculated.

Definition at line 91 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ m_tsWork

realT* MagAOX::app::modalPSDs::m_tsWork { nullptr }

protected

Definition at line 96 of file modalPSDs.hpp.

Referenced by allocate(), appShutdown(), and psdThreadExec().

◆ m_tsWorkSize

size_t MagAOX::app::modalPSDs::m_tsWorkSize { 0 }

protected

Definition at line 97 of file modalPSDs.hpp.

◆ m_typeSize

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

protectedinherited

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

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

◆ m_width

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

protectedinherited

The width of the images in the stream.

Definition at line 116 of file shmimMonitor.hpp.

◆ m_win

std::vector<realT> MagAOX::app::modalPSDs::m_win

protected

The window function. By default this is Hann.

Definition at line 94 of file modalPSDs.hpp.

Referenced by allocate(), and psdThreadExec().

◆ MagAOXPath

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

protectedinherited

The base path of the MagAO-X system.

Definition at line 81 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 93 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 91 of file MagAOXApp.hpp.

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

apps/modalPSDs/modalPSDs.hpp

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Friends

INDI Interface

PSD Calculation Thread

PID Locking

Power Management

SIGSEGV & SIGBUS signal handling

shmimmonitor Thread

INDI

Logging

Application State

Signal Handling

Privilege Management

Detailed Description

Member Typedef Documentation

◆ ampCircBuffT

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ complexT

◆ logManagerT

◆ realT

◆ shmimMonitorT

Constructor & Destructor Documentation

◆ modalPSDs()

◆ ~modalPSDs()

Member Function Documentation

◆ _handlerSigTerm()

◆ allocate()

◆ allocatePSDStreams()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ checkConfig()

◆ clearFSMAlert()

◆ configDir()

◆ configLog()

◆ configName()

◆ createINDIFIFOS()

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()

◆ dataType()

◆ depth()

◆ derived()

◆ driverCtrlName()

◆ driverInName()

◆ driverOutName()

◆ execute()

◆ handleDefProperty()

◆ handleGetProperties()

◆ handleNewProperty()

◆ handlerSigTerm()

◆ handleSetProperty()

◆ height()

◆ INDI_NEWCALLBACK_DECL() [1/3]

◆ INDI_NEWCALLBACK_DECL() [2/3]

◆ INDI_NEWCALLBACK_DECL() [3/3]

◆ INDI_SETCALLBACK_DECL() [1/2]

◆ INDI_SETCALLBACK_DECL() [2/2]

◆ indiTargetUpdate()

◆ loadBasicConfig()

◆ loadConfig() [1/2]

◆ loadConfig() [2/2]

◆ loadConfigImpl()

◆ lockPID()

◆ log() [1/2]

◆ log() [2/2]

◆ logMessage()

◆ newCallBack_clearFSMAlert()

◆ onPowerOff()

◆ powerOnWaitElapsed()