ifw-fcf 7.1.4
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions | Variables
ifw::fcf::devmgr::maxis Namespace Reference

MAxis class header file. More...

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_POSITIONS = "positions"
 
constexpr auto CI_POS_NAME = "name"
 
constexpr auto CI_POS_VALUES = "values"
 
constexpr auto RPC_MOVE_AXES = "rpcMoveAxes"
 
constexpr int SUBSTATE_RESETTING = 109
 
constexpr int SUBSTATE_ENABLING = 110
 
constexpr auto SUBSTATE_RESETTING_STR = "Resetting"
 
constexpr auto SUBSTATE_ENABLING_STR = "Enabling"
 
const std::unordered_map< short, std::string > SUBSTATE_MAP
 
const std::unordered_map< short, std::string > HW_ERRORS
 
const std::unordered_map< short, std::string > RPC_ERRORS
 

Detailed Description

MAxis class header file.

MAxis class source file.

adcLcsIf class header file.

MAxisConfig class header file.

Typedef Documentation

◆ VectorAttributes

using ifw::fcf::devmgr::maxis::VectorAttributes = 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()

ifw::fcf::devmgr::maxis::REGISTER_DEVICE ( MAxis )

Variable Documentation

◆ CI_AXES

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

◆ CI_MOTOR_MAP_FILE

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

◆ CI_POS_NAME

constexpr auto ifw::fcf::devmgr::maxis::CI_POS_NAME = "name"
constexpr

◆ CI_POS_VALUES

constexpr auto ifw::fcf::devmgr::maxis::CI_POS_VALUES = "values"
constexpr

◆ CI_POSITIONS

constexpr auto ifw::fcf::devmgr::maxis::CI_POSITIONS = "positions"
constexpr

◆ HW_ERRORS

const std::unordered_map<short, std::string> ifw::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 ifw::fcf::devmgr::maxis::LOGGER_NAME = "maxis"
constexpr

◆ RPC_ERRORS

const std::unordered_map<short, std::string> ifw::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_AXES

constexpr auto ifw::fcf::devmgr::maxis::RPC_MOVE_AXES = "rpcMoveAxes"
constexpr

◆ SUBSTATE_ENABLING

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

◆ SUBSTATE_ENABLING_STR

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

◆ SUBSTATE_MAP

const std::unordered_map<short, std::string> ifw::fcf::devmgr::maxis::SUBSTATE_MAP
Initial value:
= {
{fcf::devmgr::common::SUBSTATE_NOTREADY, ifw::fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
{SUBSTATE_RESETTING, SUBSTATE_RESETTING_STR},
{fcf::devmgr::common::SUBSTATE_INITIALISING, ifw::fcf::devmgr::common::SUBSTATE_INITIALISING_STR},
{fcf::devmgr::common::SUBSTATE_READY, ifw::fcf::devmgr::common::SUBSTATE_READY_STR},
{SUBSTATE_ENABLING, SUBSTATE_ENABLING_STR},
{fcf::devmgr::motor::SUBSTATE_ABORTING, ifw::fcf::devmgr::motor::SUBSTATE_ABORTING_STR},
{fcf::devmgr::common::SUBSTATE_ERROR, ifw::fcf::devmgr::common::SUBSTATE_ERROR_STR},
{fcf::devmgr::common::SUBSTATE_OP_DISABLING, ifw::fcf::devmgr::common::SUBSTATE_OP_DISABLING_STR},
{fcf::devmgr::motor::SUBSTATE_OP_STANDSTILL, ifw::fcf::devmgr::motor::SUBSTATE_OP_STANDSTILL_STR},
{fcf::devmgr::motor::SUBSTATE_OP_MOVING, ifw::fcf::devmgr::motor::SUBSTATE_OP_MOVING_STR},
{fcf::devmgr::motor::SUBSTATE_OP_STOPPING, ifw::fcf::devmgr::motor::SUBSTATE_OP_STOPPING_STR},
{fcf::devmgr::common::SUBSTATE_OP_ERROR, ifw::fcf::devmgr::common::SUBSTATE_OP_ERROR_STR},
}
constexpr auto SUBSTATE_INITIALISING_STR
Definition deviceConfig.hpp:100
constexpr auto SUBSTATE_ERROR_STR
Definition deviceConfig.hpp:102
constexpr auto SUBSTATE_NOTREADY_STR
Definition deviceConfig.hpp:99
constexpr auto SUBSTATE_OP_DISABLING_STR
Definition deviceConfig.hpp:107
constexpr auto SUBSTATE_READY_STR
Definition deviceConfig.hpp:101
constexpr auto SUBSTATE_OP_ERROR_STR
Definition deviceConfig.hpp:108
constexpr auto SUBSTATE_OP_STANDSTILL_STR
Definition motorBaseConfig.hpp:58
constexpr auto SUBSTATE_ABORTING_STR
Definition motorBaseConfig.hpp:57
constexpr auto SUBSTATE_OP_MOVING_STR
Definition motorBaseConfig.hpp:59
constexpr auto SUBSTATE_OP_STOPPING_STR
Definition motorBaseConfig.hpp:61

◆ SUBSTATE_RESETTING

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

◆ SUBSTATE_RESETTING_STR

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