API
Public Types | Static Public Member Functions | List of all members
MagAOX::app::stateCodes Struct Reference
libMagAOX: the MagAO-X software library » The Base MagAOX Application

Scoping struct for application state codes. More...

#include <stateCodes.hpp>

Collaboration diagram for MagAOX::app::stateCodes:
Collaboration graph

Public Types

enum  : stateCodeT {
  FAILURE =-20 , ERROR =-10 , UNINITIALIZED = 0 , INITIALIZED = 1 ,
  NODEVICE = 2 , POWEROFF = 4 , POWERON = 6 , NOTCONNECTED = 8 ,
  CONNECTED = 10 , LOGGEDIN = 15 , CONFIGURING = 20 , NOTHOMED = 24 ,
  HOMING = 25 , OPERATING = 30 , READY = 35 , SHUTDOWN = 10000
}
 The numeric codes descrbing an application's state. More...
 
typedef int16_t stateCodeT
 The type of the state code. More...
 

Static Public Member Functions

static std::string codeText (stateCodeT stateCode)
 Get an ASCII string corresponding to an application stateCode. More...
 

Detailed Description

Scoping struct for application state codes.

We do not use the enum class feature since it does not have automatic integer conversion.

Definition at line 25 of file stateCodes.hpp.

Member Typedef Documentation

◆ stateCodeT

typedef int16_t MagAOX::app::stateCodes::stateCodeT

The type of the state code.

Definition at line 31 of file stateCodes.hpp.

Member Function Documentation

◆ codeText()

std::string MagAOX::app::stateCodes::codeText ( stateCodeT  stateCode)
static

Get an ASCII string corresponding to an application stateCode.

Returns
a string with the text name of the stateCode
Parameters
[in]stateCodethe stateCode for which the name is desired

Definition at line 16 of file stateCodes.cpp.

Referenced by MagAOX::app::siglentSDG::appLogic(), and MagAOX::logger::state_change::msgString().

The documentation for this struct was generated from the following files: