Inheritance diagram for TCSITEST::tcsInterface_test:

Collaboration diagram for TCSITEST::tcsInterface_test:

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

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

Public Member Functions
	tcsInterface_test (const std::string device)

virtual void	setupConfig ()

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

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

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

virtual void	loadConfig ()

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

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

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

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

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

int	getMagTelStatus (std::string &response, const std::string &statreq)

int	sendMagTelCommand (const std::string &command, int timeout)

int	parse_xms (double &x, double &m, double &s, const std::string &xmsstr)

std::vector< std::string >	parse_teldata (std::string &tdat)

int	getTelTime ()

int	getTelPos ()

int	getTelData ()

int	getCatData ()

int	getVaneData ()

int	getEnvData ()

int	getSeeing ()

int	updateINDI ()

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

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

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

	INDI_SETCALLBACK_DECL (tcsInterface, m_indiP_loopState)

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

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

int	telem ()
	Make a telemetry recording, for an empty record. More...

Telemeter Interface
int	checkRecordTimes ()

int	recordTelem (const telem_telpos *)

int	recordTelem (const telem_teldata *)

int	recordTelem (const telem_telvane *)

int	recordTelem (const telem_telenv *)

int	recordTelem (const telem_telcat *)

int	recordTelem (const telem_telsee *)

int	recordTelPos (bool force=false)

int	recordTelData (bool force=false)

int	recordTelVane (bool force=false)

int	recordTelEnv (bool force=false)

int	recordTelCat (bool force=false)

int	recordTelSee (bool force=false)

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

Public Attributes
int	m_loopState {0}

pcf::IndiProperty	m_indiP_loopState
	Property used to report the loop state. More...

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

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

logManagerT	m_tel

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

Protected Attributes
double	m_telST {0}

pcf::IndiProperty	m_indiP_teltime

double	m_telEpoch {0}

double	m_telRA {0}

double	m_telDec {0}

double	m_telEl {0}

double	m_telHA {0}

double	m_telAM {0}

double	m_telRotOff {0}

pcf::IndiProperty	m_indiP_telpos

double	m_telSecZ {0}

double	m_telEncZ {0}

double	m_telSecX {0}

double	m_telEncX {0}

double	m_telSecY {0}

double	m_telEncY {0}

double	m_telSecH {0}

double	m_telEncH {0}

double	m_telSecV {0}

double	m_telEncV {0}

pcf::IndiProperty	m_indiP_vaneend
	INDI Property for the vane end positions. More...

double	m_wxtemp {0}
	Outside temperature, Celsius. More...

double	m_wxpres {0}
	Outside pressue, millibars. More...

double	m_wxhumid {0}
	Outside humidity, percent. More...

double	m_wxwind {0}
	outside wind intensity, mph More...

double	m_wxwdir {0}
	outside wind direction, degrees More...

double	m_ttruss {0}
	Telescope truss temperature, Celsius. More...

double	m_tcell {0}
	Primary mirror cell temperature, Celsius. More...

double	m_tseccell {0}
	Secondary mirror cell temperature, Celsius. More...

double	m_tambient {0}
	Dome air temperature, Celsius. More...

double	m_wxdewpoint {0}
	Dew point from weather station. More...

pcf::IndiProperty	m_indiP_env
	INDI Property for environment. More...

double	m_dimm_el {0}
	DIMM elevation at time of seeing measurement. More...

double	m_dimm_fwhm {0}
	DIMM raw FWHM. More...

double	m_dimm_fwhm_corr {0}
	DIMM elevation corrected FWHM. More...

int	m_dimm_time {0}
	Seconds since midnight of DIMM measurement. More...

double	m_mag1_el {0}
	MAG1 elevation at time of seeing measurement. More...

double	m_mag1_fwhm {0}
	MAG1 raw FWHM. More...

double	m_mag1_fwhm_corr {0}
	MAG1 elevation corrected FWHM. More...

int	m_mag1_time {0}
	Seconds since midnight of MAG1 measurement. More...

double	m_mag2_el {0}
	MAG2 elevation at time of seeing measurement. More...

double	m_mag2_fwhm {0}
	MAG2 raw FWHM. More...

double	m_mag2_fwhm_corr {0}
	MAG2 elevation corrected FWHM. More...

int	m_mag2_time {0}
	Seconds since midnight of MAG2 measurement. More...

pcf::IndiProperty	m_indiP_seeing
	INDI Property for seeing. More...

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

TCS Networking
std::string	m_deviceAddr {"localhost"}
	The IP address or resolvable name of the TCS. More...

int	m_devicePort {5811}
	The IP port for TCS communications. Should be the command port. Default is 5811. More...

int	m_seeingInterval {2}

std::mutex	m_tcsMutex
	Mutex for locking TCS communications. More...

tty::netSerial	m_sock

Telescope Data
int	m_telROI {0}
	The rotator of interest. More...

int	m_telTracking {0}
	tracking state More...

int	m_telGuiding {0}
	guider moving state More...

int	m_telSlewing {0}
	slewing state More...

int	m_telGuiderMoving {0}
	guider moving state More...

double	m_telAz {0}
	azimuth More...

double	m_telZd {0}
	zenith distance More...

double	m_telPA {0}
	parallactic angle More...

double	m_telDomeAz {0}
	dome azimuth More...

int	m_telDomeStat {0}
	dome status More...

pcf::IndiProperty	m_indiP_teldata

Telescope Catalog Information
double	m_catRA {0}
	Catalog right ascension [degrees]. More...

double	m_catDec {0}
	Catalog declination [degrees]. More...

double	m_catEp {0}
	Catalog epoch. More...

double	m_catRo {0}
	Catalog rotator offset. More...

