API
MagAOX::app::filterWheelCtrl Class Reference

#include <filterWheelCtrl.hpp>

Inheritance diagram for MagAOX::app::filterWheelCtrl:
Inheritance graph
Collaboration diagram for MagAOX::app::filterWheelCtrl:
Collaboration graph

Public Types

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

Public Member Functions

 filterWheelCtrl ()
 Default c'tor. More...
 
 ~filterWheelCtrl () noexcept
 D'tor, declared and defined for noexcept. More...
 
virtual void setupConfig ()
 Setup the configuration system (called by MagAOXApp::setup()) More...
 
virtual void loadConfig ()
 load the configuration system results (called by MagAOXApp::setup()) More...
 
virtual int appStartup ()
 Startup functions. More...
 
virtual int appLogic ()
 Implementation of the FSM for the TTM Modulator. More...
 
virtual int appShutdown ()
 Do any needed shutdown tasks. Currently nothing in this app. More...
 
virtual int onPowerOff ()
 This method is called when the change to poweroff is detected. More...
 
virtual int whilePowerOff ()
 This method is called while the power is off, once per FSM loop. More...
 
 INDI_NEWCALLBACK_DECL (filterWheelCtrl, m_indiP_counts)
 
int shutdown ()
 Get the value of the shutdown flag. More...
 
virtual void setDefaults (int argc, char **argv)
 Set the paths for config files. More...
 
virtual void setupBasicConfig ()
 The basic MagAO-X configuration setup method. Should not normally be overridden. More...
 
virtual void loadBasicConfig ()
 The basic MagAO-X configuration processing method. Should not normally be overridden. More...
 
virtual void checkConfig ()
 Check for unused and unrecognized config options and settings. More...
 
virtual int execute ()
 The execute method implementing the standard main loop. Should not normally be overridden. More...
 
int setupConfig (mx::app::appConfigurator &config)
 Setup an application configurator for the USB section. More...
 
int loadConfig (mx::app::appConfigurator &config)
 Load the USB section from an application configurator. More...
 
int getDeviceName ()
 Get the device name from udev using the vendor, product, and serial number. More...
 
int connect ()
 Connect to the device. More...
 
int setupConfig (mx::app::appConfigurator &config)
 Setup the configuration system. More...
 
int loadConfig (mx::app::appConfigurator &config)
 load the configuration system results More...
 
int telem (const typename telT::messageT &msg)
 Make a telemetry recording. More...
 
int telem ()
 Make a telemetry recording, for an empty record. More...
 
int setupConfig (appConfigurator &config)
 Setup an application configurator for the device section. More...
 
int loadConfig (appConfigurator &config)
 Load the device section from an application configurator. More...
 
int checkRecordTimes (const telT &tel, telTs... tels)
 Check the time of the last record for each telemetry type and make an entry if needed. More...
 
int checkRecordTimes (timespec &ts, const telT &tel, telTs... tels)
 Worker function to actually perform the record time checking logic. More...
 
int checkRecordTimes (timespec &ts)
 Empty function called at the end of the template list. More...
 
Threads
template<class thisPtr , class Function >
int threadStart (std::thread &thrd, bool &thrdInit, pid_t &tpid, pcf::IndiProperty &thProp, int thrdPrio, const std::string &cpuset, const std::string &thrdName, thisPtr *thrdThis, Function &&thrdStart)
 Start a thread, using this class's privileges to set priority, etc. More...
 
Member Accessors
std::string configName ()
 Get the config name. More...
 
std::string configDir ()
 Get the config directory. More...
 
std::string driverInName ()
 Get the INDI input FIFO file name. More...
 
std::string driverOutName ()
 Get the INDI output FIFO file name. More...
 
std::string driverCtrlName ()
 Get the INDI control FIFO file name. More...
 

Public Attributes

std::string m_idVendor
 The vendor id 4-digit code. More...
 
std::string m_idProduct
 The product id 4-digit code. More...
 
std::string m_serial
 The serial number. More...
 
speed_t m_baudRate {0}
 The baud rate specification. More...
 
std::string m_deviceName
 The device path name, e.g. /dev/ttyUSB0. More...
 
int m_fileDescrip {0}
 The file descriptor. More...
 
logManagerT m_tel
 
double m_maxInterval
 The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds. More...
 

Protected Member Functions

int onPowerOnConnect ()
 Set up the MCBL controller, called after each power-on/connection. More...
 
int getSwitch ()
 Get the home switch status, sets m_switch to true or false. More...
 
int getMoving ()
 Get the moving-state of the wheel, sets m_moving to true or false. More...
 
int getPos ()
 Get the current position of the wheel, sets m_rawPos to the current motor counts. More...
 
int startHoming ()
 Start a high-level homing sequence. More...
 
int presetNumber ()
 
int home ()
 Start a low-level homing sequence. More...
 
int stop ()
 Stop the wheel motion immediately. More...
 
int moveToRaw (const long &counts)
 Move to an absolute position in raw counts. More...
 
int moveToRawRelative (const long &counts)
 Move to a new position relative to current, in raw counts. More...
 
int moveTo (const double &filters)
 Move to an absolute position in filter units. More...
 
Telemeter Interface
int checkRecordTimes ()
 
int recordTelem (const telem_stage *)
 
int recordTelem (const telem_position *)
 
int recordStage (bool force=false)
 
int recordPosition (bool force=false)
 

Protected Attributes

pcf::IndiProperty m_indiP_counts
 The position of the wheel in counts. More...
 
std::string MagAOXPath
 The base path of the MagAO-X system. More...
 
std::string m_configName
 The name of the configuration file (minus .conf). More...
 
std::string m_configDir
 The path to configuration files for MagAOX. More...
 
std::string m_configBase
 The name of a base config class for this app (minus .conf). More...
 
std::string m_calibDir
 The path to calibration files for MagAOX. More...
 
std::string sysPath
 The path to the system directory, for PID file, etc. More...
 
std::string secretsPath
 Path to the secrets directory, where passwords, etc, are stored. More...
 
unsigned long m_loopPause {MAGAOX_default_loopPause}
 The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X. More...
 
int m_shutdown {0}
 Flag to signal it's time to shutdown. When not 0, the main loop exits. More...
 
