#include <smc100ccCtrl.hpp>
Public Types | |
typedef logger::logManager< MagAOXApp< _useINDI >, logFileRaw > | logManagerT |
The log manager type. More... | |
typedef logger::logManager< smc100ccCtrl, logFileRaw > | logManagerT |
The log manager type. More... | |
Public Member Functions | |
INDI_NEWCALLBACK_DECL (smc100ccCtrl, m_indiP_position) | |
smc100ccCtrl () | |
Default c'tor. More... | |
~smc100ccCtrl () noexcept | |
virtual void | setupConfig () |
Setup the configuration system (called by MagAOXApp::setup()) More... | |
virtual void | loadConfig () |
Load the configuration system results (called by MagAOXApp::setup()) More... | |
virtual int | appStartup () |
Checks if the device was found during loadConfig. More... | |
virtual int | appLogic () |
Changes device state based on testing connection and device status. More... | |
virtual int | appShutdown () |
Do any needed shutdown tasks. Currently nothing in this app. More... | |
virtual int | onPowerOff () |
This method is called when the change to poweroff is detected. More... | |
int | makeCom (std::string &str, const std::string &com) |
int | splitResponse (int &axis, std::string &com, std::string &val, std::string &resp) |
int | getCtrlState (std::string &state) |
int | testConnection () |
Tests if device is cabale of recieving/executing IO commands. More... | |
int | getPosition (double &pos) |
Verifies current status of controller. More... | |
int | getLastError (std::string &errStr) |
Returns any error controller has. 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 | setupConfig (mx::app::appConfigurator &config) |
Setup an application configurator for the USB section. More... | |
int | loadConfig (mx::app::appConfigurator &config) |
Load the USB section from an application configurator. More... | |
int | getDeviceName () |
Get the device name from udev using the vendor, product, and serial number. More... | |
int | connect () |
Connect to the device. More... | |
int | setupConfig (mx::app::appConfigurator &config) |
Setup an application configurator for the device section. More... | |
int | loadConfig (mx::app::appConfigurator &config) |
Load the device section from an application configurator. More... | |
int | setupConfig (mx::app::appConfigurator &config) |
Setup the configuration system. More... | |
int | loadConfig (mx::app::appConfigurator &config) |
load the configuration system results More... | |
int | 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... | |
int | setupConfig (appConfigurator &config) |
Setup an application configurator for the device section. More... | |
int | loadConfig (appConfigurator &config) |
Load the device section from an application configurator. More... | |
int | checkRecordTimes (const telT &tel, telTs... tels) |
Check the time of the last record for each telemetry type and make an entry if needed. More... | |
int | checkRecordTimes (timespec &ts, const telT &tel, telTs... tels) |
Worker function to actually perform the record time checking logic. More... | |
int | checkRecordTimes (timespec &ts) |
Empty function called at the end of the template list. More... | |
Standard Motion Stage Interface | |
int | stop () |
int | startHoming () |
double | presetNumber () |
int | moveTo (double position) |
Telemeter Interface | |
int | checkRecordTimes () |
int | recordTelem (const telem_stage *) |
int | recordTelem (const telem_position *) |
int | recordStage (bool force=false) |
int | recordPosition (bool force=false) |
Threads | |
template<class thisPtr , class Function > | |
int | threadStart (std::thread &thrd, bool &thrdInit, pid_t &tpid, pcf::IndiProperty &thProp, int thrdPrio, const std::string &cpuset, const std::string &thrdName, thisPtr *thrdThis, Function &&thrdStart) |
Start a thread, using this class's privileges to set priority, etc. More... | |
Member Accessors | |
std::string | configName () |
Get the config name. More... | |
std::string | configDir () |
Get the config directory. More... | |
std::string | driverInName () |
Get the INDI input FIFO file name. More... | |
std::string | driverOutName () |
Get the INDI output FIFO file name. More... | |
std::string | driverCtrlName () |
Get the INDI control FIFO file name. More... | |
Public Attributes | |
std::string | m_idVendor |
The vendor id 4-digit code. More... | |
std::string | m_idProduct |
The product id 4-digit code. More... | |
std::string | m_serial |
The serial number. More... | |
speed_t | m_baudRate {0} |
The baud rate specification. More... | |
std::string | m_deviceName |
The device path name, e.g. /dev/ttyUSB0. More... | |
int | m_fileDescrip {0} |
The file descriptor. More... | |
unsigned | m_readTimeout {1000} |
The read timeout [msec]. More... | |
unsigned | m_writeTimeout {1000} |
The write timeout [msec]. More... | |
logManagerT | m_tel |
double | m_maxInterval |
The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds. More... | |
Protected Attributes | |
pcf::IndiProperty | m_indiP_position |
Indi variable for reporting the stage position. More... | |
std::vector< std::string > | validStateCodes {} |
double | m_position {0} |
double | m_target {0} |
bool | m_wasHoming {0} |
bool | m_powerOnHomed {false} |
std::string | MagAOXPath |
The base path of the MagAO-X system. More... | |
std::string | m_configName |
The name of the configuration file (minus .conf). More... | |
std::string | m_configDir |
The path to configuration files for MagAOX. More... | |
std::string | m_configBase |
The name of a base config class for this app (minus .conf). More... | |
std::string | m_calibDir |
The path to calibration files for MagAOX. More... | |
std::string | sysPath |
The path to the system directory, for PID file, etc. More... | |
std::string | secretsPath |
Path to the secrets directory, where passwords, etc, are stored. More... | |
unsigned long | m_loopPause {MAGAOX_default_loopPause} |
The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X. More... | |
int | m_shutdown {0} |
Flag to signal it's time to shutdown. When not 0, the main loop exits. More... | |
std::string | m_presetNotation |
Notation used to refer to a preset, should be singular, as in "preset" or "filter". More... | |
bool | m_fractionalPresets |
Flag to set in constructor determining if fractional presets are allowed. Used for INDI/GUIs. More... | |
bool | m_defaultPositions |
Flag controlling whether the default preset positions (the vector index) are set in loadConfig. More... | |
int8_t | m_moving |
Whether or not the stage is moving. -2 means powered off, -1 means not homed, 0 means not moving, 1 means moving, 2 means homing. More... | |
int8_t | m_movingState |
Used to track the type of command. If > 1 this is a command to move to a preset. If 0 then it is a move to an arbitrary position. More... | |
double | m_preset |
The current numerical preset position [1.0 is index 0 in the preset name vector]. More... | |
double | m_preset_target |
The target numerical preset position [1.0 is index 0 in the preset name vector]. More... | |
Configurable Parameters | |
double | m_homingOffset {0} |
cpusets | |
The path to the cpusets mount is configured by the environment varialbe defined by MAGOX_env_cpuset in environment.hpp. This environment varialbe is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used. This is normally "/opt/MagAOX/cpuset/" | |
std::string | m_cpusetPath {MAGAOX_cpusetPath} |
Configurable Parameters | |
bool | m_powerOnHome |
If true, then the motor is homed at startup (by this software or actual power on) More... | |
int | m_homePreset |
If >=0, this preset position is moved to after homing. More... | |
std::vector< std::string > | m_presetNames |
The names of each position on the stage. More... | |
std::vector< double > | m_presetPositions |
The positions, in arbitrary units, of each preset. If 0, then the integer position number (starting from 1) is used to calculate. More... | |
Private Member Functions | |
int | clearFSMAlert () |
Clear the FSM alert state. More... | |
smc100ccCtrl & | derived () |
Friends | |
class | dev::stdMotionStage< smc100ccCtrl > |
class | dev::telemeter< smc100ccCtrl > |
PID Locking | |
Each MagAOXApp has a PID lock file in the system directory. The app will not startup if it detects that the PID is already locked, preventing duplicates. This is based on the configured name, not the invoked name (argv[0]). | |
std::string | pidFileName |
The name of the PID file. More... | |
pid_t | m_pid {0} |
This process's PID. More... | |
int | lockPID () |
Attempt to lock the PID by writing it to a file. Fails if a process is already running with the same config name. More... | |
int | unlockPID () |
Remove the PID file. More... | |
INDI Interface | |
For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property. | |
std::unordered_map< std::string, 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 | createStandardIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &label="", const std::string &group="") |
Create a standard R/W INDI Text property with target and current elements. More... | |
int | createROIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &elName, const std::string &propLabel="", const std::string &propGroup="", const std::string &elLabel="") |
Create a standard ReadOnly INDI Text property, with at least one element. More... | |
template<typename T > | |
int | createStandardIndiNumber (pcf::IndiProperty &prop, const std::string &name, const T &min, const T &max, const T &step, const std::string &format, const std::string &label="", const std::string &group="") |
Create a standard R/W INDI Number property with target and current elements. More... | |
int | createROIndiNumber (pcf::IndiProperty &prop, const std::string &propName, const std::string &propLabel="", const std::string &propGroup="") |
Create a ReadOnly INDI Number property. More... | |
int | createStandardIndiToggleSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="") |
Create a standard R/W INDI switch with a single toggle element. More... | |
int | createStandardIndiRequestSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="") |
Create a standard R/W INDI switch with a single request element. More... | |
int | createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::vector< std::string > &elementLabels, const std::string &label="", const std::string &group="") |
Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels. More... | |
int | createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::string &label="", const std::string &group="") |
Create a standard R/W INDI selection (one of many) switch with vector of elements using the element strings as their own labels. More... | |
int | registerIndiPropertyReadOnly (pcf::IndiProperty &prop) |
Register an INDI property which is read only. More... | |
int | registerIndiPropertyReadOnly (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState) |
Register an INDI property which is read only. More... | |
int | registerIndiPropertyNew (pcf::IndiProperty &prop, int(*)(void *, const pcf::IndiProperty &)) |
Register an INDI property which is exposed for others to request a New Property for. More... | |
int | registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, int(*)(void *, const pcf::IndiProperty &)) |
Register an INDI property which is exposed for others to request a New Property for. More... | |
int | registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, const pcf::IndiProperty::SwitchRuleType &propRule, int(*)(void *, const pcf::IndiProperty &)) |
Register an INDI property which is exposed for others to request a New Property for, with a switch rule. More... | |
int | registerIndiPropertySet (pcf::IndiProperty &prop, const std::string &devName, const std::string &propName, int(*)(void *, const pcf::IndiProperty &)) |
Register an INDI property which is monitored for updates from others. More... | |
void | sendGetPropertySetList (bool all=false) |
void | handleDefProperty (const pcf::IndiProperty &ipRecv) |
Handler for the DEF INDI properties notification. More... | |
void | handleGetProperties (const pcf::IndiProperty &ipRecv) |
Handler for the get INDI properties request. More... | |
void | handleNewProperty (const pcf::IndiProperty &ipRecv) |
Handler for the new INDI property request. More... | |
void | handleSetProperty (const pcf::IndiProperty &ipRecv) |
Handler for the set INDI property request. More... | |
typedef std::pair< std::string, indiCallBack > | callBackValueType |
Value type of the indiCallBack map. More... | |
typedef std::unordered_map< std::string, indiCallBack >::iterator | callBackIterator |
Iterator type of the indiCallBack map. More... | |
typedef std::pair< callBackIterator, bool > | callBackInsertResult |
Return type of insert on the indiCallBack map. More... | |
constexpr static bool | m_useINDI = _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... | |
int | createINDIFIFOS () |
Create the INDI FIFOs. More... | |
int | startINDI () |
Start INDI Communications. More... | |
template<typename T > | |
void | updateIfChanged (pcf::IndiProperty &p, const std::string &el, const T &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok) |
Update an INDI property element value if it has changed. More... | |
void | updateIfChanged (pcf::IndiProperty &p, const std::string &el, const char *newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok) |
Update an INDI property element value if it has changed. More... | |
template<typename T > | |
void | updateIfChanged (pcf::IndiProperty &p, const std::string &el, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok) |
Update an INDI property if values have changed. More... | |
template<typename T > | |
void | updateIfChanged (pcf::IndiProperty &p, const std::vector< std::string > &els, const std::vector< T > &newVals) |
Update an INDI property if values have changed. More... | |
void | updateSwitchIfChanged (pcf::IndiProperty &p, const std::string &el, const pcf::IndiElement::SwitchStateType &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok) |
Update an INDI switch element value if it has changed. More... | |
template<typename T > | |
int | indiTargetUpdate (pcf::IndiProperty &localProperty, T &localTarget, const pcf::IndiProperty &remoteProperty, bool setBusy=true) |
Get the target element value from an new property. More... | |
template<typename T > | |
int | sendNewProperty (const pcf::IndiProperty &ipSend, const std::string &el, const T &newVal) |
Send a newProperty command to another device (using the INDI Client interface) More... | |
int | sendNewProperty (const pcf::IndiProperty &ipSend) |
Send a newProperty command to another device (using the INDI Client interface) More... | |
int | sendNewStandardIndiToggle (const std::string &device, const std::string &property, bool onoff) |
Send a new property commmand for a standard toggle switch. More... | |
int | newCallBack_clearFSMAlert (const pcf::IndiProperty &ipRecv) |
The callback called by the static version, to actually process the FSM Alert Clear request. More... | |
static int | st_newCallBack_clearFSMAlert (void *app, const pcf::IndiProperty &ipRecv) |
The static callback function to be registered for requesting to clear the FSM alert. More... | |
Power Management | |
For devices which have remote power management (e.g. from one of the PDUs) we implement a standard power state monitoring and management component for the FSM. This needs to be enabled in the derived app constructor. To stay enabled, m_powerDevice and m_powerChannel must be not empty strings after the configuration. These could be set in the derived app defaults. If power management is enabled, then while power is off, appLogic will not be called. Instead a parrallel set of virtual functions is called, onPowerOff (to allow apps to perform cleanup) and whilePowerOff (to allow apps to keep variables updated, etc). Note that these could merely call appLogic if desired. | |
bool | m_powerMgtEnabled {false} |
Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error. More... | |
std::string | m_powerDevice |
The INDI device name of the power controller. More... | |
std::string | m_powerChannel |
The INDI property name of the channel controlling this device's power. More... | |
std::string | m_powerElement {"state"} |
The INDI element name to monitor for this device's power state. More... | |
std::string | m_powerTargetElement {"target"} |
The INDI element name to monitor for this device's power state. More... | |
unsigned long | m_powerOnWait {0} |
Time in sec to wait for device to boot after power on. More... | |
int | m_powerOnCounter {-1} |
Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup. More... | |
int | m_powerState {-1} |
Current power state, 1=On, 0=Off, -1=Unk. More... | |
int | m_powerTargetState {-1} |
Current target power state, 1=On, 0=Off, -1=Unk. More... | |
pcf::IndiProperty | m_indiP_powerChannel |
INDI property used to communicate power state. More... | |
int | powerState () |
Returns the current power state. More... | |
int | powerStateTarget () |
Returns the target power state. More... | |
INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel) | |
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 | |
pcf::IndiProperty | m_indiP_preset |
The position of the stage in presets. More... | |
pcf::IndiProperty | m_indiP_presetName |
The name of the nearest preset for this position. More... | |
pcf::IndiProperty | m_indiP_home |
Command the stage to home. . More... | |
pcf::IndiProperty | m_indiP_stop |
Command the stage to halt. More... | |
int | newCallBack_m_indiP_preset (const pcf::IndiProperty &ipRecv) |
Callback to process a NEW preset position request. More... | |
int | newCallBack_m_indiP_presetName (const pcf::IndiProperty &ipRecv) |
Callback to process a NEW preset name request. More... | |
int | newCallBack_m_indiP_home (const pcf::IndiProperty &ipRecv) |
Callback to process a NEW home request switch toggle. More... | |
int | newCallBack_m_indiP_stop (const pcf::IndiProperty &ipRecv) |
Callback to process a NEW stop request switch toggle. More... | |
int | updateINDI () |
Update the INDI properties for this device controller. More... | |
static int | st_newCallBack_stdMotionStage (void *app, const pcf::IndiProperty &ipRecv) |
The static callback function to be registered for stdMotionStage properties. More... | |
Logging | |
void | logMessage (bufferPtrT &b) |
Handle a log message from the logging system. More... | |
static logManagerT | m_log |
template<typename logT , int retval = 0> | |
static int | log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT) |
Make a log entry. More... | |
template<typename logT , int retval = 0> | |
static int | log (logPrioT level=logPrio::LOG_DEFAULT) |
Make a log entry. More... | |
static void | configLog (const std::string &name, const int &code, const std::string &value, const std::string &source) |
Callback for config system logging. More... | |
Application State | |
stateCodes::stateCodeT | state () |
Get the current state code. More... | |
void | state (const stateCodes::stateCodeT &s, bool stateAlert=false) |
Set the current state code. More... | |
int | stateLogged () |
Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards. More... | |
stateCodes::stateCodeT | m_state {stateCodes::UNINITIALIZED} |
The application's state. Never ever set this directly, use state(const stateCodeT & s). More... | |
bool | m_stateAlert {false} |
bool | m_gitAlert {false} |
int | m_stateLogged {0} |
Counter and flag for use to log errors just once. Never ever access directly, use stateLogged(). More... | |
Signal Handling | |
static MagAOXApp * | m_self = nullptr |
Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers. More... | |
static void | _handlerSigTerm (int signum, siginfo_t *siginf, void *ucont) |
The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm. More... | |
int | setSigTermHandler () |
Sets the handler for SIGTERM, SIGQUIT, and SIGINT. More... | |
void | handlerSigTerm (int signum, siginfo_t *siginf, void *ucont) |
Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal. More... | |
Privilege Management | |
uid_t | m_euidReal |
The real user id of the proces (i.e. the lower privileged id of the user) More... | |
uid_t | m_euidCalled |
The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid). More... | |
uid_t | m_suid |
The save-set user id of the process. More... | |
int | setEuidCalled () |
Set the effective user ID to the called value, i.e. the highest possible. More... | |
int | setEuidReal () |
Set the effective user ID to the real value, i.e. the file owner. More... | |
TS command: Checks if there were any errors during initialization Solid orange LED: everything is okay, TS should return 1TS00000A PW command: change all stage and motor configuration parameters OR command: gets controller to ready state (must go through homing first) In ready state, can move relative and move absolute RS command: TO get from ready to not referenced
Change to stateCodes::OPERATING and stateCodes::READY
Definition at line 42 of file smc100ccCtrl.hpp.
|
inherited |
Return type of insert on the indiCallBack map.
Definition at line 561 of file MagAOXApp.hpp.
|
inherited |
Iterator type of the indiCallBack map.
Definition at line 558 of file MagAOXApp.hpp.
|
inherited |
Value type of the indiCallBack map.
Definition at line 555 of file MagAOXApp.hpp.
|
inherited |
The log manager type.
Definition at line 54 of file telemeter.hpp.
|
inherited |
The log manager type.
Definition at line 82 of file MagAOXApp.hpp.
|
inline |
Default c'tor.
Definition at line 179 of file smc100ccCtrl.hpp.
|
inlinenoexcept |
Definition at line 81 of file smc100ccCtrl.hpp.
|
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 1709 of file MagAOXApp.hpp.
|
virtual |
Changes device state based on testing connection and device status.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 277 of file smc100ccCtrl.hpp.
|
virtual |
Do any needed shutdown tasks. Currently nothing in this app.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 694 of file smc100ccCtrl.hpp.
|
virtual |
Checks if the device was found during loadConfig.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 237 of file smc100ccCtrl.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 1327 of file MagAOXApp.hpp.
int MagAOX::app::smc100ccCtrl::checkRecordTimes | ( | ) |
Definition at line 1088 of file smc100ccCtrl.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 131 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 152 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 142 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 2155 of file MagAOXApp.hpp.
|
inherited |
Get the config directory.
Definition at line 3247 of file MagAOXApp.hpp.
|
staticprivateinherited |
Callback for config system logging.
Called by appConfigurator each time a value is set using the config() operator. You never need to call this directly.
[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 1650 of file MagAOXApp.hpp.
|
inherited |
Get the config name.
Definition at line 3241 of file MagAOXApp.hpp.
Referenced by MagAOXApp_tests::MagAOXApp_test::configName(), MagAOX::app::andorCtrl::loadConfig(), and MagAOX::app::andorCtrl::writeConfig().
|
inherited |
Connect to the device.
Closes the device file descriptor if open, then calls ttyOpenRaw.
Definition at line 108 of file usbDevice.cpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), appLogic(), and MagAOX::app::rhusbMon::connect().
|
protectedinherited |
Create the INDI FIFOs.
Changes permissions to max available and creates the FIFOs at the configured path.
Definition at line 2603 of file MagAOXApp.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 2294 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 2209 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 2246 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 2352 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 2426 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 2383 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 2180 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 2321 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().
|
inlineprivateinherited |
Definition at line 256 of file stdMotionStage.hpp.
|
inherited |
Get the INDI control FIFO file name.
Definition at line 3265 of file MagAOXApp.hpp.
|
inherited |
Get the INDI input FIFO file name.
Definition at line 3253 of file MagAOXApp.hpp.
|
inherited |
Get the INDI output FIFO file name.
Definition at line 3259 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 1370 of file MagAOXApp.hpp.
int MagAOX::app::smc100ccCtrl::getCtrlState | ( | std::string & | state | ) |
Definition at line 784 of file smc100ccCtrl.hpp.
Referenced by appLogic().
|
inherited |
Get the device name from udev using the vendor, product, and serial number.
Definition at line 103 of file usbDevice.cpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), appLogic(), MagAOX::app::zaberLowLevel::appLogic(), and MagAOX::app::rhusbMon::connect().
int MagAOX::app::smc100ccCtrl::getLastError | ( | std::string & | errStr | ) |
Returns any error controller has.
Called after every command is sent
[out] | errStr | the last error string |
Definition at line 864 of file smc100ccCtrl.hpp.
Referenced by appLogic(), and moveTo().
int MagAOX::app::smc100ccCtrl::getPosition | ( | double & | pos | ) |
Verifies current status of controller.
Checks if controller is moving or has moved to correct position
[out] | pos | on output, the current position |
Definition at line 838 of file smc100ccCtrl.hpp.
Referenced by appLogic().
|
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 2759 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 2765 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 2827 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 1718 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 2849 of file MagAOXApp.hpp.
MagAOX::app::smc100ccCtrl::INDI_NEWCALLBACK_DECL | ( | smc100ccCtrl | , |
m_indiP_position | |||
) |
|
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 2951 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 1278 of file MagAOXApp.hpp.
|
virtual |
Load the configuration system results (called by MagAOXApp::setup())
Definition at line 199 of file smc100ccCtrl.hpp.
|
inherited |
Load the device section from an application configurator.
[in] | config | an application configuration from which to load values |
Definition at line 95 of file telemeter.hpp.
|
inherited |
Load the device section from an application configurator.
[in] | config | an application configuration from which to load values |
Definition at line 28 of file ioDevice.cpp.
Referenced by MagAOX::app::picoMotorCtrl::loadConfig(), loadConfig(), MagAOX::app::trippLitePDU::loadConfig(), MagAOX::app::dev::edtCamera< derivedT >::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::pi335Ctrl::loadConfigImpl(), MagAOX::app::rhusbMon::loadConfigImpl(), and MagAOX::app::tcsInterface::loadConfigImpl().
|
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 106 of file stdMotionStage.hpp.
|
inherited |
Load the USB section from an application configurator.
If config does not contain a baud rate, m_baudRate is unchanged. If m_baudRate is 0 at the end of this method, an error is returned. Set m_baudRate prior to calling to avoid this error.
[in] | config | an application configuration from which to load values |
Definition at line 34 of file usbDevice.cpp.
Referenced by MagAOX::app::filterWheelCtrl::loadConfig(), loadConfig(), MagAOX::app::zaberLowLevel::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::koolanceCtrl::loadConfigImpl(), MagAOX::app::pi335Ctrl::loadConfigImpl(), and MagAOX::app::rhusbMon::loadConfigImpl().
|
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 1796 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 1590 of file MagAOXApp.hpp.
Referenced by MagAOX::app::zylaCtrl::acquireAndCheckValid(), MagAOX::app::streamWriter::allocate_circbufs(), MagAOX::app::streamWriter::allocate_xrif(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), 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::picoMotorCtrl::appStartup(), MagAOX::app::qhyCtrl::appStartup(), MagAOX::app::siglentSDG::appStartup(), appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::trippLitePDU::appStartup(), MagAOX::app::xt1121DCDU::appStartup(), MagAOX::app::zaberCtrl::appStartup(), MagAOX::app::zylaCtrl::appStartup(), MagAOX::app::andorCtrl::cameraSelect(), MagAOX::app::zylaCtrl::cameraSelect(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::sysMonitor::findChronyStatus(), MagAOX::app::sysMonitor::findCPULoads(), MagAOX::app::sysMonitor::findCPUTemperatures(), MagAOX::app::sysMonitor::findDiskUsage(), MagAOX::app::sysMonitor::findRamUsage(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::andorCtrl::getFPS(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::zylaCtrl::getTemp(), MagAOX::app::ocam2KCtrl::getTemps(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), MagAOX::app::filterWheelCtrl::home(), MagAOX::app::streamWriter::initialize_xrif(), MagAOX::app::zylaCtrl::loadImageIntoStream(), audibleAlerts.core.AudibleAlerts::loop(), MagAOX::app::ttmModulator::modTTM(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::zaberCtrl::moveTo(), 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(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ttmModulator::restTTM(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::zylaCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), MagAOX::app::ttmModulator::setTTM(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::zylaCtrl::startAcquisition(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::zaberCtrl::stop(), MagAOX::app::acronameUsbHub::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::acronameUsbHub::turnOutletOn(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), MagAOX::app::acronameUsbHub::updateOutletState(), and MagAOX::app::xt1121DCDU::updateOutletState().
|
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 1600 of file MagAOXApp.hpp.
Referenced by audibleAlerts.core.AudibleAlerts::handle_personality_switch(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), audibleAlerts.core.AudibleAlerts::loop(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), corAlign.corAlign::setup(), and efcControl.efcControl::setup().
|
inherited |
Handle a log message from the logging system.
This is a callback from the logManager, and is called when the log thread is processing log entries.
Decides whether to display to stderr and whether to send via INDI.
Definition at line 1607 of file MagAOXApp.hpp.
int MagAOX::app::smc100ccCtrl::makeCom | ( | std::string & | str, |
const std::string & | com | ||
) |
Definition at line 699 of file smc100ccCtrl.hpp.
Referenced by appLogic(), and getCtrlState().
int MagAOX::app::smc100ccCtrl::moveTo | ( | double | position | ) |
Definition at line 1057 of file smc100ccCtrl.hpp.
Referenced by appLogic().
|
protectedinherited |
The callback called by the static version, to actually process the FSM Alert Clear request.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 3130 of file MagAOXApp.hpp.
|
inherited |
Callback to process a NEW home request switch toggle.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 227 of file stdMotionStage.hpp.
|
inherited |
Callback to process a NEW preset position request.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 213 of file stdMotionStage.hpp.
|
inherited |
Callback to process a NEW preset name request.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 220 of file stdMotionStage.hpp.
|
inherited |
Callback to process a NEW stop request switch toggle.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 234 of file stdMotionStage.hpp.
|
inlinevirtual |
This method is called when the change to poweroff is detected.
Reimplemented from MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 100 of file smc100ccCtrl.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 3163 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::appLogic(), and appLogic().
|
inherited |
Returns the current power state.
If power management is not enabled, this always returns 1=On.
Definition at line 3179 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 3187 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().
double MagAOX::app::smc100ccCtrl::presetNumber | ( | ) |
Definition at line 1047 of file smc100ccCtrl.hpp.
Referenced by appLogic().
int MagAOX::app::smc100ccCtrl::recordPosition | ( | bool | force = false | ) |
Definition at line 1108 of file smc100ccCtrl.hpp.
Referenced by appLogic(), moveTo(), onPowerOff(), recordTelem(), startHoming(), and stop().
int MagAOX::app::smc100ccCtrl::recordStage | ( | bool | force = false | ) |
Definition at line 1103 of file smc100ccCtrl.hpp.
Referenced by appLogic(), moveTo(), onPowerOff(), recordTelem(), startHoming(), and stop().
int MagAOX::app::smc100ccCtrl::recordTelem | ( | const telem_position * | ) |
Definition at line 1098 of file smc100ccCtrl.hpp.
int MagAOX::app::smc100ccCtrl::recordTelem | ( | const telem_stage * | ) |
Definition at line 1093 of file smc100ccCtrl.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 2437 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 2463 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 2569 of file MagAOXApp.hpp.
|
inherited |
Definition at line 2723 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 3066 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 3031 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ttmModulator::modTTM(), MagAOX::app::zaberCtrl::moveTo(), MagAOX::app::ttmModulator::offset12(), MagAOX::app::ttmModulator::offsetXY(), MagAOX::app::ttmModulator::restTTM(), MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::ttmModulator::setTTM(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::zaberCtrl::stop(), MagAOX::app::xt1121DCDU::turnOutletOff(), and MagAOX::app::xt1121DCDU::turnOutletOn().
|
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 3084 of file MagAOXApp.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 1152 of file MagAOXApp.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 1757 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 1776 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::restore().
|
privateinherited |
Sets the handler for SIGTERM, SIGQUIT, and SIGINT.
Definition at line 1660 of file MagAOXApp.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 1249 of file MagAOXApp.hpp.
|
virtual |
Setup the configuration system (called by MagAOXApp::setup())
Definition at line 189 of file smc100ccCtrl.hpp.
|
inherited |
Setup an application configurator for the device section.
[in] | config | an application configuration to setup |
Definition at line 87 of file telemeter.hpp.
|
inherited |
Setup an application configurator for the device section.
[in] | config | an application configuration to setup |
Definition at line 20 of file ioDevice.cpp.
Referenced by MagAOX::app::flipperCtrl::setupConfig(), MagAOX::app::pi335Ctrl::setupConfig(), MagAOX::app::picoMotorCtrl::setupConfig(), MagAOX::app::rhusbMon::setupConfig(), setupConfig(), MagAOX::app::tcsInterface::setupConfig(), MagAOX::app::trippLitePDU::setupConfig(), and MagAOX::app::dev::edtCamera< derivedT >::setupConfig().
|
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 96 of file stdMotionStage.hpp.
|
inherited |
Setup an application configurator for the USB section.
[in] | config | an application configuration to setup |
Definition at line 24 of file usbDevice.cpp.
Referenced by MagAOX::app::filterWheelCtrl::setupConfig(), MagAOX::app::flipperCtrl::setupConfig(), MagAOX::app::koolanceCtrl::setupConfig(), MagAOX::app::pi335Ctrl::setupConfig(), MagAOX::app::rhusbMon::setupConfig(), setupConfig(), and MagAOX::app::zaberLowLevel::setupConfig().
|
inherited |
Get the value of the shutdown flag.
Definition at line 1146 of file MagAOXApp.hpp.
Referenced by MagAOX::app::streamWriter::swThreadExec().
int MagAOX::app::smc100ccCtrl::splitResponse | ( | int & | axis, |
std::string & | com, | ||
std::string & | val, | ||
std::string & | resp | ||
) |
Definition at line 717 of file smc100ccCtrl.hpp.
Referenced by getCtrlState(), and testConnection().
|
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 the new property request. |
Definition at line 3122 of file MagAOXApp.hpp.
|
staticinherited |
The static callback function to be registered for stdMotionStage properties.
Dispatches to the relevant handler
[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 204 of file stdMotionStage.hpp.
int MagAOX::app::smc100ccCtrl::startHoming | ( | ) |
Definition at line 1028 of file smc100ccCtrl.hpp.
Referenced by appLogic().
|
protectedinherited |
Start INDI Communications.
Definition at line 2666 of file MagAOXApp.hpp.
|
inherited |
Get the current state code.
Definition at line 2082 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picamCtrl::acquireAndCheckValid(), MagAOX::app::qhyCtrl::acquireAndCheckValid(), MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), 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(), 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(), 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(), 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 2088 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 2140 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(), 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().
int MagAOX::app::smc100ccCtrl::stop | ( | ) |
Definition at line 1007 of file smc100ccCtrl.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 80 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 70 of file telemeter.hpp.
int MagAOX::app::smc100ccCtrl::testConnection | ( | ) |
Tests if device is cabale of recieving/executing IO commands.
Sends command for device to return serial number, and compares to device serial number indi property
Definition at line 671 of file smc100ccCtrl.hpp.
Referenced by appLogic().
|
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 1950 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 1927 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 2891 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 2916 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 2877 of file MagAOXApp.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), 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(), 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 |
Definition at line 2936 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 243 of file stdMotionStage.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 2901 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(), startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::hsfwCtrl::stop(), 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 159 of file stdMotionStage.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 3157 of file MagAOXApp.hpp.
|
friend |
Definition at line 1108 of file smc100ccCtrl.hpp.
|
friend |
Definition at line 1108 of file smc100ccCtrl.hpp.
|
protectedinherited |
Flag indicating that all registered Set properties have been updated since last Get.
Definition at line 576 of file MagAOXApp.hpp.
|
inherited |
The baud rate specification.
Definition at line 38 of file usbDevice.hpp.
Referenced by MagAOX::app::filterWheelCtrl::loadConfig(), loadConfig(), MagAOX::app::zaberLowLevel::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::koolanceCtrl::loadConfigImpl(), and MagAOX::app::pi335Ctrl::loadConfigImpl().
|
protectedinherited |
The path to calibration files for MagAOX.
Definition at line 94 of file MagAOXApp.hpp.
|
protectedinherited |
The name of a base config class for this app (minus .conf).
Definition at line 92 of file MagAOXApp.hpp.
|
protectedinherited |
The path to configuration files for MagAOX.
Definition at line 90 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::configureAcquisition().
|
protectedinherited |
The name of the configuration file (minus .conf).
Definition at line 88 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 421 of file MagAOXApp.hpp.
|
protectedinherited |
Flag controlling whether the default preset positions (the vector index) are set in loadConfig.
Definition at line 75 of file stdMotionStage.hpp.
|
inherited |
The device path name, e.g. /dev/ttyUSB0.
Definition at line 40 of file usbDevice.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), appLogic(), MagAOX::app::zaberLowLevel::appLogic(), MagAOX::app::pi335Ctrl::appStartup(), MagAOX::app::rhusbMon::connect(), MagAOX::app::zaberLowLevel::connect(), and MagAOX::app::pi335Ctrl::testConnection().
|
protectedinherited |
Full path name of the INDI driver control FIFO.
This is currently only used to signal restarts.
Definition at line 587 of file MagAOXApp.hpp.
|
protectedinherited |
Full path name of the INDI driver input FIFO.
Definition at line 579 of file MagAOXApp.hpp.
|
protectedinherited |
Full path name of the INDI driver output FIFO.
Definition at line 582 of file MagAOXApp.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 315 of file MagAOXApp.hpp.
|
privateinherited |
The real user id of the proces (i.e. the lower privileged id of the user)
Definition at line 314 of file MagAOXApp.hpp.
|
inherited |
The file descriptor.
Definition at line 42 of file usbDevice.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), appLogic(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), getCtrlState(), getLastError(), MagAOX::app::filterWheelCtrl::getMoving(), MagAOX::app::filterWheelCtrl::getPos(), MagAOX::app::flipperCtrl::getPos(), getPosition(), MagAOX::app::koolanceCtrl::getStatus(), MagAOX::app::filterWheelCtrl::getSwitch(), MagAOX::app::filterWheelCtrl::home(), MagAOX::app::pi335Ctrl::home_1(), MagAOX::app::pi335Ctrl::home_2(), MagAOX::app::pi335Ctrl::home_3(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::koolanceCtrl::initialConnect(), MagAOX::app::pi335Ctrl::move_1(), MagAOX::app::pi335Ctrl::move_2(), MagAOX::app::pi335Ctrl::move_3(), moveTo(), MagAOX::app::flipperCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::filterWheelCtrl::moveToRawRelative(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::pi335Ctrl::releaseDM(), MagAOX::app::koolanceCtrl::setFanLvl(), MagAOX::app::koolanceCtrl::setPumpLvl(), startHoming(), MagAOX::app::filterWheelCtrl::stop(), stop(), MagAOX::app::pi335Ctrl::testConnection(), and testConnection().
|
protectedinherited |
Flag to set in constructor determining if fractional presets are allowed. Used for INDI/GUIs.
Definition at line 73 of file stdMotionStage.hpp.
|
privateinherited |
Definition at line 472 of file MagAOXApp.hpp.
|
protectedinherited |
If >=0, this preset position is moved to after homing.
Definition at line 63 of file stdMotionStage.hpp.
|
protected |
Definition at line 56 of file smc100ccCtrl.hpp.
Referenced by appLogic(), and loadConfig().
|
inherited |
The product id 4-digit code.
Definition at line 35 of file usbDevice.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), appLogic(), MagAOX::app::zaberLowLevel::appLogic(), MagAOX::app::pi335Ctrl::appStartup(), MagAOX::app::usbtempMon::checkConnections(), MagAOX::app::rhusbMon::connect(), and MagAOX::app::usbtempMon::loadConfigImpl().
|
inherited |
The vendor id 4-digit code.
Definition at line 34 of file usbDevice.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), appLogic(), MagAOX::app::zaberLowLevel::appLogic(), MagAOX::app::pi335Ctrl::appStartup(), MagAOX::app::usbtempMon::checkConnections(), MagAOX::app::rhusbMon::connect(), and MagAOX::app::usbtempMon::loadConfigImpl().
|
inherited |
The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.
Definition at line 537 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::appLogic(), appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::streamWriter::updateINDI(), and MagAOX::app::magAOXMaths::updateVals().
|
inherited |
Mutex for locking INDI communications.
Definition at line 540 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), 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 567 of file MagAOXApp.hpp.
|
protectedinherited |
indi Property to clear an FSM alert.
Definition at line 948 of file MagAOXApp.hpp.
|
protectedinherited |
Command the stage to home. .
Definition at line 191 of file stdMotionStage.hpp.
|
protected |
Indi variable for reporting the stage position.
Definition at line 61 of file smc100ccCtrl.hpp.
Referenced by appLogic(), appStartup(), and moveTo().
|
protectedinherited |
INDI property used to communicate power state.
Definition at line 998 of file MagAOXApp.hpp.
|
protectedinherited |
The position of the stage in presets.
Definition at line 185 of file stdMotionStage.hpp.
|
protectedinherited |
The name of the nearest preset for this position.
Definition at line 188 of file stdMotionStage.hpp.
|
protectedinherited |
indi Property to report the application state.
Definition at line 945 of file MagAOXApp.hpp.
|
protectedinherited |
Command the stage to halt.
Definition at line 194 of file stdMotionStage.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 572 of file MagAOXApp.hpp.
|
staticinherited |
Definition at line 242 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 100 of file MagAOXApp.hpp.
Referenced by MagAOX::app::trippLitePDU::trippLitePDU(), MagAOX::app::siglentSDG::appLogic(), and MagAOX::app::xt1121Ctrl::appLogic().
|
inherited |
The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.
Definition at line 58 of file telemeter.hpp.
|
protectedinherited |
Whether or not the stage is moving. -2 means powered off, -1 means not homed, 0 means not moving, 1 means moving, 2 means homing.
Definition at line 77 of file stdMotionStage.hpp.
|
protectedinherited |
Used to track the type of command. If > 1 this is a command to move to a preset. If 0 then it is a move to an arbitrary position.
Definition at line 78 of file stdMotionStage.hpp.
|
protectedinherited |
This process's PID.
Definition at line 394 of file MagAOXApp.hpp.
|
protected |
Definition at line 65 of file smc100ccCtrl.hpp.
Referenced by appLogic(), and presetNumber().
|
protectedinherited |
The INDI property name of the channel controlling this device's power.
Definition at line 985 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI device name of the power controller.
Definition at line 984 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI element name to monitor for this device's power state.
Definition at line 986 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 981 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(), 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 992 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), and MagAOX::app::zylaCtrl::onPowerOff().
|
protectedinherited |
If true, then the motor is homed at startup (by this software or actual power on)
Definition at line 61 of file stdMotionStage.hpp.
|
protected |
Definition at line 71 of file smc100ccCtrl.hpp.
Referenced by appLogic(), and onPowerOff().
|
protectedinherited |
Time in sec to wait for device to boot after power on.
Definition at line 989 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), smc100ccCtrl(), and MagAOX::app::zylaCtrl::zylaCtrl().
|
protectedinherited |
Current power state, 1=On, 0=Off, -1=Unk.
Definition at line 995 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), 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 987 of file MagAOXApp.hpp.
|
protectedinherited |
Current target power state, 1=On, 0=Off, -1=Unk.
Definition at line 996 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), 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(), getCtrlState(), getLastError(), getPosition(), 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(), startHoming(), stop(), testConnection(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
protectedinherited |
The current numerical preset position [1.0 is index 0 in the preset name vector].
Definition at line 80 of file stdMotionStage.hpp.
|
protectedinherited |
The target numerical preset position [1.0 is index 0 in the preset name vector].
Definition at line 81 of file stdMotionStage.hpp.
|
protectedinherited |
The names of each position on the stage.
Definition at line 65 of file stdMotionStage.hpp.
|
protectedinherited |
Notation used to refer to a preset, should be singular, as in "preset" or "filter".
Definition at line 71 of file stdMotionStage.hpp.
|
protectedinherited |
The positions, in arbitrary units, of each preset. If 0, then the integer position number (starting from 1) is used to calculate.
Definition at line 67 of file stdMotionStage.hpp.
|
inherited |
The read timeout [msec].
Definition at line 28 of file ioDevice.hpp.
Referenced by MagAOX::app::rhusbMon::rhusbMon(), MagAOX::app::tcsInterface::acquireFromGuider(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), getCtrlState(), getLastError(), MagAOX::app::tcsInterface::getMagTelStatus(), MagAOX::app::flipperCtrl::getPos(), getPosition(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::tcsInterface::sendFoffload(), MagAOX::app::tcsInterface::sendPyrNudge(), MagAOX::app::tcsInterface::sendTToffload(), MagAOX::app::pi335Ctrl::testConnection(), testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().
|
staticprivateinherited |
Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers.
Definition at line 291 of file MagAOXApp.hpp.
|
inherited |
The serial number.
Definition at line 36 of file usbDevice.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::flipperCtrl::appLogic(), MagAOX::app::koolanceCtrl::appLogic(), MagAOX::app::pi335Ctrl::appLogic(), appLogic(), MagAOX::app::zaberLowLevel::appLogic(), MagAOX::app::pi335Ctrl::appStartup(), MagAOX::app::usbtempMon::checkConnections(), and MagAOX::app::rhusbMon::connect().
|
protectedinherited |
Flag to signal it's time to shutdown. When not 0, the main loop exits.
Definition at line 102 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), appStartup(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::streamWriter::fgThreadExec(), MagAOX::app::andorCtrl::loadConfig(), MagAOX::app::picoMotorCtrl::loadConfig(), loadConfig(), MagAOX::app::streamWriter::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().
|
privateinherited |
The application's state. Never ever set this directly, use state(const stateCodeT & s).
Definition at line 468 of file MagAOXApp.hpp.
|
privateinherited |
Definition at line 470 of file MagAOXApp.hpp.
|
privateinherited |
Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().
Definition at line 474 of file MagAOXApp.hpp.
|
privateinherited |
The save-set user id of the process.
Definition at line 316 of file MagAOXApp.hpp.
|
protected |
Definition at line 67 of file smc100ccCtrl.hpp.
|
inherited |
Definition at line 56 of file telemeter.hpp.
|
staticconstexprprotectedinherited |
Flag controlling whether INDI is used. If false, then no INDI code executes.
Definition at line 532 of file MagAOXApp.hpp.
|
protected |
Definition at line 69 of file smc100ccCtrl.hpp.
Referenced by appLogic().
|
inherited |
The write timeout [msec].
Definition at line 29 of file ioDevice.hpp.
Referenced by MagAOX::app::rhusbMon::rhusbMon(), MagAOX::app::picoMotorCtrl::appLogic(), appLogic(), MagAOX::app::picoMotorCtrl::channelThreadExec(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), getCtrlState(), getLastError(), MagAOX::app::flipperCtrl::getPos(), getPosition(), MagAOX::app::pi335Ctrl::home_1(), MagAOX::app::pi335Ctrl::home_2(), MagAOX::app::pi335Ctrl::home_3(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::pi335Ctrl::move_1(), MagAOX::app::pi335Ctrl::move_2(), MagAOX::app::pi335Ctrl::move_3(), moveTo(), MagAOX::app::flipperCtrl::moveTo(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::pi335Ctrl::releaseDM(), startHoming(), stop(), MagAOX::app::pi335Ctrl::testConnection(), testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().
|
protectedinherited |
The base path of the MagAO-X system.
Definition at line 86 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 98 of file MagAOXApp.hpp.
|
protectedinherited |
The path to the system directory, for PID file, etc.
Definition at line 96 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picoMotorCtrl::readChannelCounts(), and MagAOX::app::picoMotorCtrl::writeChannelCounts().
|
protected |
Definition at line 63 of file smc100ccCtrl.hpp.