std::string	m_catRm
	Catalog rotator mode. More...

std::string	m_catObj
	Catalog object name. More...

pcf::IndiProperty	m_indiP_catalog
	INDI Property for the catalog text information. More...

pcf::IndiProperty	m_indiP_catdata
	INDI Property for the catalog data. 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

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

tcsInterface &	derived ()
	Access the derived class. More...

Pyramid Nudging and Acquisition
Handling of nudges on pyramid tip.
	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_pyrNudge)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_acqFromGuider)

int	sendPyrNudge (float x, float y, float z)

int	acquireFromGuider ()

float	m_pyrNudge_C_00 {1}

float	m_pyrNudge_C_01 {0}

float	m_pyrNudge_C_10 {0}

float	m_pyrNudge_C_11 {1}

float	m_pyrNudge_F_sign {1}

float	m_pyrNudge_ang {45.0}

float	m_pyrNudge_ang0 {0.0}

float	m_pyrNudge_parity {-1}

pcf::IndiProperty	m_indiP_pyrNudge
	Property used to request a pyramid nudge. More...

int	m_acqZdSign {-1}

float	m_acqAz0 {18.5}

float	m_acqAzOff {0}

float	m_acqEl0 {10}

float	m_acqElOff {0}

float	m_acqFocus {1400}

pcf::IndiProperty	m_indiP_acqFromGuider
	Property used to request a pyramid nudge. More...

Woofer Offloading
Handling of offloads from the average woofer shape to the telescope
	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTenable)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTdump)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTavgInt)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTgain)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTthresh)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFenable)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFdump)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFavgInt)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFgain)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFthresh)

	INDI_SETCALLBACK_DECL (tcsInterface, m_indiP_offloadCoeffs)

void	offloadThreadExec ()
	Offload thread function. More...

int	doTToffload (float TT_0, float TT_1)

int	sendTToffload (float TT_0, float TT_1)

int	doFoffload (float F_0)

int	sendFoffload (float F_0)

bool	m_offloadThreadInit {true}
	Initialization flag for the offload thread. More...

pid_t	m_offloadThreadID {0}
	Offload thread pid. More...

pcf::IndiProperty	m_offloadThreadProp
	Offload thread INDI property. More...

std::thread	m_offloadThread
	The offloading thread. More...

pcf::IndiProperty	m_indiP_offloadCoeffs
	Property used to report the latest woofer modal coefficients for offloading. More...

std::vector< std::vector< float > >	m_offloadRequests

size_t	m_firstRequest {0}

size_t	m_lastRequest {std::numeric_limits<size_t>::max()}

size_t	m_nRequests {0}

size_t	m_last_nRequests {0}

float	m_lab_offlTT_C_00 {0.17}

float	m_lab_offlTT_C_01 {1.03}

float	m_lab_offlTT_C_10 {-1.03}

float	m_lab_offlTT_C_11 {0.48}

float	m_offlTT_C_00 {-0.5}

float	m_offlTT_C_01 {0}

float	m_offlTT_C_10 {0}

float	m_offlTT_C_11 {-0.25}

bool	m_offlTT_enabled {false}

bool	m_offlTT_dump {false}

float	m_offlTT_avgInt {1.0}

float	m_offlTT_gain {0.1}

float	m_offlTT_thresh {0.1}

pcf::IndiProperty	m_indiP_offlTTenable

pcf::IndiProperty	m_indiP_offlTTdump

pcf::IndiProperty	m_indiP_offlTTavgInt

pcf::IndiProperty	m_indiP_offlTTgain

pcf::IndiProperty	m_indiP_offlTTthresh

float	m_offlCFocus_00 {1}

bool	m_offlF_enabled {false}

bool	m_offlF_dump {false}

float	m_offlF_avgInt {1.0}

float	m_offlF_gain {0.1}

float	m_offlF_thresh {0.1}

pcf::IndiProperty	m_indiP_offlFenable

pcf::IndiProperty	m_indiP_offlFdump

pcf::IndiProperty	m_indiP_offlFavgInt

pcf::IndiProperty	m_indiP_offlFgain

pcf::IndiProperty	m_indiP_offlFthresh

float	m_offlCComa_00 {1}

float	m_offlCComa_01 {0}

float	m_offlCComa_10 {1}

float	m_offlCComa_11 {0}

static void	offloadThreadStart (tcsInterface *t)
	Offload thread starter function. 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.
	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

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

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

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

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

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 logManagerT	m_log

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

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

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

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

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

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

lab mode
bool	m_labMode {true}

pcf::IndiProperty	m_indiP_labMode

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_labMode)

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

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

Definition at line 20 of file tcsInterface_test.cpp.

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

◆ logManagerT [1/2]

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

inherited

The log manager type.

Definition at line 71 of file telemeter.hpp.

◆ logManagerT [2/2]

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

inherited

The log manager type.

Definition at line 78 of file MagAOXApp.hpp.

Constructor & Destructor Documentation

◆ tcsInterface_test()

TCSITEST::tcsInterface_test::tcsInterface_test ( const std::string device )

inline

Definition at line 24 of file tcsInterface_test.cpp.

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.

◆ acquireFromGuider()

int MagAOX::app::tcsInterface::acquireFromGuider ( )

inherited

Todo:: need logtypes for nudges and offloads

Definition at line 2464 of file tcsInterface.hpp.

◆ appLogic()

int MagAOX::app::tcsInterface::appLogic ( )

inlinevirtualinherited

Implementation of the FSM for tcsInterface.

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

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

Definition at line 843 of file tcsInterface.hpp.

◆ appShutdown()

int MagAOX::app::tcsInterface::appShutdown ( )

inlinevirtualinherited

Shutdown the app.

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

Definition at line 958 of file tcsInterface.hpp.

◆ appStartup()

int MagAOX::app::tcsInterface::appStartup ( )

inlinevirtualinherited

Startup function.

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

Definition at line 548 of file tcsInterface.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.

◆ checkRecordTimes() [1/4]

int MagAOX::app::tcsInterface::checkRecordTimes ( )

inlineinherited

Definition at line 2129 of file tcsInterface.hpp.

◆ checkRecordTimes() [2/4]

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

inherited

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

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

Returns: 0 on succcess; -1 on error

Parameters

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

Definition at line 148 of file telemeter.hpp.

◆ checkRecordTimes() [3/4]

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

inherited

Empty function called at the end of the template list.

Returns: 0 on succcess; -1 on error

Parameters

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

Definition at line 169 of file telemeter.hpp.

◆ checkRecordTimes() [4/4]

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

inherited

Worker function to actually perform the record time checking logic.

Recursively calls itself until the variadic template list is exhausted.

Returns: 0 on succcess; -1 on error

Parameters

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

Definition at line 159 of file telemeter.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.

◆ derived()

tcsInterface & MagAOX::app::dev::telemeter< tcsInterface >::derived ( )

inlineprivateinherited

Access the derived class.

Definition at line 173 of file telemeter.hpp.

◆ doFoffload()

int MagAOX::app::tcsInterface::doFoffload ( float F_0 )

inherited

Definition at line 2703 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

◆ doTToffload()

int MagAOX::app::tcsInterface::doTToffload	(	float	TT_0,
		float	TT_1
	)

inherited

Definition at line 2633 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

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

◆ getCatData()

int MagAOX::app::tcsInterface::getCatData ( )

inlineinherited

Definition at line 1426 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

◆ getEnvData()

int MagAOX::app::tcsInterface::getEnvData ( )

inlineinherited

Definition at line 1563 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

◆ getMagTelStatus()

int MagAOX::app::tcsInterface::getMagTelStatus	(	std::string &	response,
		const std::string &	statreq
	)

inlineinherited

Definition at line 976 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::getTelTime(), and MagAOX::app::tcsInterface::getVaneData().

◆ getSeeing()

int MagAOX::app::tcsInterface::getSeeing ( )

inlineinherited

Definition at line 1611 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

◆ getTelData()

int MagAOX::app::tcsInterface::getTelData ( )

inlineinherited

Definition at line 1358 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

◆ getTelPos()

int MagAOX::app::tcsInterface::getTelPos ( )

inlineinherited

Definition at line 1285 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

◆ getTelTime()

int MagAOX::app::tcsInterface::getTelTime ( )

inlineinherited

Definition at line 1243 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

◆ getVaneData()

int MagAOX::app::tcsInterface::getVaneData ( )

inlineinherited

Definition at line 1514 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

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

◆ INDI_NEWCALLBACK_DECL() [1/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_acqFromGuider
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [2/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_labMode
	)

protectedinherited

◆ INDI_NEWCALLBACK_DECL() [3/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFavgInt
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [4/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFdump
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [5/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFenable
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [6/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFgain
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [7/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFthresh
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [8/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTavgInt
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [9/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTdump
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [10/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTenable
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [11/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTgain
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [12/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTthresh
	)

inherited

◆ INDI_NEWCALLBACK_DECL() [13/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_pyrNudge
	)

inherited

◆ INDI_SETCALLBACK_DECL() [1/3]

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

inherited

◆ INDI_SETCALLBACK_DECL() [2/3]

MagAOX::app::tcsInterface::INDI_SETCALLBACK_DECL	(	tcsInterface	,
		m_indiP_loopState
	)

inherited

◆ INDI_SETCALLBACK_DECL() [3/3]

MagAOX::app::tcsInterface::INDI_SETCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offloadCoeffs
	)

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 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/3]

void MagAOX::app::tcsInterface::loadConfig ( )

inlinevirtualinherited

Definition at line 542 of file tcsInterface.hpp.

◆ loadConfig() [2/3]

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

inherited

Load the device section from an application configurator.

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

Parameters

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

Definition at line 112 of file telemeter.hpp.

◆ loadConfig() [3/3]

int MagAOX::app::dev::ioDevice::loadConfig ( mx::app::appConfigurator & config )

inherited

Load the device section from an application configurator.

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

Parameters

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

Definition at line 28 of file ioDevice.cpp.

Referenced by MagAOX::app::picoMotorCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::trippLitePDU::loadConfig(), MagAOX::app::dev::edtCamera< derivedT >::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::pi335Ctrl::loadConfigImpl(), MagAOX::app::rhusbMon::loadConfigImpl(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ loadConfigImpl()

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

inlineinherited

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 485 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::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.

◆ offloadThreadExec()

void MagAOX::app::tcsInterface::offloadThreadExec ( )

inherited

Offload thread function.

Runs until m_shutdown is true.

Todo:: offloading: These sections ought to be separate functions for clarity

Definition at line 2502 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadStart().

◆ offloadThreadStart()

void MagAOX::app::tcsInterface::offloadThreadStart ( tcsInterface * t )

staticinherited

Offload thread starter function.

Parameters

[in] t pointer to this

Definition at line 2497 of file tcsInterface.hpp.

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

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

◆ parse_teldata()

std::vector< std::string > MagAOX::app::tcsInterface::parse_teldata ( std::string & tdat )

inlineinherited

Definition at line 1068 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::getTelTime(), and MagAOX::app::tcsInterface::getVaneData().

◆ parse_xms()

int MagAOX::app::tcsInterface::parse_xms	(	double &	x,
		double &	m,
		double &	s,
		const std::string &	xmsstr
	)

inlineinherited

Definition at line 1119 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::getTelTime(), and TCSITEST::SCENARIO().

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

◆ recordTelCat()

int MagAOX::app::tcsInterface::recordTelCat ( bool force = false )

inlineinherited

Definition at line 2338 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::recordTelem().

◆ recordTelData()

int MagAOX::app::tcsInterface::recordTelData ( bool force = false )

inlineinherited

Definition at line 2210 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getTelData(), and MagAOX::app::tcsInterface::recordTelem().

◆ recordTelem() [1/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telcat * )

inlineinherited

Definition at line 2163 of file tcsInterface.hpp.

◆ recordTelem() [2/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_teldata * )

inlineinherited

Definition at line 2142 of file tcsInterface.hpp.

◆ recordTelem() [3/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telenv * )

inlineinherited

Definition at line 2156 of file tcsInterface.hpp.

◆ recordTelem() [4/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telpos * )

inlineinherited

Definition at line 2135 of file tcsInterface.hpp.

◆ recordTelem() [5/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telsee * )

inlineinherited

Definition at line 2170 of file tcsInterface.hpp.

◆ recordTelem() [6/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telvane * )

inlineinherited

Definition at line 2149 of file tcsInterface.hpp.

◆ recordTelEnv()

int MagAOX::app::tcsInterface::recordTelEnv ( bool force = false )

inlineinherited

Definition at line 2294 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getEnvData(), and MagAOX::app::tcsInterface::recordTelem().

◆ recordTelPos()

int MagAOX::app::tcsInterface::recordTelPos ( bool force = false )

inlineinherited

Definition at line 2177 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getTelPos(), and MagAOX::app::tcsInterface::recordTelem().

◆ recordTelSee()

int MagAOX::app::tcsInterface::recordTelSee ( bool force = false )

inlineinherited

Definition at line 2368 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getSeeing(), and MagAOX::app::tcsInterface::recordTelem().

◆ recordTelVane()

int MagAOX::app::tcsInterface::recordTelVane ( bool force = false )

inlineinherited

Definition at line 2252 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getVaneData(), and MagAOX::app::tcsInterface::recordTelem().

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

◆ sendFoffload()

int MagAOX::app::tcsInterface::sendFoffload ( float F_0 )

inherited

Definition at line 2736 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::doFoffload().

◆ sendGetPropertySetList()

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

inherited

Definition at line 821 of file MagAOXApp.hpp.

◆ sendMagTelCommand()

int MagAOX::app::tcsInterface::sendMagTelCommand	(	const std::string &	command,
		int	timeout
	)

inlineinherited

Definition at line 1024 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), MagAOX::app::tcsInterface::sendFoffload(), MagAOX::app::tcsInterface::sendPyrNudge(), and MagAOX::app::tcsInterface::sendTToffload().

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

◆ sendPyrNudge()

int MagAOX::app::tcsInterface::sendPyrNudge	(	float	x,
		float	y,
		float	z
	)

inherited

Todo:: need logtypes for nudges and offloads

Definition at line 2420 of file tcsInterface.hpp.

◆ sendTToffload()

int MagAOX::app::tcsInterface::sendTToffload	(	float	TT_0,
		float	TT_1
	)

inherited

Definition at line 2671 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::doTToffload().

◆ 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/3]

void MagAOX::app::tcsInterface::setupConfig ( )

inlinevirtualinherited

Definition at line 429 of file tcsInterface.hpp.

◆ setupConfig() [2/3]

int MagAOX::app::dev::telemeter< tcsInterface >::setupConfig ( appConfigurator & config )

inherited

Setup an application configurator for the device section.

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

Parameters

[in] config an application configuration to setup

Definition at line 104 of file telemeter.hpp.

◆ setupConfig() [3/3]

int MagAOX::app::dev::ioDevice::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup an application configurator for the device section.

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

Parameters

[in] config an application configuration to setup

Definition at line 20 of file ioDevice.cpp.

Referenced by MagAOX::app::flipperCtrl::setupConfig(), MagAOX::app::pi335Ctrl::setupConfig(), MagAOX::app::picoMotorCtrl::setupConfig(), MagAOX::app::rhusbMon::setupConfig(), MagAOX::app::smc100ccCtrl::setupConfig(), MagAOX::app::tcsInterface::setupConfig(), MagAOX::app::trippLitePDU::setupConfig(), and MagAOX::app::dev::edtCamera< derivedT >::setupConfig().

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

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

◆ telem() [1/2]

int MagAOX::app::dev::telemeter< tcsInterface >::telem

inherited

Make a telemetry recording, for an empty record.

Wrapper for logManager::log, which updates telT::lastRecord.

Template Parameters

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

Definition at line 97 of file telemeter.hpp.

◆ telem() [2/2]

int MagAOX::app::dev::telemeter< tcsInterface >::telem ( const typename telT::messageT & msg )

inherited

Make a telemetry recording.

Wrapper for logManager::log, which updates telT::lastRecord.

Template Parameters

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

Parameters

[in] msg the data to log

Definition at line 87 of file telemeter.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.

◆ 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::tcsInterface::updateINDI ( )

inlineinherited

Definition at line 1756 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic().

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

Member Data Documentation

◆ m_acqAz0

float MagAOX::app::tcsInterface::m_acqAz0 {18.5}

inherited

Definition at line 300 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_acqAzOff

float MagAOX::app::tcsInterface::m_acqAzOff {0}

inherited

Definition at line 301 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_acqEl0

float MagAOX::app::tcsInterface::m_acqEl0 {10}

inherited

Definition at line 302 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_acqElOff

float MagAOX::app::tcsInterface::m_acqElOff {0}

inherited

Definition at line 303 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_acqFocus

float MagAOX::app::tcsInterface::m_acqFocus {1400}

inherited

Definition at line 304 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_acqZdSign

int MagAOX::app::tcsInterface::m_acqZdSign {-1}

inherited

Definition at line 299 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ 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_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_catDec

double MagAOX::app::tcsInterface::m_catDec {0}

protectedinherited

Catalog declination [degrees].

Definition at line 117 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::recordTelCat(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_catEp

double MagAOX::app::tcsInterface::m_catEp {0}

protectedinherited

Catalog epoch.

Definition at line 118 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::recordTelCat(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_catObj

std::string MagAOX::app::tcsInterface::m_catObj

protectedinherited

Catalog object name.

Definition at line 121 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::recordTelCat(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_catRA

double MagAOX::app::tcsInterface::m_catRA {0}

protectedinherited

Catalog right ascension [degrees].

Definition at line 116 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::recordTelCat(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_catRm

std::string MagAOX::app::tcsInterface::m_catRm

protectedinherited

Catalog rotator mode.

Definition at line 120 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::recordTelCat(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_catRo

double MagAOX::app::tcsInterface::m_catRo {0}

protectedinherited

Catalog rotator offset.

Definition at line 119 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getCatData(), MagAOX::app::tcsInterface::recordTelCat(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_deviceAddr

std::string MagAOX::app::tcsInterface::m_deviceAddr {"localhost"}

protectedinherited

The IP address or resolvable name of the TCS.

Definition at line 68 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_devicePort

int MagAOX::app::tcsInterface::m_devicePort {5811}

protectedinherited

The IP port for TCS communications. Should be the command port. Default is 5811.

Definition at line 69 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_dimm_el

double MagAOX::app::tcsInterface::m_dimm_el {0}

protectedinherited

DIMM elevation at time of seeing measurement.

Definition at line 157 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_dimm_fwhm

double MagAOX::app::tcsInterface::m_dimm_fwhm {0}

protectedinherited

DIMM raw FWHM.

Definition at line 158 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_dimm_fwhm_corr

double MagAOX::app::tcsInterface::m_dimm_fwhm_corr {0}

protectedinherited

DIMM elevation corrected FWHM.

Definition at line 159 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_dimm_time

int MagAOX::app::tcsInterface::m_dimm_time {0}

protectedinherited

Seconds since midnight of DIMM measurement.

Definition at line 160 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_firstRequest

size_t MagAOX::app::tcsInterface::m_firstRequest {0}

inherited

Definition at line 352 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_gitAlert

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

privateinherited

Definition at line 478 of file MagAOXApp.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_acqFromGuider

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_acqFromGuider

inherited

Property used to request a pyramid nudge.

Definition at line 308 of file tcsInterface.hpp.

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

◆ m_indiP_catalog

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_catalog

protectedinherited

INDI Property for the catalog text information.

Definition at line 123 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_catdata

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_catdata

protectedinherited

INDI Property for the catalog data.

Definition at line 124 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_env

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_env

protectedinherited

INDI Property for environment.

Definition at line 154 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_labMode

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_labMode

protectedinherited

Definition at line 58 of file tcsInterface.hpp.

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

◆ m_indiP_loopState

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_loopState

inherited

Property used to report the loop state.

Definition at line 271 of file tcsInterface.hpp.

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

◆ m_indiP_offlFavgInt

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFavgInt

inherited

Definition at line 405 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlFdump

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFdump

inherited

Definition at line 402 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlFenable

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFenable

inherited

Definition at line 399 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlFgain

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFgain

inherited

Definition at line 408 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlFthresh

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFthresh

inherited

Definition at line 411 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offloadCoeffs

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offloadCoeffs

inherited

Property used to report the latest woofer modal coefficients for offloading.

Definition at line 347 of file tcsInterface.hpp.

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

◆ m_indiP_offlTTavgInt

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTavgInt

inherited

Definition at line 381 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlTTdump

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTdump

inherited

Definition at line 378 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlTTenable

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTenable

inherited

Definition at line 375 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlTTgain

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTgain

inherited

Definition at line 384 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_offlTTthresh

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTthresh

inherited

Definition at line 387 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_pyrNudge

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_pyrNudge

inherited

Property used to request a pyramid nudge.

Definition at line 296 of file tcsInterface.hpp.

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

◆ m_indiP_seeing

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_seeing

protectedinherited

INDI Property for seeing.

Definition at line 172 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_indiP_teldata

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_teldata

protectedinherited

Definition at line 110 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_telpos

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_telpos

protectedinherited

Definition at line 94 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_teltime

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_teltime

protectedinherited

Definition at line 83 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_indiP_vaneend

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_vaneend

protectedinherited

INDI Property for the vane end positions.

Definition at line 139 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_lab_offlTT_C_00

float MagAOX::app::tcsInterface::m_lab_offlTT_C_00 {0.17}

inherited

Definition at line 358 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_lab_offlTT_C_01

float MagAOX::app::tcsInterface::m_lab_offlTT_C_01 {1.03}

inherited

Definition at line 359 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_lab_offlTT_C_10

float MagAOX::app::tcsInterface::m_lab_offlTT_C_10 {-1.03}

inherited

Definition at line 360 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_lab_offlTT_C_11

float MagAOX::app::tcsInterface::m_lab_offlTT_C_11 {0.48}

inherited

Definition at line 361 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_labMode

bool MagAOX::app::tcsInterface::m_labMode {true}

protectedinherited

Definition at line 56 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::doFoffload(), MagAOX::app::tcsInterface::doTToffload(), MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::sendTToffload().

◆ m_last_nRequests

size_t MagAOX::app::tcsInterface::m_last_nRequests {0}

inherited

Definition at line 355 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_lastRequest

size_t MagAOX::app::tcsInterface::m_lastRequest {std::numeric_limits<size_t>::max()}

inherited

Definition at line 353 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

◆ 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_loopState

int MagAOX::app::tcsInterface::m_loopState {0}

inherited

Definition at line 270 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_mag1_el

double MagAOX::app::tcsInterface::m_mag1_el {0}

protectedinherited

MAG1 elevation at time of seeing measurement.

Definition at line 162 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag1_fwhm

double MagAOX::app::tcsInterface::m_mag1_fwhm {0}

protectedinherited

MAG1 raw FWHM.

Definition at line 163 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag1_fwhm_corr

double MagAOX::app::tcsInterface::m_mag1_fwhm_corr {0}

protectedinherited

MAG1 elevation corrected FWHM.

Definition at line 164 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag1_time

int MagAOX::app::tcsInterface::m_mag1_time {0}

protectedinherited

Seconds since midnight of MAG1 measurement.

Definition at line 165 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag2_el

double MagAOX::app::tcsInterface::m_mag2_el {0}

protectedinherited

MAG2 elevation at time of seeing measurement.

Definition at line 167 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag2_fwhm

double MagAOX::app::tcsInterface::m_mag2_fwhm {0}

protectedinherited

MAG2 raw FWHM.

Definition at line 168 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag2_fwhm_corr

double MagAOX::app::tcsInterface::m_mag2_fwhm_corr {0}

protectedinherited

MAG2 elevation corrected FWHM.

Definition at line 169 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_mag2_time

int MagAOX::app::tcsInterface::m_mag2_time {0}

protectedinherited

Seconds since midnight of MAG2 measurement.

Definition at line 170 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getSeeing(), MagAOX::app::tcsInterface::recordTelSee(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_maxInterval

double MagAOX::app::dev::telemeter< tcsInterface >::m_maxInterval

inherited

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

Definition at line 75 of file telemeter.hpp.

◆ m_nRequests

size_t MagAOX::app::tcsInterface::m_nRequests {0}

inherited

Definition at line 354 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_offlCComa_00

float MagAOX::app::tcsInterface::m_offlCComa_00 {1}

inherited

Definition at line 414 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlCComa_01

float MagAOX::app::tcsInterface::m_offlCComa_01 {0}

inherited

Definition at line 415 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlCComa_10

float MagAOX::app::tcsInterface::m_offlCComa_10 {1}

inherited

Definition at line 416 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlCComa_11

float MagAOX::app::tcsInterface::m_offlCComa_11 {0}

inherited

Definition at line 417 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlCFocus_00

float MagAOX::app::tcsInterface::m_offlCFocus_00 {1}

inherited

Definition at line 391 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlF_avgInt

float MagAOX::app::tcsInterface::m_offlF_avgInt {1.0}

inherited

Definition at line 395 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::loadConfigImpl(), MagAOX::app::tcsInterface::offloadThreadExec(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlF_dump

bool MagAOX::app::tcsInterface::m_offlF_dump {false}

inherited

Definition at line 394 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::doFoffload(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlF_enabled

bool MagAOX::app::tcsInterface::m_offlF_enabled {false}

inherited

Definition at line 393 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::doFoffload(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlF_gain

float MagAOX::app::tcsInterface::m_offlF_gain {0.1}

inherited

Definition at line 396 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::doFoffload(), MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlF_thresh

float MagAOX::app::tcsInterface::m_offlF_thresh {0.1}

inherited

Definition at line 397 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::doFoffload(), MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offloadRequests

std::vector<std::vector<float> > MagAOX::app::tcsInterface::m_offloadRequests

inherited

Definition at line 351 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_offloadThread

std::thread MagAOX::app::tcsInterface::m_offloadThread

inherited

The offloading thread.

Definition at line 324 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appShutdown(), and MagAOX::app::tcsInterface::appStartup().

◆ m_offloadThreadID

pid_t MagAOX::app::tcsInterface::m_offloadThreadID {0}

inherited

Offload thread pid.

Definition at line 320 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_offloadThreadInit

bool MagAOX::app::tcsInterface::m_offloadThreadInit {true}

inherited

Initialization flag for the offload thread.

Definition at line 318 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), and MagAOX::app::tcsInterface::offloadThreadExec().

◆ m_offloadThreadProp

pcf::IndiProperty MagAOX::app::tcsInterface::m_offloadThreadProp

inherited

Offload thread INDI property.

Definition at line 322 of file tcsInterface.hpp.

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

◆ m_offlTT_avgInt

float MagAOX::app::tcsInterface::m_offlTT_avgInt {1.0}

inherited

Definition at line 371 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::loadConfigImpl(), MagAOX::app::tcsInterface::offloadThreadExec(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlTT_C_00

float MagAOX::app::tcsInterface::m_offlTT_C_00 {-0.5}

inherited

Definition at line 364 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlTT_C_01

float MagAOX::app::tcsInterface::m_offlTT_C_01 {0}

inherited

Definition at line 365 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlTT_C_10

float MagAOX::app::tcsInterface::m_offlTT_C_10 {0}

inherited

Definition at line 366 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlTT_C_11

float MagAOX::app::tcsInterface::m_offlTT_C_11 {-0.25}

inherited

Definition at line 367 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_offlTT_dump

bool MagAOX::app::tcsInterface::m_offlTT_dump {false}

inherited

Definition at line 370 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::doTToffload(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlTT_enabled

bool MagAOX::app::tcsInterface::m_offlTT_enabled {false}

inherited

Definition at line 369 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::doTToffload(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlTT_gain

float MagAOX::app::tcsInterface::m_offlTT_gain {0.1}

inherited

Definition at line 372 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::doTToffload(), MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_offlTT_thresh

float MagAOX::app::tcsInterface::m_offlTT_thresh {0.1}

inherited

Definition at line 373 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::doTToffload(), MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_pyrNudge_ang

float MagAOX::app::tcsInterface::m_pyrNudge_ang {45.0}

inherited

Definition at line 287 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_pyrNudge_ang0

float MagAOX::app::tcsInterface::m_pyrNudge_ang0 {0.0}

inherited

Definition at line 288 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_pyrNudge_C_00

float MagAOX::app::tcsInterface::m_pyrNudge_C_00 {1}

inherited

Definition at line 281 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::sendPyrNudge().

◆ m_pyrNudge_C_01

float MagAOX::app::tcsInterface::m_pyrNudge_C_01 {0}

inherited

Definition at line 282 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::sendPyrNudge().

◆ m_pyrNudge_C_10

float MagAOX::app::tcsInterface::m_pyrNudge_C_10 {0}

inherited

Definition at line 283 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::sendPyrNudge().

◆ m_pyrNudge_C_11

float MagAOX::app::tcsInterface::m_pyrNudge_C_11 {1}

inherited

Definition at line 284 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl(), and MagAOX::app::tcsInterface::sendPyrNudge().

◆ m_pyrNudge_F_sign

float MagAOX::app::tcsInterface::m_pyrNudge_F_sign {1}

inherited

Definition at line 285 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), and MagAOX::app::tcsInterface::sendPyrNudge().

◆ m_pyrNudge_parity

float MagAOX::app::tcsInterface::m_pyrNudge_parity {-1}

inherited

Definition at line 289 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::loadConfigImpl().

◆ m_readTimeout

unsigned MagAOX::app::dev::ioDevice::m_readTimeout {1000}

inherited

The read timeout [msec].

Definition at line 28 of file ioDevice.hpp.

Referenced by MagAOX::app::rhusbMon::rhusbMon(), MagAOX::app::tcsInterface::acquireFromGuider(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::tcsInterface::getMagTelStatus(), MagAOX::app::flipperCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::tcsInterface::sendFoffload(), MagAOX::app::tcsInterface::sendPyrNudge(), MagAOX::app::tcsInterface::sendTToffload(), MagAOX::app::pi335Ctrl::testConnection(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().

◆ m_seeingInterval

int MagAOX::app::tcsInterface::m_seeingInterval {2}

protectedinherited

Definition at line 70 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getSeeing().

◆ 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_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_sock

tty::netSerial MagAOX::app::tcsInterface::m_sock

protectedinherited

Definition at line 76 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appLogic(), MagAOX::app::tcsInterface::getMagTelStatus(), and MagAOX::app::tcsInterface::sendMagTelCommand().

◆ 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_tambient

double MagAOX::app::tcsInterface::m_tambient {0}

protectedinherited

Dome air temperature, Celsius.

Definition at line 151 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_tcell

double MagAOX::app::tcsInterface::m_tcell {0}

protectedinherited

Primary mirror cell temperature, Celsius.

Definition at line 149 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_tcsMutex

std::mutex MagAOX::app::tcsInterface::m_tcsMutex

protectedinherited

Mutex for locking TCS communications.

Definition at line 74 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::getMagTelStatus(), and MagAOX::app::tcsInterface::sendMagTelCommand().

◆ m_tel

logManagerT MagAOX::app::dev::telemeter< tcsInterface >::m_tel

inherited

Definition at line 73 of file telemeter.hpp.

◆ m_telAM

double MagAOX::app::tcsInterface::m_telAM {0}

protectedinherited

Definition at line 91 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telAz

double MagAOX::app::tcsInterface::m_telAz {0}

protectedinherited

azimuth

Definition at line 104 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telDec

double MagAOX::app::tcsInterface::m_telDec {0}

protectedinherited

Definition at line 88 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telDomeAz

double MagAOX::app::tcsInterface::m_telDomeAz {0}

protectedinherited

dome azimuth

Definition at line 107 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telDomeStat

int MagAOX::app::tcsInterface::m_telDomeStat {0}

protectedinherited

dome status

Definition at line 108 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEl

double MagAOX::app::tcsInterface::m_telEl {0}

protectedinherited

Definition at line 89 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEncH

double MagAOX::app::tcsInterface::m_telEncH {0}

protectedinherited

Definition at line 135 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEncV

double MagAOX::app::tcsInterface::m_telEncV {0}

protectedinherited

Definition at line 137 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEncX

double MagAOX::app::tcsInterface::m_telEncX {0}

protectedinherited

Definition at line 131 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEncY

double MagAOX::app::tcsInterface::m_telEncY {0}

protectedinherited

Definition at line 133 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEncZ

double MagAOX::app::tcsInterface::m_telEncZ {0}

protectedinherited

Definition at line 129 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telEpoch

double MagAOX::app::tcsInterface::m_telEpoch {0}

protectedinherited

Definition at line 86 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telGuiderMoving

int MagAOX::app::tcsInterface::m_telGuiderMoving {0}

protectedinherited

guider moving state

Definition at line 103 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telGuiding

int MagAOX::app::tcsInterface::m_telGuiding {0}

protectedinherited

guider moving state

Definition at line 101 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telHA

double MagAOX::app::tcsInterface::m_telHA {0}

protectedinherited

Definition at line 90 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telPA

double MagAOX::app::tcsInterface::m_telPA {0}

protectedinherited

parallactic angle

Definition at line 106 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telRA

double MagAOX::app::tcsInterface::m_telRA {0}

protectedinherited

Definition at line 87 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telROI

int MagAOX::app::tcsInterface::m_telROI {0}

protectedinherited

The rotator of interest.

Definition at line 99 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telRotOff

double MagAOX::app::tcsInterface::m_telRotOff {0}

protectedinherited

Definition at line 92 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelPos(), MagAOX::app::tcsInterface::recordTelPos(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telSecH

double MagAOX::app::tcsInterface::m_telSecH {0}

protectedinherited

Definition at line 134 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telSecV

double MagAOX::app::tcsInterface::m_telSecV {0}

protectedinherited

Definition at line 136 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telSecX

double MagAOX::app::tcsInterface::m_telSecX {0}

protectedinherited

Definition at line 130 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telSecY

double MagAOX::app::tcsInterface::m_telSecY {0}

protectedinherited

Definition at line 132 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telSecZ

double MagAOX::app::tcsInterface::m_telSecZ {0}

protectedinherited

Definition at line 128 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getVaneData(), MagAOX::app::tcsInterface::recordTelVane(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telSlewing

int MagAOX::app::tcsInterface::m_telSlewing {0}

protectedinherited

slewing state

Definition at line 102 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telST

double MagAOX::app::tcsInterface::m_telST {0}

protectedinherited

Definition at line 81 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelTime(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telTracking

int MagAOX::app::tcsInterface::m_telTracking {0}

protectedinherited

tracking state

Definition at line 100 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_telZd

double MagAOX::app::tcsInterface::m_telZd {0}

protectedinherited

zenith distance

Definition at line 105 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::acquireFromGuider(), MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getTelData(), MagAOX::app::tcsInterface::recordTelData(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_tseccell

double MagAOX::app::tcsInterface::m_tseccell {0}

protectedinherited

Secondary mirror cell temperature, Celsius.

Definition at line 150 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_ttruss

double MagAOX::app::tcsInterface::m_ttruss {0}

protectedinherited

Telescope truss temperature, Celsius.

Definition at line 148 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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_writeTimeout

unsigned MagAOX::app::dev::ioDevice::m_writeTimeout {1000}

inherited

The write timeout [msec].

Definition at line 29 of file ioDevice.hpp.

◆ m_wxdewpoint

double MagAOX::app::tcsInterface::m_wxdewpoint {0}

protectedinherited

Dew point from weather station.

Definition at line 152 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_wxhumid

double MagAOX::app::tcsInterface::m_wxhumid {0}

protectedinherited

Outside humidity, percent.

Definition at line 145 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_wxpres

double MagAOX::app::tcsInterface::m_wxpres {0}

protectedinherited

Outside pressue, millibars.

Definition at line 144 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_wxtemp

double MagAOX::app::tcsInterface::m_wxtemp {0}

protectedinherited

Outside temperature, Celsius.

Definition at line 143 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_wxwdir

double MagAOX::app::tcsInterface::m_wxwdir {0}

protectedinherited

outside wind direction, degrees

Definition at line 147 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ m_wxwind

double MagAOX::app::tcsInterface::m_wxwind {0}

protectedinherited

outside wind intensity, mph

Definition at line 146 of file tcsInterface.hpp.

Referenced by MagAOX::app::tcsInterface::appStartup(), MagAOX::app::tcsInterface::getEnvData(), MagAOX::app::tcsInterface::recordTelEnv(), and MagAOX::app::tcsInterface::updateINDI().

◆ 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/tcsInterface/tests/tcsInterface_test.cpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Pyramid Nudging and Acquisition

Woofer Offloading

Power Management

Logging

Application State

INDI Interface

lab mode

PID Locking

Signal Handling

Privilege Management

Detailed Description

Member Typedef Documentation

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ logManagerT [1/2]

◆ logManagerT [2/2]

Constructor & Destructor Documentation

◆ tcsInterface_test()

Member Function Documentation

◆ _handlerSigTerm()

◆ acquireFromGuider()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ checkConfig()

◆ checkRecordTimes() [1/4]

◆ checkRecordTimes() [2/4]

◆ checkRecordTimes() [3/4]

◆ checkRecordTimes() [4/4]

◆ clearFSMAlert()

◆ configDir()

◆ configLog()

◆ configName()

◆ createINDIFIFOS()

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()

◆ derived()

◆ doFoffload()

◆ doTToffload()

◆ driverCtrlName()

◆ driverInName()

◆ driverOutName()

◆ execute()

◆ getCatData()

◆ getEnvData()

◆ getMagTelStatus()

◆ getSeeing()

◆ getTelData()

◆ getTelPos()

◆ getTelTime()

◆ getVaneData()

◆ handleDefProperty()

◆ handleGetProperties()

◆ handleNewProperty()

◆ handlerSigTerm()

◆ handleSetProperty()

◆ INDI_NEWCALLBACK_DECL() [1/13]

◆ INDI_NEWCALLBACK_DECL() [2/13]

◆ INDI_NEWCALLBACK_DECL() [3/13]

◆ INDI_NEWCALLBACK_DECL() [4/13]

◆ INDI_NEWCALLBACK_DECL() [5/13]

◆ INDI_NEWCALLBACK_DECL() [6/13]

◆ INDI_NEWCALLBACK_DECL() [7/13]

◆ INDI_NEWCALLBACK_DECL() [8/13]

◆ INDI_NEWCALLBACK_DECL() [9/13]

◆ INDI_NEWCALLBACK_DECL() [10/13]

◆ INDI_NEWCALLBACK_DECL() [11/13]

◆ INDI_NEWCALLBACK_DECL() [12/13]