std::string m_presetNotation
 Notation used to refer to a preset, should be singular, as in "preset" or "filter". More...
 
bool m_fractionalPresets
 Flag to set in constructor determining if fractional presets are allowed. Used for INDI/GUIs. More...
 
bool m_defaultPositions
 Flag controlling whether the default preset positions (the vector index) are set in loadConfig. More...
 
int8_t m_moving
 Whether or not the stage is moving. -2 means powered off, -1 means not homed, 0 means not moving, 1 means moving, 2 means homing.
More...
 
int8_t m_movingState
 Used to track the type of command. If > 1 this is a command to move to a preset. If 0 then it is a move to an arbitrary position. More...
 
double m_preset
 The current numerical preset position [1.0 is index 0 in the preset name vector]. More...
 
double m_preset_target
 The target numerical preset position [1.0 is index 0 in the preset name vector]. More...
 
Non-configurable parameters
int m_motorType {2}
 
Configurable Parameters
int m_writeTimeOut {1000}
 The timeout for writing to the device [msec]. More...
 
int m_readTimeOut {1000}
 The timeout for reading from the device [msec]. More...
 
double m_acceleration {100}
 
double m_deceleration {50}
 
double m_motorSpeed {3000}
 
long m_circleSteps {0}
 The number of position counts in 1 360-degree revolution. More...
 
long m_homeOffset {0}
 The number of position counts to offset from the home position. More...
 
Status
bool m_switch {false}
 The home switch status. More...
 
long m_rawPos {0}
 The position of the wheel in motor counts. More...
 
int m_homingState {0}
 The homing state, tracks the stages of homing. More...
 
cpusets

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

std::string m_cpusetPath {MAGAOX_cpusetPath}
 
Configurable Parameters
bool m_powerOnHome
 If true, then the motor is homed at startup (by this software or actual power on) More...
 
int m_homePreset
 If >=0, this preset position is moved to after homing. More...
 
std::vector< std::string > m_presetNames
 The names of each position on the stage. More...
 
std::vector< double > m_presetPositions
 The positions, in arbitrary units, of each preset. If 0, then the integer position number (starting from 1) is used to calculate. More...
 

Private Member Functions

int clearFSMAlert ()
 Clear the FSM alert state. More...
 
filterWheelCtrlderived ()
 

Friends

class dev::stdMotionStage< filterWheelCtrl >
 
class dev::telemeter< filterWheelCtrl >
 

PID Locking

Each MagAOXApp has a PID lock file in the system directory. The app will not startup if it detects that the PID is already locked, preventing duplicates. This is based on the configured name, not the invoked name (argv[0]).

std::string pidFileName
 The name of the PID file. More...
 
pid_t m_pid {0}
 This process's PID. More...
 
int lockPID ()
 Attempt to lock the PID by writing it to a file. Fails if a process is already running with the same config name. More...
 
int unlockPID ()
 Remove the PID file. More...
 

INDI Interface

For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property.

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

Power Management

For devices which have remote power management (e.g. from one of the PDUs) we implement a standard power state monitoring and management component for the FSM. This needs to be enabled in the derived app constructor. To stay enabled, m_powerDevice and m_powerChannel must be not empty strings after the configuration. These could be set in the derived app defaults.

If power management is enabled, then while power is off, appLogic will not be called. Instead a parrallel set of virtual functions is called, onPowerOff (to allow apps to perform cleanup) and whilePowerOff (to allow apps to keep variables updated, etc). Note that these could merely call appLogic if desired.

bool m_powerMgtEnabled {false}
 Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error. More...
 
std::string m_powerDevice
 The INDI device name of the power controller. More...
 
std::string m_powerChannel
 The INDI property name of the channel controlling this device's power. More...
 
std::string m_powerElement {"state"}
 The INDI element name to monitor for this device's power state. More...
 
std::string m_powerTargetElement {"target"}
 The INDI element name to monitor for this device's power state. More...
 
unsigned long m_powerOnWait {0}
 Time in sec to wait for device to boot after power on. More...
 
int m_powerOnCounter {-1}
 Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup. More...
 
int m_powerState {-1}
 Current power state, 1=On, 0=Off, -1=Unk. More...
 
int m_powerTargetState {-1}
 Current target power state, 1=On, 0=Off, -1=Unk. More...
 
pcf::IndiProperty m_indiP_powerChannel
 INDI property used to communicate power state. More...
 
int powerState ()
 Returns the current power state. More...
 
int powerStateTarget ()
 Returns the target power state. More...
 
 INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)
 
bool powerOnWaitElapsed ()
 This method tests whether the power on wait time has elapsed. More...
 

INDI

pcf::IndiProperty m_indiP_preset
 The position of the stage in presets. More...
 
pcf::IndiProperty m_indiP_presetName
 The name of the nearest preset for this position. More...
 
pcf::IndiProperty m_indiP_home
 Command the stage to home. . More...
 
pcf::IndiProperty m_indiP_stop
 Command the stage to halt. More...
 
int newCallBack_m_indiP_preset (const pcf::IndiProperty &ipRecv)
 Callback to process a NEW preset position request. More...
 
int newCallBack_m_indiP_presetName (const pcf::IndiProperty &ipRecv)
 Callback to process a NEW preset name request. More...
 
int newCallBack_m_indiP_home (const pcf::IndiProperty &ipRecv)
 Callback to process a NEW home request switch toggle. More...
 
int newCallBack_m_indiP_stop (const pcf::IndiProperty &ipRecv)
 Callback to process a NEW stop request switch toggle. More...
 
int updateINDI ()
 Update the INDI properties for this device controller. More...
 
static int st_newCallBack_stdMotionStage (void *app, const pcf::IndiProperty &ipRecv)
 The static callback function to be registered for stdMotionStage properties. More...
 

Logging

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

Application State

stateCodes::stateCodeT state ()
 Get the current state code. More...
 
void state (const stateCodes::stateCodeT &s, bool stateAlert=false)
 Set the current state code. More...
 
int stateLogged ()
 Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards. More...
 
stateCodes::stateCodeT m_state {stateCodes::UNINITIALIZED}
 The application's state. Never ever set this directly, use state(const stateCodeT & s). More...
 
bool m_stateAlert {false}
 
bool m_gitAlert {false}
 
int m_stateLogged {0}
 Counter and flag for use to log errors just once. Never ever access directly, use stateLogged(). More...
 

Signal Handling

libMagAOX/logger/types/software_log.hpp

static MagAOXAppm_self = nullptr
 Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers. More...
 
static void _handlerSigTerm (int signum, siginfo_t *siginf, void *ucont)
 The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm. More...
 
int setSigTermHandler ()
 Sets the handler for SIGTERM, SIGQUIT, and SIGINT. More...
 
void handlerSigTerm (int signum, siginfo_t *siginf, void *ucont)
 Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal. More...
 

Privilege Management

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

Detailed Description

MagAO-X application to control a Faulhaber MCBL controlled filter wheel.

Todo:

add temperature monitoring

add INDI props to md doc

should move in least time direction, rather than always in the same direction.

add tests

should be an iodevice

Definition at line 43 of file filterWheelCtrl.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 561 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 558 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 555 of file MagAOXApp.hpp.

◆ logManagerT [1/2]

The log manager type.

Definition at line 54 of file telemeter.hpp.

◆ logManagerT [2/2]

template<bool _useINDI = true>
typedef logger::logManager<MagAOXApp<_useINDI>, logFileRaw> MagAOX::app::MagAOXApp< _useINDI >::logManagerT
inherited

The log manager type.

Definition at line 82 of file MagAOXApp.hpp.

Constructor & Destructor Documentation

◆ filterWheelCtrl()

MagAOX::app::filterWheelCtrl::filterWheelCtrl ( )
inline

Default c'tor.

Definition at line 247 of file filterWheelCtrl.hpp.

◆ ~filterWheelCtrl()

MagAOX::app::filterWheelCtrl::~filterWheelCtrl ( )
inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 96 of file filterWheelCtrl.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]signumspecifies the signal.
[in]siginfignored by MagAOXApp
[in]ucontignored by MagAOXApp

Definition at line 1709 of file MagAOXApp.hpp.

◆ appLogic()

int MagAOX::app::filterWheelCtrl::appLogic ( )
inlinevirtual

Implementation of the FSM for the TTM Modulator.

Returns
0 on success
-1 on error.

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

Definition at line 327 of file filterWheelCtrl.hpp.

◆ appShutdown()

int MagAOX::app::filterWheelCtrl::appShutdown ( )
inlinevirtual

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

Returns
0 on success
-1 on error.

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

Definition at line 654 of file filterWheelCtrl.hpp.

◆ appStartup()

int MagAOX::app::filterWheelCtrl::appStartup ( )
inlinevirtual

Startup functions.

Setsup the INDI vars.

Returns
0 on success
-1 on error.

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

Definition at line 303 of file filterWheelCtrl.hpp.

◆ checkConfig()

template<bool _useINDI>
void MagAOX::app::MagAOXApp< _useINDI >::checkConfig
virtualinherited

Check for unused and unrecognized config options and settings.

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

Definition at line 1327 of file MagAOXApp.hpp.

◆ checkRecordTimes() [1/4]

int MagAOX::app::filterWheelCtrl::checkRecordTimes ( )
protected

Definition at line 962 of file filterWheelCtrl.hpp.

◆ checkRecordTimes() [2/4]

int MagAOX::app::dev::telemeter< filterWheelCtrl >::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 131 of file telemeter.hpp.

◆ checkRecordTimes() [3/4]

int MagAOX::app::dev::telemeter< filterWheelCtrl >::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 152 of file telemeter.hpp.

◆ checkRecordTimes() [4/4]

int MagAOX::app::dev::telemeter< filterWheelCtrl >::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 142 of file telemeter.hpp.

◆ clearFSMAlert()

template<bool _useINDI>
int MagAOX::app::MagAOXApp< _useINDI >::clearFSMAlert
privateinherited

Clear the FSM alert state.

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

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

◆ configLog()

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

Callback for config system logging.

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

Parameters
[in]nameThe name of the config value
[in]codenumeric code specifying the type
[in]valuethe value read by the config system
[in]sourcethe source of the value.

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

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

◆ connect()

int MagAOX::tty::usbDevice::connect ( )
inherited

Connect to the device.

Closes the device file descriptor if open, then calls ttyOpenRaw.

Returns
TTY_E_NOERROR on success.
TTY_E_TCGETATTR on a error from tcgetattr.
TTY_E_TCSETATTR on an error from tcsetattr.
TTY_E_SETISPEED on a cfsetispeed error.
TTY_E_SETOSPEED on a cfsetospeed error.

Definition at line 108 of file usbDevice.cpp.

Referenced by appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), and MagAOX::app::rhusbMon::connect().

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

◆ createROIndiNumber()

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

Create a ReadOnly INDI Number property.

Returns
0 on success
-1 on error
Parameters
[out]propthe property to create and setup
[in]propNamethe 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 2294 of file MagAOXApp.hpp.

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

◆ createROIndiText()

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

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

Returns
0 on success
-1 on error
Parameters
[out]propthe property to create and setup
[in]propNamethe name of the property
[in]elNamethe 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 2209 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]propthe property to create and setup
[in]namethe name of the property
[in]minthe minimum value for the elements, applied to both target and current
[in]maxthe minimum value for the elements, applied to both target and current
[in]stepthe step size for the elements, applied to both target and current
[in]formatthe _ 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 2246 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]propthe property to create and setup
[in]namethe 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 2352 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]propthe property to create and setup
[in]namethe name of the property,
[in]elementsthe 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 2426 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]propthe property to create and setup
[in]namethe name of the property,
[in]elementsthe element names to give to the switches
[in]elementLabelsthe 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 2383 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]propthe property to create and setup
[in]propNamethe 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 2180 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]propthe property to create and setup
[in]namethe 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 2321 of file MagAOXApp.hpp.

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

◆ derived()

filterWheelCtrl & MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::derived ( )
inlineprivateinherited

Definition at line 256 of file stdMotionStage.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 3265 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 3253 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 3259 of file MagAOXApp.hpp.

◆ execute()

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

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

Performs final startup steps. That is:

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

◆ getDeviceName()

int MagAOX::tty::usbDevice::getDeviceName ( )
inherited

◆ getMoving()

int MagAOX::app::filterWheelCtrl::getMoving ( )
protected

Get the moving-state of the wheel, sets m_moving to true or false.

Returns
0 on success.
-1 on error.

Definition at line 771 of file filterWheelCtrl.hpp.

Referenced by appLogic().

◆ getPos()

int MagAOX::app::filterWheelCtrl::getPos ( )
protected

Get the current position of the wheel, sets m_rawPos to the current motor counts.

Returns
0 on success.
-1 on error.

Definition at line 799 of file filterWheelCtrl.hpp.

Referenced by appLogic().

◆ getSwitch()

int MagAOX::app::filterWheelCtrl::getSwitch ( )
protected

Get the home switch status, sets m_switch to true or false.

Returns
0 on success.
-1 on error.

Definition at line 750 of file filterWheelCtrl.hpp.

Referenced by appLogic().

◆ 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]ipRecvThe property being sent.

Definition at line 2759 of file MagAOXApp.hpp.

◆ handleGetProperties()

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

Handler for the get INDI properties request.

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

Parameters
[in]ipRecvThe property being requested.

Definition at line 2765 of file MagAOXApp.hpp.

◆ handleNewProperty()

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

Handler for the new INDI property request.

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

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

Todo:
handle errors, are they FATAL?
Parameters
[in]ipRecvThe property being changed.

Definition at line 2827 of file MagAOXApp.hpp.

Referenced by MagAOXApp_tests::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]signumspecifies the signal.
[in]siginfignored by MagAOXApp
[in]ucontignored by MagAOXApp

Definition at line 1718 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]ipRecvThe property being changed.

Definition at line 2849 of file MagAOXApp.hpp.

◆ home()

int MagAOX::app::filterWheelCtrl::home ( )
protected

Start a low-level homing sequence.

This initiates the device homing sequence.

Returns
0 on success.
-1 on error.

Definition at line 850 of file filterWheelCtrl.hpp.

Referenced by appLogic(), and startHoming().

◆ INDI_NEWCALLBACK_DECL()

MagAOX::app::filterWheelCtrl::INDI_NEWCALLBACK_DECL ( filterWheelCtrl  ,
m_indiP_counts   
)

◆ INDI_SETCALLBACK_DECL()

template<bool _useINDI = true>
MagAOX::app::MagAOXApp< _useINDI >::INDI_SETCALLBACK_DECL ( MagAOXApp< _useINDI >  ,
m_indiP_powerChannel   
)
inherited

◆ indiTargetUpdate()

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

Get the target element value from an new property.

Returns
0 on success
-1 on error
Parameters
[out]localPropertyThe local property to update
[out]localTargetThe local value to update
[in]remotePropertythe new property received
[in]setBusy[optional] set property to busy if true

Definition at line 2951 of file MagAOXApp.hpp.

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

◆ loadBasicConfig()

template<bool _useINDI>
void MagAOX::app::MagAOXApp< _useINDI >::loadBasicConfig
virtualinherited

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

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

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

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

Definition at line 1278 of file MagAOXApp.hpp.

◆ loadConfig() [1/4]

void MagAOX::app::filterWheelCtrl::loadConfig ( )
inlinevirtual

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

Definition at line 276 of file filterWheelCtrl.hpp.

◆ loadConfig() [2/4]

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

Load the device section from an application configurator.

Returns
0 on success
-1 on error (nothing implemented yet)
Parameters
[in]configan application configuration from which to load values

Definition at line 95 of file telemeter.hpp.

◆ loadConfig() [3/4]

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::loadConfig ( mx::app::appConfigurator &  config)
inherited

load the configuration system results

This should be called in derivedT::loadConfig as

stdMotionStage<derivedT>::loadConfig(config);

with appropriate error checking.

Parameters
[in]configthe derived classes configurator

Definition at line 106 of file stdMotionStage.hpp.

◆ loadConfig() [4/4]

int MagAOX::tty::usbDevice::loadConfig ( mx::app::appConfigurator &  config)
inherited

Load the USB section from an application configurator.

If config does not contain a baud rate, m_baudRate is unchanged. If m_baudRate is 0 at the end of this method, an error is returned. Set m_baudRate prior to calling to avoid this error.

Returns
0 on success
-1 on error (nothing implemented yet)
Parameters
[in]configan application configuration from which to load values

Definition at line 34 of file usbDevice.cpp.

Referenced by loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::zaberLowLevel::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::koolanceCtrl::loadConfigImpl(), MagAOX::app::pi335Ctrl::loadConfigImpl(), and MagAOX::app::rhusbMon::loadConfigImpl().

◆ 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 1796 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
logTthe log entry type
retvalthe value returned by this method.
Parameters
[in]msgthe message to log
[in]level[optional] the log level. The default is used if not specified.

Definition at line 1590 of file MagAOXApp.hpp.

