Classes
class	Adc
	The Adc class. More...

class	AdcConfig
	adc Configuration class More...

struct	AdcControllerData
	The adcControllerData struct. More...

class	AdcLcsIf
	Adc Local Control System (LCS) Interface (IF) class. More...

Enumerations
enum	{ HW_SUCCESS = 100, HW_ERR_HW_NOT_OP, HW_ERR_WRONG_CMD, HW_ERR_INCONSISTENT, HW_ERR_INIT_FAILURE, HW_ERR_ENABLE_FAILURE, HW_ERR_DISABLE_FAILURE }

enum	{ RPC_SUCCESS = 0, RPC_ERR_NOT_OP = -1, RPC_ERR_NOT_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_NOTREADY = -3, RPC_ERR_MOTOR_LOCAL = -4, RPC_ERR_MOTOR_LOWER_LIMIT = -5, RPC_ERR_MOTOR_UPPER_LIMIT = -6 }

Functions
	REGISTER_DEVICE (Adc)

Variables
constexpr auto	CI_MOTOR_MAP_FILE = "mapMotorFile"

constexpr auto	CI_AXES = "axes"

constexpr auto	CI_FOCUS_SIGN = "focus_sign"

constexpr auto	CI_DIR_SIGN = "dir_sign"

constexpr auto	CI_STAT_REF = "off_ref"

constexpr auto	CI_STAT_AUTO = "auto_ref"

constexpr auto	CI_LATITUDE = "latitude"

constexpr auto	CI_LONGITUDE = "longitude"

constexpr auto	CI_TRK_PERIOD = "trk_period"

constexpr auto	CI_TRK_THRESHOLD = "trk_threshold"

constexpr auto	CI_PSLOPE = "pslope"

constexpr auto	CI_POFFSET = "poffset"

constexpr auto	CI_TSLOPE = "tslope"

constexpr auto	CI_TOFFSET = "toffset"

constexpr auto	CI_AFACTOR = "afactor"

constexpr auto	CI_ZDLIMIT = "zdlimit"

constexpr auto	CI_MINELEV = "minelev"

constexpr auto	CI_MOT1_SIGN_OFF = "mot1_signoff"

constexpr auto	CI_MOT2_SIGN_OFF = "mot2_signoff"

constexpr auto	CI_MOT1_SIGN_AUTO = "mot1_signauto"

constexpr auto	CI_MOT2_SIGN_AUTO = "mot2_signauto"

constexpr auto	CI_MOT1_SIGN_PHI = "mot1_signphi"

constexpr auto	CI_MOT2_SIGN_PHI = "mot2_signphi"

constexpr auto	CI_MOT1_REF_OFF = "mot1_refoff"

constexpr auto	CI_MOT2_REF_OFF = "mot2_refoff"

constexpr auto	CI_MOT1_REF_AUTO = "mot1_refauto"

constexpr auto	CI_MOT2_REF_AUTO = "mot2_refauto"

constexpr auto	CI_MOT1_COFFSET = "mot1_coffset"

constexpr auto	CI_MOT2_COFFSET = "mot2_coffset"

constexpr auto	CI_MOT1_POSOFFSET = "mot1_poffset"

constexpr auto	CI_MOT2_POSOFFSET = "mot2_poffset"

constexpr auto	CI_MOT1_DROTFACTOR = "mot1_drotfactor"

constexpr auto	CI_MOT2_DROTFACTOR = "mot2_drotfactor"

constexpr auto	RPC_MOVE_ANGLE = "rpcMoveAngle"

constexpr auto	RPC_START_TRACK = "rpcStartTrack"

constexpr auto	RPC_STOP_TRACK = "rpcStopTrack"

constexpr int	SUBSTATE_RESETTING = 109

constexpr int	SUBSTATE_ENABLING = 110

constexpr int	SUBSTATE_OP_TRACKING = 220

constexpr int	SUBSTATE_OP_PRESETTING = 221

constexpr auto	SUBSTATE_RESETTING_STR = "Resetting"

constexpr auto	SUBSTATE_ENABLING_STR = "Enabling"

constexpr auto	SUBSTATE_OP_TRACKING_STR = "Tracking"

constexpr auto	SUBSTATE_OP_PRESETTING_STR = "Presetting"

const std::unordered_map < short, std::string >	SubstateMap

constexpr short	TRK_MODE_ENG = 0

constexpr short	TRK_MODE_OFF = 1

constexpr short	TRK_MODE_AUTO = 2

constexpr auto	TRK_MODE_ENG_STR = "eng"

constexpr auto	TRK_MODE_OFF_STR = "off"

constexpr auto	TRK_MODE_AUTO_STR = "auto"

const std::unordered_map < short, std::string >	TrkModeMap

constexpr auto	CI_STAT_TRACK_MODE = "track_mode"

constexpr auto	CI_STAT_ALPHA = "alpha"

constexpr auto	CI_STAT_DELTA = "delta"

const std::vector< std::string >	cfgMapping

const std::vector< std::string >	statMapping

const std::vector< std::string >	rpcMapping

const std::unordered_map < short, std::string >	hw_errors

const std::unordered_map < short, std::string >	rpc_errors

Enumeration Type Documentation

anonymous enum

Enumerator
HW_SUCCESS
HW_ERR_HW_NOT_OP
HW_ERR_WRONG_CMD
HW_ERR_INCONSISTENT
HW_ERR_INIT_FAILURE
HW_ERR_ENABLE_FAILURE
HW_ERR_DISABLE_FAILURE

anonymous enum

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_MOTOR_LOCAL
RPC_ERR_MOTOR_LOWER_LIMIT
RPC_ERR_MOTOR_UPPER_LIMIT

Function Documentation

fcf::devmgr::adc::REGISTER_DEVICE ( Adc )

Variable Documentation

const std::vector<std::string> fcf::devmgr::adc::cfgMapping

Initial value:

= {

}

constexpr auto fcf::devmgr::adc::CI_AFACTOR = "afactor"

constexpr auto fcf::devmgr::adc::CI_AXES = "axes"

constexpr auto fcf::devmgr::adc::CI_DIR_SIGN = "dir_sign"

constexpr auto fcf::devmgr::adc::CI_FOCUS_SIGN = "focus_sign"

constexpr auto fcf::devmgr::adc::CI_LATITUDE = "latitude"

constexpr auto fcf::devmgr::adc::CI_LONGITUDE = "longitude"

constexpr auto fcf::devmgr::adc::CI_MINELEV = "minelev"

constexpr auto fcf::devmgr::adc::CI_MOT1_COFFSET = "mot1_coffset"

constexpr auto fcf::devmgr::adc::CI_MOT1_DROTFACTOR = "mot1_drotfactor"

constexpr auto fcf::devmgr::adc::CI_MOT1_POSOFFSET = "mot1_poffset"

constexpr auto fcf::devmgr::adc::CI_MOT1_REF_AUTO = "mot1_refauto"

constexpr auto fcf::devmgr::adc::CI_MOT1_REF_OFF = "mot1_refoff"

constexpr auto fcf::devmgr::adc::CI_MOT1_SIGN_AUTO = "mot1_signauto"

constexpr auto fcf::devmgr::adc::CI_MOT1_SIGN_OFF = "mot1_signoff"

constexpr auto fcf::devmgr::adc::CI_MOT1_SIGN_PHI = "mot1_signphi"

constexpr auto fcf::devmgr::adc::CI_MOT2_COFFSET = "mot2_coffset"

constexpr auto fcf::devmgr::adc::CI_MOT2_DROTFACTOR = "mot2_drotfactor"

constexpr auto fcf::devmgr::adc::CI_MOT2_POSOFFSET = "mot2_poffset"

constexpr auto fcf::devmgr::adc::CI_MOT2_REF_AUTO = "mot2_refauto"

constexpr auto fcf::devmgr::adc::CI_MOT2_REF_OFF = "mot2_refoff"

constexpr auto fcf::devmgr::adc::CI_MOT2_SIGN_AUTO = "mot2_signauto"

constexpr auto fcf::devmgr::adc::CI_MOT2_SIGN_OFF = "mot2_signoff"

constexpr auto fcf::devmgr::adc::CI_MOT2_SIGN_PHI = "mot2_signphi"

constexpr auto fcf::devmgr::adc::CI_MOTOR_MAP_FILE = "mapMotorFile"

constexpr auto fcf::devmgr::adc::CI_POFFSET = "poffset"

constexpr auto fcf::devmgr::adc::CI_PSLOPE = "pslope"

constexpr auto fcf::devmgr::adc::CI_STAT_ALPHA = "alpha"

constexpr auto fcf::devmgr::adc::CI_STAT_AUTO = "auto_ref"

constexpr auto fcf::devmgr::adc::CI_STAT_DELTA = "delta"

constexpr auto fcf::devmgr::adc::CI_STAT_REF = "off_ref"

constexpr auto fcf::devmgr::adc::CI_STAT_TRACK_MODE = "track_mode"

constexpr auto fcf::devmgr::adc::CI_TOFFSET = "toffset"

constexpr auto fcf::devmgr::adc::CI_TRK_PERIOD = "trk_period"

constexpr auto fcf::devmgr::adc::CI_TRK_THRESHOLD = "trk_threshold"

constexpr auto fcf::devmgr::adc::CI_TSLOPE = "tslope"

constexpr auto fcf::devmgr::adc::CI_ZDLIMIT = "zdlimit"

const std::unordered_map<short, std::string> fcf::devmgr::adc::hw_errors

Initial value:

= {
        {HW_ERR_HW_NOT_OP,       "TwinCAT not in OP state or CouplerState not mapped"},
        {HW_ERR_WRONG_CMD,       "Adc unknown command"},
        {HW_ERR_INCONSISTENT,    "Adc inconsistent hardware signals"},
        {HW_ERR_INIT_FAILURE,    "Adc init failure"},
        {HW_ERR_ENABLE_FAILURE,  "Adc enable failure"},
        {HW_ERR_DISABLE_FAILURE, "Adc disable failure"},
      }

const std::unordered_map<short, std::string> fcf::devmgr::adc::rpc_errors

Initial value:

= {
        {RPC_ERR_NOT_OP,               "Cannot disable Adc. Not in OP state"},
        {RPC_ERR_NOT_STANDBY_READY,    "Cannot enable Adc. Not in STANDBY_READY."},
        {RPC_ERR_NOT_STANDBY_NOTREADY, "Cannot init Adc. Not in STANDBY_NOTREADY or FAILURE."},
        {RPC_ERR_MOTOR_LOCAL,          "RPC calls are not allowed in Local mode."},
        {RPC_ERR_MOTOR_LOWER_LIMIT,    "Move rejected. Target position beyond lower SW limit."},
        {RPC_ERR_MOTOR_UPPER_LIMIT,    "Move rejected. Target position beyond upper SW limit."}
      }

constexpr auto fcf::devmgr::adc::RPC_MOVE_ANGLE = "rpcMoveAngle"

constexpr auto fcf::devmgr::adc::RPC_START_TRACK = "rpcStartTrack"

constexpr auto fcf::devmgr::adc::RPC_STOP_TRACK = "rpcStopTrack"

const std::vector<std::string> fcf::devmgr::adc::rpcMapping

Initial value:

= {
        fcf::devmgr::common::RPC_INIT,
        fcf::devmgr::common::RPC_ENABLE,
        fcf::devmgr::common::RPC_DISABLE,
        fcf::devmgr::common::RPC_RESET,
        fcf::devmgr::common::RPC_STOP,
        RPC_MOVE_ANGLE,
        RPC_START_TRACK,
        RPC_STOP_TRACK
      }

const std::vector<std::string> fcf::devmgr::adc::statMapping

Initial value:

= {
        fcf::devmgr::common::CI_STAT_SUBSTATE,
        fcf::devmgr::common::CI_STAT_STATE,
        fcf::devmgr::common::CI_STAT_LOCAL,
        CI_STAT_TRACK_MODE,
        CI_STAT_ALPHA,
        CI_STAT_DELTA
      }

constexpr int fcf::devmgr::adc::SUBSTATE_ENABLING = 110

constexpr auto fcf::devmgr::adc::SUBSTATE_ENABLING_STR = "Enabling"

constexpr int fcf::devmgr::adc::SUBSTATE_OP_PRESETTING = 221

constexpr auto fcf::devmgr::adc::SUBSTATE_OP_PRESETTING_STR = "Presetting"

constexpr int fcf::devmgr::adc::SUBSTATE_OP_TRACKING = 220

constexpr auto fcf::devmgr::adc::SUBSTATE_OP_TRACKING_STR = "Tracking"

constexpr int fcf::devmgr::adc::SUBSTATE_RESETTING = 109

constexpr auto fcf::devmgr::adc::SUBSTATE_RESETTING_STR = "Resetting"

const std::unordered_map<short, std::string> fcf::devmgr::adc::SubstateMap

Initial value:

= {
        {fcf::devmgr::common::SUBSTATE_NOTREADY,       fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
        {SUBSTATE_RESETTING,      SUBSTATE_RESETTING_STR},
        {fcf::devmgr::common::SUBSTATE_INITIALISING,   fcf::devmgr::common::SUBSTATE_INITIALISING_STR},
        {fcf::devmgr::common::SUBSTATE_READY,          fcf::devmgr::common::SUBSTATE_READY_STR},
        {SUBSTATE_ENABLING,       SUBSTATE_ENABLING_STR},
        {devmgr::motor::SUBSTATE_ABORTING,       fcf::devmgr::motor::SUBSTATE_ABORTING_STR},
        {fcf::devmgr::common::SUBSTATE_ERROR,          fcf::devmgr::common::SUBSTATE_ERROR_STR},
        {fcf::devmgr::common::SUBSTATE_OP_DISABLING,   fcf::devmgr::common::SUBSTATE_OP_DISABLING_STR},
        {devmgr::motor::SUBSTATE_OP_STANDSTILL,  fcf::devmgr::motor::SUBSTATE_OP_STANDSTILL_STR},
        {devmgr::motor::SUBSTATE_OP_MOVING,      fcf::devmgr::motor::SUBSTATE_OP_MOVING_STR},
        {SUBSTATE_OP_TRACKING,    SUBSTATE_OP_TRACKING_STR},
        {SUBSTATE_OP_PRESETTING,    SUBSTATE_OP_PRESETTING_STR},
        {devmgr::motor::SUBSTATE_OP_STOPPING,    fcf::devmgr::motor::SUBSTATE_OP_STOPPING_STR},
        {fcf::devmgr::common::SUBSTATE_OP_ERROR,     fcf::devmgr::common::SUBSTATE_OP_ERROR_STR},
      }

constexpr short fcf::devmgr::adc::TRK_MODE_AUTO = 2

constexpr auto fcf::devmgr::adc::TRK_MODE_AUTO_STR = "auto"

constexpr short fcf::devmgr::adc::TRK_MODE_ENG = 0

constexpr auto fcf::devmgr::adc::TRK_MODE_ENG_STR = "eng"

constexpr short fcf::devmgr::adc::TRK_MODE_OFF = 1

constexpr auto fcf::devmgr::adc::TRK_MODE_OFF_STR = "off"

const std::unordered_map<short, std::string> fcf::devmgr::adc::TrkModeMap

Initial value:

= {
        {TRK_MODE_ENG,       TRK_MODE_ENG_STR},
        {TRK_MODE_OFF,       TRK_MODE_OFF_STR},
        {TRK_MODE_AUTO,      TRK_MODE_AUTO_STR},
      }

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

Function Documentation

Variable Documentation