MagAOX::app::siglentSDG Class Reference

#include <siglentSDG.hpp>

Inheritance diagram for MagAOX::app::siglentSDG:

Collaboration diagram for MagAOX::app::siglentSDG:

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

Public Member Functions
	siglentSDG ()
	Default c'tor.
	~siglentSDG () noexcept
	D'tor, declared and defined for noexcept.
virtual void	setupConfig ()
	Setup the configuration system (called by MagAOXApp::setup())
virtual void	loadConfig ()
	load the configuration system results (called by MagAOXApp::setup())
virtual int	appStartup ()
	Startup functions.
virtual int	appLogic ()
	Implementation of the FSM for the Siglent SDG.
virtual int	onPowerOff ()
	Implementation of the on-power-off FSM logic.
virtual int	whilePowerOff ()
	Implementation of the while-powered-off FSM.
virtual int	appShutdown ()
	Do any needed shutdown tasks. Currently nothing in this app.
int	writeRead (std::string &strRead, const std::string &command)
	Write a command to the device and get the response. Not mutex-ed.
int	writeCommand (const std::string &commmand)
	Write a command to the device.
int	queryMDWV (std::string &state, int channel)
	Send the MDWV? query and get the response state.
int	querySWWV (std::string &state, int channel)
	Send the SWWV? query and get the response state.
int	queryBTWV (std::string &state, int channel)
	Send the BTWV? query and get the response state.
int	queryARWV (int &index, int channel)
	Send the ARWV? query and get the response index.
int	queryBSWV (int channel)
	Send the BSWV? query for a channel.
int	querySYNC (bool &sync, int channel)
	Send the SYNC? query for a channel.
int	checkSetup ()
	Check the setup is correct and safe for PI TTM control.
int	normalizeSetup ()
	Normalize the setup, called during connection if checkSetup shows a problem, or on power-up.
int	queryOUTP (int channel)
	Send the OUTP? query for a channel.
int	changeOutp (int channel, const std::string &newOutp)
	Change the output status (on/off) of one channel.
int	changeOutp (int channel, const pcf::IndiProperty &ipRecv)
	Change the output status (on/off) of one channel in response to an INDI property. This locks the mutex.
int	changeFreq (int channel, double newFreq)
	Send a change frequency command to the device.
int	changeFreq (int channel, const pcf::IndiProperty &ipRecv)
	Send a change frequency command to the device in response to an INDI property. This locks the mutex.
int	changeAmp (int channel, double newAmp)
	Send a change amplitude command to the device.
int	changeAmp (int channel, const pcf::IndiProperty &ipRecv)
	Send a change amplitude command to the device in response to an INDI property.
int	changeOfst (int channel, double newOfst)
	Send a change offset command to the device.
int	changeOfst (int channel, const pcf::IndiProperty &ipRecv)
	Send a change offset command to the device in response to an INDI property.
int	changePhse (int channel, double newPhse)
	Send a change phase command to the device.
int	changePhse (int channel, const pcf::IndiProperty &ipRecv)
	Send a change phase command to the device in response to an INDI property.
int	changeWdth (int channel, double newWdth)
	Send a width command to the device.
int	changeWdth (int channel, const pcf::IndiProperty &ipRecv)
	Send a change phase command to the device in response to an INDI property.
int	changeWvtp (int channel, const std::string &newWvtp)
	Send a change wavetype command to the device.
int	changeWvtp (int channel, const pcf::IndiProperty &ipRecv)
	Send a change wavetype command to the device in response to an INDI property.
int	changeSync (int channel, bool newSync)
	Send a change sync command to the device.
int	changeSync (int channel, const pcf::IndiProperty &ipRecv)
	Send a change sync command to the device in response to an INDI property.
virtual void	setDefaults (int argc, char **argv)
	Set the paths for config files.
virtual void	setupBasicConfig ()
	The basic MagAO-X configuration setup method. Should not normally be overridden.
virtual void	loadBasicConfig ()
	The basic MagAO-X configuration processing method. Should not normally be overridden.
virtual void	checkConfig ()
	Check for unused and unrecognized config options and settings.
virtual int	execute ()
	The execute method implementing the standard main loop. Should not normally be overridden.
int	telem (const typename telT::messageT &msg)
	Make a telemetry recording.
int	setupConfig (appConfigurator &config)
	Setup an application configurator for the device section.
int	loadConfig (appConfigurator &config)
	Load the device section from an application configurator.
int	checkRecordTimes (const telT &tel, telTs... tels)
	Check the time of the last record for each telemetry type and make an entry if needed.
int	checkRecordTimes (timespec &ts, const telT &tel, telTs... tels)
	Worker function to actually perform the record time checking logic.
int	checkRecordTimes (timespec &ts)
	Empty function called at the end of the template list.
Telemeter Interface
int	checkRecordTimes ()
int	recordTelem (const telem_fxngen *)
int	recordParams (bool force=false)
Threads
template<class thisPtr , class Function >
int	threadStart (std::thread &thrd, bool &thrdInit, pid_t &tpid, pcf::IndiProperty &thProp, int thrdPrio, const std::string &cpuset, const std::string &thrdName, thisPtr *thrdThis, Function &&thrdStart)
	Start a thread, using this class's privileges to set priority, etc.
Member Accessors
std::string	basePath ()
	Get the.
std::string	configName ()
	Get the config name.
std::string	configDir ()
	Get the config directory.
std::string	configBase ()
	Get the config base file.
std::string	calibDir ()
	Get the calibration directory.
std::string	sysPath ()
	Get the system path.
std::string	secretsPath ()
	Get the secrets path.
std::string	cpusetPath ()
	Get the cpuset path.
unsigned long	loopPause ()
	Get the loop pause time.
int	shutdown ()
	Get the value of the shutdown flag.
std::string	driverInName ()
	Get the INDI input FIFO file name.
std::string	driverOutName ()
	Get the INDI output FIFO file name.
std::string	driverCtrlName ()
	Get the INDI control FIFO file name.

Public Attributes
logManagerT	m_tel
double	m_maxInterval
	The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.

Protected Attributes
tty::telnetConn	m_telnetConn
	The telnet connection manager.
std::string	m_waveform
uint8_t	m_C1outp {0}
	std::string m_clock; ///<INTernal or EXTernal
double	m_C1frequency {0}
	The output frequency of channel 1.
double	m_C1vpp {0}
	The peak-2-peak voltage of channel 1.
double	m_C1vppDefault {0}
	default value for vpp of channel 1
double	m_C1ofst {0}
	The offset voltage of channel 1.
double	m_C1phse {0}
	The phase of channel 1 (SINE only)
double	m_C1wdth {0}
	The width of channel 1 (PULSE only)
std::string	m_C1wvtp
	The wave type of channel 1.
double	m_C1ampMax {10.0}
	The maximum voltage output for channel 1.
uint8_t	m_C2outp {0}
	The output status channel 2.
double	m_C2frequency {0}
	The output frequency of channel 2.
double	m_C2vpp {0}
	The peak-2-peak voltage of channel 2.
double	m_C2vppDefault {0}
	default value for vpp of channel 2
double	m_C2ofst {0}
	The offset voltage of channel 2.
double	m_C2phse {0}
	The phase of channel 2 (SINE only)
double	m_C2wdth {0}
	The width of channel 2 (PULSE only)
std::string	m_C2wvtp
	The wave type of channel 2.
double	m_C2ampMax {10.0}
	The maximum voltage output for channel 2.
double	m_C1frequency_tgt {-1}
double	m_C1vpp_tgt {-1}
double	m_C2frequency_tgt {-1}
double	m_C2vpp_tgt {-1}
bool	m_C1sync {false}
bool	m_C2sync {false}
std::string	m_basePath
	The base path of the MagAO-X system.
std::string	m_configName
	The name of the configuration file (minus .conf).
std::string	m_configDir
	The path to configuration files for MagAOX.
std::string	m_configBase
	The name of a base config class for this app (minus .conf).
std::string	m_calibDir
	The path to calibration files for MagAOX.
std::string	m_sysPath
	The path to the system directory, for PID file, etc.
std::string	m_secretsPath
	Path to the secrets directory, where passwords, etc, are stored.
std::string	m_cpusetPath { MAGAOX_cpusetPath }
	Path to the cpusets mount.
unsigned long	m_loopPause { MAGAOX_default_loopPause }
int	m_shutdown { 0 }
	Flag to signal it's time to shutdown. When not 0, the main loop exits.
Configurable Parameters
std::string	m_deviceAddr
	The device address.
std::string	m_devicePort
	The device port.
double	m_bootDelay {10}
	Time in seconds it takes the device to boot.
int	m_writeTimeOut {10000}
	The timeout for writing to the device [msec].
int	m_readTimeOut {10000}
	The timeout for reading from the device [msec].
double	m_C1setVoltage {5.0}
	the set position voltage of Ch. 1.
double	m_C2setVoltage {5.0}
	the set position voltage of Ch. 2.
bool	m_C1outpOn {false}
bool	m_C2outpOn {false}

Private Member Functions
int	clearFSMAlert ()
	Clear the FSM alert state.
siglentSDG &	derived ()
	Access the derived class.

Private Attributes
std::vector< double >	m_ampMax = {1.2801, 1.2801, 1.0201}
std::vector< double >	m_maxFreq = {0.0, 2000, 3000}
bool	m_poweredOn {false}
double	m_powerOnCounter {0}
	Counts the number of loops since power-on, used to control logging of connect failures.

Static Private Attributes
static constexpr double	cs_MaxOfst = 10.0
static constexpr double	cs_MaxVolts = 10.0

Friends
class	siglentSDG_test
class	dev::telemeter< siglentSDG >

Signal Handling
libMagAOX/logger/types/software_log.hpp
static MagAOXApp *	m_self = nullptr
int	setSigTermHandler ()
	Sets the handler for SIGTERM, SIGQUIT, and SIGINT.
void	handlerSigTerm (int signum, siginfo_t *siginf, void *ucont)
	Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.
static void	_handlerSigTerm (int signum, siginfo_t *siginf, void *ucont)
	The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

Privilege Management
uid_t	m_euidReal
	The real user id of the proces (i.e. the lower privileged id of the user)
uid_t	m_euidCalled
uid_t	m_suid
	The save-set user id of the process.
int	setEuidCalled ()
	Set the effective user ID to the called value, i.e. the highest possible.
int	setEuidReal ()
	Set the effective user ID to the real value, i.e. the file owner.

Application State
stateCodes::stateCodeT	m_state { stateCodes::UNINITIALIZED }
bool	m_stateAlert { false }
bool	m_gitAlert { false }
int	m_stateLogged { 0 }
stateCodes::stateCodeT	state ()
	Get the current state code.
void	state (const stateCodes::stateCodeT &s, bool stateAlert=false)
	Set the current state code.
bool	stateAlert ()
	Get the value of the state alert flag.
bool	gitAlert ()
	Get the value of the git alert flag.
int	stateLogged ()
	Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

INDI
pcf::IndiProperty	m_indiP_status
pcf::IndiProperty	m_indiP_C1outp
pcf::IndiProperty	m_indiP_C1wvtp
pcf::IndiProperty	m_indiP_C1freq
pcf::IndiProperty	m_indiP_C1peri
pcf::IndiProperty	m_indiP_C1amp
pcf::IndiProperty	m_indiP_C1ampvrms
pcf::IndiProperty	m_indiP_C1ofst
pcf::IndiProperty	m_indiP_C1hlev
pcf::IndiProperty	m_indiP_C1llev
pcf::IndiProperty	m_indiP_C1phse
pcf::IndiProperty	m_indiP_C1wdth
pcf::IndiProperty	m_indiP_C1sync
pcf::IndiProperty	m_indiP_C2outp
pcf::IndiProperty	m_indiP_C2wvtp
pcf::IndiProperty	m_indiP_C2freq
pcf::IndiProperty	m_indiP_C2peri
pcf::IndiProperty	m_indiP_C2amp
pcf::IndiProperty	m_indiP_C2ampvrms
pcf::IndiProperty	m_indiP_C2ofst
pcf::IndiProperty	m_indiP_C2hlev
pcf::IndiProperty	m_indiP_C2llev
pcf::IndiProperty	m_indiP_C2phse
pcf::IndiProperty	m_indiP_C2wdth
pcf::IndiProperty	m_indiP_C2sync
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1outp)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1freq)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1amp)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1ofst)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1phse)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1wdth)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1wvtp)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C1sync)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2outp)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2freq)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2amp)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2ofst)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2phse)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2wdth)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2wvtp)
	INDI_NEWCALLBACK_DECL (siglentSDG, m_indiP_C2sync)

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

INDI Interface
For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property.
std::unordered_map< std::string, indiCallBack >	m_indiNewCallBacks
	Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.
std::unordered_map< std::string, indiCallBack >	m_indiSetCallBacks
	Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.
bool	m_allDefsReceived { false }
	Flag indicating that all registered Set properties have been updated since last Get.
std::string	m_driverInName
	Full path name of the INDI driver input FIFO.
std::string	m_driverOutName
	Full path name of the INDI driver output FIFO.
std::string	m_driverCtrlName
	Full path name of the INDI driver control FIFO.
pcf::IndiProperty	m_indiP_state
	indi Property to report the application state.
pcf::IndiProperty	m_indiP_clearFSMAlert
	indi Property to clear an FSM alert.
int	createStandardIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Text property with target and current elements.
int	createROIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &elName, const std::string &propLabel="", const std::string &propGroup="", const std::string &elLabel="")
	Create a standard ReadOnly INDI Text property, with at least one element.
template<typename T >
int	createStandardIndiNumber (pcf::IndiProperty &prop, const std::string &name, const T &min, const T &max, const T &step, const std::string &format, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Number property with target and current elements.
int	createROIndiNumber (pcf::IndiProperty &prop, const std::string &propName, const std::string &propLabel="", const std::string &propGroup="")
	Create a ReadOnly INDI Number property.
int	createStandardIndiToggleSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single toggle element.
int	createStandardIndiRequestSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single request element.
int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::vector< std::string > &elementLabels, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.
int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::string &label="", const std::string &group="")
int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop)
	Register an INDI property which is read only.