Referenced by MagAOX::app::zylaCtrl::acquireAndCheckValid(), MagAOX::app::streamWriter::allocate_circbufs(), MagAOX::app::streamWriter::allocate_xrif(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::qhyCtrl::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::acronameUsbHub::appStartup(), MagAOX::app::andorCtrl::appStartup(), MagAOX::app::cameraSim::appStartup(), appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picamCtrl::appStartup(), MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::qhyCtrl::appStartup(), MagAOX::app::siglentSDG::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::andorCtrl::cameraSelect(), MagAOX::app::zylaCtrl::cameraSelect(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::sysMonitor::findChronyStatus(), MagAOX::app::sysMonitor::findCPULoads(), MagAOX::app::sysMonitor::findCPUTemperatures(), MagAOX::app::sysMonitor::findDiskUsage(), MagAOX::app::sysMonitor::findRamUsage(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::andorCtrl::getFPS(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::zylaCtrl::getTemp(), MagAOX::app::ocam2KCtrl::getTemps(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), home(), MagAOX::app::streamWriter::initialize_xrif(), MagAOX::app::zylaCtrl::loadImageIntoStream(), audibleAlerts.core.AudibleAlerts::loop(), MagAOX::app::ttmModulator::modTTM(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::zaberCtrl::moveTo(), moveToRaw(), moveToRawRelative(), MagAOX::app::picoMotorCtrl::newCallBack_picopos(), MagAOX::app::ttmModulator::offset12(), onPowerOnConnect(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), MagAOX::app::zylaCtrl::reconfig(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ttmModulator::restTTM(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::zylaCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), MagAOX::app::ttmModulator::setTTM(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::zylaCtrl::startAcquisition(), MagAOX::app::zaberCtrl::startHoming(), stop(), MagAOX::app::zaberCtrl::stop(), MagAOX::app::acronameUsbHub::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::acronameUsbHub::turnOutletOn(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), MagAOX::app::acronameUsbHub::updateOutletState(), and MagAOX::app::xt1121DCDU::updateOutletState().

◆ log() [2/2]

template<bool _useINDI>
template<typename logT , int retval>
int MagAOX::app::MagAOXApp< _useINDI >::log ( logPrioT  level = logPrio::LOG_DEFAULT)
staticinherited

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

◆ moveTo()

int MagAOX::app::filterWheelCtrl::moveTo ( const double &  filters)
protected

Move to an absolute position in filter units.

Returns
0 on success.
-1 on error.
Parameters
[in]filtersThe new position in absolute filter units

Definition at line 951 of file filterWheelCtrl.hpp.

Referenced by appLogic().

◆ moveToRaw()

int MagAOX::app::filterWheelCtrl::moveToRaw ( const long &  counts)
protected

Move to an absolute position in raw counts.

Returns
0 on success.
-1 on error.
Parameters
[in]countsThe new position in absolute motor counts

Definition at line 901 of file filterWheelCtrl.hpp.

Referenced by appLogic(), and moveTo().

◆ moveToRawRelative()

int MagAOX::app::filterWheelCtrl::moveToRawRelative ( const long &  counts)
protected

Move to a new position relative to current, in raw counts.

Returns
0 on success.
-1 on error.
Parameters
[in]countsThe new position in relative motor counts

Definition at line 926 of file filterWheelCtrl.hpp.

Referenced by appLogic().

◆ 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]ipRecvthe INDI property sent with the the new property request.

Definition at line 3130 of file MagAOXApp.hpp.

◆ newCallBack_m_indiP_home()

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::newCallBack_m_indiP_home ( const pcf::IndiProperty &  ipRecv)
inherited

Callback to process a NEW home request switch toggle.

Returns
0 on success.
-1 on error.
Parameters
[in]ipRecvthe INDI property sent with the the new property request.

Definition at line 227 of file stdMotionStage.hpp.

◆ newCallBack_m_indiP_preset()

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::newCallBack_m_indiP_preset ( const pcf::IndiProperty &  ipRecv)
inherited

Callback to process a NEW preset position request.

Returns
0 on success.
-1 on error.
Parameters
[in]ipRecvthe INDI property sent with the the new property request.

Definition at line 213 of file stdMotionStage.hpp.

◆ newCallBack_m_indiP_presetName()

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::newCallBack_m_indiP_presetName ( const pcf::IndiProperty &  ipRecv)
inherited

Callback to process a NEW preset name request.

Returns
0 on success.
-1 on error.
Parameters
[in]ipRecvthe INDI property sent with the the new property request.

Definition at line 220 of file stdMotionStage.hpp.

◆ newCallBack_m_indiP_stop()

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::newCallBack_m_indiP_stop ( const pcf::IndiProperty &  ipRecv)
inherited

Callback to process a NEW stop request switch toggle.

Returns
0 on success.
-1 on error.
Parameters
[in]ipRecvthe INDI property sent with the the new property request.

Definition at line 234 of file stdMotionStage.hpp.

◆ onPowerOff()

int MagAOX::app::filterWheelCtrl::onPowerOff ( )
inlinevirtual

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

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

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

Definition at line 661 of file filterWheelCtrl.hpp.

◆ onPowerOnConnect()

int MagAOX::app::filterWheelCtrl::onPowerOnConnect ( )
protected

Set up the MCBL controller, called after each power-on/connection.

Returns
0 on success.
-1 on error.

Definition at line 717 of file filterWheelCtrl.hpp.

Referenced by appLogic().

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

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

◆ powerState()

template<bool _useINDI>
int MagAOX::app::MagAOXApp< _useINDI >::powerState
inherited

◆ powerStateTarget()

template<bool _useINDI>
int MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget
inherited

◆ presetNumber()

int MagAOX::app::filterWheelCtrl::presetNumber ( )
protected

Definition at line 828 of file filterWheelCtrl.hpp.

◆ recordPosition()

int MagAOX::app::filterWheelCtrl::recordPosition ( bool  force = false)
protected

◆ recordStage()

int MagAOX::app::filterWheelCtrl::recordStage ( bool  force = false)
protected

◆ recordTelem() [1/2]

int MagAOX::app::filterWheelCtrl::recordTelem ( const telem_position )
protected

Definition at line 972 of file filterWheelCtrl.hpp.

◆ recordTelem() [2/2]

int MagAOX::app::filterWheelCtrl::recordTelem ( const telem_stage )
protected

Definition at line 967 of file filterWheelCtrl.hpp.

◆ registerIndiPropertyNew() [1/3]

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

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

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

Returns
0 on success.
-1 on error.
Parameters
[out]propthe property to register
[in]propNamethe name of the property
[in]propTypethe type of the property
[in]propPermthe permissions of the property
[in]propStatethe state of the property
[in]propRulethe 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]propthe property to register
[in]propNamethe name of the property
[in]propTypethe type of the property
[in]propPermthe permissions of the property
[in]propStatethe 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]propthe property to register, must be fully set up

Referenced by appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::zaberCtrl::appStartup(), and MagAOXApp_tests::SCENARIO().

◆ registerIndiPropertyReadOnly() [1/2]

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

Register an INDI property which is read only.

This version requires the property be fully set up.

Returns
0 on success.
-1 on error.
Parameters
[in]propthe property to register, must be completely setup

Definition at line 2437 of file MagAOXApp.hpp.

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

◆ registerIndiPropertyReadOnly() [2/2]

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

Register an INDI property which is read only.

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

Returns
0 on success.
-1 on error.
Parameters
[out]propthe property to register, will be configured
[in]propNamethe name of the property
[in]propTypethe type of the property
[in]propPermthe permissions of the property
[in]propStatethe state of the property

Definition at line 2463 of file MagAOXApp.hpp.

◆ registerIndiPropertySet()

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

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

Returns
0 on success.
-1 on error.
Parameters
[out]propthe property to register
[in]devNamethe device which owns this property
[in]propNamethe name of the property

Definition at line 2569 of file MagAOXApp.hpp.

◆ sendGetPropertySetList()

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

Definition at line 2723 of file MagAOXApp.hpp.

◆ sendNewProperty() [1/2]

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

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

Returns
0 on success.
-1 on an error, which will be logged
Parameters
[in]ipSendThe property to send a "new" INDI command for

Definition at line 3066 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]ipSendThe property to send a "new" INDI command for
[in]elThe element of the property to change
[in]newValThe value to request for the element.

Definition at line 3031 of file MagAOXApp.hpp.

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

◆ sendNewStandardIndiToggle()

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

Send a new property commmand for a standard toggle switch.

Returns
0 on success
-1 on an error, which will be logged.
Parameters
[in]deviceThe device name
[in]propertyThe property name
[in]onoffSwitch state to send: true = on, false = off

Definition at line 3084 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]argcstandard command line result specifying number of arguments in argv
[in]argvstandard command line result containing the arguments.

Definition at line 1152 of file MagAOXApp.hpp.

◆ setEuidCalled()

template<bool _useINDI>
int MagAOX::app::MagAOXApp< _useINDI >::setEuidCalled
privateinherited

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

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

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

Returns
0 on success
-1 on error from setuid().

Definition at line 1757 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 1776 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 1660 of file MagAOXApp.hpp.

◆ setupBasicConfig()

template<bool _useINDI>
void MagAOX::app::MagAOXApp< _useINDI >::setupBasicConfig
virtualinherited

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

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

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

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

Definition at line 1249 of file MagAOXApp.hpp.

◆ setupConfig() [1/4]

void MagAOX::app::filterWheelCtrl::setupConfig ( )
inlinevirtual

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

Definition at line 257 of file filterWheelCtrl.hpp.

◆ setupConfig() [2/4]

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

Setup an application configurator for the device section.

Returns
0 on success.
-1 on error (nothing implemented yet)
Parameters
[in]configan application configuration to setup

Definition at line 87 of file telemeter.hpp.

◆ setupConfig() [3/4]

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::setupConfig ( mx::app::appConfigurator &  config)
inherited

Setup the configuration system.

This should be called in derivedT::setupConfig as

stdMotionStage<derivedT>::setupConfig(config);

with appropriate error checking.

Parameters
[out]configthe derived classes configurator

Definition at line 96 of file stdMotionStage.hpp.

◆ setupConfig() [4/4]

int MagAOX::tty::usbDevice::setupConfig ( mx::app::appConfigurator &  config)
inherited

Setup an application configurator for the USB section.

Returns
0 on success.
-1 on error (nothing implemented yet)
Parameters
[in]configan application configuration to setup

Definition at line 24 of file usbDevice.cpp.

Referenced by setupConfig(), MagAOX::app::flipperCtrl::setupConfig(), MagAOX::app::koolanceCtrl::setupConfig(), MagAOX::app::pi335Ctrl::setupConfig(), MagAOX::app::rhusbMon::setupConfig(), MagAOX::app::smc100ccCtrl::setupConfig(), and MagAOX::app::zaberLowLevel::setupConfig().

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

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

◆ st_newCallBack_clearFSMAlert()

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

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

Returns
0 on success.
-1 on error.
Parameters
[in]appa pointer to this, will be static_cast-ed to MagAOXApp.
[in]ipRecvthe INDI property sent with the the new property request.

Definition at line 3122 of file MagAOXApp.hpp.

◆ st_newCallBack_stdMotionStage()

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::st_newCallBack_stdMotionStage ( void *  app,
const pcf::IndiProperty &  ipRecv 
)
staticinherited

The static callback function to be registered for stdMotionStage properties.

Dispatches to the relevant handler

Returns
0 on success.
-1 on error.
Parameters
[in]appa pointer to this, will be static_cast-ed to derivedT.
[in]ipRecvthe INDI property sent with the the new property request.

Definition at line 204 of file stdMotionStage.hpp.

◆ startHoming()

int MagAOX::app::filterWheelCtrl::startHoming ( )
protected

Start a high-level homing sequence.

For this device this includes the homing dither.

Returns
0 on success.
-1 on error.

Definition at line 817 of file filterWheelCtrl.hpp.

Referenced by appLogic().

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

Referenced by MagAOX::app::picamCtrl::acquireAndCheckValid(), MagAOX::app::qhyCtrl::acquireAndCheckValid(), MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::siglentSDG::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::cameraSim::appStartup(), 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(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::cameraSim::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::qhyCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::qhyCtrl::getExpTime(), MagAOX::app::qhyCtrl::getTemp(), MagAOX::app::picamCtrl::getTemps(), home(), MagAOX::app::qhyCtrl::loadImageIntoStream(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::andorCtrl::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::qhyCtrl::setNextROI(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::cameraSim::startAcquisition(), MagAOX::app::qhyCtrl::startAcquisition(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::ocam2KCtrl::stateStringValid(), MagAOX::app::streamWriter::swThreadExec(), MagAOX::app::acronameUsbHub::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletStates(), and MagAOX::app::siglentSDG::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]sThe new application state
[in]stateAlert[optional] flag to set the alert state of the FSM property.

Definition at line 2088 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
{
if(!stateLogged()) log<text_log>("Not connected");
}
stateCodes::stateCodeT state()
Get the current state code.
Definition: MagAOXApp.hpp:2082
int stateLogged()
Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change,...
Definition: MagAOXApp.hpp:2140
@ NOTCONNECTED
The application is not connected to the device or service.
Definition: stateCodes.hpp:44

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

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

◆ stop()

int MagAOX::app::filterWheelCtrl::stop ( )
protected

Stop the wheel motion immediately.

Returns
0 on success.
-1 on error.

Definition at line 884 of file filterWheelCtrl.hpp.

◆ telem() [1/2]

Make a telemetry recording, for an empty record.

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

Template Parameters
logTthe log entry type
retvalthe value returned by this method.

Definition at line 80 of file telemeter.hpp.

◆ telem() [2/2]

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

Make a telemetry recording.

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

Template Parameters
logTthe log entry type
retvalthe value returned by this method.
Parameters
[in]msgthe data to log

Definition at line 70 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]thrdThe 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]thrdPrioThe r/t priority to set for this thread
[in]cpusetthe cpuset to place this thread on. Ignored if "".
[in]thrdNameThe name of the thread (just for logging)
[in]thrdThisThe `this` pointer to pass to the thread starter function
[in]thrdStartThe thread starting function, a static function taking a `this` pointer as argument.

Definition at line 1950 of file MagAOXApp.hpp.

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

◆ unlockPID()

template<bool _useINDI>
int MagAOX::app::MagAOXApp< _useINDI >::unlockPID
protectedinherited

Remove the PID file.

Definition at line 1927 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]elThe element name
[in]newValthe new value

Definition at line 2891 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]elBeginning of each element name
[in]newValsthe new values
[in]ipState[optional] the new state

Definition at line 2916 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]elThe element name
[in]newValthe new value

