 |
API
|
|
|
API
|
|
Public Types | |
| typedef dev::stdCamera< cameraSim > | stdCameraT |
| typedef dev::frameGrabber< cameraSim > | frameGrabberT |
| typedef dev::telemeter< cameraSim > | telemeterT |
| typedef logger::logManager< MagAOXApp< _useINDI >, logFileRaw > | logManagerT |
| The log manager type. More... | |
| typedef logger::logManager< cameraSim, logFileRaw > | logManagerT |
| The log manager type. More... | |
| enum | fgFlip |
Public Member Functions | |
| cameraSim_test (const std::string device) | |
| virtual void | setupConfig () |
| Setup the configuration system (called by MagAOXApp::setup()) More... | |
| void | setupConfig (mx::app::appConfigurator &config) |
| Setup the configuration system. More... | |
| int | setupConfig (mx::app::appConfigurator &config) |
| Setup the configuration system. More... | |
| int | setupConfig (appConfigurator &config) |
| Setup an application configurator for the device section. More... | |
| virtual int | loadConfigImpl (mx::app::appConfigurator &cfg) |
| load the configuration system results (called by MagAOXApp::setup()) More... | |
| virtual void | loadConfig () |
| load the configuration system results (called by MagAOXApp::setup()) More... | |
| void | loadConfig (mx::app::appConfigurator &config) |
| load the configuration system results More... | |
| int | loadConfig (mx::app::appConfigurator &config) |
| load the configuration system results More... | |
| int | loadConfig (appConfigurator &config) |
| Load the device section from an application configurator. More... | |
| virtual int | appStartup () |
| Startup functions. More... | |
| virtual int | appLogic () |
| Implementation of the FSM for the Siglent SDG. More... | |
| virtual int | appShutdown () |
| Do any needed shutdown tasks. Currently nothing in this app. More... | |
| int | configureAcquisition () |
| int | startAcquisition () |
| int | acquireAndCheckValid () |
| int | loadImageIntoStream (void *dest) |
| int | reconfig () |
| 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... | |
| 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 | onPowerOff () |
| Actions on power off. More... | |
| int | onPowerOff () |
| On power off, sets m_reconfig to true. More... | |
| int | whilePowerOff () |
| Actions while powered off. More... | |
| int | telem (const typename telT::messageT &msg) |
| Make a telemetry recording. More... | |
| int | telem () |
| Make a telemetry recording, for an empty record. 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... | |
Telemeter Interface | |
| int | recordCamera (bool force=false) |
Telemeter Interface | |
| int | recordFGTimings (bool force=false) |
Public Attributes | |
| logManagerT | m_tel |
| double | m_maxInterval |
| The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds. More... | |
Static Public Attributes | |
app::dev Configurations | |
| static constexpr bool | c_stdCamera_tempControl |
| app::dev config to tell stdCamera to not expose temperature controls More... | |
| static constexpr bool | c_stdCamera_temp = true |
| app::dev config to tell stdCamera to expose temperature More... | |
| static constexpr bool | c_stdCamera_readoutSpeed |
| app::dev config to tell stdCamera not to expose readout speed controls More... | |
| static constexpr bool | c_stdCamera_vShiftSpeed |
| app:dev config to tell stdCamera not to expose vertical shift speed control More... | |
| static constexpr bool | c_stdCamera_emGain |
| app::dev config to tell stdCamera to not expose EM gain controls More... | |
| static constexpr bool | c_stdCamera_exptimeCtrl |
| app::dev config to tell stdCamera to expose exposure time controls More... | |
| static constexpr bool | c_stdCamera_fpsCtrl = true |
| app::dev config to tell stdCamera to expose FPS controls More... | |
| static constexpr bool | c_stdCamera_fps |
| app::dev config to tell stdCamera not to expose FPS status (ignored since fpsCtrl=true) More... | |
| static constexpr bool | c_stdCamera_synchro |
| app::dev config to tell stdCamera to not expose synchro mode controls More... | |
| static constexpr bool | c_stdCamera_usesModes |
| app:dev config to tell stdCamera not to expose mode controls More... | |
| static constexpr bool | c_stdCamera_usesROI = true |
| app:dev config to tell stdCamera to expose ROI controls More... | |
| static constexpr bool | c_stdCamera_cropMode |
| app:dev config to tell stdCamera not to expose Crop Mode controls More... | |
| static constexpr bool | c_stdCamera_hasShutter |
| app:dev config to tell stdCamera to expose shutter controls More... | |
| static constexpr bool | c_stdCamera_usesStateString |
| app::dev confg to tell stdCamera to expose the state string property More... | |
| static constexpr bool | c_frameGrabber_flippable |
| app:dev config to tell framegrabber that this camera can be flipped More... | |
Protected Types | |
| typedef uint16_t | cbIndexT |
Protected Member Functions | |
| float | fps () |
| int | createReadoutSpeed (const mx::meta::trueFalseT< true > &t) |
| int | createReadoutSpeed (const mx::meta::trueFalseT< false > &f) |
| int | createVShiftSpeed (const mx::meta::trueFalseT< true > &t) |
| int | createVShiftSpeed (const mx::meta::trueFalseT< false > &f) |
| void * | loadImageIntoStreamCopy (void *dest, void *src, size_t width, size_t height, size_t szof) |
stdCamera Interface | |
| int | powerOnDefaults () |
| Set defaults for a power on state. More... | |
| int | setTempControl () |
| int | setTempSetPt () |
| int | setReadoutSpeed () |
| int | setVShiftSpeed () |
| int | setExpTime () |
| Set the Exposure Time. [stdCamera interface]. More... | |
| int | setFPS () |
| Set the framerate. More... | |
| int | setSynchro () |
| int | setEMGain () |
| int | checkNextROI () |
| Check the next ROI. More... | |
| int | setCropMode () |
| int | setNextROI () |
| Set the next ROI. More... | |
| int | setShutter (int ss) |
| std::string | stateString () |
| bool | stateStringValid () |
Telemeter Interface | |
| int | checkRecordTimes () |
| int | recordTelem (const telem_stdcam *) |
Protected Attributes | |
| mx::improc::eigenImage< int16_t > | m_fgimage |
| double | m_lastTime { 0 } |
| double | m_offset = { 0 } |
| float | m_bias { 500 } |
| the simulated bias level. default 500. More... | |
| float | m_ron { 5 } |
| the simulated readout noise, in counts/read. default 5. More... | |
| std::vector< float > | m_xcen { 0 } |
| std::vector< float > | m_ycen { 0 } |
| std::vector< float > | m_peak { 2000 } |
| the simulated star peak, in counts/second. one per star. default 2000. More... | |
| float | m_fwhm { 2 } |
| the simulated star FWHM in pixels. the same for all stars. default 2. More... | |
| float | m_jitter { 0.1 } |
| the simulated jitter, in pixels/read. the same for all stars. default 0.1. More... | |
| mx::math::normDistT< float > | m_norm |
| 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 } |
| int | m_shutdown { 0 } |
| Flag to signal it's time to shutdown. When not 0, the main loop exits. More... | |
| int | m_currentFlip |
| uint32_t | m_width |
| The width of the image, once deinterlaced etc. More... | |
| uint32_t | m_height |
| The height of the image, once deinterlaced etc. More... | |
| uint8_t | m_dataType |
| The ImageStreamIO type code. More... | |
| size_t | m_typeSize |
| The size of the type, in bytes. Result of sizeof. More... | |
| int | m_xbinning |
| The x-binning according to the framegrabber. More... | |
| int | m_ybinning |
| The y-binning according to the framegrabber. More... | |
| timespec | m_currImageTimestamp |
| The timestamp of the current image. More... | |
| bool | m_reconfig |
| Flag to set if a camera reconfiguration requires a framegrabber reset. More... | |
| IMAGE * | m_imageStream |
| The ImageStreamIO shared memory buffer. More... | |
| mx::sigproc::circularBufferIndex< timespec, cbIndexT > | m_atimes |
| mx::sigproc::circularBufferIndex< timespec, cbIndexT > | m_wtimes |
| std::vector< double > | m_atimesD |
| std::vector< double > | m_wtimesD |
| std::vector< double > | m_watimesD |
| timespec | m_dummy_ts |
| uint64_t | m_dummy_cnt |
| char | m_dummy_c |
| double | m_mna |
| double | m_vara |
| double | m_mnw |
| double | m_varw |
| double | m_mnwa |
| double | m_varwa |
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 | |
| cameraConfigMap | m_cameraModes |
| Map holding the possible camera mode configurations. More... | |
| std::string | m_startupMode |
| The camera mode to load during first init after a power-on. More... | |
| float | m_startupTemp |
| The temperature to set after a power-on. Set to <= -999 to not use [default]. More... | |
| std::string | m_defaultReadoutSpeed |
| The default readout speed of the camera. More... | |
| std::string | m_defaultVShiftSpeed |
| The default readout speed of the camera. More... | |
Temperature Control Interface | |
| float | m_minTemp |
| float | m_maxTemp |
| float | m_stepTemp |
| float | m_ccdTemp |
| The current temperature, in C. More... | |
| float | m_ccdTempSetpt |
| The desired temperature, in C. More... | |
| bool | m_tempControlStatus |
| Whether or not temperature control is active. More... | |
| bool | m_tempControlStatusSet |
| Desired state of temperature control. More... | |
| bool | m_tempControlOnTarget |
| Whether or not the temperature control system is on its target temperature. More... | |
| std::string | m_tempControlStatusStr |
| Camera specific description of temperature control status. More... | |
| pcf::IndiProperty | m_indiP_temp |
| pcf::IndiProperty | m_indiP_tempcont |
| pcf::IndiProperty | m_indiP_tempstat |
Readout Control | |
| std::vector< std::string > | m_readoutSpeedNames |
| std::vector< std::string > | m_readoutSpeedNameLabels |
| std::string | m_readoutSpeedName |
| The current readout speed name. More... | |
| std::string | m_readoutSpeedNameSet |
| The user requested readout speed name, to be set by derived() More... | |
| std::vector< std::string > | m_vShiftSpeedNames |
| std::vector< std::string > | m_vShiftSpeedNameLabels |
| std::string | m_vShiftSpeedName |
| The current vshift speed name. More... | |
| std::string | m_vShiftSpeedNameSet |
| The user requested vshift speed name, to be set by derived() More... | |
| float | m_adcSpeed |
| float | m_vshiftSpeed |
| float | m_emGain |
| The camera's current EM gain (if available). More... | |
| float | m_emGainSet |
| The camera's EM gain, as set by the user. More... | |
| float | m_maxEMGain |
| The configurable maximum EM gain. To be enforced in derivedT. More... | |
| pcf::IndiProperty | m_indiP_readoutSpeed |
| pcf::IndiProperty | m_indiP_vShiftSpeed |
| pcf::IndiProperty | m_indiP_emGain |
Exposure Control | |
| float | m_minExpTime |
| The minimum exposure time, used for INDI attributes. More... | |
| float | m_maxExpTime |
| The maximum exposure time, used for INDI attributes. More... | |
| float | m_stepExpTime |
| The maximum exposure time stepsize, used for INDI attributes. More... | |
| float | m_expTime |
| The current exposure time, in seconds. More... | |
| float | m_expTimeSet |
| The exposure time, in seconds, as set by user. More... | |
| float | m_minFPS |
| The minimum FPS, used for INDI attributes. More... | |
| float | m_maxFPS |
| The maximum FPS, used for INDI attributes. More... | |
| float | m_stepFPS |
| The FPS step size, used for INDI attributes. More... | |
| float | m_fps |
| The current FPS. More... | |
| float | m_fpsSet |
| The commanded fps, as set by user. More... | |
| pcf::IndiProperty | m_indiP_exptime |
| pcf::IndiProperty | m_indiP_fps |
External Synchronization | |
| bool | m_synchroSet |
| Target status of m_synchro. More... | |
| bool | m_synchro |
| Status of synchronization, true is on, false is off. More... | |
| pcf::IndiProperty | m_indiP_synchro |
Modes | |
| std::string | m_modeName |
| The current mode name. More... | |
| std::string | m_nextMode |
| The mode to be set by the next reconfiguration. More... | |
| pcf::IndiProperty | m_indiP_mode |
| Property used to report the current mode. More... | |
| pcf::IndiProperty | m_indiP_reconfig |
| Request switch which forces the framegrabber to go through the reconfigure process. More... | |
ROIs | |
ROI controls are exposed if derivedT::c_stdCamera_usesROI==true | |
| roi | m_currentROI |
| roi | m_nextROI |
| roi | m_lastROI |
| float | m_minROIx |
| float | m_maxROIx |
| float | m_stepROIx |
| float | m_minROIy |
| float | m_maxROIy |
| float | m_stepROIy |
| int | m_minROIWidth |
| int | m_maxROIWidth |
| int | m_stepROIWidth |
| int | m_minROIHeight |
| int | m_maxROIHeight |
| int | m_stepROIHeight |
| int | m_minROIBinning_x |
| int | m_maxROIBinning_x |
| int | m_stepROIBinning_x |
| int | m_minROIBinning_y |
| int | m_maxROIBinning_y |
| int | m_stepROIBinning_y |
| float | m_default_x |
| Power-on ROI center x coordinate. More... | |
| float | m_default_y |
| Power-on ROI center y coordinate. More... | |
| int | m_default_w |
| Power-on ROI width. More... | |
| int | m_default_h |
| Power-on ROI height. More... | |
| int | m_default_bin_x |
| Power-on ROI x binning. More... | |
| int | m_default_bin_y |
| Power-on ROI y binning. More... | |
| float | m_full_x |
| The full ROI center x coordinate. More... | |
| float | m_full_y |
| The full ROI center y coordinate. More... | |
| int | m_full_w |
| The full ROI width. More... | |
| int | m_full_h |
| The full ROI height. More... | |
| int | m_full_bin_x |
| The x-binning in the full ROI. More... | |
| int | m_full_bin_y |
| The y-binning in the full ROI. More... | |
| float | m_full_currbin_x |
| The current-binning full ROI center x coordinate. More... | |
| float | m_full_currbin_y |
| The current-binning full ROI center y coordinate. More... | |
| int | m_full_currbin_w |
| The current-binning full ROI width. More... | |
| int | m_full_currbin_h |
| The current-binning full ROI height. More... | |
| pcf::IndiProperty | m_indiP_roi_x |
| Property used to set the ROI x center coordinate. More... | |
| pcf::IndiProperty | m_indiP_roi_y |
| Property used to set the ROI x center coordinate. More... | |
| pcf::IndiProperty | m_indiP_roi_w |
| Property used to set the ROI width. More... | |
| pcf::IndiProperty | m_indiP_roi_h |
| Property used to set the ROI height. More... | |
| pcf::IndiProperty | m_indiP_roi_bin_x |
| Property used to set the ROI x binning. More... | |
| pcf::IndiProperty | m_indiP_roi_bin_y |
| Property used to set the ROI y binning. More... | |
| pcf::IndiProperty | m_indiP_fullROI |
| Property used to preset the full ROI dimensions. More... | |
| pcf::IndiProperty | m_indiP_roi_check |
| Property used to trigger checking the target ROI. More... | |
| pcf::IndiProperty | m_indiP_roi_set |
| Property used to trigger setting the ROI. More... | |
| pcf::IndiProperty | m_indiP_roi_full |
| Property used to trigger setting the full ROI. More... | |
| pcf::IndiProperty | m_indiP_roi_fullbin |
| Property used to trigger setting the full in current binning ROI. More... | |
| pcf::IndiProperty | m_indiP_roi_loadlast |
| Property used to trigger loading the last ROI as the target. More... | |
| pcf::IndiProperty | m_indiP_roi_last |
| Property used to trigger setting the last ROI. More... | |
| pcf::IndiProperty | m_indiP_roi_default |
| Property used to trigger setting the default and startup ROI. More... | |
Crop Mode | |
Crop mode controls are exposed if derivedT::c_stdCamera_cropMode==true | |
| bool | m_cropMode |
| Status of crop mode ROIs, if enabled for this camera. More... | |
| bool | m_cropModeSet |
| Desired status of crop mode ROIs, if enabled for this camera. More... | |
| pcf::IndiProperty | m_indiP_cropMode |
| Property used to toggle crop mode on and off. More... | |
Shutter Control | |
Shutter controls are exposed if derivedT::c_stdCamera_hasShutter == true. | |
| std::string | m_shutterStatus |
| int | m_shutterState |
| pcf::IndiProperty | m_indiP_shutterStatus |
| State of the shutter. 0 = shut, 1 = open, -1 = unknown. More... | |
| pcf::IndiProperty | m_indiP_shutter |
| Property used to control the shutter, a switch. More... | |
State String | |
The State string is exposed if derivedT::c_stdCamera_usesStateString is true. | |
| pcf::IndiProperty | m_indiP_stateString |
Configurable Parameters | |
| std::string | m_shmimName |
The name of the shared memory image, is used in /tmp/<shmimName>.im.shm. Derived classes should set a default. More... | |
| int | m_fgThreadPrio |
| Priority of the framegrabber thread, should normally be > 00. More... | |
| std::string | m_fgCpuset |
| The cpuset to assign the framegrabber thread to. Not used if empty, the default. More... | |
| uint32_t | m_circBuffLength |
| Length of the circular buffer, in frames. More... | |
| uint16_t | m_latencyCircBuffMaxLength |
| Maximum length of the latency measurement circular buffers. More... | |
| float | m_latencyCircBuffMaxTime |
| Maximum time of the latency meaurement circular buffers. More... | |
| int | m_defaultFlip |
Private Member Functions | |
| int | clearFSMAlert () |
| Clear the FSM alert state. More... | |
| cameraSim & | derived () |
INDI | |
| int | setTempControl (const mx::meta::trueFalseT< true > &t) |
| Interface to setTempControl when the derivedT has temperature control. More... | |
| int | setTempControl (const mx::meta::trueFalseT< false > &f) |
| Interface to setTempControl when the derivedT does not have temperature control. More... | |
| int | setTempSetPt (const mx::meta::trueFalseT< true > &t) |
| Interface to setTempSetPt when the derivedT has temperature control. More... | |
| int | setTempSetPt (const mx::meta::trueFalseT< false > &f) |
| Interface to setTempSetPt when the derivedT does not have temperature control. More... | |
| int | setReadoutSpeed (const mx::meta::trueFalseT< true > &t) |
| Interface to setReadoutSpeed when the derivedT has readout speed control. More... | |
| int | setReadoutSpeed (const mx::meta::trueFalseT< false > &f) |
| Interface to setReadoutSpeed when the derivedT does not have readout speed control. More... | |
| int | setVShiftSpeed (const mx::meta::trueFalseT< true > &t) |
| Interface to setVShiftSpeed when the derivedT has vshift speed control. More... | |
| int | setVShiftSpeed (const mx::meta::trueFalseT< false > &f) |
| Interface to setVShiftSpeed when the derivedT does not have vshift speed control. More... | |
| int | setExpTime (const mx::meta::trueFalseT< true > &t) |
| Interface to setExpTime when the derivedT uses exposure time controls. More... | |
| int | setExpTime (const mx::meta::trueFalseT< false > &f) |
| Interface to setExptime when the derivedT does not use exposure time controls. More... | |
| int | setFPS (const mx::meta::trueFalseT< true > &t) |
| Interface to setFPS when the derivedT uses FPS controls. More... | |
| int | setFPS (const mx::meta::trueFalseT< false > &f) |
| Interface to setFPS when the derivedT does not use FPS controls. More... | |
| int | setSynchro (const mx::meta::trueFalseT< true > &t) |
| Interface to setSynchro when the derivedT has synchronization. More... | |
| int | setSynchro (const mx::meta::trueFalseT< false > &f) |
| Interface to setSynchro when the derivedT does not have synchronization. More... | |
| int | setEMGain (const mx::meta::trueFalseT< true > &t) |
| Interface to setEMGain when the derivedT has EM Gain. More... | |
| int | setEMGain (const mx::meta::trueFalseT< false > &f) |
| Interface to setEMGain when the derivedT does not have EM Gain. More... | |
| int | checkNextROI (const mx::meta::trueFalseT< true > &t) |
| Interface to checkNextROI when the derivedT uses ROIs. More... | |
| int | checkNextROI (const mx::meta::trueFalseT< false > &f) |
| Interface to checkNextROI when the derivedT does not use ROIs. More... | |
| int | setCropMode (const mx::meta::trueFalseT< true > &t) |
| Interface to setCropMode when the derivedT has crop mode. More... | |
| int | setCropMode (const mx::meta::trueFalseT< false > &f) |
| Interface to setCropMode when the derivedT does not have crop mode. More... | |
| int | setNextROI (const mx::meta::trueFalseT< true > &t) |
| Interface to setNextROI when the derivedT uses ROIs. More... | |
| int | setNextROI (const mx::meta::trueFalseT< false > &f) |
| Interface to setNextROI when the derivedT does not use ROIs. More... | |
| int | setShutter (int ss, const mx::meta::trueFalseT< true > &t) |
| Interface to setShutter when the derivedT has a shutter. More... | |
| int | setShutter (int ss, const mx::meta::trueFalseT< false > &f) |
| Interface to setShutter when the derivedT does not have a shutter. More... | |
| std::string | stateString (const mx::meta::trueFalseT< true > &t) |
| Interface to stateString when the derivedT provides it. More... | |
| std::string | stateString (const mx::meta::trueFalseT< false > &f) |
| Interface to stateString when the derivedT does not provide it. More... | |
| bool | stateStringValid (const mx::meta::trueFalseT< true > &t) |
| Interface to stateStringValid when the derivedT provides it. More... | |
| bool | stateStringValid (const mx::meta::trueFalseT< false > &f) |
| Interface to stateStringValid when the derivedT does not provide it. More... | |
| int | newCallBack_stdCamera (const pcf::IndiProperty &ipRecv) |
| The callback function for stdCamera properties. More... | |
| int | newCallBack_temp (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW CCD temp request. More... | |
| int | newCallBack_temp_controller (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW CCD temp control request. More... | |
| int | newCallBack_readoutSpeed (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW readout speed request. More... | |
| int | newCallBack_vShiftSpeed (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW vshift speed request. More... | |
| int | newCallBack_emgain (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW EM gain request. More... | |
| int | newCallBack_exptime (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW exposure time request. More... | |
| int | newCallBack_fps (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW fps request. More... | |
| int | newCallBack_synchro (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW synchro request. More... | |
| int | newCallBack_mode (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW mode request. More... | |
| int | newCallBack_reconfigure (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW reconfigure request. More... | |
| int | newCallBack_cropMode (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW cropMode request. More... | |
| int | newCallBack_roi_x (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_x request. More... | |
| int | newCallBack_roi_y (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_y request. More... | |
| int | newCallBack_roi_w (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_w request. More... | |
| int | newCallBack_roi_h (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_h request. More... | |
| int | newCallBack_roi_bin_x (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW bin_x request. More... | |
| int | newCallBack_roi_bin_y (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW bin_y request. More... | |
| int | newCallBack_roi_check (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_check request. More... | |
| int | newCallBack_roi_set (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_set request. More... | |
| int | newCallBack_roi_full (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_full request. More... | |
| int | newCallBack_roi_fullbin (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_fullbin request. More... | |
| int | newCallBack_roi_loadlast (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_loadlast request. More... | |
| int | newCallBack_roi_last (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_last request. More... | |
| int | newCallBack_roi_default (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW roi_default request. More... | |
| int | newCallBack_shutter (const pcf::IndiProperty &ipRecv) |
| Callback to process a NEW shutter request. More... | |
| int | updateINDI () |
| Update the INDI properties for this device controller. More... | |
| static int | st_newCallBack_stdCamera (void *app, const pcf::IndiProperty &ipRecv) |
| The static callback function to be registered for stdCamera 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 } |
| bool | m_stateAlert { false } |
| bool | m_gitAlert { false } |
| int | m_stateLogged { 0 } |
INDI Interface | |
For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property. | |
| int | createStandardIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &label="", const std::string &group="") |
| Create a standard R/W INDI Text property with target and current elements. More... | |
| int | createROIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &elName, const std::string &propLabel="", const std::string &propGroup="", const std::string &elLabel="") |
| Create a standard ReadOnly INDI Text property, with at least one element. More... | |
| 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="") |
| int | registerIndiPropertyReadOnly (pcf::IndiProperty &prop) |
| Register an INDI property which is read only. More... | |
| int | registerIndiPropertyReadOnly (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState) |
| Register an INDI property which is read only. More... | |
| int | registerIndiPropertyNew (pcf::IndiProperty &prop, int(*)(void *, const pcf::IndiProperty &)) |
| Register an INDI property which is exposed for others to request a New Property for. More... | |
| int | registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, int(*)(void *, const pcf::IndiProperty &)) |
| Register an INDI property which is exposed for others to request a New Property for. More... | |
| int | registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, const pcf::IndiProperty::SwitchRuleType &propRule, int(*)(void *, const pcf::IndiProperty &)) |
| Register an INDI property which is exposed for others to request a New Property for, with a switch rule. More... | |
| int | registerIndiPropertySet (pcf::IndiProperty &prop, const std::string &devName, const std::string &propName, int(*)(void *, const pcf::IndiProperty &)) |
| Register an INDI property which is monitored for updates from others. More... | |
| void | sendGetPropertySetList (bool all=false) |
| void | handleDefProperty (const pcf::IndiProperty &ipRecv) |
| Handler for the DEF INDI properties notification. More... | |
| void | handleGetProperties (const pcf::IndiProperty &ipRecv) |
| Handler for the get INDI properties request. More... | |
| void | handleNewProperty (const pcf::IndiProperty &ipRecv) |
| Handler for the new INDI property request. More... | |
| void | handleSetProperty (const pcf::IndiProperty &ipRecv) |
| Handler for the set INDI property request. More... | |
| typedef std::pair< std::string, indiCallBack > | callBackValueType |
| Value type of the indiCallBack map. More... | |
| typedef std::unordered_map< std::string, indiCallBack >::iterator | callBackIterator |
| Iterator type of the indiCallBack map. More... | |
| typedef std::pair< callBackIterator, bool > | callBackInsertResult |
| Return type of insert on the indiCallBack map. More... | |
| std::unordered_map< std::string, indiCallBack > | m_indiNewCallBacks |
| Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name. More... | |
| std::unordered_map< std::string, indiCallBack > | m_indiSetCallBacks |
| Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name. More... | |
| bool | m_allDefsReceived { 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 | 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, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok) |
| Update an INDI property if values have changed. More... | |
| void | updateSwitchIfChanged (pcf::IndiProperty &p, const std::string &el, const pcf::IndiElement::SwitchStateType &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok) |
| Update an INDI switch element value if it has changed. More... | |
| 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... | |
| 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. | |
| int | powerState () |
| Returns the current power state. More... | |
| int | powerStateTarget () |
| Returns the target power state. More... | |
| INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel) | |
| bool | m_powerMgtEnabled { false } |
| 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 } |
| 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... | |
| virtual int | onPowerOff () |
| This method is called when the change to poweroff is detected. More... | |
| virtual int | whilePowerOff () |
| This method is called while the power is off, once per FSM loop. More... | |
| bool | powerOnWaitElapsed () |
| This method tests whether the power on wait time has elapsed. More... | |
INDI | |
| int | updateINDI () |
| Update the INDI properties for this device controller. More... | |
| pcf::IndiProperty | m_indiP_shmimName |
| Property used to report the shmim buffer name. More... | |
| pcf::IndiProperty | m_indiP_frameSize |
| Property used to report the current frame size. More... | |
| pcf::IndiProperty | m_indiP_timing |
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 () |
| int | unlockPID () |
| Remove the PID file. More... | |
Framegrabber Thread | |
| bool | m_fgThreadInit |
| Synchronizer for thread startup, to allow priority setting to finish. More... | |
| pid_t | m_fgThreadID |
| The ID of the framegrabber thread. More... | |
| pcf::IndiProperty | m_fgThreadProp |
| The property to hold the f.g. thread details. More... | |
| std::thread | m_fgThread |
| A separate thread for the actual framegrabbings. More... | |
| void | fgThreadExec () |
| Execute framegrabbing. More... | |
| static void | fgThreadStart (frameGrabber *o) |
| Thread starter, called by MagAOXApp::threadStart on thread construction. Calls fgThreadExec. More... | |
Signal Handling | |
| static MagAOXApp * | m_self = nullptr |
| int | setSigTermHandler () |
| Sets the handler for SIGTERM, SIGQUIT, and SIGINT. More... | |
| void | handlerSigTerm (int signum, siginfo_t *siginf, void *ucont) |
| Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal. More... | |
| static void | _handlerSigTerm (int signum, siginfo_t *siginf, void *ucont) |
| The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm. More... | |
Privilege Management | |
| uid_t | m_euidReal |
| The real user id of the proces (i.e. the lower privileged id of the user) More... | |
| uid_t | m_euidCalled |
| uid_t | m_suid |
| The save-set user id of the process. More... | |
| int | setEuidCalled () |
| Set the effective user ID to the called value, i.e. the highest possible. More... | |
| int | setEuidReal () |
| Set the effective user ID to the real value, i.e. the file owner. More... | |
Definition at line 20 of file cameraSim_test.cpp.
|
inherited |
Return type of insert on the indiCallBack map.
Definition at line 567 of file MagAOXApp.hpp.
|
inherited |
Iterator type of the indiCallBack map.
Definition at line 564 of file MagAOXApp.hpp.
|
inherited |
Value type of the indiCallBack map.
Definition at line 561 of file MagAOXApp.hpp.
|
protectedinherited |
Definition at line 143 of file frameGrabber.hpp.
|
inherited |
Definition at line 56 of file cameraSim.hpp.
|
inherited |
The log manager type.
Definition at line 71 of file telemeter.hpp.
|
inherited |
The log manager type.
Definition at line 78 of file MagAOXApp.hpp.
|
inherited |
Definition at line 55 of file cameraSim.hpp.
|
inherited |
Definition at line 57 of file cameraSim.hpp.
|
inherited |
Definition at line 104 of file frameGrabber.hpp.
|
inline |
Definition at line 24 of file cameraSim_test.cpp.
|
staticprivateinherited |
The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.
| [in] | signum | specifies the signal. |
| [in] | siginf | ignored by MagAOXApp |
| [in] | ucont | ignored by MagAOXApp |
Definition at line 1921 of file MagAOXApp.hpp.
|
inherited |
Definition at line 578 of file cameraSim.hpp.
|
inlinevirtualinherited |
Implementation of the FSM for the Siglent SDG.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 481 of file cameraSim.hpp.
|
inlinevirtualinherited |
Do any needed shutdown tasks. Currently nothing in this app.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 520 of file cameraSim.hpp.
|
inlinevirtualinherited |
Startup functions.
Sets up the INDI vars.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 433 of file cameraSim.hpp.
|
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 1441 of file MagAOXApp.hpp.
|
inlineprotectedinherited |
Check the next ROI.
Checks if the target values are valid and adjusts them to the closest valid values if needed.
Definition at line 730 of file cameraSim.hpp.
|
inherited |
Interface to checkNextROI when the derivedT does not use ROIs.
Tag-dispatch resolution of c_stdCamera_usesROI==false will call this function. This prevents requiring derivedT to have its own checkNextROI().
Definition at line 890 of file stdCamera.hpp.
|
inherited |
Interface to checkNextROI when the derivedT uses ROIs.
Tag-dispatch resolution of c_stdCamera_usesROI==true will call this function. Calls derivedT::checkNextROI.
Definition at line 884 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 777 of file cameraSim.hpp.
|
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.
| [in] | tel | [unused] object of the telemetry type to record |
| [in] | tels | [unused] objects of the additional telemetry types to record |
Definition at line 148 of file telemeter.hpp.
|
inherited |
Empty function called at the end of the template list.
| [in] | ts | [unused] the timestamp that records are compared to |
Definition at line 169 of file telemeter.hpp.
|
inherited |
Worker function to actually perform the record time checking logic.
Recursively calls itself until the variadic template list is exhausted.
| [in] | ts | [unused] the timestamp that records are compared to |
| [in] | tel | [unused] objects of the telemetry type to record |
| [in] | tels | [unused] objects of the additional telemetry types to record |
Definition at line 159 of file telemeter.hpp.
|
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 2376 of file MagAOXApp.hpp.
|
inherited |
Get the config directory.
Definition at line 3483 of file MagAOXApp.hpp.
|
staticprotectedinherited |
Callback for config system logging.
Called by appConfigurator each time a value is set using the config() operator. You never need to call this directly.
| [in] | name | The name of the config value |
| [in] | code | numeric code specifying the type |
| [in] | value | the value read by the config system |
| [in] | source | the source of the value. |
Definition at line 1863 of file MagAOXApp.hpp.
|
inherited |
Get the config name.
Definition at line 3477 of file MagAOXApp.hpp.
Referenced by MagAOXApp_tests::MagAOXApp_test::configName(), MagAOX::app::andorCtrl::loadConfig(), and MagAOX::app::andorCtrl::writeConfig().
|
inherited |
Definition at line 532 of file cameraSim.hpp.
|
protectedinherited |
Create the INDI FIFOs.
Changes permissions to max available and creates the FIFOs at the configured path.
Definition at line 2828 of file MagAOXApp.hpp.
|
protectedinherited |
|
protectedinherited |
Definition at line 546 of file stdCamera.hpp.
|
inherited |
Create a ReadOnly INDI Number property.
| [out] | prop | the property to create and setup |
| [in] | propName | the name of the property |
| [in] | propLabel | [optional] the GUI label suggestion for this property |
| [in] | propGroup | [optional] the group for this property |
Definition at line 2517 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picamCtrl::appStartup(), and MagAOX::app::zaberCtrl::appStartup().
|
inherited |
Create a standard ReadOnly INDI Text property, with at least one element.
| [out] | prop | the property to create and setup |
| [in] | propName | the name of the property |
| [in] | elName | the name of the element |
| [in] | propLabel | [optional] the GUI label suggestion for this property |
| [in] | propGroup | [optional] the group for this property |
| [in] | elLabel | [optional] the GUI label suggestion for the element |
Definition at line 2434 of file MagAOXApp.hpp.
|
inherited |
Create a standard R/W INDI Number property with target and current elements.
| [out] | prop | the property to create and setup |
| [in] | name | the name of the property |
| [in] | min | the minimum value for the elements, applied to both target and current |
| [in] | max | the minimum value for the elements, applied to both target and current |
| [in] | step | the step size for the elements, applied to both target and current |
| [in] | format | the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type. |
| [in] | label | [optional] the GUI label suggestion for this property |
| [in] | group | [optional] the group for this property |
Definition at line 2470 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::appStartup().
|
inherited |
Create a standard R/W INDI switch with a single request element.
This switch is intended to function like a momentary switch.
| [out] | prop | the property to create and setup |
| [in] | name | the name of the property |
| [in] | label | [optional] the GUI label suggestion for this property |
| [in] | group | [optional] the group for this property |
Definition at line 2573 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::appStartup().
|
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.
| [out] | prop | the property to create and setup |
| [in] | name | the name of the property, |
| [in] | elements | the element names to give to the switches |
| [in] | label | [optional] the GUI label suggestion for this property |
| [in] | group | [optional] the group for this property |
Definition at line 2645 of file MagAOXApp.hpp.
|
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.
| [out] | prop | the property to create and setup |
| [in] | name | the name of the property, |
| [in] | elements | the element names to give to the switches |
| [in] | elementLabels | the element labels to give to the switches |
| [in] | label | [optional] the GUI label suggestion for this property |
| [in] | group | [optional] the group for this property |
Definition at line 2603 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::appStartup().
|
inherited |
Create a standard R/W INDI Text property with target and current elements.
| [out] | prop | the property to create and setup |
| [in] | propName | the name of the property |
| [in] | label | [optional] the GUI label suggestion for this property |
| [in] | group | [optional] the group for this property |
Definition at line 2406 of file MagAOXApp.hpp.
|
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.
| [out] | prop | the property to create and setup |
| [in] | name | the name of the property |
| [in] | label | [optional] the GUI label suggestion for this property |
| [in] | group | [optional] the group for this property |
Definition at line 2543 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().
|
protectedinherited |
|
protectedinherited |
Definition at line 550 of file stdCamera.hpp.
|
inlineprivateinherited |
Definition at line 1020 of file stdCamera.hpp.
|
inherited |
Get the INDI control FIFO file name.
Definition at line 3501 of file MagAOXApp.hpp.
|
inherited |
Get the INDI input FIFO file name.
Definition at line 3489 of file MagAOXApp.hpp.
|
inherited |
Get the INDI output FIFO file name.
Definition at line 3495 of file MagAOXApp.hpp.
|
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:
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.
Definition at line 1508 of file MagAOXApp.hpp.
|
protectedinherited |
Execute framegrabbing.
Definition at line 259 of file frameGrabber.hpp.
|
staticprotectedinherited |
Thread starter, called by MagAOXApp::threadStart on thread construction. Calls fgThreadExec.
| [in] | o | a pointer to a frameGrabber instance (normally this) |
Definition at line 256 of file frameGrabber.hpp.
|
inlineprotectedinherited |
Definition at line 648 of file cameraSim.hpp.
|
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.
| [in] | ipRecv | The property being sent. |
Definition at line 2989 of file MagAOXApp.hpp.
|
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.
| [in] | ipRecv | The property being requested. |
Definition at line 2995 of file MagAOXApp.hpp.
|
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.
| [in] | ipRecv | The property being changed. |
Definition at line 3064 of file MagAOXApp.hpp.
Referenced by MagAOXApp_tests::SCENARIO().
|
privateinherited |
Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.
| [in] | signum | specifies the signal. |
| [in] | siginf | ignored by MagAOXApp |
| [in] | ucont | ignored by MagAOXApp |
Definition at line 1927 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::_handlerSigTerm().
|
inherited |
Handler for the set INDI property request.
This is called by m_indiDriver's indiDriver::handleSetProperties.
| [in] | ipRecv | The property being changed. |
Definition at line 3089 of file MagAOXApp.hpp.
|
inherited |
|
protectedinherited |
Get the target element value from an new property.
| [out] | localProperty | The local property to update |
| [out] | localTarget | The local value to update |
| [in] | remoteProperty | the new property received |
| [in] | setBusy | [optional] set property to busy if true |
Definition at line 3197 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::newCallBack_picopos().
|
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 1383 of file MagAOXApp.hpp.
|
inlinevirtualinherited |
load the configuration system results (called by MagAOXApp::setup())
Definition at line 425 of file cameraSim.hpp.
|
inherited |
Load the device section from an application configurator.
| [in] | config | an application configuration from which to load values |
Definition at line 112 of file telemeter.hpp.
|
inherited |
load the configuration system results
This should be called in derivedT::loadConfig as
with appropriate error checking.
| [in] | config | the derived classes configurator |
Definition at line 188 of file frameGrabber.hpp.
|
inherited |
load the configuration system results
This should be called in derivedT::loadConfig as
with appropriate error checking.
| [in] | config | the derived classes configurator |
Definition at line 542 of file stdCamera.hpp.
|
inlinevirtualinherited |
load the configuration system results (called by MagAOXApp::setup())
Definition at line 377 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::loadConfig().
|
inherited |
Definition at line 628 of file cameraSim.hpp.
|
protectedinherited |
Definition at line 264 of file frameGrabber.hpp.
|
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
Definition at line 1999 of file MagAOXApp.hpp.
|
staticinherited |
Make a log entry.
Wrapper for logManager::log
| logT | the log entry type |
| retval | the value returned by this method. |
| [in] | msg | the message to log |
| [in] | level | [optional] the log level. The default is used if not specified. |
Definition at line 1804 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(), MagAOX::app::filterWheelCtrl::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(), MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picamCtrl::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(), visxCtrl.xapp.VisX::cancel_exposure(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), visxCtrl.xapp.VisX::finalize_exposure(), MagAOX::app::sysMonitor::findChronyStatus(), MagAOX::app::sysMonitor::findCPULoads(), MagAOX::app::sysMonitor::findCPUTemperatures(), MagAOX::app::sysMonitor::findDiskTemperature(), MagAOX::app::sysMonitor::findDiskUsage(), MagAOX::app::sysMonitor::findRamUsage(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::andorCtrl::getFPS(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::zylaCtrl::getTemp(), MagAOX::app::ocam2KCtrl::getTemps(), visxCtrl.xapp.VisX::handle_expose(), visxCtrl.xapp.VisX::handle_exptime(), visxCtrl.xapp.VisX::handle_gain(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), visxCtrl.xapp.VisX::handle_temp_ccd(), MagAOX::app::filterWheelCtrl::home(), dbIngest.dbIngest::ingest_line(), MagAOX::app::streamWriter::initialize_xrif(), dbIngest.dbIngest::launch_followers(), MagAOX::app::zylaCtrl::loadImageIntoStream(), audibleAlerts.core.AudibleAlerts::loop(), visxCtrl.xapp.VisX::loop(), MagAOX::app::ttmModulator::modTTM(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::zaberCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::filterWheelCtrl::moveToRawRelative(), MagAOX::app::picoMotorCtrl::newCallBack_picopos(), MagAOX::app::ttmModulator::offset12(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), MagAOX::app::zylaCtrl::reconfig(), dbIngest.dbIngest::rescan_files(), 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(), visxCtrl.xapp.VisX::setup(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::zylaCtrl::startAcquisition(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::zaberCtrl::stop(), visxCtrl.xapp.VisX::subscribe_to_other_devices(), 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().
|
staticinherited |
Make a log entry.
Wrapper for logManager::log
| logT | the log entry type |
| retval | the value returned by this method. |
| [in] | level | [optional] the log level. The default is used if not specified. |
Definition at line 1812 of file MagAOXApp.hpp.
Referenced by visxCtrl.xapp.VisX::cancel_exposure(), visxCtrl.xapp.VisX::finalize_exposure(), visxCtrl.xapp.VisX::handle_expose(), visxCtrl.xapp.VisX::handle_exptime(), visxCtrl.xapp.VisX::handle_gain(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), visxCtrl.xapp.VisX::handle_temp_ccd(), dbIngest.dbIngest::ingest_line(), dbIngest.dbIngest::launch_followers(), audibleAlerts.core.AudibleAlerts::loop(), visxCtrl.xapp.VisX::loop(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), dbIngest.dbIngest::rescan_files(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), visxCtrl.xapp.VisX::setup(), and visxCtrl.xapp.VisX::subscribe_to_other_devices().
|
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 1819 of file MagAOXApp.hpp.
|
protectedinherited |
The callback called by the static version, to actually process the FSM Alert Clear request.
| [in] | ipRecv | the INDI property sent with the new property request. |
Definition at line 3364 of file MagAOXApp.hpp.
|
inherited |
Callback to process a NEW cropMode request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 836 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW EM gain request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 746 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW exposure time request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 765 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW fps request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 784 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW mode request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 810 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW readout speed request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 708 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW reconfigure request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 817 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW bin_x request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 871 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW bin_y request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 878 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_check request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 897 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_default request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 951 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_full request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 923 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_fullbin request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 930 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_h request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 864 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_last request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 944 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_loadlast request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 937 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_set request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 916 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_w request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 857 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_x request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 843 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW roi_y request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 850 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW shutter request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 974 of file stdCamera.hpp.
|
inherited |
The callback function for stdCamera properties.
Dispatches to the relevant handler
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 651 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW synchro request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 803 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW CCD temp request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 670 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW CCD temp control request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 689 of file stdCamera.hpp.
|
inherited |
Callback to process a NEW vshift speed request.
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 727 of file stdCamera.hpp.
|
inherited |
On power off, sets m_reconfig to true.
This should be called in derivedT::onPowerOff as
with appropriate error checking.
Definition at line 225 of file frameGrabber.hpp.
|
inherited |
Actions on power off.
This should be called from the derived's onPowerOff() as in
with appropriate error checking.
The INDI mutex should be locked before calling.
Definition at line 598 of file stdCamera.hpp.
|
protectedvirtualinherited |
This method is called when the change to poweroff is detected.
Reimplemented in MagAOX::app::zylaCtrl, MagAOX::app::zaberLowLevel, MagAOX::app::xt1121Ctrl, MagAOX::app::smc100ccCtrl, MagAOX::app::siglentSDG, MagAOX::app::picoMotorCtrl, MagAOX::app::picamCtrl, MagAOX::app::ocam2KCtrl, MagAOX::app::irisaoCtrl, MagAOX::app::hsfwCtrl, MagAOX::app::filterWheelCtrl, MagAOX::app::bmcCtrl, MagAOX::app::andorCtrl, MagAOX::app::alpaoCtrl, and MagAOX::app::acronameUsbHub.
Definition at line 3385 of file MagAOXApp.hpp.
|
inlineprotectedinherited |
Set defaults for a power on state.
Definition at line 653 of file cameraSim.hpp.
|
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.
Definition at line 3397 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::appLogic(), and MagAOX::app::smc100ccCtrl::appLogic().
|
inherited |
Returns the current power state.
If power management is not enabled, this always returns 1=On.
Definition at line 3414 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::picamCtrl::capExpTime(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), and MagAOX::app::hsfwCtrl::startHoming().
|
inherited |
Returns the target power state.
If power management is not enabled, this always returns 1=On.
Definition at line 3423 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::picamCtrl::capExpTime(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), and MagAOX::app::hsfwCtrl::startHoming().
|
inherited |
Definition at line 642 of file cameraSim.hpp.
|
inherited |
Definition at line 1015 of file stdCamera.hpp.
|
inherited |
Definition at line 301 of file frameGrabber.hpp.
|
inlineprotectedinherited |
Definition at line 782 of file cameraSim.hpp.
|
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.
| [out] | prop | the property to register |
| [in] | propName | the name of the property |
| [in] | propType | the type of the property |
| [in] | propPerm | the permissions of the property |
| [in] | propState | the state of the property |
| [in] | propRule | the switch rule type |
|
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.
| [out] | prop | the property to register |
| [in] | propName | the name of the property |
| [in] | propType | the type of the property |
| [in] | propPerm | the permissions of the property |
| [in] | propState | the state of the property |
|
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.
| [in] | prop | the property to register, must be fully set up |
Referenced by MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::zaberCtrl::appStartup(), and MagAOXApp_tests::SCENARIO().
|
inherited |
Register an INDI property which is read only.
This version requires the property be fully set up.
| [in] | prop | the property to register, must be completely setup |
Definition at line 2655 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picamCtrl::appStartup(), and MagAOX::app::zaberCtrl::appStartup().
|
inherited |
Register an INDI property which is read only.
This verison sets up the INDI property according to the arguments.
| [out] | prop | the property to register, will be configured |
| [in] | propName | the name of the property |
| [in] | propType | the type of the property |
| [in] | propPerm | the permissions of the property |
| [in] | propState | the state of the property |
Definition at line 2684 of file MagAOXApp.hpp.
|
inherited |
Register an INDI property which is monitored for updates from others.
| [out] | prop | the property to register |
| [in] | devName | the device which owns this property |
| [in] | propName | the name of the property |
Definition at line 2792 of file MagAOXApp.hpp.
|
inherited |
Definition at line 2949 of file MagAOXApp.hpp.
|
protectedinherited |
Send a newProperty command to another device (using the INDI Client interface)
| [in] | ipSend | The property to send a "new" INDI command for |
Definition at line 3302 of file MagAOXApp.hpp.
|
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.
| [in] | ipSend | The property to send a "new" INDI command for |
| [in] | el | The element of the property to change |
| [in] | newVal | The value to request for the element. |
Definition at line 3268 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().
|
protectedinherited |
Send a new property commmand for a standard toggle switch.
| [in] | device | The device name |
| [in] | property | The property name |
| [in] | onoff | Switch state to send: true = on, false = off |
Definition at line 3321 of file MagAOXApp.hpp.
|
inlineprotectedinherited |
Definition at line 754 of file cameraSim.hpp.
|
inherited |
Interface to setCropMode when the derivedT does not have crop mode.
Tag-dispatch resolution of c_stdCamera_cropMode==false will call this function. This prevents requiring derivedT to have its own setCropMode().
Definition at line 829 of file stdCamera.hpp.
|
inherited |
Interface to setCropMode when the derivedT has crop mode.
Tag-dispatch resolution of c_stdCamera_cropMode==true will call this function. Calls derivedT::setCropMode.
Definition at line 823 of file stdCamera.hpp.
|
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.
| [in] | argc | standard command line result specifying number of arguments in argv |
| [in] | argv | standard command line result containing the arguments. |
Definition at line 1188 of file MagAOXApp.hpp.
|
inlineprotectedinherited |
Definition at line 724 of file cameraSim.hpp.
|
inherited |
Interface to setEMGain when the derivedT does not have EM Gain.
Tag-dispatch resolution of c_stdCamera_emGain==false will call this function. This prevents requiring derivedT to have its own setEMGain().
Definition at line 739 of file stdCamera.hpp.
|
inherited |
Interface to setEMGain when the derivedT has EM Gain.
Tag-dispatch resolution of c_stdCamera_emGain==true will call this function. Calls derivedT::setEMGain.
Definition at line 733 of file stdCamera.hpp.
|
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
Definition at line 1961 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::elevate().
|
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
Definition at line 1980 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::restore().
|
inlineprotectedinherited |
Set the Exposure Time. [stdCamera interface].
Sets the frame rate to m_expTimeSet.
Definition at line 689 of file cameraSim.hpp.
|
inherited |
Interface to setExptime when the derivedT does not use exposure time controls.
Tag-dispatch resolution of c_stdCamera_exptimeCtrl==false will call this function. This prevents requiring derivedT to have its own setExpTime().
Definition at line 758 of file stdCamera.hpp.
|
inherited |
Interface to setExpTime when the derivedT uses exposure time controls.
Tag-dispatch resolution of c_stdCamera_exptimeCtrl==true will call this function. Calls derivedT::setExpTime.
Definition at line 752 of file stdCamera.hpp.
|
inlineprotectedinherited |
|
inherited |
Interface to setFPS when the derivedT does not use FPS controls.
Tag-dispatch resolution of c_stdCamera_hasFPS==false will call this function. This prevents requiring derivedT to have its own setFPS().
Definition at line 777 of file stdCamera.hpp.
|
inherited |
Interface to setFPS when the derivedT uses FPS controls.
Tag-dispatch resolution of c_stdCamera_fpsCtrl==true will call this function. Calls derivedT::setFPS.
Definition at line 771 of file stdCamera.hpp.
|
inlineprotectedinherited |
|
inherited |
Interface to setNextROI when the derivedT does not use ROIs.
Tag-dispatch resolution of c_stdCamera_usesROI==false will call this function. This prevents requiring derivedT to have its own setNextROI().
Definition at line 909 of file stdCamera.hpp.
|
inherited |
Interface to setNextROI when the derivedT uses ROIs.
Tag-dispatch resolution of c_stdCamera_usesROI==true will call this function. Calls derivedT::setNextROI.
Definition at line 903 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 677 of file cameraSim.hpp.
|
inherited |
Interface to setReadoutSpeed when the derivedT does not have readout speed control.
Tag-dispatch resolution of c_stdCamera_readoutSpeed==false will call this function. Just returns 0.
Definition at line 701 of file stdCamera.hpp.
|
inherited |
Interface to setReadoutSpeed when the derivedT has readout speed control.
Tag-dispatch resolution of c_stdCamera_readoutSpeed==true will call this function. Calls derivedT::setReadoutSpeed.
Definition at line 695 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 760 of file cameraSim.hpp.
|
inherited |
Interface to setShutter when the derivedT does not have a shutter.
Tag-dispatch resolution of c_stdCamera_hasShutter==false will call this function. This prevents requiring derivedT to have its own setShutter().
Definition at line 965 of file stdCamera.hpp.
|
inherited |
Interface to setShutter when the derivedT has a shutter.
Tag-dispatch resolution of c_stdCamera_hasShutter==true will call this function. Calls derivedT::setShutter.
Definition at line 957 of file stdCamera.hpp.
|
privateinherited |
Sets the handler for SIGTERM, SIGQUIT, and SIGINT.
Definition at line 1872 of file MagAOXApp.hpp.
|
inlineprotectedinherited |
Definition at line 718 of file cameraSim.hpp.
|
inherited |
Interface to setSynchro when the derivedT does not have synchronization.
Tag-dispatch resolution of c_stdCamera_ynchro==false will call this function. This prevents requiring derivedT to have its own setSynchro().
Definition at line 796 of file stdCamera.hpp.
|
inherited |
Interface to setSynchro when the derivedT has synchronization.
Tag-dispatch resolution of c_stdCamera_synchro==true will call this function. Calls derivedT::setSynchro.
Definition at line 790 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 665 of file cameraSim.hpp.
|
inherited |
Interface to setTempControl when the derivedT does not have temperature control.
Tag-dispatch resolution of c_stdCamera_tempControl==false will call this function. Prevents requiring derivedT::setTempControl.
Definition at line 682 of file stdCamera.hpp.
|
inherited |
Interface to setTempControl when the derivedT has temperature control.
Tag-dispatch resolution of c_stdCamera_tempControl==true will call this function. Calls derivedT::setTempControl.
Definition at line 676 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 671 of file cameraSim.hpp.
|
inherited |
Interface to setTempSetPt when the derivedT does not have temperature control.
Tag-dispatch resolution of c_stdCamera_tempControl==false will call this function. Prevents requiring derivedT::setTempSetPt.
Definition at line 663 of file stdCamera.hpp.
|
inherited |
Interface to setTempSetPt when the derivedT has temperature control.
Tag-dispatch resolution of c_stdCamera_tempControl==true will call this function. Calls derivedT::setTempSetPt.
Definition at line 657 of file stdCamera.hpp.
|
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 1294 of file MagAOXApp.hpp.
|
inlinevirtualinherited |
Setup the configuration system (called by MagAOXApp::setup())
Definition at line 268 of file cameraSim.hpp.
|
inherited |
Setup an application configurator for the device section.
| [in] | config | an application configuration to setup |
Definition at line 104 of file telemeter.hpp.
|
inherited |
Setup the configuration system.
This should be called in derivedT::setupConfig as
with appropriate error checking.
| [out] | config | the derived classes configurator |
Definition at line 178 of file frameGrabber.hpp.
|
inherited |
Setup the configuration system.
This should be called in derivedT::setupConfig as
with appropriate error checking.
| [out] | config | the derived classes configurator |
Definition at line 532 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 683 of file cameraSim.hpp.
|
inherited |
Interface to setVShiftSpeed when the derivedT does not have vshift speed control.
Tag-dispatch resolution of c_stdCamera_vShiftSpeed==false will call this function. Just returns 0.
Definition at line 720 of file stdCamera.hpp.
|
inherited |
Interface to setVShiftSpeed when the derivedT has vshift speed control.
Tag-dispatch resolution of c_stdCamera_vShiftSpeed==true will call this function. Calls derivedT::setVShiftSpeed.
Definition at line 714 of file stdCamera.hpp.
|
inherited |
Get the value of the shutdown flag.
Definition at line 1182 of file MagAOXApp.hpp.
Referenced by MagAOX::app::streamWriter::swThreadExec().
|
staticprotectedinherited |
The static callback function to be registered for requesting to clear the FSM alert.
| [in] | app | a pointer to this, will be static_cast-ed to MagAOXApp. |
| [in] | ipRecv | the INDI property sent with the new property request. |
Definition at line 3358 of file MagAOXApp.hpp.
|
staticinherited |
The static callback function to be registered for stdCamera properties.
Calls newCallback_stdCamera
| [in] | app | a pointer to this, will be static_cast-ed to derivedT. |
| [in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 641 of file stdCamera.hpp.
|
inherited |
Definition at line 567 of file cameraSim.hpp.
|
protectedinherited |
Start INDI Communications.
Definition at line 2892 of file MagAOXApp.hpp.
|
inherited |
Get the current state code.
Definition at line 2297 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(), MagAOX::app::filterWheelCtrl::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(), MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::qhyCtrl::appStartup(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::trippLitePDU::appStartup(), MagAOX::app::xt1121DCDU::appStartup(), MagAOX::app::zylaCtrl::appStartup(), MagAOX::app::andorCtrl::cameraSelect(), 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(), MagAOX::app::filterWheelCtrl::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().
|
inherited |
Set the current state code.
| [in] | s | The new application state |
| [in] | stateAlert | [optional] flag to set the alert state of the FSM property. |
Definition at line 2303 of file MagAOXApp.hpp.
|
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:
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.
Definition at line 2361 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::filterWheelCtrl::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().
|
inlineprotectedinherited |
Definition at line 767 of file cameraSim.hpp.
|
inherited |
Interface to stateString when the derivedT does not provide it.
Tag-dispatch resolution of c_stdCamera_usesStateString==false will call this function. returns "".
Definition at line 986 of file stdCamera.hpp.
|
inherited |
Interface to stateString when the derivedT provides it.
Tag-dispatch resolution of c_stdCamera_usesStateString==true will call this function. Calls derivedT::stateString.
Definition at line 980 of file stdCamera.hpp.
|
inlineprotectedinherited |
Definition at line 772 of file cameraSim.hpp.
|
inherited |
Interface to stateStringValid when the derivedT does not provide it.
Tag-dispatch resolution of c_stdCamera_usesStateString==false will call this function. returns false.
Definition at line 998 of file stdCamera.hpp.
|
inherited |
Interface to stateStringValid when the derivedT provides it.
Tag-dispatch resolution of c_stdCamera_usesStateString==true will call this function. Calls derivedT::stateStringValid.
Definition at line 992 of file stdCamera.hpp.
|
inherited |
Make a telemetry recording, for an empty record.
Wrapper for logManager::log, which updates telT::lastRecord.
| logT | the log entry type |
| retval | the value returned by this method. |
Definition at line 97 of file telemeter.hpp.
|
inherited |
Make a telemetry recording.
Wrapper for logManager::log, which updates telT::lastRecord.
| logT | the log entry type |
| retval | the value returned by this method. |
| [in] | msg | the data to log |
Definition at line 87 of file telemeter.hpp.
|
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:
where impl is the derived class, and mThreadStart and myThreadExec are members of impl.
| [out] | thrd | The thread object to start executing |
| thrdInit | [in/out] The thread initilization synchronizer. | |
| tpid | [in/out] The thread pid to be filled in by thrdStart immediately upon call | |
| thProp | [in/out] The INDI property to publish the thread details | |
| [in] | thrdPrio | The r/t priority to set for this thread |
| [in] | cpuset | the cpuset to place this thread on. Ignored if "". |
| [in] | thrdName | The name of the thread (just for logging) |
| [in] | thrdThis | The `this` pointer to pass to the thread starter function |
| [in] | thrdStart | The thread starting function, a static function taking a `this` pointer as argument. |
Definition at line 2157 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().
|
protectedinherited |
Remove the PID file.
Definition at line 2133 of file MagAOXApp.hpp.
|
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.
| p | [in/out] The property containing the element to possibly update | |
| [in] | el | The element name |
| [in] | newVal | the new value |
Definition at line 3135 of file MagAOXApp.hpp.
|
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.
| p | [in/out] The property containing the element to possibly update | |
| [in] | el | Beginning of each element name |
| [in] | newVals | the new values |
| [in] | ipState | [optional] the new state |
Definition at line 3160 of file MagAOXApp.hpp.
|
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.
| p | [in/out] The property containing the element to possibly update | |
| [in] | el | The element name |
| [in] | newVal | the new value |
Definition at line 3120 of file MagAOXApp.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::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(), MagAOX::app::filterWheelCtrl::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().
|
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.
| p | [in/out] The property containing the element to possibly update | |
| [in] | els | String vector of element names |
| [in] | newVals | the new values |
| [in] | newState | [optional] The state of the property |
Definition at line 3181 of file MagAOXApp.hpp.
|
inherited |
Update the INDI properties for this device controller.
You should call this once per main loop. It is not called automatically.
Definition at line 293 of file frameGrabber.hpp.
|
inherited |
Update the INDI properties for this device controller.
You should call this once per main loop. It is not called automatically.
Definition at line 1007 of file stdCamera.hpp.
|
protectedinherited |
Update an INDI switch element value if it has changed.
Will only peform a SetProperty if the new element switch state has changed, or the propery state has changed.
| p | [in/out] The property containing the element to possibly update | |
| [in] | el | The element name |
| [in] | newVal | the new value |
Definition at line 3144 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::cameraSim::setNextROI(), MagAOX::app::picamCtrl::setNextROI(), MagAOX::app::qhyCtrl::setNextROI(), MagAOX::app::zylaCtrl::setNextROI(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::picamCtrl::setTempControl(), MagAOX::app::filterWheelCtrl::startHoming(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::hsfwCtrl::stop(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::zaberCtrl::stop(), and MagAOX::app::sysMonitor::updateVals().
|
inherited |
Actions while powered off.
This should be called from the derived's whilePowerOff() as in
with appropriate error checking.
Definition at line 611 of file stdCamera.hpp.
|
protectedvirtualinherited |
This method is called while the power is off, once per FSM loop.
Reimplemented in MagAOX::app::zylaCtrl, MagAOX::app::zaberLowLevel, MagAOX::app::xt1121Ctrl, MagAOX::app::siglentSDG, MagAOX::app::picoMotorCtrl, MagAOX::app::picamCtrl, MagAOX::app::ocam2KCtrl, MagAOX::app::irisaoCtrl, MagAOX::app::hsfwCtrl, MagAOX::app::filterWheelCtrl, MagAOX::app::bmcCtrl, MagAOX::app::andorCtrl, MagAOX::app::alpaoCtrl, and MagAOX::app::acronameUsbHub.
Definition at line 3391 of file MagAOXApp.hpp.
|
staticconstexprinherited |
app:dev config to tell framegrabber that this camera can be flipped
Definition at line 101 of file cameraSim.hpp.
|
staticconstexprinherited |
app:dev config to tell stdCamera not to expose Crop Mode controls
Definition at line 92 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera to not expose EM gain controls
Definition at line 73 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera to expose exposure time controls
Definition at line 76 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera not to expose FPS status (ignored since fpsCtrl=true)
Definition at line 81 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera to expose FPS controls
Definition at line 79 of file cameraSim.hpp.
|
staticconstexprinherited |
app:dev config to tell stdCamera to expose shutter controls
Definition at line 95 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera not to expose readout speed controls
Definition at line 67 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera to not expose synchro mode controls
Definition at line 84 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera to expose temperature
Definition at line 65 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev config to tell stdCamera to not expose temperature controls
Definition at line 62 of file cameraSim.hpp.
|
staticconstexprinherited |
app:dev config to tell stdCamera not to expose mode controls
Definition at line 87 of file cameraSim.hpp.
|
staticconstexprinherited |
app:dev config to tell stdCamera to expose ROI controls
Definition at line 90 of file cameraSim.hpp.
|
staticconstexprinherited |
app::dev confg to tell stdCamera to expose the state string property
Definition at line 98 of file cameraSim.hpp.
|
staticconstexprinherited |
app:dev config to tell stdCamera not to expose vertical shift speed control
Definition at line 70 of file cameraSim.hpp.
|
protectedinherited |
Definition at line 346 of file stdCamera.hpp.
|
protectedinherited |
Flag indicating that all registered Set properties have been updated since last Get.
Definition at line 582 of file MagAOXApp.hpp.
|
protectedinherited |
Definition at line 145 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 148 of file frameGrabber.hpp.
|
protectedinherited |
the simulated bias level. default 500.
Definition at line 112 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
protectedinherited |
The path to calibration files for MagAOX.
Definition at line 89 of file MagAOXApp.hpp.
|
protectedinherited |
Map holding the possible camera mode configurations.
Definition at line 294 of file stdCamera.hpp.
|
protectedinherited |
The current temperature, in C.
Definition at line 313 of file stdCamera.hpp.
|
protectedinherited |
The desired temperature, in C.
Definition at line 315 of file stdCamera.hpp.
|
protectedinherited |
Length of the circular buffer, in frames.
Definition at line 116 of file frameGrabber.hpp.
|
protectedinherited |
The name of a base config class for this app (minus .conf).
Definition at line 87 of file MagAOXApp.hpp.
|
protectedinherited |
The path to configuration files for MagAOX.
Definition at line 85 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::configureAcquisition().
|
protectedinherited |
The name of the configuration file (minus .conf).
Definition at line 83 of file MagAOXApp.hpp.
Referenced by MagAOX::app::mzmqClient::loadConfig(), MagAOX::app::mzmqServer::loadConfig(), MagAOX::app::zaberCtrl::loadConfigImpl(), MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().
|
protectedinherited |
Definition at line 424 of file MagAOXApp.hpp.
|
protectedinherited |
Status of crop mode ROIs, if enabled for this camera.
Definition at line 494 of file stdCamera.hpp.
|
protectedinherited |
Desired status of crop mode ROIs, if enabled for this camera.
Definition at line 495 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 125 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 422 of file stdCamera.hpp.
|
protectedinherited |
The timestamp of the current image.
Definition at line 137 of file frameGrabber.hpp.
|
protectedinherited |
The ImageStreamIO type code.
Definition at line 130 of file frameGrabber.hpp.
|
protectedinherited |
Power-on ROI x binning.
Definition at line 454 of file stdCamera.hpp.
|
protectedinherited |
Power-on ROI y binning.
Definition at line 455 of file stdCamera.hpp.
|
protectedinherited |
Power-on ROI height.
Definition at line 453 of file stdCamera.hpp.
|
protectedinherited |
Power-on ROI width.
Definition at line 452 of file stdCamera.hpp.
|
protectedinherited |
Power-on ROI center x coordinate.
Definition at line 450 of file stdCamera.hpp.
|
protectedinherited |
Power-on ROI center y coordinate.
Definition at line 451 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 121 of file frameGrabber.hpp.
|
protectedinherited |
The default readout speed of the camera.
Definition at line 300 of file stdCamera.hpp.
|
protectedinherited |
The default readout speed of the camera.
Definition at line 301 of file stdCamera.hpp.
|
protectedinherited |
Full path name of the INDI driver control FIFO.
This is currently only used to signal restarts.
Definition at line 593 of file MagAOXApp.hpp.
|
protectedinherited |
Full path name of the INDI driver input FIFO.
Definition at line 585 of file MagAOXApp.hpp.
|
protectedinherited |
Full path name of the INDI driver output FIFO.
Definition at line 588 of file MagAOXApp.hpp.
|
protectedinherited |
Definition at line 154 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 153 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 152 of file frameGrabber.hpp.
|
protectedinherited |
The camera's current EM gain (if available).
Definition at line 349 of file stdCamera.hpp.
|
protectedinherited |
The camera's EM gain, as set by the user.
Definition at line 350 of file stdCamera.hpp.
|
privateinherited |
The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid).
Definition at line 314 of file MagAOXApp.hpp.
|
privateinherited |
The real user id of the proces (i.e. the lower privileged id of the user)
Definition at line 313 of file MagAOXApp.hpp.
|
protectedinherited |
The current exposure time, in seconds.
Definition at line 367 of file stdCamera.hpp.
|
protectedinherited |
The exposure time, in seconds, as set by user.
Definition at line 368 of file stdCamera.hpp.
|
protectedinherited |
The cpuset to assign the framegrabber thread to. Not used if empty, the default.
Definition at line 114 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 107 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), MagAOX::app::cameraSim::configureAcquisition(), and MagAOX::app::cameraSim::loadImageIntoStream().
|
protectedinherited |
A separate thread for the actual framegrabbings.
Definition at line 253 of file frameGrabber.hpp.
|
protectedinherited |
The ID of the framegrabber thread.
Definition at line 249 of file frameGrabber.hpp.
|
protectedinherited |
Synchronizer for thread startup, to allow priority setting to finish.
Definition at line 247 of file frameGrabber.hpp.
|
protectedinherited |
Priority of the framegrabber thread, should normally be > 00.
Definition at line 113 of file frameGrabber.hpp.
|
protectedinherited |
The property to hold the f.g. thread details.
Definition at line 251 of file frameGrabber.hpp.
|
protectedinherited |
The current FPS.
Definition at line 374 of file stdCamera.hpp.
|
protectedinherited |
The commanded fps, as set by user.
Definition at line 375 of file stdCamera.hpp.
|
protectedinherited |
The x-binning in the full ROI.
Definition at line 461 of file stdCamera.hpp.
|
protectedinherited |
The y-binning in the full ROI.
Definition at line 462 of file stdCamera.hpp.
|
protectedinherited |
The current-binning full ROI height.
Definition at line 467 of file stdCamera.hpp.
|
protectedinherited |
The current-binning full ROI width.
Definition at line 466 of file stdCamera.hpp.
|
protectedinherited |
The current-binning full ROI center x coordinate.
Definition at line 464 of file stdCamera.hpp.
|
protectedinherited |
The current-binning full ROI center y coordinate.
Definition at line 465 of file stdCamera.hpp.
|
protectedinherited |
The full ROI height.
Definition at line 460 of file stdCamera.hpp.
|
protectedinherited |
The full ROI width.
Definition at line 459 of file stdCamera.hpp.
|
protectedinherited |
The full ROI center x coordinate.
Definition at line 457 of file stdCamera.hpp.
|
protectedinherited |
The full ROI center y coordinate.
Definition at line 458 of file stdCamera.hpp.
|
protectedinherited |
the simulated star FWHM in pixels. the same for all stars. default 2.
Definition at line 120 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
privateinherited |
Definition at line 478 of file MagAOXApp.hpp.
|
protectedinherited |
The height of the image, once deinterlaced etc.
Definition at line 128 of file frameGrabber.hpp.
|
protectedinherited |
The ImageStreamIO shared memory buffer.
Definition at line 141 of file frameGrabber.hpp.
|
inherited |
The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.
Definition at line 542 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().
|
inherited |
Mutex for locking INDI communications.
Definition at line 545 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::filterWheelCtrl::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(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::zylaCtrl::reconfig(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), MagAOX::app::ocam2KCtrl::whilePowerOff(), and MagAOX::app::zylaCtrl::whilePowerOff().
|
protectedinherited |
Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.
The key for these is the property name.
Definition at line 573 of file MagAOXApp.hpp.
|
protectedinherited |
indi Property to clear an FSM alert.
Definition at line 980 of file MagAOXApp.hpp.
|
protectedinherited |
Property used to toggle crop mode on and off.
Definition at line 497 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 356 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 377 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 379 of file stdCamera.hpp.
|
protectedinherited |
Property used to report the current frame size.
Definition at line 281 of file frameGrabber.hpp.
|
protectedinherited |
Property used to preset the full ROI dimensions.
Definition at line 476 of file stdCamera.hpp.
|
protectedinherited |
Property used to report the current mode.
Definition at line 402 of file stdCamera.hpp.
|
protectedinherited |
INDI property used to communicate power state.
Definition at line 1036 of file MagAOXApp.hpp.
|
protectedinherited |
Definition at line 353 of file stdCamera.hpp.
|
protectedinherited |
Request switch which forces the framegrabber to go through the reconfigure process.
Definition at line 404 of file stdCamera.hpp.
|
protectedinherited |
Property used to set the ROI x binning.
Definition at line 473 of file stdCamera.hpp.
|
protectedinherited |
Property used to set the ROI y binning.
Definition at line 474 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger checking the target ROI.
Definition at line 478 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger setting the default and startup ROI.
Definition at line 486 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger setting the full ROI.
Definition at line 482 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger setting the full in current binning ROI.
Definition at line 483 of file stdCamera.hpp.
|
protectedinherited |
Property used to set the ROI height.
Definition at line 472 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger setting the last ROI.
Definition at line 485 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger loading the last ROI as the target.
Definition at line 484 of file stdCamera.hpp.
|
protectedinherited |
Property used to trigger setting the ROI.
Definition at line 480 of file stdCamera.hpp.
|
protectedinherited |
Property used to set the ROI width.
Definition at line 471 of file stdCamera.hpp.
|
protectedinherited |
Property used to set the ROI x center coordinate.
Definition at line 469 of file stdCamera.hpp.
|
protectedinherited |
Property used to set the ROI x center coordinate.
Definition at line 470 of file stdCamera.hpp.
|
protectedinherited |
Property used to report the shmim buffer name.
Definition at line 279 of file frameGrabber.hpp.
|
protectedinherited |
Property used to control the shutter, a switch.
Definition at line 508 of file stdCamera.hpp.
|
protectedinherited |
State of the shutter. 0 = shut, 1 = open, -1 = unknown.
Property to report shutter status
Definition at line 507 of file stdCamera.hpp.
|
protectedinherited |
indi Property to report the application state.
Definition at line 977 of file MagAOXApp.hpp.
|
protectedinherited |
Definition at line 516 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 390 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 324 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 325 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 326 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 283 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 354 of file stdCamera.hpp.
|
protectedinherited |
Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.
The key for these is device.name
Definition at line 578 of file MagAOXApp.hpp.
|
protectedinherited |
the simulated jitter, in pixels/read. the same for all stars. default 0.1.
Definition at line 122 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
protectedinherited |
Definition at line 424 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 109 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), MagAOX::app::cameraSim::appStartup(), and MagAOX::app::cameraSim::startAcquisition().
|
protectedinherited |
Maximum length of the latency measurement circular buffers.
Definition at line 118 of file frameGrabber.hpp.
|
protectedinherited |
Maximum time of the latency meaurement circular buffers.
Definition at line 119 of file frameGrabber.hpp.
|
staticinherited |
Definition at line 237 of file MagAOXApp.hpp.
|
protectedinherited |
The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X.
Definition at line 95 of file MagAOXApp.hpp.
Referenced by MagAOX::app::trippLitePDU::trippLitePDU(), MagAOX::app::siglentSDG::appLogic(), and MagAOX::app::xt1121Ctrl::appLogic().
|
protectedinherited |
The configurable maximum EM gain. To be enforced in derivedT.
Definition at line 351 of file stdCamera.hpp.
|
protectedinherited |
The maximum exposure time, used for INDI attributes.
Definition at line 364 of file stdCamera.hpp.
|
protectedinherited |
The maximum FPS, used for INDI attributes.
Definition at line 371 of file stdCamera.hpp.
|
inherited |
The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.
Definition at line 75 of file telemeter.hpp.
|
protectedinherited |
Definition at line 443 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 447 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 439 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 435 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 427 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 431 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 310 of file stdCamera.hpp.
|
protectedinherited |
The minimum exposure time, used for INDI attributes.
Definition at line 363 of file stdCamera.hpp.
|
protectedinherited |
The minimum FPS, used for INDI attributes.
Definition at line 370 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 442 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 446 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 438 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 434 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 426 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 430 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 309 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 156 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 159 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 162 of file frameGrabber.hpp.
|
protectedinherited |
The current mode name.
Definition at line 398 of file stdCamera.hpp.
|
protectedinherited |
The mode to be set by the next reconfiguration.
Definition at line 400 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 423 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 124 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid().
|
protectedinherited |
Definition at line 110 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), MagAOX::app::cameraSim::appStartup(), and MagAOX::app::cameraSim::startAcquisition().
|
protectedinherited |
the simulated star peak, in counts/second. one per star. default 2000.
Definition at line 119 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
protectedinherited |
This process's PID.
Definition at line 394 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI property name of the channel controlling this device's power.
Definition at line 1022 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI device name of the power controller.
Definition at line 1021 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI element name to monitor for this device's power state.
Definition at line 1023 of file MagAOXApp.hpp.
|
protectedinherited |
Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error.
Definition at line 1016 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::acronameUsbHub(), MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::cameraSim::cameraSim(), MagAOX::app::filterWheelCtrl::filterWheelCtrl(), MagAOX::app::hsfwCtrl::hsfwCtrl(), MagAOX::app::mzmqClient::mzmqClient(), MagAOX::app::mzmqServer::mzmqServer(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::picamCtrl::picamCtrl(), MagAOX::app::picoMotorCtrl::picoMotorCtrl(), MagAOX::app::qhyCtrl::qhyCtrl(), MagAOX::app::siglentSDG::siglentSDG(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), MagAOX::app::streamWriter::streamWriter(), MagAOX::app::ttmModulator::ttmModulator(), MagAOX::app::xt1121Ctrl::xt1121Ctrl(), MagAOX::app::xt1121DCDU::xt1121DCDU(), and MagAOX::app::zylaCtrl::zylaCtrl().
|
protectedinherited |
Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup.
Definition at line 1029 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), and MagAOX::app::zylaCtrl::onPowerOff().
|
protectedinherited |
Time in sec to wait for device to boot after power on.
Definition at line 1026 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), and MagAOX::app::zylaCtrl::zylaCtrl().
|
protectedinherited |
Current power state, 1=On, 0=Off, -1=Unk.
Definition at line 1033 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::xt1121Ctrl::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::siglentSDG::checkSetup(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), MagAOX::app::picamCtrl::reconfig(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
protectedinherited |
The INDI element name to monitor for this device's power state.
Definition at line 1024 of file MagAOXApp.hpp.
|
protectedinherited |
Current target power state, 1=On, 0=Off, -1=Unk.
Definition at line 1034 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::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::siglentSDG::checkSetup(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
protectedinherited |
The current readout speed name.
Definition at line 337 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 335 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 334 of file stdCamera.hpp.
|
protectedinherited |
The user requested readout speed name, to be set by derived()
Definition at line 338 of file stdCamera.hpp.
|
protectedinherited |
Flag to set if a camera reconfiguration requires a framegrabber reset.
Definition at line 139 of file frameGrabber.hpp.
|
protectedinherited |
the simulated readout noise, in counts/read. default 5.
Definition at line 113 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
staticprivateinherited |
Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers.
Definition at line 289 of file MagAOXApp.hpp.
|
protectedinherited |
The name of the shared memory image, is used in /tmp/<shmimName>.im.shm. Derived classes should set a default.
Definition at line 111 of file frameGrabber.hpp.
|
protectedinherited |
Flag to signal it's time to shutdown. When not 0, the main loop exits.
Definition at line 100 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::streamWriter::fgThreadExec(), MagAOX::app::andorCtrl::loadConfig(), MagAOX::app::cameraSim::loadConfig(), MagAOX::app::picoMotorCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::streamWriter::loadConfig(), MagAOX::app::sysMonitor::loadConfig(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), MagAOX::app::sysMonitor::setlatThreadExec(), MagAOX::app::streamWriter::swThreadExec(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
protectedinherited |
Definition at line 505 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 504 of file stdCamera.hpp.
|
protectedinherited |
The camera mode to load during first init after a power-on.
Definition at line 296 of file stdCamera.hpp.
|
protectedinherited |
The temperature to set after a power-on. Set to <= -999 to not use [default].
Definition at line 298 of file stdCamera.hpp.
|
privateinherited |
The application's state. Never ever set this directly, use state(const stateCodeT & s).
Definition at line 472 of file MagAOXApp.hpp.
|
privateinherited |
Definition at line 475 of file MagAOXApp.hpp.
|
privateinherited |
Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().
Definition at line 480 of file MagAOXApp.hpp.
|
protectedinherited |
The maximum exposure time stepsize, used for INDI attributes.
Definition at line 365 of file stdCamera.hpp.
|
protectedinherited |
The FPS step size, used for INDI attributes.
Definition at line 372 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 444 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 448 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 440 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 436 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 428 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 432 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 311 of file stdCamera.hpp.
|
privateinherited |
The save-set user id of the process.
Definition at line 316 of file MagAOXApp.hpp.
|
protectedinherited |
Status of synchronization, true is on, false is off.
Definition at line 388 of file stdCamera.hpp.
|
protectedinherited |
Target status of m_synchro.
Definition at line 386 of file stdCamera.hpp.
|
inherited |
Definition at line 73 of file telemeter.hpp.
|
protectedinherited |
Whether or not the temperature control system is on its target temperature.
Definition at line 320 of file stdCamera.hpp.
|
protectedinherited |
Whether or not temperature control is active.
Definition at line 317 of file stdCamera.hpp.
|
protectedinherited |
Desired state of temperature control.
Definition at line 318 of file stdCamera.hpp.
|
protectedinherited |
Camera specific description of temperature control status.
Definition at line 322 of file stdCamera.hpp.
|
protectedinherited |
The size of the type, in bytes. Result of sizeof.
Definition at line 131 of file frameGrabber.hpp.
|
staticconstexprprotectedinherited |
Flag controlling whether INDI is used. If false, then no INDI code executes.
Definition at line 537 of file MagAOXApp.hpp.
|
protectedinherited |
Definition at line 157 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 160 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 163 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 347 of file stdCamera.hpp.
|
protectedinherited |
The current vshift speed name.
Definition at line 343 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 341 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 340 of file stdCamera.hpp.
|
protectedinherited |
The user requested vshift speed name, to be set by derived()
Definition at line 344 of file stdCamera.hpp.
|
protectedinherited |
Definition at line 150 of file frameGrabber.hpp.
|
protectedinherited |
The width of the image, once deinterlaced etc.
Definition at line 127 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 146 of file frameGrabber.hpp.
|
protectedinherited |
Definition at line 149 of file frameGrabber.hpp.
|
protectedinherited |
The x-binning according to the framegrabber.
Definition at line 133 of file frameGrabber.hpp.
|
protectedinherited |
the simulated star x center coordinate, relative to image center. one per star. default 0
Definition at line 115 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
protectedinherited |
The y-binning according to the framegrabber.
Definition at line 134 of file frameGrabber.hpp.
|
protectedinherited |
the simulated star y center coordinate, relative to image center. one per star. default 0.
Definition at line 117 of file cameraSim.hpp.
Referenced by MagAOX::app::cameraSim::acquireAndCheckValid(), and MagAOX::app::cameraSim::loadConfigImpl().
|
protectedinherited |
The base path of the MagAO-X system.
Definition at line 81 of file MagAOXApp.hpp.
Referenced by MagAOX::app::streamWriter::loadConfig().
|
protectedinherited |
The name of the PID file.
Definition at line 392 of file MagAOXApp.hpp.
|
protectedinherited |
Path to the secrets directory, where passwords, etc, are stored.
Definition at line 93 of file MagAOXApp.hpp.
|
protectedinherited |
The path to the system directory, for PID file, etc.
Definition at line 91 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().
1.9.1