int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState)
	Register an INDI property which is read only.
int	registerIndiPropertyNew (pcf::IndiProperty &prop, int(*)(void *, const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.
int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, int(*)(void *, const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.
int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, const pcf::IndiProperty::SwitchRuleType &propRule, int(*)(void *, const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for, with a switch rule.
int	registerIndiPropertySet (pcf::IndiProperty &prop, const std::string &devName, const std::string &propName, int(*)(void *, const pcf::IndiProperty &))
	Register an INDI property which is monitored for updates from others.
void	resetIndiSetPropertyRetry (indiCallBack &callBack)
	Reset retry tracking for a monitored INDI Set-property subscription.
bool	indiSetPropertyShouldRequest (const indiCallBack &callBack, bool all, const std::chrono::steady_clock::time_point &now) const
	Determine whether an unresolved Set-property subscription should be requested now.
void	noteIndiSetPropertyRequested (indiCallBack &callBack, const std::chrono::steady_clock::time_point &now)
	Update retry tracking after sending a GetProperties request for a monitored Set-property.
void	sendGetPropertySetList (bool all=false)
void	handleDefProperty (const pcf::IndiProperty &ipRecv)
	Handler for the DEF INDI properties notification.
void	handleGetProperties (const pcf::IndiProperty &ipRecv)
	Handler for the get INDI properties request.
void	handleNewProperty (const pcf::IndiProperty &ipRecv)
	Handler for the new INDI property request.
void	handleSetProperty (const pcf::IndiProperty &ipRecv)
	Handler for the set INDI property request.
typedef std::pair< std::string, indiCallBack >	callBackValueType
	Value type of the indiCallBack map.
typedef std::unordered_map< std::string, indiCallBack >::iterator	callBackIterator
	Iterator type of the indiCallBack map.
typedef std::pair< callBackIterator, bool >	callBackInsertResult
	Return type of insert on the indiCallBack map.
static constexpr bool	m_useINDI = _useINDI
	Flag controlling whether INDI is used. If false, then no INDI code executes.
indiDriver< MagAOXApp > *	m_indiDriver { nullptr }
	The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.
std::mutex	m_indiMutex
	Mutex for locking INDI communications.
std::mutex	m_indiCallBackMutex
	Mutex for locking INDI callback maps and per-entry callback state.
static int	st_newCallBack_clearFSMAlert (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for requesting to clear the FSM alert.
int	createINDIFIFOS ()
	Create the INDI FIFOs.
int	startINDI ()
	Start INDI Communications.
template<typename T >
void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const T &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.
void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const char *newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.
template<typename T >
void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.
template<typename T >
void	updateIfChanged (pcf::IndiProperty &p, const std::vector< std::string > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.
void	updateSwitchIfChanged (pcf::IndiProperty &p, const std::string &el, const pcf::IndiElement::SwitchStateType &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI switch element value if it has changed.
template<typename T >
void	updatesIfChanged (pcf::IndiProperty &p, const std::vector< const char * > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)
template<typename T >
int	indiTargetUpdate (pcf::IndiProperty &localProperty, T &localTarget, const pcf::IndiProperty &remoteProperty, bool setBusy=true)
	Get the target element value from an new property.
template<typename T >
int	sendNewProperty (const pcf::IndiProperty &ipSend, const std::string &el, const T &newVal)
	Send a newProperty command to another device (using the INDI Client interface)
int	sendNewProperty (const pcf::IndiProperty &ipSend)
	Send a newProperty command to another device (using the INDI Client interface)
int	sendNewStandardIndiToggle (const std::string &device, const std::string &property, bool onoff)
	Send a new property commmand for a standard toggle switch.
int	newCallBack_clearFSMAlert (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the FSM Alert Clear request.

Power Management
For devices which have remote power management (e.g. from one of the PDUs) we implement a standard power state monitoring and management component for the FSM. This needs to be enabled in the derived app constructor. To stay enabled, m_powerDevice and m_powerChannel must be not empty strings after the configuration. These could be set in the derived app defaults. If power management is enabled, then while power is off, appLogic will not be called. Instead a parrallel set of virtual functions is called, onPowerOff (to allow apps to perform cleanup) and whilePowerOff (to allow apps to keep variables updated, etc). Note that these could merely call appLogic if desired.
bool	m_powerMgtEnabled { false }
std::string	m_powerDevice
	The INDI device name of the power controller.
std::string	m_powerChannel
	The INDI property name of the channel controlling this device's power.
std::string	m_powerElement { "state" }
	The INDI element name to monitor for this device's power state.
std::string	m_powerTargetElement { "target" }
	The INDI element name to monitor for this device's power state.
unsigned long	m_powerOnWait { 55 }
	Default time in sec to wait for device to boot after power on.
int	m_powerState { -1 }
	Current power state, 1=On, 0=Off, -1=Unk.
int	m_powerTargetState { -1 }
	Current target power state, 1=On, 0=Off, -1=Unk.
pcf::IndiProperty	m_indiP_powerChannel
	INDI property used to communicate power state.
int	powerState ()
	Returns the current power state.
int	powerStateTarget ()
	Returns the target power state.
	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)
bool	powerOnWaitElapsed ()
	This method tests whether the power on wait time has elapsed.

Logging
void	logMessage (bufferPtrT &b)
	Handle a log message from the logging system.
static logManagerT	m_log
template<typename logT , int retval = 0>
static int	log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.
template<typename logT , int retval = 0>
static int	log (logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.
static void	configLog (const std::string &name, const int &code, const std::string &value, const std::string &source)
	Callback for config system logging.

Detailed Description

MagAO-X application to control a Siglent SDG series function generator

Todo:

need to recognize signals in tty polls and not return errors, etc.

need to implement an onDisconnect() to update values to unknown indicators.

need a frequency-dependent max amp facility.

convert to ioDevice

need telnet device, with optional username/password.

Definition at line 26 of file siglentSDG.hpp.

Member Typedef Documentation

callBackInsertResult

template<bool _useINDI = true>

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

inherited

Return type of insert on the indiCallBack map.

Definition at line 701 of file MagAOXApp.hpp.

callBackIterator

template<bool _useINDI = true>

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

inherited

Iterator type of the indiCallBack map.

Definition at line 698 of file MagAOXApp.hpp.

callBackValueType

template<bool _useINDI = true>

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

inherited

Value type of the indiCallBack map.

Definition at line 695 of file MagAOXApp.hpp.

logManagerT [1/2]

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

inherited

The log manager type.

Definition at line 79 of file telemeter.hpp.

logManagerT [2/2]

template<bool _useINDI = true>

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

inherited

The log manager type.

Definition at line 185 of file MagAOXApp.hpp.

verboseT [1/2]

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

inherited

Definition at line 76 of file telemeter.hpp.

verboseT [2/2]

template<bool _useINDI = true>

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

inherited

Definition at line 182 of file MagAOXApp.hpp.

Constructor & Destructor Documentation

siglentSDG()

MagAOX::app::siglentSDG::siglentSDG ( )

inline

Default c'tor.

Definition at line 447 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::m_powerMgtEnabled, MagAOX::tty::telnetConn::m_prompt, and m_telnetConn.

~siglentSDG()

MagAOX::app::siglentSDG::~siglentSDG ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 111 of file siglentSDG.hpp.

Member Function Documentation

_handlerSigTerm()

template<bool _useINDI>

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

staticprivateinherited

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

Parameters

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

Definition at line 2219 of file MagAOXApp.hpp.

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

appLogic()

int MagAOX::app::siglentSDG::appLogic ( )

inlinevirtual

Implementation of the FSM for the Siglent SDG.

Todo:

the connection process in siglentSDG is a total hack. Figure out why this is needed to clear the channel, especially on a post-poweroff/on reconnect.

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

Definition at line 639 of file siglentSDG.hpp.

References checkSetup(), MagAOX::app::stateCodes::codeText(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::tty::telnetConn::connect(), MagAOX::app::stateCodes::CONNECTED, MagAOX::app::stateCodes::ERROR, INDI_IDLE, INDI_OK, MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_CRITICAL, flatlogs::logPrio::LOG_NOTICE, m_bootDelay, m_C1outp, m_C1sync, m_C2outp, m_C2sync, m_deviceAddr, m_devicePort, MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, m_indiP_C1sync, m_indiP_C2sync, MagAOX::app::MagAOXApp< _useINDI >::m_loopPause, m_poweredOn, m_powerOnCounter, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_readTimeOut, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::tty::telnetConn::m_strRead, m_telnetConn, m_writeTimeOut, MagAOX::tty::telnetConn::noLogin(), normalizeSetup(), MagAOX::app::stateCodes::NOTCONNECTED, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::POWERON, queryBSWV(), queryOUTP(), MagAOX::tty::telnetConn::read(), MagAOX::app::stateCodes::READY, recordParams(), SDG_PARSEERR_WVTP, MagAOX::app::MagAOXApp< _useINDI >::state(), MagAOX::app::MagAOXApp< _useINDI >::stateLogged(), MagAOX::app::MagAOXApp< _useINDI >::updateSwitchIfChanged(), and MagAOX::tty::telnetConn::write().

appShutdown()

int MagAOX::app::siglentSDG::appShutdown ( )

inlinevirtual

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

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

Definition at line 1014 of file siglentSDG.hpp.

References MagAOX::app::dev::telemeter< derivedT >::appShutdown().

appStartup()

int MagAOX::app::siglentSDG::appStartup ( )

inlinevirtual

Startup functions.

Setsup the INDI vars.

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

Definition at line 507 of file siglentSDG.hpp.

References CREATE_REG_INDI_NEW_NUMBERF, MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiToggleSw(), MagAOX::app::MagAOXApp< _useINDI >::log(), m_indiP_C1amp, m_indiP_C1ampvrms, m_indiP_C1freq, m_indiP_C1hlev, m_indiP_C1llev, m_indiP_C1ofst, m_indiP_C1outp, m_indiP_C1peri, m_indiP_C1phse, m_indiP_C1sync, m_indiP_C1wdth, m_indiP_C1wvtp, m_indiP_C2amp, m_indiP_C2ampvrms, m_indiP_C2freq, m_indiP_C2hlev, m_indiP_C2llev, m_indiP_C2ofst, m_indiP_C2outp, m_indiP_C2peri, m_indiP_C2phse, m_indiP_C2sync, m_indiP_C2wdth, m_indiP_C2wvtp, m_indiP_status, m_waveform, REG_INDI_NEWPROP, REG_INDI_NEWPROP_NOCB, and MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew().

basePath()

template<bool _useINDI>

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

inherited

Get the.

Returns

the value of m_ *

Definition at line 3976 of file MagAOXApp.hpp.

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

calibDir()

template<bool _useINDI>

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

inherited

Get the calibration directory.

Returns

the value of m_calibDir

Definition at line 4000 of file MagAOXApp.hpp.

changeAmp() [1/2]

int MagAOX::app::siglentSDG::changeAmp ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change amplitude command to the device in response to an INDI property.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new amplitude [V p2p]

Definition at line 2035 of file siglentSDG.hpp.

References changeAmp(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeAmp() [2/2]

int MagAOX::app::siglentSDG::changeAmp ( int  channel, double  newAmp  )

inline

Send a change amplitude command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newAmp	The requested new amplitude [V p2p]

Definition at line 1942 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, flatlogs::logPrio::LOG_WARNING, m_ampMax, m_C1ampMax, m_C1frequency_tgt, m_C1ofst, m_C1vpp_tgt, m_C2ampMax, m_C2frequency_tgt, m_C2ofst, m_C2vpp_tgt, m_maxFreq, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_waveform, MagAOX::app::makeCommand(), recordParams(), and writeCommand().

Referenced by changeAmp(), and normalizeSetup().

changeFreq() [1/2]

int MagAOX::app::siglentSDG::changeFreq ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change frequency command to the device in response to an INDI property. This locks the mutex.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new frequency [Hz]

Definition at line 1909 of file siglentSDG.hpp.

References changeFreq(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeFreq() [2/2]

int MagAOX::app::siglentSDG::changeFreq ( int  channel, double  newFreq  )

inline

Send a change frequency command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newFreq	The requested new frequency [Hz]

Definition at line 1819 of file siglentSDG.hpp.

References MagAOX::app::autoPulseWidthFromFrequency(), changeWdth(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, flatlogs::logPrio::LOG_WARNING, m_ampMax, m_C1frequency_tgt, m_C1vpp_tgt, m_C2frequency_tgt, m_C2vpp_tgt, m_maxFreq, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_waveform, MagAOX::app::makeCommand(), recordParams(), and writeCommand().

Referenced by changeFreq(), and normalizeSetup().

changeOfst() [1/2]

int MagAOX::app::siglentSDG::changeOfst ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change offset command to the device in response to an INDI property.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new offset [V p2p]

Definition at line 2123 of file siglentSDG.hpp.

References changeOfst(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeOfst() [2/2]

int MagAOX::app::siglentSDG::changeOfst ( int  channel, double  newOfst  )

inline

Send a change offset command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newOfst	The requested new offset [V p2p]

Definition at line 2069 of file siglentSDG.hpp.

References cs_MaxOfst, MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, flatlogs::logPrio::LOG_WARNING, m_C1ampMax, m_C1vpp, m_C2ampMax, m_C2vpp, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::makeCommand(), and writeCommand().

Referenced by changeOfst(), and normalizeSetup().

changeOutp() [1/2]

int MagAOX::app::siglentSDG::changeOutp ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Change the output status (on/off) of one channel in response to an INDI property. This locks the mutex.

Returns

0 on success

-1 on error.

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested output state [On/Off]

Definition at line 1785 of file siglentSDG.hpp.

References changeOutp(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeOutp() [2/2]

int MagAOX::app::siglentSDG::changeOutp ( int  channel, const std::string &  newOutp  )

inline

Change the output status (on/off) of one channel.

Returns

0 on success

-1 on error.

Parameters

[in]	channel	the channel to send the command to.
[in]	newOutp	The requested output state [On/Off]

Definition at line 1742 of file siglentSDG.hpp.

References changeSync(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::makeCommand(), recordParams(), and writeCommand().

Referenced by changeOutp(), and normalizeSetup().

changePhse() [1/2]

int MagAOX::app::siglentSDG::changePhse ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change phase command to the device in response to an INDI property.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new phase [deg]

Definition at line 2185 of file siglentSDG.hpp.

References changePhse(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changePhse() [2/2]

int MagAOX::app::siglentSDG::changePhse ( int  channel, double  newPhse  )

inline

Send a change phase command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newPhse	The requested new phase [deg]

Definition at line 2157 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, flatlogs::logPrio::LOG_WARNING, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_waveform, MagAOX::app::makeCommand(), and writeCommand().

Referenced by changePhse(), and normalizeSetup().

changeSync() [1/2]

int MagAOX::app::siglentSDG::changeSync ( int  channel, bool  newSync  )

inline

Send a change sync command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newSync	The requested new sync state

Definition at line 2339 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::makeCommand(), recordParams(), and writeCommand().

Referenced by changeOutp(), and changeSync().

changeSync() [2/2]

int MagAOX::app::siglentSDG::changeSync ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change sync command to the device in response to an INDI property.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new sync state

Definition at line 2368 of file siglentSDG.hpp.

References changeSync(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeWdth() [1/2]

int MagAOX::app::siglentSDG::changeWdth ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change phase command to the device in response to an INDI property.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new width [s]

Definition at line 2247 of file siglentSDG.hpp.

References changeWdth(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeWdth() [2/2]

int MagAOX::app::siglentSDG::changeWdth ( int  channel, double  newWdth  )

inline

Send a width command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newWdth	The requested new width [s]

Definition at line 2219 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, flatlogs::logPrio::LOG_WARNING, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_waveform, MagAOX::app::makeCommand(), and writeCommand().

Referenced by changeFreq(), changeWdth(), and normalizeSetup().

changeWvtp() [1/2]

int MagAOX::app::siglentSDG::changeWvtp ( int  channel, const pcf::IndiProperty &  ipRecv  )

inline

Send a change wavetype command to the device in response to an INDI property.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	ipRecv	INDI property containing the requested new wavetype

Definition at line 2305 of file siglentSDG.hpp.

References changeWvtp(), MagAOX::app::stateCodes::CONFIGURING, MagAOX::app::ipRecv, MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::READY, and MagAOX::app::MagAOXApp< _useINDI >::state().

changeWvtp() [2/2]

int MagAOX::app::siglentSDG::changeWvtp ( int  channel, const std::string &  newWvtp  )

inline

Send a change wavetype command to the device.

Returns

0 on success

-1 on error

Parameters

[in]	channel	the channel to send the command to.
[in]	newWvtp	The requested new wavetype

Definition at line 2282 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_NOTICE, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::makeCommand(), and writeCommand().

Referenced by changeWvtp(), and normalizeSetup().

checkConfig()

template<bool _useINDI>

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

virtualinherited

Check for unused and unrecognized config options and settings.

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

Definition at line 1658 of file MagAOXApp.hpp.

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

checkRecordTimes() [1/4]

int MagAOX::app::siglentSDG::checkRecordTimes ( )

inline

Definition at line 2522 of file siglentSDG.hpp.

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

checkRecordTimes() [2/4]

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

inherited

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

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

Returns

0 on succcess

-1 on error

Parameters

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

Definition at line 156 of file telemeter.hpp.

checkRecordTimes() [3/4]

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

inherited

Empty function called at the end of the template list.

Returns

0 on succcess

-1 on error

Parameters

[in]

ts

[unused] the timestamp that records are compared to

Definition at line 177 of file telemeter.hpp.

checkRecordTimes() [4/4]

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

inherited

Worker function to actually perform the record time checking logic.

Recursively calls itself until the variadic template list is exhausted.

Returns

0 on succcess

-1 on error

Parameters

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

Definition at line 167 of file telemeter.hpp.

checkSetup()

int MagAOX::app::siglentSDG::checkSetup ( )

inline

Check the setup is correct and safe for PI TTM control.

Returns

0 if the fxn gen is setup for safe operation

1 if a non-normal setup is detected.

-1 on an error, e.g. comms or parsing.

Definition at line 1508 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), m_C1sync, m_C2sync, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, queryARWV(), queryBTWV(), queryMDWV(), querySWWV(), querySYNC(), and MagAOX::app::MagAOXApp< _useINDI >::state().

Referenced by appLogic().

clearFSMAlert()

template<bool _useINDI>

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

privateinherited

Clear the FSM alert state.

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

Definition at line 2692 of file MagAOXApp.hpp.

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

configBase()

template<bool _useINDI>

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

inherited

Get the config base file.

Returns

the value of m_confgBase

Definition at line 3994 of file MagAOXApp.hpp.

configDir()

template<bool _useINDI>

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

inherited

Get the config directory.

Returns

the current value of m_configDir

Definition at line 3988 of file MagAOXApp.hpp.

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

configLog()

template<bool _useINDI>

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

staticprotectedinherited

Callback for config system logging.

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

Parameters

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

Definition at line 2139 of file MagAOXApp.hpp.

configName()

template<bool _useINDI>

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

inherited

Get the config name.

Returns

the current value of m_configName

Definition at line 3982 of file MagAOXApp.hpp.

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

cpusetPath()

template<bool _useINDI>

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

inherited

Get the cpuset path.

Returns

the value of m_cpusetPath

Definition at line 4018 of file MagAOXApp.hpp.

createINDIFIFOS()

template<bool _useINDI>

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

protectedinherited

Create the INDI FIFOs.

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

Todo:

make driver FIFO path full configurable.

Definition at line 3229 of file MagAOXApp.hpp.

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

createROIndiNumber()

template<bool _useINDI>

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

inherited

Create a ReadOnly INDI Number property.

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2847 of file MagAOXApp.hpp.

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

createROIndiText()

template<bool _useINDI>

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

inherited

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

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2764 of file MagAOXApp.hpp.

createStandardIndiNumber()

template<bool _useINDI>

template<typename T >

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

inherited

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

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2800 of file MagAOXApp.hpp.

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

createStandardIndiRequestSw()

template<bool _useINDI>

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

inherited

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

This switch is intended to function like a momentary switch.

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2903 of file MagAOXApp.hpp.

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

createStandardIndiSelectionSw() [1/2]

template<bool _useINDI>

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

inherited

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

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2978 of file MagAOXApp.hpp.

createStandardIndiSelectionSw() [2/2]

template<bool _useINDI>

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

inherited

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

This switch is intended to function like drop down menu.

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2933 of file MagAOXApp.hpp.

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

createStandardIndiText()

template<bool _useINDI>

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

inherited

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

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2736 of file MagAOXApp.hpp.

createStandardIndiToggleSw()

template<bool _useINDI>

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

inherited

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

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

Returns

0 on success

-1 on error

Parameters

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

Definition at line 2873 of file MagAOXApp.hpp.

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

derived()

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

inlineprivateinherited

Access the derived class.

Definition at line 181 of file telemeter.hpp.

driverCtrlName()

template<bool _useINDI>

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

inherited

Get the INDI control FIFO file name.

Returns

the current value of m_driverCtrlName

Definition at line 4048 of file MagAOXApp.hpp.

driverInName()

template<bool _useINDI>

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

inherited

Get the INDI input FIFO file name.

Returns

the current value of m_driverInName

Definition at line 4036 of file MagAOXApp.hpp.

driverOutName()

template<bool _useINDI>

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

inherited

Get the INDI output FIFO file name.

Returns

the current value of m_driverOutName

Definition at line 4042 of file MagAOXApp.hpp.

execute()

template<bool _useINDI>

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

virtualinherited

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

Performs final startup steps. That is:

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

Errors in the above steps will cause a process exit.

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

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

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

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

Todo:

Need a heartbeat update here.

Definition at line 1725 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_CRITICAL.

gitAlert()

template<bool _useINDI>

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

inherited

Get the value of the git alert flag.

Returns

the current value of m_gitAlert

Definition at line 2671 of file MagAOXApp.hpp.

handleDefProperty()

template<bool _useINDI>

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

inherited

Handler for the DEF INDI properties notification.

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

Parameters

[in]

ipRecv

The property being sent.

Definition at line 3437 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv.

handleGetProperties()

template<bool _useINDI>

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

inherited

Handler for the get INDI properties request.

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

Parameters

[in]

ipRecv

The property being requested.

Definition at line 3443 of file MagAOXApp.hpp.

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

handleNewProperty()

template<bool _useINDI>

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

inherited

Handler for the new INDI property request.

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

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

Todo:

handle errors, are they FATAL?

Parameters

[in]

ipRecv

The property being changed.

Definition at line 3530 of file MagAOXApp.hpp.

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

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

handlerSigTerm()

template<bool _useINDI>

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

privateinherited

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

Parameters

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

Definition at line 2225 of file MagAOXApp.hpp.

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

handleSetProperty()

template<bool _useINDI>

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

inherited

Handler for the set INDI property request.

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

Todo:

handle errors, are they FATAL?

Todo:

log an error here because callBack should not be null

Todo:

log invalid SetProperty request.

Parameters

[in]

ipRecv

The property being changed.

Definition at line 3562 of file MagAOXApp.hpp.

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

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

INDI_NEWCALLBACK_DECL() [1/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1amp
	)

INDI_NEWCALLBACK_DECL() [2/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1freq
	)

INDI_NEWCALLBACK_DECL() [3/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1ofst
	)

INDI_NEWCALLBACK_DECL() [4/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1outp
	)

INDI_NEWCALLBACK_DECL() [5/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1phse
	)

INDI_NEWCALLBACK_DECL() [6/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1sync
	)

INDI_NEWCALLBACK_DECL() [7/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1wdth
	)

INDI_NEWCALLBACK_DECL() [8/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C1wvtp
	)

INDI_NEWCALLBACK_DECL() [9/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2amp
	)

INDI_NEWCALLBACK_DECL() [10/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2freq
	)

INDI_NEWCALLBACK_DECL() [11/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2ofst
	)

INDI_NEWCALLBACK_DECL() [12/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2outp
	)

INDI_NEWCALLBACK_DECL() [13/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2phse
	)

INDI_NEWCALLBACK_DECL() [14/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2sync
	)

INDI_NEWCALLBACK_DECL() [15/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2wdth
	)

INDI_NEWCALLBACK_DECL() [16/16]

MagAOX::app::siglentSDG::INDI_NEWCALLBACK_DECL	(	siglentSDG	,
		m_indiP_C2wvtp
	)

INDI_SETCALLBACK_DECL()

template<bool _useINDI = true>

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

inherited

indiSetPropertyShouldRequest()

template<bool _useINDI>

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

inlineinherited

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

Parameters

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

Definition at line 3182 of file MagAOXApp.hpp.

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

indiTargetUpdate()

template<bool _useINDI>

template<typename T >

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

protectedinherited

Get the target element value from an new property.

Returns

0 on success

-1 on error

Parameters

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

Definition at line 3707 of file MagAOXApp.hpp.

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

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

loadBasicConfig()

template<bool _useINDI>

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

virtualinherited

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

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

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

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

Definition at line 1595 of file MagAOXApp.hpp.

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

loadConfig() [1/2]

void MagAOX::app::siglentSDG::loadConfig ( )

inlinevirtual

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

config(m_clock, "fxngen.clock");

Definition at line 481 of file siglentSDG.hpp.

References MagAOX::app::dev::telemeter< derivedT >::loadConfig(), m_C1ampMax, m_C1ofst, m_C1outpOn, m_C1vppDefault, m_C2ampMax, m_C2ofst, m_C2outpOn, m_C2vppDefault, m_deviceAddr, m_devicePort, m_readTimeOut, m_waveform, and m_writeTimeOut.

loadConfig() [2/2]

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

inherited

Load the device section from an application configurator.

Returns

0 on success

-1 on error (nothing implemented yet)

Parameters

[in]

config

an application configuration from which to load values

Definition at line 120 of file telemeter.hpp.

lockPID()

template<bool _useINDI>

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

protectedinherited

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

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

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

Returns

0 on success.

-1 on any error, including creating the PID file or if this app is already running.

Definition at line 2296 of file MagAOXApp.hpp.

log() [1/2]

template<bool _useINDI>

template<typename logT , int retval>

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

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

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

Parameters

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

Definition at line 2081 of file MagAOXApp.hpp.

References MagAOX::app::msg.

Referenced by MagAOX::app::picoMotorCtrl::motorChannel::motorChannel(), MagAOX::app::zylaCtrl::zylaCtrl(), MagAOX::app::picamCtrl::~picamCtrl(), MagAOX::app::streamWriter::~streamWriter(), MagAOX::app::zylaCtrl::~zylaCtrl(), dbIngest.dbIngest::_ensure_connected(), visxCtrl.core.visxCtrl::_gather_metadata(), MagAOX::app::streamWriter::_handlerSigSegv(), visxCtrl.core.visxCtrl::_init_properties(), MagAOX::app::qhyCtrl::AbortAcquisition(), MagAOX::app::andorCtrl::acquireAndCheckValid(), MagAOX::app::baslerCtrl::acquireAndCheckValid(), MagAOX::app::cameraSim::acquireAndCheckValid(), MagAOX::app::cred2Ctrl::acquireAndCheckValid(), MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::picamCtrl::acquireAndCheckValid(), MagAOX::app::zylaCtrl::acquireAndCheckValid(), MagAOX::app::streamWriter::allocate_circbufs(), MagAOX::app::streamWriter::allocate_xrif(), MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::baslerCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::cred2Ctrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::mzmqClient::appLogic(), MagAOX::app::mzmqServer::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::qhyCtrl::appLogic(), appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::streamWriter::appLogic(), MagAOX::app::sysMonitor::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::andorCtrl::appShutdown(), MagAOX::app::baslerCtrl::appShutdown(), MagAOX::app::hsfwCtrl::appShutdown(), MagAOX::app::mzmqClient::appShutdown(), MagAOX::app::mzmqServer::appShutdown(), MagAOX::app::picamCtrl::appShutdown(), MagAOX::app::picoMotorCtrl::appShutdown(), MagAOX::app::qhyCtrl::appShutdown(), MagAOX::app::streamWriter::appShutdown(), MagAOX::app::zylaCtrl::appShutdown(), MagAOX::app::acronameUsbHub::appStartup(), MagAOX::app::andorCtrl::appStartup(), MagAOX::app::baslerCtrl::appStartup(), MagAOX::app::cameraSim::appStartup(), MagAOX::app::cred2Ctrl::appStartup(), MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::mzmqClient::appStartup(), MagAOX::app::mzmqServer::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picamCtrl::appStartup(), MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::qhyCtrl::appStartup(), appStartup(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::trippLitePDU::appStartup(), MagAOX::app::xt1121DCDU::appStartup(), MagAOX::app::zaberCtrl::appStartup(), MagAOX::app::zylaCtrl::appStartup(), MagAOX::app::ttmModulator::calcState(), MagAOX::app::andorCtrl::cameraSelect(), MagAOX::app::zylaCtrl::cameraSelect(), visxCtrl.core.visxCtrl::cancel_exposure(), MagAOX::app::picamCtrl::capExpTime(), changeAmp(), changeAmp(), changeFreq(), changeFreq(), changeOfst(), changeOfst(), changeOutp(), changeOutp(), changePhse(), changePhse(), changeSync(), changeSync(), changeWdth(), changeWdth(), changeWvtp(), changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::picoMotorCtrl::channelThreadStart(), MagAOX::app::baslerCtrl::checkNextROI(), MagAOX::app::cred2Ctrl::checkNextROI(), MagAOX::app::andorCtrl::checkRecordTimes(), MagAOX::app::baslerCtrl::checkRecordTimes(), MagAOX::app::cameraSim::checkRecordTimes(), MagAOX::app::cred2Ctrl::checkRecordTimes(), MagAOX::app::ocam2KCtrl::checkRecordTimes(), MagAOX::app::picamCtrl::checkRecordTimes(), MagAOX::app::qhyCtrl::checkRecordTimes(), checkRecordTimes(), MagAOX::app::smc100ccCtrl::checkRecordTimes(), MagAOX::app::sysMonitor::checkRecordTimes(), MagAOX::app::zaberCtrl::checkRecordTimes(), MagAOX::app::zylaCtrl::checkRecordTimes(), checkSetup(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), MagAOX::app::cameraSim::configureAcquisition(), MagAOX::app::cred2Ctrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::connect(), MagAOX::app::picamCtrl::connect(), MagAOX::app::qhyCtrl::connect(), pupilCorAlign.pupilCorAlign::control_position(), MagAOX::app::sysMonitor::criticalCoreTemperature(), MagAOX::app::sysMonitor::criticalDiskTemperature(), MagAOX::app::ocam2KCtrl::destroySyncStream(), MagAOX::app::trippLitePDU::devConnect(), MagAOX::app::trippLitePDU::devLogin(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::streamWriter::doEncode(), MagAOX::app::ocam2KCtrl::ensureSyncStream(), MagAOX::app::streamWriter::fgThreadExec(), MagAOX::app::streamWriter::fgThreadStart(), visxCtrl.core.visxCtrl::finalize_exposure(), MagAOX::app::sysMonitor::findChronyStatus(), MagAOX::app::sysMonitor::findCPULoads(), MagAOX::app::sysMonitor::findCPUTemperatures(), MagAOX::app::sysMonitor::findDiskTemperature(), MagAOX::app::sysMonitor::findDiskUsage(), MagAOX::app::sysMonitor::findRamUsage(), camtipSR.core.camtipSR::fit_SR_EE(), camtipSR.core.camtipSR::fit_SR_gauss(), MagAOX::app::ocam2KCtrl::frameGrabberPostPublish(), pupilCorAlign.pupilCorAlign::get_current_state(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::cred2Ctrl::getAnalogGain(), MagAOX::app::streamWriter::getCircBuffLengths(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::andorCtrl::getEMGain(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::baslerCtrl::getExpTime(), MagAOX::app::qhyCtrl::getExpTime(), MagAOX::app::cred2Ctrl::getFanSpeed(), MagAOX::app::picamCtrl::getFanSpeed(), MagAOX::app::andorCtrl::getFPS(), MagAOX::app::cred2Ctrl::getFPS(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::cred2Ctrl::getLEDState(), MagAOX::app::filterWheelCtrl::getMoving(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::filterWheelCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::filterWheelCtrl::getSwitch(), MagAOX::app::andorCtrl::getTemp(), MagAOX::app::baslerCtrl::getTemp(), MagAOX::app::qhyCtrl::getTemp(), MagAOX::app::zylaCtrl::getTemp(), MagAOX::app::cred2Ctrl::getTemps(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), camtipSR.core.camtipSR::grab_img(), camtipSR.core.camtipSR::grab_stack(), pupilCorAlign.pupilCorAlign::handle_centroid_ref(), corAlign.corAlign::handle_closed_loop(), adcCtrl.app.adcCtrl::handle_ctrl_mtx(), visxCtrl.core.visxCtrl::handle_expose(), visxCtrl.core.visxCtrl::handle_exptime(), pupilCorAlign.pupilCorAlign::handle_fwlyot(), pupilCorAlign.pupilCorAlign::handle_fwlyot_ref(), pupilCorAlign.pupilCorAlign::handle_fwpupil(), pupilCorAlign.pupilCorAlign::handle_fwpupil_ref(), adcCtrl.app.adcCtrl::handle_gain(), pupilCorAlign.pupilCorAlign::handle_gain(), visxCtrl.core.visxCtrl::handle_gain(), adcCtrl.app.adcCtrl::handle_knife_edge(), adcCtrl.app.adcCtrl::handle_knife_edge_findzero(), adcCtrl.app.adcCtrl::handle_labmode(), adcCtrl.app.adcCtrl::handle_n_avg(), camtipSR.core.camtipSR::handle_n_avg(), corAlign.corAlign::handle_n_avg(), camtipSR.core.camtipSR::handle_n_jitter(), adcCtrl.app.adcCtrl::handle_no_measurements(), pupilCorAlign.pupilCorAlign::handle_nstack(), adcCtrl.app.adcCtrl::handle_offset(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), corAlign.corAlign::handle_ref_x(), corAlign.corAlign::handle_ref_y(), adcCtrl.app.adcCtrl::handle_reset(), xapp.aoSim.aoSim::handle_reset(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), adcCtrl.app.adcCtrl::handle_state(), corAlign.corAlign::handle_state(), visxCtrl.core.visxCtrl::handle_temp_ccd(), MagAOX::app::streamWriter::handlerSigSegv(), MagAOX::app::filterWheelCtrl::home(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), dbIngest.dbIngest::ingest_line(), MagAOX::app::streamWriter::initialize_xrif(), MagAOX::app::cred2Ctrl::issueCommand(), dbIngest.dbIngest::launch_followers(), audibleAlerts.core.AudibleAlerts::load_personality(), MagAOX::app::andorCtrl::loadConfig(), MagAOX::app::baslerCtrl::loadConfig(), MagAOX::app::cred2Ctrl::loadConfig(), MagAOX::app::filterWheelCtrl::loadConfig(), MagAOX::app::hsfwCtrl::loadConfig(), MagAOX::app::mzmqClient::loadConfig(), MagAOX::app::mzmqServer::loadConfig(), MagAOX::app::ocam2KCtrl::loadConfig(), MagAOX::app::picoMotorCtrl::loadConfig(), MagAOX::app::qhyCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::streamWriter::loadConfig(), MagAOX::app::sysMonitor::loadConfig(), MagAOX::app::xt1121Ctrl::loadConfig(), MagAOX::app::baslerCtrl::loadConfigImpl(), MagAOX::app::picoMotorCtrl::loadConfigImpl(), MagAOX::app::zaberCtrl::loadConfigImpl(), MagAOX::app::cameraSim::loadConfigImpl(), MagAOX::app::cred2Ctrl::loadConfigImpl(), MagAOX::app::andorCtrl::loadImageIntoStream(), MagAOX::app::baslerCtrl::loadImageIntoStream(), MagAOX::app::cameraSim::loadImageIntoStream(), MagAOX::app::cred2Ctrl::loadImageIntoStream(), MagAOX::app::ocam2KCtrl::loadImageIntoStream(), MagAOX::app::picamCtrl::loadImageIntoStream(), MagAOX::app::qhyCtrl::loadImageIntoStream(), MagAOX::app::zylaCtrl::loadImageIntoStream(), adcCtrl.app.adcCtrl::loop(), audibleAlerts.core.AudibleAlerts::loop(), corAlign.corAlign::loop(), dbIngest.dbIngest::loop(), pupilCorAlign.pupilCorAlign::loop(), visxCtrl.core.visxCtrl::loop(), MagAOX::app::smc100ccCtrl::makeCom(), corAlign.corAlign::measure_fpm_mask_shift(), MagAOX::app::ttmModulator::modTTM(), MagAOX::app::filterWheelCtrl::moveTo(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::zaberCtrl::moveTo(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::filterWheelCtrl::moveToRawRelative(), MagAOX::app::picoMotorCtrl::newCallBack_picopos(), MagAOX::app::picoMotorCtrl::newCallBack_presetName(), normalizeSetup(), MagAOX::app::ttmModulator::offset12(), MagAOX::app::ttmModulator::offsetXY(), MagAOX::app::acronameUsbHub::onPowerOff(), MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::cred2Ctrl::onPowerOff(), MagAOX::app::filterWheelCtrl::onPowerOff(), MagAOX::app::hsfwCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), MagAOX::app::picamCtrl::onPowerOff(), MagAOX::app::zylaCtrl::onPowerOff(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), MagAOX::app::sysMonitor::parseCPULoads(), MagAOX::app::sysMonitor::parseCPUTemperatures(), MagAOX::app::sysMonitor::parseCPUTemperaturesAMD(), MagAOX::app::sysMonitor::parseCPUTemperaturesIntel(), MagAOX::app::sysMonitor::parseDiskTemperature(), MagAOX::app::sysMonitor::parseDiskUsage(), MagAOX::app::trippLitePDU::parsePDUStatus(), MagAOX::app::sysMonitor::parseRamUsage(), MagAOX::app::zylaCtrl::powerOnDefaults(), audibleAlerts.core.AudibleAlerts::preprocess(), MagAOX::app::filterWheelCtrl::presetNumber(), MagAOX::app::smc100ccCtrl::presetNumber(), MagAOX::app::zaberCtrl::presetNumber(), queryARWV(), queryBSWV(), queryBTWV(), queryMDWV(), queryOUTP(), querySWWV(), querySYNC(), audibleAlerts.core.AudibleAlerts::reaction_handler(), MagAOX::app::picoMotorCtrl::readChannelCounts(), MagAOX::app::andorCtrl::reconfig(), MagAOX::app::cred2Ctrl::reconfig(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::picamCtrl::reconfig(), MagAOX::app::zylaCtrl::reconfig(), MagAOX::app::sysMonitor::recordChronyStatus(), MagAOX::app::sysMonitor::recordCoreLoads(), MagAOX::app::sysMonitor::recordCoreTemps(), MagAOX::app::sysMonitor::recordDriveTemps(), recordParams(), MagAOX::app::streamWriter::recordSavingState(), MagAOX::app::streamWriter::recordSavingStats(), MagAOX::app::filterWheelCtrl::recordStage(), MagAOX::app::smc100ccCtrl::recordStage(), MagAOX::app::zaberCtrl::recordTelem(), MagAOX::app::sysMonitor::recordUsage(), MagAOX::app::zaberCtrl::recordZaber(), dbIngest.dbIngest::refresh_properties(), visxCtrl.core.visxCtrl::refresh_properties(), MagAOX::app::streamWriter::release_circbufs(), MagAOX::app::mzmqClient::reportError(), MagAOX::app::mzmqServer::reportError(), MagAOX::app::mzmqClient::reportInfo(), MagAOX::app::mzmqServer::reportInfo(), MagAOX::app::mzmqClient::reportNotice(), MagAOX::app::mzmqServer::reportNotice(), MagAOX::app::mzmqClient::reportWarning(), MagAOX::app::mzmqServer::reportWarning(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ttmModulator::restTTM(), adcCtrl.app.adcCtrl::send_command(), MagAOX::app::cred2Ctrl::sendCommand(), MagAOX::app::cred2Ctrl::setAnalogGain(), MagAOX::app::andorCtrl::setCropMode(), MagAOX::app::andorCtrl::setEMGain(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::andorCtrl::setExpTime(), MagAOX::app::baslerCtrl::setExpTime(), MagAOX::app::cameraSim::setExpTime(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::qhyCtrl::setExpTime(), MagAOX::app::cred2Ctrl::setFanSpeed(), MagAOX::app::baslerCtrl::setFPS(), MagAOX::app::cameraSim::setFPS(), MagAOX::app::cred2Ctrl::setFPS(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::sysMonitor::setlatThreadExec(), MagAOX::app::sysMonitor::setlatThreadStart(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::cred2Ctrl::setSerialBaud(), MagAOX::app::ocam2KCtrl::setShutter(), MagAOX::app::picamCtrl::setShutter(), MagAOX::app::zylaCtrl::setShutter(), MagAOX::app::cameraSim::setShutter(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::streamWriter::setSigSegvHandler(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::andorCtrl::setTempControl(), MagAOX::app::cred2Ctrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::zylaCtrl::setTempControl(), MagAOX::app::andorCtrl::setTempSetPt(), MagAOX::app::cred2Ctrl::setTempSetPt(), MagAOX::app::ocam2KCtrl::setTempSetPt(), MagAOX::app::ttmModulator::setTTM(), adcCtrl.app.adcCtrl::setup(), camtipSR.core.camtipSR::setup(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), pupilCorAlign.pupilCorAlign::setup(), sparkleTracker.sparkleTracker::setup(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::smc100ccCtrl::splitResponse(), pupilCorAlign.pupilCorAlign::stages_are_ready(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::baslerCtrl::startAcquisition(), MagAOX::app::cred2Ctrl::startAcquisition(), MagAOX::app::ocam2KCtrl::startAcquisition(), MagAOX::app::zylaCtrl::startAcquisition(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::baslerCtrl::stateString(), MagAOX::app::ocam2KCtrl::stateString(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::zaberCtrl::stop(), visxCtrl.core.visxCtrl::subscribe_to_other_devices(), MagAOX::app::streamWriter::swThreadExec(), MagAOX::app::streamWriter::swThreadStart(), MagAOX::app::zaberCtrl::syncPowerOffStageTelemetry(), MagAOX::app::cred2Ctrl::syncROIFromCamera(), MagAOX::app::smc100ccCtrl::testConnection(), adcCtrl.app.adcCtrl::transition_to_idle(), camtipSR.core.camtipSR::transition_to_idle(), corAlign.corAlign::transition_to_idle(), MagAOX::app::acronameUsbHub::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::acronameUsbHub::turnOutletOn(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), pupilCorAlign.pupilCorAlign::update_properties(), adcCtrl.app.adcCtrl::update_wavelength(), MagAOX::app::trippLitePDU::updateAlarmsAndWarnings(), MagAOX::app::cred2Ctrl::updateFPSLimits(), MagAOX::app::acronameUsbHub::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletState(), MagAOX::app::xt1121DCDU::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletStates(), MagAOX::app::magAOXMaths::updateVals(), MagAOX::app::sysMonitor::updateVals(), MagAOX::app::streamWriter::waitForWriteCompletion(), audibleAlerts.core.AudibleAlerts::walkup_handler(), MagAOX::app::andorCtrl::whilePowerOff(), MagAOX::app::cred2Ctrl::whilePowerOff(), MagAOX::app::filterWheelCtrl::whilePowerOff(), MagAOX::app::hsfwCtrl::whilePowerOff(), MagAOX::app::ocam2KCtrl::whilePowerOff(), MagAOX::app::picamCtrl::whilePowerOff(), MagAOX::app::zylaCtrl::whilePowerOff(), MagAOX::app::picoMotorCtrl::writeChannelCounts(), writeCommand(), MagAOX::app::andorCtrl::writeConfig(), MagAOX::app::cred2Ctrl::writeConfig(), writeRead(), MagAOX::app::xt1121DCDU::xtChannelName(), and MagAOX::app::xt1121DCDU::xtChannelProperty().

log() [2/2]

template<bool _useINDI>

template<typename logT , int retval>

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

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

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

Parameters

[in]

level

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

Definition at line 2089 of file MagAOXApp.hpp.

Referenced by dbIngest.dbIngest::_ensure_connected(), visxCtrl.core.visxCtrl::_gather_metadata(), visxCtrl.core.visxCtrl::_init_properties(), visxCtrl.core.visxCtrl::cancel_exposure(), pupilCorAlign.pupilCorAlign::control_position(), visxCtrl.core.visxCtrl::finalize_exposure(), camtipSR.core.camtipSR::fit_SR_EE(), camtipSR.core.camtipSR::fit_SR_gauss(), pupilCorAlign.pupilCorAlign::get_current_state(), camtipSR.core.camtipSR::grab_img(), camtipSR.core.camtipSR::grab_stack(), pupilCorAlign.pupilCorAlign::handle_centroid_ref(), corAlign.corAlign::handle_closed_loop(), adcCtrl.app.adcCtrl::handle_ctrl_mtx(), visxCtrl.core.visxCtrl::handle_expose(), visxCtrl.core.visxCtrl::handle_exptime(), pupilCorAlign.pupilCorAlign::handle_fwlyot(), pupilCorAlign.pupilCorAlign::handle_fwlyot_ref(), pupilCorAlign.pupilCorAlign::handle_fwpupil(), pupilCorAlign.pupilCorAlign::handle_fwpupil_ref(), adcCtrl.app.adcCtrl::handle_gain(), pupilCorAlign.pupilCorAlign::handle_gain(), visxCtrl.core.visxCtrl::handle_gain(), adcCtrl.app.adcCtrl::handle_knife_edge(), adcCtrl.app.adcCtrl::handle_knife_edge_findzero(), adcCtrl.app.adcCtrl::handle_labmode(), adcCtrl.app.adcCtrl::handle_n_avg(), camtipSR.core.camtipSR::handle_n_avg(), corAlign.corAlign::handle_n_avg(), camtipSR.core.camtipSR::handle_n_jitter(), adcCtrl.app.adcCtrl::handle_no_measurements(), pupilCorAlign.pupilCorAlign::handle_nstack(), adcCtrl.app.adcCtrl::handle_offset(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), corAlign.corAlign::handle_ref_x(), corAlign.corAlign::handle_ref_y(), adcCtrl.app.adcCtrl::handle_reset(), xapp.aoSim.aoSim::handle_reset(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), adcCtrl.app.adcCtrl::handle_state(), corAlign.corAlign::handle_state(), visxCtrl.core.visxCtrl::handle_temp_ccd(), dbIngest.dbIngest::ingest_line(), dbIngest.dbIngest::launch_followers(), audibleAlerts.core.AudibleAlerts::load_personality(), adcCtrl.app.adcCtrl::loop(), audibleAlerts.core.AudibleAlerts::loop(), corAlign.corAlign::loop(), dbIngest.dbIngest::loop(), pupilCorAlign.pupilCorAlign::loop(), visxCtrl.core.visxCtrl::loop(), corAlign.corAlign::measure_fpm_mask_shift(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), dbIngest.dbIngest::refresh_properties(), visxCtrl.core.visxCtrl::refresh_properties(), adcCtrl.app.adcCtrl::send_command(), adcCtrl.app.adcCtrl::setup(), camtipSR.core.camtipSR::setup(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), pupilCorAlign.pupilCorAlign::setup(), sparkleTracker.sparkleTracker::setup(), pupilCorAlign.pupilCorAlign::stages_are_ready(), visxCtrl.core.visxCtrl::subscribe_to_other_devices(), adcCtrl.app.adcCtrl::transition_to_idle(), camtipSR.core.camtipSR::transition_to_idle(), corAlign.corAlign::transition_to_idle(), pupilCorAlign.pupilCorAlign::update_properties(), adcCtrl.app.adcCtrl::update_wavelength(), and audibleAlerts.core.AudibleAlerts::walkup_handler().

logMessage()

template<bool _useINDI>

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

inherited

Handle a log message from the logging system.

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

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

Definition at line 2096 of file MagAOXApp.hpp.

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

loopPause()

template<bool _useINDI>

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

inherited

Get the loop pause time.

Returns

the value of m_loopPause

Definition at line 4024 of file MagAOXApp.hpp.

newCallBack_clearFSMAlert()

template<bool _useINDI>

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

protectedinherited

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

Returns

0 on success.

-1 on error.

Parameters

[in]

ipRecv

the INDI property sent with the new property request.

Definition at line 3858 of file MagAOXApp.hpp.

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

normalizeSetup()

int MagAOX::app::siglentSDG::normalizeSetup ( )

inline

Normalize the setup, called during connection if checkSetup shows a problem, or on power-up.

Definition at line 1647 of file siglentSDG.hpp.

References changeAmp(), changeFreq(), changeOfst(), changeOutp(), changePhse(), changeWdth(), changeWvtp(), MagAOX::app::MagAOXApp< _useINDI >::log(), m_C1ofst, m_C1outpOn, m_C1vppDefault, m_C2ofst, m_C2outpOn, m_C2vppDefault, m_waveform, MagAOX::app::makeCommand(), recordParams(), and writeCommand().

Referenced by appLogic().

noteIndiSetPropertyRequested()

template<bool _useINDI>

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

inlineinherited

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

Parameters

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

Definition at line 3200 of file MagAOXApp.hpp.

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

onPowerOff()

int MagAOX::app::siglentSDG::onPowerOff ( )

inlinevirtual

Implementation of the on-power-off FSM logic.

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

Definition at line 943 of file siglentSDG.hpp.

References INDI_IDLE, MagAOX::app::lock(), m_C1frequency, m_C1frequency_tgt, m_C1ofst, m_C1outp, m_C1vpp, m_C1vpp_tgt, m_C1wvtp, m_C2frequency, m_C2frequency_tgt, m_C2ofst, m_C2outp, m_C2vpp, m_C2vpp_tgt, m_C2wvtp, MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, m_indiP_C1amp, m_indiP_C1ampvrms, m_indiP_C1freq, m_indiP_C1hlev, m_indiP_C1llev, m_indiP_C1ofst, m_indiP_C1outp, m_indiP_C1peri, m_indiP_C1phse, m_indiP_C1sync, m_indiP_C1wdth, m_indiP_C1wvtp, m_indiP_C2amp, m_indiP_C2ampvrms, m_indiP_C2freq, m_indiP_C2hlev, m_indiP_C2llev, m_indiP_C2ofst, m_indiP_C2peri, m_indiP_C2phse, m_indiP_C2sync, m_indiP_C2wdth, m_indiP_C2wvtp, m_waveform, MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged(), and MagAOX::app::MagAOXApp< _useINDI >::updateSwitchIfChanged().

Referenced by whilePowerOff().

powerOnWaitElapsed()

template<bool _useINDI>

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

protectedinherited

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

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

Returns

true if the time since POWERON is greater than the power-on wait, or if power management is not enabled

false otherwise

Definition at line 3891 of file MagAOXApp.hpp.

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

powerState()

template<bool _useINDI>

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

inherited

Returns the current power state.

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

Returns

-1 if power state is unknown

0 if power is off

1 if power is on or m_powerMgtEnabled==false

Definition at line 3910 of file MagAOXApp.hpp.

Referenced by MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cred2Ctrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::picamCtrl::capExpTime(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::picamCtrl::getFanSpeed(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::cred2Ctrl::sendCommand(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), and MagAOX::app::hsfwCtrl::startHoming().

powerStateTarget()

template<bool _useINDI>

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

inherited

Returns the target power state.

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

Returns

-1 if target power state is unknown

0 if target power state is off

1 if target power is on or m_powerMgtEnabled==false

Definition at line 3921 of file MagAOXApp.hpp.

Referenced by MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cred2Ctrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::picamCtrl::capExpTime(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::picamCtrl::getFanSpeed(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::cred2Ctrl::sendCommand(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), and MagAOX::app::hsfwCtrl::startHoming().

queryARWV()

int MagAOX::app::siglentSDG::queryARWV ( int &  index, int  channel  )

inline

Send the ARWV? query and get the response index.

This does not update internal state.

Returns

0 on success

-1 on an error.

Parameters

[out]	index	the ARWV index
[in]	channel	the channel to query

Definition at line 1263 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::app::makeCommand(), MagAOX::app::parseARWV(), and writeRead().

Referenced by checkSetup().

queryBSWV()

int MagAOX::app::siglentSDG::queryBSWV ( int  channel )

inline

Send the BSWV? query for a channel.

This updates member variables and INDI.

Returns

0 on success

-1 on an error.

Parameters

channel

< [in] the channel to query

Definition at line 1308 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, m_C1frequency, m_C1frequency_tgt, m_C1ofst, m_C1phse, m_C1vpp, m_C1vpp_tgt, m_C1wdth, m_C1wvtp, m_C2frequency, m_C2frequency_tgt, m_C2ofst, m_C2phse, m_C2vpp, m_C2vpp_tgt, m_C2wdth, m_C2wvtp, m_indiP_C1amp, m_indiP_C1ampvrms, m_indiP_C1freq, m_indiP_C1hlev, m_indiP_C1llev, m_indiP_C1ofst, m_indiP_C1peri, m_indiP_C1phse, m_indiP_C1wdth, m_indiP_C1wvtp, m_indiP_C2amp, m_indiP_C2ampvrms, m_indiP_C2freq, m_indiP_C2hlev, m_indiP_C2llev, m_indiP_C2ofst, m_indiP_C2peri, m_indiP_C2phse, m_indiP_C2wdth, m_indiP_C2wvtp, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, m_waveform, MagAOX::app::makeCommand(), MagAOX::app::parseBSWV(), recordParams(), MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged(), and writeRead().

Referenced by appLogic().

queryBTWV()

int MagAOX::app::siglentSDG::queryBTWV ( std::string &  state, int  channel  )

inline

Send the BTWV? query and get the response state.

This does not update internal state.

Returns

0 on success

-1 on an error.

Parameters

[out]	state	the BTWV state, ON or OFF
[in]	channel	the channel to query

Definition at line 1218 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::app::makeCommand(), MagAOX::app::parseBTWV(), MagAOX::app::MagAOXApp< _useINDI >::state(), and writeRead().

Referenced by checkSetup().

queryMDWV()

int MagAOX::app::siglentSDG::queryMDWV ( std::string &  state, int  channel  )

inline

Send the MDWV? query and get the response state.

This does not update internal state.

Returns

0 on success

-1 on an error.

Parameters

[out]	state	the MDWV state, ON or OFF
[in]	channel	the channel to query

Definition at line 1128 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::app::makeCommand(), MagAOX::app::parseMDWV(), MagAOX::app::MagAOXApp< _useINDI >::state(), and writeRead().

Referenced by checkSetup().

queryOUTP()

int MagAOX::app::siglentSDG::queryOUTP ( int  channel )

inline

Send the OUTP? query for a channel.

Returns

0 on success

-1 on an error.

Parameters

[in]

channel

the channel to query

Definition at line 1448 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, m_C1outp, m_C2outp, m_indiP_C1outp, m_indiP_C2outp, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::app::makeCommand(), MagAOX::app::parseOUTP(), recordParams(), MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged(), and writeRead().

Referenced by appLogic().

querySWWV()

int MagAOX::app::siglentSDG::querySWWV ( std::string &  state, int  channel  )

inline

Send the SWWV? query and get the response state.

This does not update internal state.

Returns

0 on success

-1 on an error.

Parameters

[out]	state	the SWWV state, ON or OFF
[in]	channel	the channel to query

Definition at line 1173 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::app::makeCommand(), MagAOX::app::parseSWWV(), MagAOX::app::MagAOXApp< _useINDI >::state(), and writeRead().

Referenced by checkSetup().

querySYNC()

int MagAOX::app::siglentSDG::querySYNC ( bool &  sync, int  channel  )

inline

Send the SYNC? query for a channel.

This updates member variables and INDI.

Returns

0 on success

-1 on an error.

Parameters

channel

< [in] the sync state for this channel < [in] the channel to query

Definition at line 1403 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::app::makeCommand(), MagAOX::app::parseSYNC(), and writeRead().

Referenced by checkSetup().

recordParams()

int MagAOX::app::siglentSDG::recordParams ( bool  force = false )

inline

Definition at line 2534 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), m_C1frequency, m_C1ofst, m_C1outp, m_C1phse, m_C1sync, m_C1vpp, m_C1wdth, m_C1wvtp, m_C2frequency, m_C2ofst, m_C2outp, m_C2phse, m_C2sync, m_C2vpp, m_C2wdth, m_C2wvtp, TELEM_FXNGEN_WVTP_DC, TELEM_FXNGEN_WVTP_PULSE, and TELEM_FXNGEN_WVTP_SINE.

Referenced by appLogic(), changeAmp(), changeFreq(), changeOutp(), changeSync(), normalizeSetup(), queryBSWV(), queryOUTP(), and recordTelem().

recordTelem()

int MagAOX::app::siglentSDG::recordTelem ( const telem_fxngen *  )

inline

Definition at line 2528 of file siglentSDG.hpp.

References recordParams().

registerIndiPropertyNew() [1/3]

template<bool _useINDI = true>

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

inherited

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

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

Returns

0 on success.

-1 on error.

Parameters

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

registerIndiPropertyNew() [2/3]

template<bool _useINDI = true>

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

inherited

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

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

Returns

0 on success.

-1 on error.

Parameters

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

registerIndiPropertyNew() [3/3]

template<bool _useINDI = true>

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

inherited

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

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

Returns

0 on success.

-1 on error.

Parameters

[in]

prop

the property to register, must be fully set up

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

registerIndiPropertyReadOnly() [1/2]

template<bool _useINDI>

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

inherited

Register an INDI property which is read only.

This version requires the property be fully set up.

Returns

0 on success.

-1 on error.

Parameters

[in]

prop

the property to register, must be completely setup

Definition at line 2988 of file MagAOXApp.hpp.

References MagAOX::app::lock().

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

registerIndiPropertyReadOnly() [2/2]

template<bool _useINDI>

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

inherited

Register an INDI property which is read only.

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

Returns

0 on success.

-1 on error.

Parameters

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

Definition at line 3020 of file MagAOXApp.hpp.

References MagAOX::app::lock().

registerIndiPropertySet()

template<bool _useINDI = true>

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

inherited

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

Returns

0 on success.

-1 on error.

Parameters

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

Definition at line 3135 of file MagAOXApp.hpp.

References MagAOX::app::lock().

resetIndiSetPropertyRetry()

template<bool _useINDI>

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

inlineinherited

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

Parameters

callBack

[in/out] the subscription retry state to reset

Definition at line 3173 of file MagAOXApp.hpp.

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

secretsPath()

template<bool _useINDI>

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

inherited

Get the secrets path.

Returns

the value of m_secretsPath

Definition at line 4012 of file MagAOXApp.hpp.

sendGetPropertySetList()

template<bool _useINDI>

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

inherited

Definition at line 3352 of file MagAOXApp.hpp.

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

sendNewProperty() [1/2]

template<bool _useINDI>

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

protectedinherited

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

Returns

0 on success.

-1 on an error, which will be logged

Parameters

[in]

ipSend

The property to send a "new" INDI command for

Definition at line 3794 of file MagAOXApp.hpp.

sendNewProperty() [2/2]

template<bool _useINDI>

template<typename T >

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

protectedinherited

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

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

Returns

0 on success.

-1 on an errory.

Parameters

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

Definition at line 3758 of file MagAOXApp.hpp.

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

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

sendNewStandardIndiToggle()

template<bool _useINDI>

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

protectedinherited

Send a new property commmand for a standard toggle switch.

Returns

0 on success

-1 on an error, which will be logged.

Parameters

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

Definition at line 3815 of file MagAOXApp.hpp.

setDefaults()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::setDefaults ( int  argc, char **  argv  )

virtualinherited

Set the paths for config files.

Replaces the mx::application defaults with the MagAO-X config system.

This function parses the CL for "-n" or "--name".

Do not override this unless you intend to depart from the MagAO-X standard.

Parameters

[in]	argc	standard command line result specifying number of arguments in argv
[in]	argv	standard command line result containing the arguments.

Definition at line 1381 of file MagAOXApp.hpp.

References MAGAOX_calibRelPath, MAGAOX_configRelPath, MAGAOX_env_calib, MAGAOX_env_config, MAGAOX_env_cpuset, MAGAOX_env_log, MAGAOX_env_path, MAGAOX_env_secrets, MAGAOX_env_sys, MAGAOX_logRelPath, MAGAOX_path, MAGAOX_secretsRelPath, and MAGAOX_sysRelPath.

setEuidCalled()

template<bool _useINDI>

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

privateinherited

Set the effective user ID to the called value, i.e. the highest possible.

If setuid is set on the file, this will be super-user privileges.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns

0 on success

-1 on error from setuid().

Definition at line 2259 of file MagAOXApp.hpp.

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

setEuidReal()

template<bool _useINDI>

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

privateinherited

Set the effective user ID to the real value, i.e. the file owner.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns

0 on success

-1 on error from setuid().

Definition at line 2277 of file MagAOXApp.hpp.

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

setSigTermHandler()

template<bool _useINDI>

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

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 2148 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_DEBUG.

setupBasicConfig()

template<bool _useINDI>

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

virtualinherited

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

This method sets up the config system with the standard MagAO-X key=value pairs.

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

Setting up app specific config goes in setupConfig() implemented in the derived class.

Definition at line 1498 of file MagAOXApp.hpp.

setupConfig() [1/2]

void MagAOX::app::siglentSDG::setupConfig ( )

inlinevirtual

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

Definition at line 455 of file siglentSDG.hpp.

References MagAOX::app::dev::telemeter< derivedT >::setupConfig().

setupConfig() [2/2]

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

inherited

Setup an application configurator for the device section.

Returns

0 on success.

-1 on error (nothing implemented yet)

Parameters

[in]

config

an application configuration to setup

Definition at line 112 of file telemeter.hpp.

shutdown()

template<bool _useINDI>

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

inherited

Get the value of the shutdown flag.

Returns

the current value of m_shutdown

Definition at line 4030 of file MagAOXApp.hpp.

Referenced by MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::streamWriter::swThreadExec(), and libXWCTest::xInstGraphTest::TEST_CASE().

st_newCallBack_clearFSMAlert()

template<bool _useINDI>

int MagAOX::app::MagAOXApp< _useINDI >::st_newCallBack_clearFSMAlert ( void *  app, const pcf::IndiProperty &  ipRecv  )

staticprotectedinherited

The static callback function to be registered for requesting to clear the FSM alert.

Returns

0 on success.

-1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to MagAOXApp.
[in]	ipRecv	the INDI property sent with the new property request.

Definition at line 3852 of file MagAOXApp.hpp.

References MagAOX::app::ipRecv.

startINDI()

template<bool _useINDI>

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

protectedinherited

Start INDI Communications.

Returns

0 on success

-1 on error. This is fatal.

Definition at line 3295 of file MagAOXApp.hpp.

state() [1/2]

template<bool _useINDI>

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

inherited

Get the current state code.

Returns

m_state

Definition at line 2601 of file MagAOXApp.hpp.

Referenced by MagAOX::app::baslerCtrl::acquireAndCheckValid(), MagAOX::app::picamCtrl::acquireAndCheckValid(), MagAOX::app::qhyCtrl::acquireAndCheckValid(), MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::baslerCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::cred2Ctrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::streamWriter::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::acronameUsbHub::appStartup(), MagAOX::app::andorCtrl::appStartup(), MagAOX::app::baslerCtrl::appStartup(), MagAOX::app::cameraSim::appStartup(), MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::qhyCtrl::appStartup(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::trippLitePDU::appStartup(), MagAOX::app::xt1121DCDU::appStartup(), MagAOX::app::zylaCtrl::appStartup(), MagAOX::app::andorCtrl::cameraSelect(), changeAmp(), changeFreq(), changeOfst(), changeOutp(), changePhse(), changeSync(), changeWdth(), changeWvtp(), MagAOX::app::picoMotorCtrl::channelThreadExec(), checkSetup(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), MagAOX::app::cameraSim::configureAcquisition(), MagAOX::app::cred2Ctrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::connect(), MagAOX::app::picamCtrl::connect(), MagAOX::app::qhyCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::baslerCtrl::getExpTime(), MagAOX::app::qhyCtrl::getExpTime(), MagAOX::app::picamCtrl::getFanSpeed(), MagAOX::app::baslerCtrl::getFPS(), MagAOX::app::baslerCtrl::getTemp(), MagAOX::app::qhyCtrl::getTemp(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::filterWheelCtrl::home(), MagAOX::app::baslerCtrl::loadImageIntoStream(), MagAOX::app::qhyCtrl::loadImageIntoStream(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::smc100ccCtrl::moveTo(), queryBTWV(), queryMDWV(), querySWWV(), MagAOX::app::andorCtrl::reconfig(), MagAOX::app::cred2Ctrl::reconfig(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::picamCtrl::reconfig(), MagAOX::app::streamWriter::recordSavingState(), MagAOX::app::andorCtrl::setCropMode(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::andorCtrl::setExpTime(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::cred2Ctrl::setNextROI(), MagAOX::app::qhyCtrl::setNextROI(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::baslerCtrl::startAcquisition(), MagAOX::app::cameraSim::startAcquisition(), MagAOX::app::cred2Ctrl::startAcquisition(), MagAOX::app::qhyCtrl::startAcquisition(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::ocam2KCtrl::stateStringValid(), MagAOX::app::streamWriter::swThreadExec(), libXWCTest::flowRPMTest::TEST_CASE(), MagAOX::app::acronameUsbHub::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletStates(), and writeRead().

state() [2/2]

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::state ( const stateCodes::stateCodeT &  s, bool  stateAlert = false  )

inherited

Set the current state code.

Todo:

move this to a function in stateCodes

Parameters

[in]	s	The new application state
[in]	stateAlert	[optional] flag to set the alert state of the FSM property.

Definition at line 2607 of file MagAOXApp.hpp.

References INDI_ALERT, INDI_BUSY, INDI_IDLE, INDI_OK, MagAOX::app::lock(), flatlogs::logPrio::LOG_CRITICAL, flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_INFO, and flatlogs::logPrio::LOG_WARNING.

stateAlert()

template<bool _useINDI>

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

inherited

Get the value of the state alert flag.

Returns

the current value of m_stateAlert

Definition at line 2665 of file MagAOXApp.hpp.

stateLogged()

template<bool _useINDI>

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

inherited

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

This method exists to facilitate logging the reason for a state change once, but not logging it on subsequent event loops. Returns the current value upon entry, but updates before returning so that the next call returns the incremented value. Example usage:

if( connection_failed ) //some condition set this to true
{
   state( stateCodes::NOTCONNECTED );
   if(!stateLogged()) log<text_log>("Not connected");
}

In this example, the log entry is made the first time the state changes. If there are no changes to a different state in the mean time, then when the event loop gets here again and decides it is not connected, the log entry will not be made.

Returns

current value of m_stateLogged, that is the value before it is incremented.

Definition at line 2677 of file MagAOXApp.hpp.

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

sysPath()

template<bool _useINDI>

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

inherited

Get the system path.

Returns

the value of m_sysPath

Definition at line 4006 of file MagAOXApp.hpp.

telem()

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

inherited

Make a telemetry recording.

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

Template Parameters

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

Parameters

[in]

msg

the data to log

Definition at line 95 of file telemeter.hpp.

threadStart()

template<bool _useINDI>

template<class thisPtr , class Function >

int MagAOX::app::MagAOXApp< _useINDI >::threadStart ( std::thread &  thrd, bool &  thrdInit, pid_t &  tpid, pcf::IndiProperty &  thProp, int  thrdPrio, const std::string &  cpuset, const std::string &  thrdName, thisPtr *  thrdThis, Function &&  thrdStart  )

inherited

Start a thread, using this class's privileges to set priority, etc.

The thread initialization synchronizer bool is set to true at the beginning of this function, then is set to false once all initialization is complete. The thread exec function should wait until this is false before doing anything except setting the pid. This is to avoid privilege escalation bugs.

The interface of the thread start function is:

static void impl::myThreadStart( impl * o )
{
   o->myThreadExec(); //A member function which actually executes the thread
}

where impl is the derived class, and mThreadStart and myThreadExec are members of impl.

Returns

0 on success

-1 on error

Parameters

[out]	thrd	The thread object to start executing
	thrdInit	[in/out] The thread initilization synchronizer.
	tpid	[in/out] The thread pid to be filled in by thrdStart immediately upon call
	thProp	[in/out] The INDI property to publish the thread details
[in]	thrdPrio	The r/t priority to set for this thread
[in]	cpuset	the cpuset to place this thread on. Ignored if "".
[in]	thrdName	The name of the thread (just for logging)
[in]	thrdThis	The this pointer to pass to the thread starter function
[in]	thrdStart	The thread starting function, a static function taking a this pointer as argument.

Definition at line 2461 of file MagAOXApp.hpp.

References flatlogs::logPrio::LOG_NOTICE, and MAGAOX_RT_SCHED_POLICY.

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

unlockPID()

template<bool _useINDI>

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

protectedinherited

Remove the PID file.

Definition at line 2435 of file MagAOXApp.hpp.

updateIfChanged() [1/4]

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged ( pcf::IndiProperty &  p, const std::string &  el, const char *  newVal, pcf::IndiProperty::PropertyStateType  ipState = pcf::IndiProperty::Ok  )

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

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

This is a specialization for const char * to std::string.

For a property with multiple elements, you should use the vector version to minimize network traffic. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 3625 of file MagAOXApp.hpp.

updateIfChanged() [2/4]

template<bool _useINDI>

template<typename T >

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged ( pcf::IndiProperty &  p, const std::string &  el, const std::vector< T > &  newVals, pcf::IndiProperty::PropertyStateType  ipState = pcf::IndiProperty::Ok  )

protectedinherited

Update an INDI property if values have changed.

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

Constructs the element names for each value as elX where X is the index of the vector.

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

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

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	Beginning of each element name
[in]	newVals	the new values
[in]	ipState	[optional] the new state

Definition at line 3650 of file MagAOXApp.hpp.

updateIfChanged() [3/4]

template<bool _useINDI>

template<typename T >

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged ( pcf::IndiProperty &  p, const std::string &  el, const T &  newVal, pcf::IndiProperty::PropertyStateType  ipState = pcf::IndiProperty::Ok  )

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

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

For a property with multiple elements, you should use the vector version to minimize network traffic.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 3606 of file MagAOXApp.hpp.

Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::baslerCtrl::checkNextROI(), MagAOX::app::cameraSim::checkNextROI(), MagAOX::app::cred2Ctrl::checkNextROI(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), MagAOX::app::cred2Ctrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::cred2Ctrl::getTemps(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::acronameUsbHub::onPowerOff(), MagAOX::app::cred2Ctrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), onPowerOff(), MagAOX::app::xt1121Ctrl::onPowerOff(), queryBSWV(), queryOUTP(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::cred2Ctrl::syncROIFromCamera(), MagAOX::app::cred2Ctrl::updateFPSLimits(), MagAOX::app::trippLitePDU::updateOutletStates(), MagAOX::app::magAOXMaths::updateVals(), and MagAOX::app::sysMonitor::updateVals().

updateIfChanged() [4/4]

template<bool _useINDI>

template<typename T >

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

protectedinherited

Update an INDI property if values have changed.

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

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

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

Parameters

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

Definition at line 3671 of file MagAOXApp.hpp.

updatesIfChanged()

template<bool _useINDI>

template<typename T >

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

protectedinherited

Parameters

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

Definition at line 3687 of file MagAOXApp.hpp.

updateSwitchIfChanged()

template<bool _useINDI>

void MagAOX::app::MagAOXApp< _useINDI >::updateSwitchIfChanged ( pcf::IndiProperty &  p, const std::string &  el, const pcf::IndiElement::SwitchStateType &  newVal, pcf::IndiProperty::PropertyStateType  ipState = pcf::IndiProperty::Ok  )

protectedinherited

Update an INDI switch element value if it has changed.

Will only peform a SetProperty if the new element switch state has changed, or the propery state has changed.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 3634 of file MagAOXApp.hpp.

Referenced by appLogic(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), onPowerOff(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::baslerCtrl::setNextROI(), MagAOX::app::cameraSim::setNextROI(), MagAOX::app::cred2Ctrl::setNextROI(), MagAOX::app::picamCtrl::setNextROI(), MagAOX::app::qhyCtrl::setNextROI(), MagAOX::app::zylaCtrl::setNextROI(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::picamCtrl::setTempControl(), MagAOX::app::filterWheelCtrl::startHoming(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::hsfwCtrl::stop(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::zaberCtrl::stop(), and MagAOX::app::sysMonitor::updateVals().

whilePowerOff()

int MagAOX::app::siglentSDG::whilePowerOff ( )

inlinevirtual

Implementation of the while-powered-off FSM.

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

Definition at line 1008 of file siglentSDG.hpp.

References onPowerOff().

writeCommand()

int MagAOX::app::siglentSDG::writeCommand ( const std::string &  commmand )

inline

Write a command to the device.

Returns

0 on success

-1 on error

Parameters

[in]

commmand

the complete command string to send to the device

Definition at line 1058 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_readTimeOut, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, m_telnetConn, m_writeTimeOut, MagAOX::tty::telnetConn::read(), MagAOX::tty::ttyErrorString(), and MagAOX::tty::telnetConn::write().

Referenced by changeAmp(), changeFreq(), changeOfst(), changeOutp(), changePhse(), changeSync(), changeWdth(), changeWvtp(), and normalizeSetup().

writeRead()

int MagAOX::app::siglentSDG::writeRead ( std::string &  strRead, const std::string &  command  )

inline

Write a command to the device and get the response. Not mutex-ed.

We assume this is called after the m_indiMutex is locked.

Returns

0 on success

-1 on an error. May set DISCONNECTED.

Parameters

[out]	strRead	The string responseread in
[in]	command	The command to send.

Definition at line 1022 of file siglentSDG.hpp.

References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_powerState, MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState, m_readTimeOut, MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, MagAOX::tty::telnetConn::m_strRead, m_telnetConn, m_writeTimeOut, MagAOX::app::stateCodes::NOTCONNECTED, MagAOX::tty::telnetConn::read(), MagAOX::app::MagAOXApp< _useINDI >::state(), MagAOX::tty::ttyErrorString(), MagAOX::tty::telnetConn::write(), and MagAOX::tty::telnetConn::writeRead().

Referenced by queryARWV(), queryBSWV(), queryBTWV(), queryMDWV(), queryOUTP(), querySWWV(), and querySYNC().

Friends And Related Symbol Documentation

dev::telemeter< siglentSDG >

friend class dev::telemeter< siglentSDG >

friend

Definition at line 29 of file siglentSDG.hpp.

siglentSDG_test

friend class siglentSDG_test

friend

Definition at line 29 of file siglentSDG.hpp.

Member Data Documentation

cs_MaxOfst

constexpr double MagAOX::app::siglentSDG::cs_MaxOfst = 10.0

staticconstexprprivate

Definition at line 34 of file siglentSDG.hpp.

Referenced by changeOfst().

cs_MaxVolts

constexpr double MagAOX::app::siglentSDG::cs_MaxVolts = 10.0

staticconstexprprivate

Definition at line 35 of file siglentSDG.hpp.

m_allDefsReceived

template<bool _useINDI = true>

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

protectedinherited

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

Definition at line 716 of file MagAOXApp.hpp.

m_ampMax

std::vector<double> MagAOX::app::siglentSDG::m_ampMax = {1.2801, 1.2801, 1.0201}

private

Definition at line 39 of file siglentSDG.hpp.

Referenced by changeAmp(), and changeFreq().

m_basePath

template<bool _useINDI = true>

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

protectedinherited

The base path of the MagAO-X system.

Definition at line 188 of file MagAOXApp.hpp.

m_bootDelay

double MagAOX::app::siglentSDG::m_bootDelay {10}

protected

Time in seconds it takes the device to boot.

Definition at line 51 of file siglentSDG.hpp.

Referenced by appLogic().

m_C1ampMax

double MagAOX::app::siglentSDG::m_C1ampMax {10.0}

protected

The maximum voltage output for channel 1.

Definition at line 78 of file siglentSDG.hpp.

Referenced by changeAmp(), changeOfst(), and loadConfig().

m_C1frequency

double MagAOX::app::siglentSDG::m_C1frequency {0}

protected

The output frequency of channel 1.

Definition at line 71 of file siglentSDG.hpp.

Referenced by onPowerOff(), queryBSWV(), and recordParams().

m_C1frequency_tgt

double MagAOX::app::siglentSDG::m_C1frequency_tgt {-1}

protected

Definition at line 90 of file siglentSDG.hpp.

Referenced by changeAmp(), changeFreq(), onPowerOff(), and queryBSWV().

m_C1ofst

double MagAOX::app::siglentSDG::m_C1ofst {0}

protected

The offset voltage of channel 1.

Definition at line 74 of file siglentSDG.hpp.

Referenced by changeAmp(), loadConfig(), normalizeSetup(), onPowerOff(), queryBSWV(), and recordParams().

m_C1outp

uint8_t MagAOX::app::siglentSDG::m_C1outp {0}

protected

std::string m_clock; ///<INTernal or EXTernal

The output status channel 1

Definition at line 70 of file siglentSDG.hpp.

Referenced by appLogic(), onPowerOff(), queryOUTP(), and recordParams().

m_C1outpOn

bool MagAOX::app::siglentSDG::m_C1outpOn {false}

protected

Flag controlling if C1 output is on after normalization.

Definition at line 59 of file siglentSDG.hpp.

Referenced by loadConfig(), and normalizeSetup().

m_C1phse

double MagAOX::app::siglentSDG::m_C1phse {0}

protected

The phase of channel 1 (SINE only)

Definition at line 75 of file siglentSDG.hpp.

Referenced by queryBSWV(), and recordParams().

m_C1setVoltage

double MagAOX::app::siglentSDG::m_C1setVoltage {5.0}

protected

the set position voltage of Ch. 1.

Definition at line 56 of file siglentSDG.hpp.

m_C1sync

bool MagAOX::app::siglentSDG::m_C1sync {false}

protected

Definition at line 96 of file siglentSDG.hpp.

Referenced by appLogic(), checkSetup(), and recordParams().

m_C1vpp

double MagAOX::app::siglentSDG::m_C1vpp {0}

protected

The peak-2-peak voltage of channel 1.

Definition at line 72 of file siglentSDG.hpp.

Referenced by changeOfst(), onPowerOff(), queryBSWV(), and recordParams().

m_C1vpp_tgt

double MagAOX::app::siglentSDG::m_C1vpp_tgt {-1}

protected

Definition at line 91 of file siglentSDG.hpp.

Referenced by changeAmp(), changeFreq(), onPowerOff(), and queryBSWV().

m_C1vppDefault

double MagAOX::app::siglentSDG::m_C1vppDefault {0}

protected

default value for vpp of channel 1

Definition at line 73 of file siglentSDG.hpp.

Referenced by loadConfig(), and normalizeSetup().

m_C1wdth

double MagAOX::app::siglentSDG::m_C1wdth {0}

protected

The width of channel 1 (PULSE only)

Definition at line 76 of file siglentSDG.hpp.

Referenced by queryBSWV(), and recordParams().

m_C1wvtp

std::string MagAOX::app::siglentSDG::m_C1wvtp

protected

The wave type of channel 1.

Definition at line 77 of file siglentSDG.hpp.

Referenced by onPowerOff(), queryBSWV(), and recordParams().

m_C2ampMax

double MagAOX::app::siglentSDG::m_C2ampMax {10.0}

protected

The maximum voltage output for channel 2.

Definition at line 88 of file siglentSDG.hpp.

Referenced by changeAmp(), changeOfst(), and loadConfig().

m_C2frequency

double MagAOX::app::siglentSDG::m_C2frequency {0}

protected

The output frequency of channel 2.

Definition at line 81 of file siglentSDG.hpp.

Referenced by onPowerOff(), queryBSWV(), and recordParams().

m_C2frequency_tgt

double MagAOX::app::siglentSDG::m_C2frequency_tgt {-1}

protected

Definition at line 93 of file siglentSDG.hpp.

Referenced by changeAmp(), changeFreq(), onPowerOff(), and queryBSWV().

m_C2ofst

double MagAOX::app::siglentSDG::m_C2ofst {0}

protected

The offset voltage of channel 2.

Definition at line 84 of file siglentSDG.hpp.

Referenced by changeAmp(), loadConfig(), normalizeSetup(), onPowerOff(), queryBSWV(), and recordParams().

m_C2outp

uint8_t MagAOX::app::siglentSDG::m_C2outp {0}

protected

The output status channel 2.

Definition at line 80 of file siglentSDG.hpp.

Referenced by appLogic(), onPowerOff(), queryOUTP(), and recordParams().

m_C2outpOn

bool MagAOX::app::siglentSDG::m_C2outpOn {false}

protected

Flag controlling if C2 output is on after normalization. This will only have an effect if m_C1wvtp is "pulse"

Definition at line 60 of file siglentSDG.hpp.

Referenced by loadConfig(), and normalizeSetup().

m_C2phse

double MagAOX::app::siglentSDG::m_C2phse {0}

protected

The phase of channel 2 (SINE only)

Definition at line 85 of file siglentSDG.hpp.

Referenced by queryBSWV(), and recordParams().

m_C2setVoltage

double MagAOX::app::siglentSDG::m_C2setVoltage {5.0}

protected

the set position voltage of Ch. 2.

Definition at line 57 of file siglentSDG.hpp.

m_C2sync

bool MagAOX::app::siglentSDG::m_C2sync {false}

protected

Definition at line 97 of file siglentSDG.hpp.

Referenced by appLogic(), checkSetup(), and recordParams().

m_C2vpp

double MagAOX::app::siglentSDG::m_C2vpp {0}

protected

The peak-2-peak voltage of channel 2.

Definition at line 82 of file siglentSDG.hpp.

Referenced by changeOfst(), onPowerOff(), queryBSWV(), and recordParams().

m_C2vpp_tgt

double MagAOX::app::siglentSDG::m_C2vpp_tgt {-1}

protected

Definition at line 94 of file siglentSDG.hpp.

Referenced by changeAmp(), changeFreq(), onPowerOff(), and queryBSWV().

m_C2vppDefault

double MagAOX::app::siglentSDG::m_C2vppDefault {0}

protected

default value for vpp of channel 2

Definition at line 83 of file siglentSDG.hpp.

Referenced by loadConfig(), and normalizeSetup().

m_C2wdth

double MagAOX::app::siglentSDG::m_C2wdth {0}

protected

The width of channel 2 (PULSE only)

Definition at line 86 of file siglentSDG.hpp.

Referenced by queryBSWV(), and recordParams().

m_C2wvtp

std::string MagAOX::app::siglentSDG::m_C2wvtp

protected

The wave type of channel 2.

Definition at line 87 of file siglentSDG.hpp.

Referenced by onPowerOff(), queryBSWV(), and recordParams().

m_calibDir

template<bool _useINDI = true>

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

protectedinherited

The path to calibration files for MagAOX.

Definition at line 196 of file MagAOXApp.hpp.

m_configBase

template<bool _useINDI = true>

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

protectedinherited

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

Definition at line 194 of file MagAOXApp.hpp.

m_configDir

template<bool _useINDI = true>

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

protectedinherited

The path to configuration files for MagAOX.

Definition at line 192 of file MagAOXApp.hpp.

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

m_configName

template<bool _useINDI = true>

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

protectedinherited

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

Definition at line 190 of file MagAOXApp.hpp.

Referenced by MagAOX::app::mzmqClient::loadConfig(), MagAOX::app::mzmqServer::loadConfig(), MagAOX::app::zaberCtrl::loadConfigImpl(), MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().

m_cpusetPath

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_cpusetPath { MAGAOX_cpusetPath }

protectedinherited

Path to the cpusets mount.

The path to the cpusets mount is configured by the environment variable defined by MAGOX_env_cpuset in environment.hpp. This environment variable is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used.

Definition at line 207 of file MagAOXApp.hpp.

m_deviceAddr

std::string MagAOX::app::siglentSDG::m_deviceAddr

protected

The device address.

Definition at line 48 of file siglentSDG.hpp.

Referenced by appLogic(), and loadConfig().

m_devicePort

std::string MagAOX::app::siglentSDG::m_devicePort

protected

The device port.

Definition at line 49 of file siglentSDG.hpp.

Referenced by appLogic(), and loadConfig().

m_driverCtrlName

template<bool _useINDI = true>

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

protectedinherited

Full path name of the INDI driver control FIFO.

This is currently only used to signal restarts.

Definition at line 727 of file MagAOXApp.hpp.

m_driverInName

template<bool _useINDI = true>

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

protectedinherited

Full path name of the INDI driver input FIFO.

Definition at line 719 of file MagAOXApp.hpp.

m_driverOutName

template<bool _useINDI = true>

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

protectedinherited

Full path name of the INDI driver output FIFO.

Definition at line 722 of file MagAOXApp.hpp.

m_euidCalled

template<bool _useINDI = true>

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidCalled

privateinherited

The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid).

Definition at line 422 of file MagAOXApp.hpp.

m_euidReal

template<bool _useINDI = true>

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidReal

privateinherited

The real user id of the proces (i.e. the lower privileged id of the user)

Definition at line 421 of file MagAOXApp.hpp.

m_gitAlert

template<bool _useINDI = true>

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

privateinherited

Definition at line 582 of file MagAOXApp.hpp.

m_indiCallBackMutex

template<bool _useINDI = true>

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

inherited

Mutex for locking INDI callback maps and per-entry callback state.

Lock ordering policy: 1) Prefer never holding both m_indiMutex and m_indiCallBackMutex at the same time. 2) If both are required in future code, always acquire m_indiMutex before m_indiCallBackMutex.

Definition at line 669 of file MagAOXApp.hpp.

m_indiDriver

template<bool _useINDI = true>

indiDriver<MagAOXApp>* MagAOX::app::MagAOXApp< _useINDI >::m_indiDriver { nullptr }

inherited

The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

Todo:

instead of making this public, provide an accessor.

Definition at line 659 of file MagAOXApp.hpp.

Referenced by MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::streamWriter::updateINDI(), and MagAOX::app::magAOXMaths::updateVals().

m_indiMutex

template<bool _useINDI = true>

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

inherited

Mutex for locking INDI communications.

Definition at line 662 of file MagAOXApp.hpp.

Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::baslerCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::cred2Ctrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), changeAmp(), changeFreq(), changeOfst(), changeOutp(), changePhse(), changeSync(), changeWdth(), changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::cred2Ctrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::picoMotorCtrl::newCallBack_picopos(), MagAOX::app::picoMotorCtrl::newCallBack_presetName(), MagAOX::app::acronameUsbHub::onPowerOff(), MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::cred2Ctrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), MagAOX::app::picamCtrl::onPowerOff(), onPowerOff(), MagAOX::app::xt1121Ctrl::onPowerOff(), MagAOX::app::zylaCtrl::onPowerOff(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), MagAOX::app::zylaCtrl::reconfig(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), MagAOX::app::cred2Ctrl::whilePowerOff(), MagAOX::app::ocam2KCtrl::whilePowerOff(), and MagAOX::app::zylaCtrl::whilePowerOff().

m_indiNewCallBacks

template<bool _useINDI = true>

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiNewCallBacks

protectedinherited

Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is the property name.

Definition at line 707 of file MagAOXApp.hpp.

m_indiP_C1amp

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1amp

protected

Definition at line 388 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1ampvrms

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1ampvrms

protected

Definition at line 389 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1freq

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1freq

protected

Definition at line 386 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1hlev

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1hlev

protected

Definition at line 391 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1llev

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1llev

protected

Definition at line 392 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1ofst

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1ofst

protected

Definition at line 390 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1outp

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1outp

protected

Definition at line 384 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryOUTP().

m_indiP_C1peri

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1peri

protected

Definition at line 387 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1phse

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1phse

protected

Definition at line 393 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1sync

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1sync

protected

Definition at line 395 of file siglentSDG.hpp.

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

m_indiP_C1wdth

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1wdth

protected

Definition at line 394 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C1wvtp

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C1wvtp

protected

Definition at line 385 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2amp

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2amp

protected

Definition at line 401 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2ampvrms

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2ampvrms

protected

Definition at line 402 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2freq

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2freq

protected

Definition at line 399 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2hlev

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2hlev

protected

Definition at line 404 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2llev

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2llev

protected

Definition at line 405 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2ofst

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2ofst

protected

Definition at line 403 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2outp

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2outp

protected

Definition at line 397 of file siglentSDG.hpp.

Referenced by appStartup(), and queryOUTP().

m_indiP_C2peri

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2peri

protected

Definition at line 400 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2phse

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2phse

protected

Definition at line 406 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2sync

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2sync

protected

Definition at line 408 of file siglentSDG.hpp.

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

m_indiP_C2wdth

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2wdth

protected

Definition at line 407 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_C2wvtp

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_C2wvtp

protected

Definition at line 398 of file siglentSDG.hpp.

Referenced by appStartup(), onPowerOff(), and queryBSWV().

m_indiP_clearFSMAlert

template<bool _useINDI = true>

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

protectedinherited

indi Property to clear an FSM alert.

Definition at line 1137 of file MagAOXApp.hpp.

m_indiP_powerChannel

template<bool _useINDI = true>

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

protectedinherited

INDI property used to communicate power state.

Definition at line 1193 of file MagAOXApp.hpp.

m_indiP_state

template<bool _useINDI = true>

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

protectedinherited

indi Property to report the application state.

Definition at line 1134 of file MagAOXApp.hpp.

m_indiP_status

pcf::IndiProperty MagAOX::app::siglentSDG::m_indiP_status

protected

Definition at line 382 of file siglentSDG.hpp.

Referenced by appStartup().

m_indiSetCallBacks

template<bool _useINDI = true>

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiSetCallBacks

protectedinherited

Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is device.name

Definition at line 712 of file MagAOXApp.hpp.

m_log

template<bool _useINDI>

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

staticinherited

Definition at line 345 of file MagAOXApp.hpp.

m_loopPause

template<bool _useINDI = true>

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_loopPause { MAGAOX_default_loopPause }

protectedinherited

The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X.

Definition at line 209 of file MagAOXApp.hpp.

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

m_maxFreq

std::vector<double> MagAOX::app::siglentSDG::m_maxFreq = {0.0, 2000, 3000}

private

Definition at line 40 of file siglentSDG.hpp.

Referenced by changeAmp(), and changeFreq().

m_maxInterval

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

inherited

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

Definition at line 83 of file telemeter.hpp.

m_pid

template<bool _useINDI = true>

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

protectedinherited

This process's PID.

Definition at line 506 of file MagAOXApp.hpp.

m_powerChannel

template<bool _useINDI = true>

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

protectedinherited

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

Definition at line 1179 of file MagAOXApp.hpp.

m_powerDevice

template<bool _useINDI = true>

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

protectedinherited

The INDI device name of the power controller.

Definition at line 1178 of file MagAOXApp.hpp.

m_poweredOn

bool MagAOX::app::siglentSDG::m_poweredOn {false}

private

Definition at line 101 of file siglentSDG.hpp.

Referenced by appLogic().

m_powerElement

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerElement { "state" }

protectedinherited

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

Definition at line 1180 of file MagAOXApp.hpp.

m_powerMgtEnabled

template<bool _useINDI = true>

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

protectedinherited

Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error.

Definition at line 1173 of file MagAOXApp.hpp.

Referenced by MagAOX::app::acronameUsbHub::acronameUsbHub(), MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::baslerCtrl::baslerCtrl(), MagAOX::app::cameraSim::cameraSim(), MagAOX::app::cred2Ctrl::cred2Ctrl(), MagAOX::app::filterWheelCtrl::filterWheelCtrl(), MagAOX::app::hsfwCtrl::hsfwCtrl(), MagAOX::app::mzmqClient::mzmqClient(), MagAOX::app::mzmqServer::mzmqServer(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::picamCtrl::picamCtrl(), MagAOX::app::picoMotorCtrl::picoMotorCtrl(), MagAOX::app::qhyCtrl::qhyCtrl(), siglentSDG(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), MagAOX::app::streamWriter::streamWriter(), MagAOX::app::ttmModulator::ttmModulator(), MagAOX::app::xt1121Ctrl::xt1121Ctrl(), MagAOX::app::xt1121DCDU::xt1121DCDU(), and MagAOX::app::zylaCtrl::zylaCtrl().

m_powerOnCounter

double MagAOX::app::siglentSDG::m_powerOnCounter {0}

private

Counts the number of loops since power-on, used to control logging of connect failures.

Definition at line 103 of file siglentSDG.hpp.

Referenced by appLogic().

m_powerOnWait

template<bool _useINDI = true>

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

protectedinherited

Default time in sec to wait for device to boot after power on.

Definition at line 1183 of file MagAOXApp.hpp.

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

m_powerState

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_powerState { -1 }

protectedinherited

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

Definition at line 1190 of file MagAOXApp.hpp.

Referenced by MagAOX::app::andorCtrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), changeAmp(), changeFreq(), changeOfst(), changeOutp(), changePhse(), changeSync(), changeWdth(), changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), checkSetup(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), queryARWV(), queryBSWV(), queryBTWV(), queryMDWV(), queryOUTP(), querySWWV(), querySYNC(), MagAOX::app::picamCtrl::reconfig(), libXWCTest::ocam2KCtrlTest::TEST_CASE(), writeCommand(), and writeRead().

m_powerTargetElement

template<bool _useINDI = true>

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetElement { "target" }

protectedinherited

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

Definition at line 1181 of file MagAOXApp.hpp.

m_powerTargetState

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState { -1 }

protectedinherited

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

Definition at line 1191 of file MagAOXApp.hpp.

Referenced by appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), changeAmp(), changeFreq(), changeOfst(), changeOutp(), changePhse(), changeSync(), changeWdth(), changeWvtp(), checkSetup(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::smc100ccCtrl::moveTo(), queryARWV(), queryBSWV(), queryBTWV(), queryMDWV(), queryOUTP(), querySWWV(), querySYNC(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::smc100ccCtrl::stop(), libXWCTest::ocam2KCtrlTest::TEST_CASE(), MagAOX::app::smc100ccCtrl::testConnection(), writeCommand(), and writeRead().

m_readTimeOut

int MagAOX::app::siglentSDG::m_readTimeOut {10000}

protected

The timeout for reading from the device [msec].

Definition at line 54 of file siglentSDG.hpp.

Referenced by appLogic(), loadConfig(), writeCommand(), and writeRead().

m_secretsPath

template<bool _useINDI = true>

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

protectedinherited

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

Definition at line 200 of file MagAOXApp.hpp.

m_self

template<bool _useINDI>

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

staticprivateinherited

Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers.

Definition at line 397 of file MagAOXApp.hpp.

m_shutdown

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_shutdown { 0 }

protectedinherited

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

Definition at line 214 of file MagAOXApp.hpp.

Referenced by appLogic(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::picoMotorCtrl::channelThreadExec(), checkSetup(), MagAOX::app::streamWriter::fgThreadExec(), MagAOX::app::andorCtrl::loadConfig(), MagAOX::app::baslerCtrl::loadConfig(), MagAOX::app::cameraSim::loadConfig(), MagAOX::app::cred2Ctrl::loadConfig(), MagAOX::app::picoMotorCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::streamWriter::loadConfig(), MagAOX::app::sysMonitor::loadConfig(), queryARWV(), queryBSWV(), queryBTWV(), queryMDWV(), queryOUTP(), querySWWV(), querySYNC(), MagAOX::app::sysMonitor::setlatThreadExec(), MagAOX::app::streamWriter::swThreadExec(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), writeCommand(), and writeRead().

m_state

template<bool _useINDI = true>

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::m_state { stateCodes::UNINITIALIZED }

privateinherited

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

Definition at line 576 of file MagAOXApp.hpp.

m_stateAlert

template<bool _useINDI = true>

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

privateinherited

Definition at line 579 of file MagAOXApp.hpp.

m_stateLogged

template<bool _useINDI = true>

int MagAOX::app::MagAOXApp< _useINDI >::m_stateLogged { 0 }

privateinherited

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

Definition at line 584 of file MagAOXApp.hpp.

m_suid

template<bool _useINDI = true>

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_suid

privateinherited

The save-set user id of the process.

Definition at line 424 of file MagAOXApp.hpp.

m_sysPath

template<bool _useINDI = true>

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

protectedinherited

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

Definition at line 198 of file MagAOXApp.hpp.

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

m_tel

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

inherited

Definition at line 81 of file telemeter.hpp.

m_telnetConn

tty::telnetConn MagAOX::app::siglentSDG::m_telnetConn

protected

The telnet connection manager.

Definition at line 65 of file siglentSDG.hpp.

Referenced by siglentSDG(), appLogic(), writeCommand(), and writeRead().

m_useINDI

template<bool _useINDI = true>

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

staticconstexprprotectedinherited

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

Definition at line 654 of file MagAOXApp.hpp.

m_waveform

std::string MagAOX::app::siglentSDG::m_waveform

protected

The chosen funciton to generate

Definition at line 67 of file siglentSDG.hpp.

Referenced by appStartup(), changeAmp(), changeFreq(), changePhse(), changeWdth(), loadConfig(), normalizeSetup(), onPowerOff(), and queryBSWV().

m_writeTimeOut

int MagAOX::app::siglentSDG::m_writeTimeOut {10000}

protected

The timeout for writing to the device [msec].

Definition at line 53 of file siglentSDG.hpp.

Referenced by appLogic(), loadConfig(), writeCommand(), and writeRead().

pidFileName

template<bool _useINDI = true>

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

protectedinherited

The name of the PID file.

Definition at line 504 of file MagAOXApp.hpp.

---

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

• apps/siglentSDG/siglentSDG.hpp