Definition at line 2877 of file MagAOXApp.hpp.

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

◆ updateIfChanged() [4/4]

template<bool _useINDI>
template<typename T >
void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged ( pcf::IndiProperty &  p,
const std::vector< std::string > &  els,
const std::vector< T > &  newVals 
)
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]elsString vector of element names
[in]newValsthe new values

Definition at line 2936 of file MagAOXApp.hpp.

◆ updateINDI()

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::updateINDI
inherited

Update the INDI properties for this device controller.

You should call this once per main loop. It is not called automatically.

Returns
0 on success.
-1 on error.

Definition at line 243 of file stdMotionStage.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

◆ whilePowerOff()

int MagAOX::app::filterWheelCtrl::whilePowerOff ( )
inlinevirtual

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

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

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

Definition at line 675 of file filterWheelCtrl.hpp.

Friends And Related Function Documentation

◆ dev::stdMotionStage< filterWheelCtrl >

friend class dev::stdMotionStage< filterWheelCtrl >
friend

Definition at line 982 of file filterWheelCtrl.hpp.

◆ dev::telemeter< filterWheelCtrl >

friend class dev::telemeter< filterWheelCtrl >
friend

Definition at line 982 of file filterWheelCtrl.hpp.

Member Data Documentation

◆ m_acceleration

