fcf::devmgr::maxis Namespace Reference

Classes
class	MAxis
	The MAxis class. More...
class	MAxisConfig
	adc Configuration class More...
struct	MAxisControllerData
	The adcControllerData struct. More...
class	MAxisLcsIf
	MAxis Local Control System (LCS) Interface (IF) class. More...

Typedefs
using	VectorAttributes = std::vector< std::pair< std::string, unsigned int > >

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_OP_READY = -2 , RPC_ERR_NOT_OP_NOTREADY = -3 ,   RPC_ERR_MOTOR_LOCAL = -4 , RPC_ERR_MOTOR_LOWER_LIMIT = -5 , RPC_ERR_MOTOR_UPPER_LIMIT = -6 }

Functions
	REGISTER_DEVICE (MAxis)

Variables
constexpr auto	LOGGER_NAME = "maxis"
constexpr auto	CI_MOTOR_MAP_FILE = "mapMotorFile"
constexpr auto	CI_AXES = "motors"
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_MODES = "modes"
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	RPC_MOVE_ANGLE = "rpcMoveAngle"
constexpr auto	RPC_START_TRACK = "rpcStartTrack"
constexpr auto	RPC_STOP_TRACK = "rpcStopTrack"
constexpr auto	RPC_TRACK_OFFSET = "rpcTrackOffset"
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"
const std::unordered_map< short, std::string >	hw_errors
const std::unordered_map< short, std::string >	rpc_errors

Typedef Documentation

VectorAttributes

using fcf::devmgr::maxis::VectorAttributes = typedef std::vector <std::pair<std::string, unsigned int> >

Enumeration Type Documentation

anonymous enum

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

anonymous enum

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_OP_READY
RPC_ERR_NOT_OP_NOTREADY
RPC_ERR_MOTOR_LOCAL
RPC_ERR_MOTOR_LOWER_LIMIT
RPC_ERR_MOTOR_UPPER_LIMIT

Function Documentation

REGISTER_DEVICE()

fcf::devmgr::maxis::REGISTER_DEVICE

(

MAxis

)

Variable Documentation

CI_AXES

constexpr auto fcf::devmgr::maxis::CI_AXES = "motors"

constexpr

CI_DIR_SIGN

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

constexpr

CI_FOCUS_SIGN

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

constexpr

CI_LATITUDE

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

constexpr

CI_LONGITUDE

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

constexpr

CI_MODES

constexpr auto fcf::devmgr::maxis::CI_MODES = "modes"

constexpr

CI_MOTOR_MAP_FILE

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

constexpr

CI_STAT_AUTO

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

constexpr

CI_STAT_REF

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

constexpr

CI_STAT_TRACK_MODE

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

constexpr

CI_TRK_PERIOD

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

constexpr

CI_TRK_THRESHOLD

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

constexpr

hw_errors

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

Initial value:

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

LOGGER_NAME

constexpr auto fcf::devmgr::maxis::LOGGER_NAME = "maxis"

constexpr

rpc_errors

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

Initial value:

= {
        {RPC_ERR_NOT_OP,               "Cannot disable MAxis. Not in OP state"},
        {RPC_ERR_NOT_OP_READY,         "Cannot enable MAxis. Not in NOT_OP_READY."},
        {RPC_ERR_NOT_OP_NOTREADY,      "Cannot init MAxis. Not in NOT_OP_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."}
      }

RPC_MOVE_ANGLE

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

constexpr

RPC_START_TRACK

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

constexpr

RPC_STOP_TRACK

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

constexpr

RPC_TRACK_OFFSET

constexpr auto fcf::devmgr::maxis::RPC_TRACK_OFFSET = "rpcTrackOffset"

constexpr

SUBSTATE_ENABLING

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

constexpr

SUBSTATE_ENABLING_STR

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

constexpr

SUBSTATE_OP_PRESETTING

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

constexpr

SUBSTATE_OP_PRESETTING_STR

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

constexpr

SUBSTATE_OP_TRACKING

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

constexpr

SUBSTATE_OP_TRACKING_STR

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

constexpr

SUBSTATE_RESETTING

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

constexpr

SUBSTATE_RESETTING_STR

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

constexpr

SubstateMap

const std::unordered_map<short, std::string> fcf::devmgr::maxis::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},
    {fcf::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},
    {fcf::devmgr::motor::SUBSTATE_OP_STANDSTILL,  fcf::devmgr::motor::SUBSTATE_OP_STANDSTILL_STR},
    {fcf::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},
    {fcf::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},
  }

TRK_MODE_AUTO

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

constexpr

TRK_MODE_AUTO_STR

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

constexpr

TRK_MODE_ENG

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

constexpr

TRK_MODE_ENG_STR

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

constexpr

TRK_MODE_OFF

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

constexpr

TRK_MODE_OFF_STR

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

constexpr

TrkModeMap

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

Initial value:

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