double MagAOX::app::filterWheelCtrl::m_acceleration {100}
protected

Definition at line 67 of file filterWheelCtrl.hpp.

Referenced by loadConfig(), and onPowerOnConnect().

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

◆ m_baudRate

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

◆ m_circleSteps

long MagAOX::app::filterWheelCtrl::m_circleSteps {0}
protected

The number of position counts in 1 360-degree revolution.

Definition at line 71 of file filterWheelCtrl.hpp.

Referenced by appLogic(), loadConfig(), and moveTo().

◆ 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 92 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 90 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

◆ m_cpusetPath

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::m_cpusetPath {MAGAOX_cpusetPath}
protectedinherited

Definition at line 421 of file MagAOXApp.hpp.

◆ m_deceleration

double MagAOX::app::filterWheelCtrl::m_deceleration {50}
protected

Definition at line 68 of file filterWheelCtrl.hpp.

Referenced by loadConfig(), and onPowerOnConnect().

◆ m_defaultPositions

bool MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_defaultPositions
protectedinherited

Flag controlling whether the default preset positions (the vector index) are set in loadConfig.

Definition at line 75 of file stdMotionStage.hpp.

◆ m_deviceName

◆ 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 587 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 579 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 582 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 315 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 314 of file MagAOXApp.hpp.

◆ m_fileDescrip

◆ m_fractionalPresets

bool MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_fractionalPresets
protectedinherited

Flag to set in constructor determining if fractional presets are allowed. Used for INDI/GUIs.

Definition at line 73 of file stdMotionStage.hpp.

◆ m_gitAlert

template<bool _useINDI = true>
bool MagAOX::app::MagAOXApp< _useINDI >::m_gitAlert {false}
privateinherited

Definition at line 472 of file MagAOXApp.hpp.

◆ m_homeOffset

long MagAOX::app::filterWheelCtrl::m_homeOffset {0}
protected

The number of position counts to offset from the home position.

Definition at line 72 of file filterWheelCtrl.hpp.

Referenced by appLogic(), loadConfig(), and moveTo().

◆ m_homePreset

int MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_homePreset
protectedinherited

If >=0, this preset position is moved to after homing.

Definition at line 63 of file stdMotionStage.hpp.

◆ m_homingState

int MagAOX::app::filterWheelCtrl::m_homingState {0}
protected

The homing state, tracks the stages of homing.

Definition at line 86 of file filterWheelCtrl.hpp.

Referenced by appLogic(), getMoving(), startHoming(), and stop().

◆ m_idProduct

◆ m_idVendor

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

Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), 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::ocam2KCtrl::onPowerOff(), MagAOX::app::picamCtrl::onPowerOff(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::xt1121Ctrl::onPowerOff(), MagAOX::app::zylaCtrl::onPowerOff(), onPowerOnConnect(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::zylaCtrl::reconfig(), stop(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), 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 567 of file MagAOXApp.hpp.

◆ m_indiP_clearFSMAlert

template<bool _useINDI = true>
pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_clearFSMAlert
protectedinherited

indi Property to clear an FSM alert.

Definition at line 948 of file MagAOXApp.hpp.

◆ m_indiP_counts

pcf::IndiProperty MagAOX::app::filterWheelCtrl::m_indiP_counts
protected

The position of the wheel in counts.

Definition at line 147 of file filterWheelCtrl.hpp.

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

◆ m_indiP_home

pcf::IndiProperty MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_indiP_home
protectedinherited

Command the stage to home. .

Definition at line 191 of file stdMotionStage.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 998 of file MagAOXApp.hpp.

◆ m_indiP_preset

pcf::IndiProperty MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_indiP_preset
protectedinherited

The position of the stage in presets.

Definition at line 185 of file stdMotionStage.hpp.

◆ m_indiP_presetName

pcf::IndiProperty MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_indiP_presetName
protectedinherited

The name of the nearest preset for this position.

Definition at line 188 of file stdMotionStage.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 945 of file MagAOXApp.hpp.

◆ m_indiP_stop

pcf::IndiProperty MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_indiP_stop
protectedinherited

Command the stage to halt.

Definition at line 194 of file stdMotionStage.hpp.

◆ m_indiSetCallBacks

template<bool _useINDI = true>
std::unordered_map< std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiSetCallBacks
protectedinherited

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

The key for these is device.name

Definition at line 572 of file MagAOXApp.hpp.

◆ m_log

template<bool _useINDI>
MagAOXApp< _useINDI >::logManagerT MagAOX::app::MagAOXApp< _useINDI >::m_log
staticinherited

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

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

◆ m_maxInterval

double MagAOX::app::dev::telemeter< filterWheelCtrl >::m_maxInterval
inherited

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

Definition at line 58 of file telemeter.hpp.

◆ m_motorSpeed

double MagAOX::app::filterWheelCtrl::m_motorSpeed {3000}
protected

Definition at line 69 of file filterWheelCtrl.hpp.

Referenced by getMoving(), home(), loadConfig(), and onPowerOnConnect().

◆ m_motorType

int MagAOX::app::filterWheelCtrl::m_motorType {2}
protected

Definition at line 56 of file filterWheelCtrl.hpp.

Referenced by onPowerOnConnect().

◆ m_moving

int8_t MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_moving
protectedinherited

Whether or not the stage is moving. -2 means powered off, -1 means not homed, 0 means not moving, 1 means moving, 2 means homing.

Definition at line 77 of file stdMotionStage.hpp.

◆ m_movingState

int8_t MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_movingState
protectedinherited

Used to track the type of command. If > 1 this is a command to move to a preset. If 0 then it is a move to an arbitrary position.

Definition at line 78 of file stdMotionStage.hpp.

◆ m_pid

template<bool _useINDI = true>
pid_t MagAOX::app::MagAOXApp< _useINDI >::m_pid {0}
protectedinherited

This process's PID.

Definition at line 394 of file MagAOXApp.hpp.

◆ m_powerChannel

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerChannel
protectedinherited

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

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

◆ m_powerElement

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerElement {"state"}
protectedinherited

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

Definition at line 986 of file MagAOXApp.hpp.

◆ m_powerMgtEnabled

◆ m_powerOnCounter

template<bool _useINDI = true>
int MagAOX::app::MagAOXApp< _useINDI >::m_powerOnCounter {-1}
protectedinherited

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

Definition at line 992 of file MagAOXApp.hpp.

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

◆ m_powerOnHome

bool MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_powerOnHome
protectedinherited

If true, then the motor is homed at startup (by this software or actual power on)

Definition at line 61 of file stdMotionStage.hpp.

◆ m_powerOnWait

template<bool _useINDI = true>
unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_powerOnWait {0}
protectedinherited

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

Definition at line 989 of file MagAOXApp.hpp.

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

◆ m_powerState

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

◆ m_powerTargetState

◆ m_preset

double MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_preset
protectedinherited

The current numerical preset position [1.0 is index 0 in the preset name vector].

Definition at line 80 of file stdMotionStage.hpp.

◆ m_preset_target

double MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_preset_target
protectedinherited

The target numerical preset position [1.0 is index 0 in the preset name vector].

Definition at line 81 of file stdMotionStage.hpp.

◆ m_presetNames

std::vector<std::string> MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_presetNames
protectedinherited

The names of each position on the stage.

Definition at line 65 of file stdMotionStage.hpp.

◆ m_presetNotation

std::string MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_presetNotation
protectedinherited

Notation used to refer to a preset, should be singular, as in "preset" or "filter".

Definition at line 71 of file stdMotionStage.hpp.

◆ m_presetPositions

std::vector<double> MagAOX::app::dev::stdMotionStage< filterWheelCtrl >::m_presetPositions
protectedinherited

The positions, in arbitrary units, of each preset. If 0, then the integer position number (starting from 1) is used to calculate.

Definition at line 67 of file stdMotionStage.hpp.

◆ m_rawPos

long MagAOX::app::filterWheelCtrl::m_rawPos {0}
protected

The position of the wheel in motor counts.

Definition at line 84 of file filterWheelCtrl.hpp.

Referenced by appLogic(), and getPos().

◆ m_readTimeOut

int MagAOX::app::filterWheelCtrl::m_readTimeOut {1000}
protected

The timeout for reading from the device [msec].

Definition at line 65 of file filterWheelCtrl.hpp.

Referenced by appLogic(), getMoving(), getPos(), getSwitch(), and loadConfig().

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

◆ m_serial

◆ m_shutdown

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

◆ m_stateAlert

template<bool _useINDI = true>
bool MagAOX::app::MagAOXApp< _useINDI >::m_stateAlert {false}
privateinherited

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

◆ m_suid

template<bool _useINDI = true>
uid_t MagAOX::app::MagAOXApp< _useINDI >::m_suid
privateinherited

The save-set user id of the process.

Definition at line 316 of file MagAOXApp.hpp.

◆ m_switch

bool MagAOX::app::filterWheelCtrl::m_switch {false}
protected

The home switch status.

Definition at line 82 of file filterWheelCtrl.hpp.

Referenced by getSwitch().

◆ m_tel

Definition at line 56 of file telemeter.hpp.

◆ m_useINDI

template<bool _useINDI = true>
constexpr static bool MagAOX::app::MagAOXApp< _useINDI >::m_useINDI = _useINDI
staticconstexprprotectedinherited

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

Definition at line 532 of file MagAOXApp.hpp.

◆ m_writeTimeOut

int MagAOX::app::filterWheelCtrl::m_writeTimeOut {1000}
protected

The timeout for writing to the device [msec].

Definition at line 64 of file filterWheelCtrl.hpp.

Referenced by getMoving(), getPos(), getSwitch(), home(), loadConfig(), moveToRaw(), moveToRawRelative(), onPowerOnConnect(), and stop().

◆ MagAOXPath

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::MagAOXPath
protectedinherited

The base path of the MagAO-X system.

Definition at line 86 of file MagAOXApp.hpp.

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

◆ pidFileName

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::pidFileName
protectedinherited

The name of the PID file.

Definition at line 392 of file MagAOXApp.hpp.

◆ secretsPath

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::secretsPath
protectedinherited

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

Definition at line 98 of file MagAOXApp.hpp.

◆ sysPath

template<bool _useINDI = true>
std::string MagAOX::app::MagAOXApp< _useINDI >::sysPath
protectedinherited

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

Definition at line 96 of file MagAOXApp.hpp.

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


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