ifw::fcf::devmgr::modulator Namespace Reference

Modulator class source file. More...

Classes
class	Modulator
	The Modulator class. More...
struct	ModulatorControllerData
	The ModulatorControllerData struct. More...
class	ModulatorLcsIf
	Modulator Local Control System (LCS) Interface (IF) class. More...

Enumerations
enum	{   HW_SUCCESS = 0 , HW_ERR_HW_NOT_OP = 1 , HW_ERR_INIT_FAILURE = 2 , HW_ERR_UNEXPECTED_CLOSED = 3 ,   HW_ERR_UNEXPECTED_NONE = 4 , HW_ERR_UNEXPECTED_OPENED = 5 , HW_ERR_FAULT_SIG = 6 , HW_ERR_BOTH_SIG_ACTIVE = 7 ,   HW_ERR_TIMEOUT_ENABLE = 8 , HW_ERR_TIMEOUT_DISABLE = 9 , HW_ERR_TIMEOUT_INIT = 10 , HW_ERR_TIMEOUT_CLOSE = 11 ,   HW_ERR_TIMEOUT_OPEN = 12 }
enum	{   RPC_SUCCESS = 0 , RPC_ERR_NOT_OP = -1 , RPC_ERR_NOT_OP_READY = -2 , RPC_ERR_NOT_OP_NOTREADY = -3 ,   RPC_ERR_STILL_OPENNING = -4 , RPC_ERR_STILL_CLOSING = -5 , RPC_ERR_LOCAL = -6 }

Functions
	REGISTER_DEVICE (Modulator)

Variables
constexpr auto	LOGGER_NAME = "modulator"
constexpr auto	CI_TIMEOUT = "timeout"
constexpr unsigned int	DEFAULT_TIMEOUT = 10000
constexpr auto	RPC_START_CTRL = "rpcStartCtrl"
constexpr auto	RPC_STOP_CTRL = "rpcStopCtrl"
constexpr auto	RPC_SET_TRAJECTORY = "rpcSetTrajectory"
constexpr auto	RPC_SET_FREQUENCY = "rpcSetFrequency"
constexpr auto	RPC_SET_SCALE = "rpcSetScale"
constexpr short	SUBSTATE_NOTREADY = 105
constexpr short	SUBSTATE_READY = 106
constexpr short	SUBSTATE_ERROR = 107
constexpr short	SUBSTATE_OP_IDLE = 201
constexpr short	SUBSTATE_OP_RAMP_DOWN = 202
constexpr short	SUBSTATE_OP_RAMP_UP = 212
constexpr short	SUBSTATE_OP_WAIT_START = 213
constexpr short	SUBSTATE_OP_ACTIVE = 214
constexpr short	SUBSTATE_OP_ERROR = 215
constexpr auto	SUBSTATE_NOTREADY_STR = "NotReady"
constexpr auto	SUBSTATE_READY_STR = "Ready"
constexpr auto	SUBSTATE_ERROR_STR = "Error"
constexpr auto	SUBSTATE_OP_IDLE_STR = "Idle"
constexpr auto	SUBSTATE_OP_RAMP_DOWN_STR = "RampDown"
constexpr auto	SUBSTATE_OP_RAMP_UP_STR = "RampUp"
constexpr auto	SUBSTATE_OP_WAIT_START_STR = "WaitStart"
constexpr auto	SUBSTATE_OP_ACTIVE_STR = "Actve"
constexpr auto	SUBSTATE_OP_ERROR_STR = "OprError"
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

Modulator class source file.

ModulatorLcsIf class source file.

LampRpcErrors header file.

ModulatorLcsIf class header file.

ModulatorHwErrors header file.

ModulatorConfig class header file.

Copyright

ESO - European Southern Observatory

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
HW_SUCCESS
HW_ERR_HW_NOT_OP
HW_ERR_INIT_FAILURE
HW_ERR_UNEXPECTED_CLOSED
HW_ERR_UNEXPECTED_NONE
HW_ERR_UNEXPECTED_OPENED
HW_ERR_FAULT_SIG
HW_ERR_BOTH_SIG_ACTIVE
HW_ERR_TIMEOUT_ENABLE
HW_ERR_TIMEOUT_DISABLE
HW_ERR_TIMEOUT_INIT
HW_ERR_TIMEOUT_CLOSE
HW_ERR_TIMEOUT_OPEN

anonymous enum

anonymous enum

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_OP_READY
RPC_ERR_NOT_OP_NOTREADY
RPC_ERR_STILL_OPENNING
RPC_ERR_STILL_CLOSING
RPC_ERR_LOCAL

Function Documentation

REGISTER_DEVICE()

ifw::fcf::devmgr::modulator::REGISTER_DEVICE

(

Modulator

)

Variable Documentation

CI_TIMEOUT

constexpr auto ifw::fcf::devmgr::modulator::CI_TIMEOUT = "timeout"

constexpr

DEFAULT_TIMEOUT

constexpr unsigned int ifw::fcf::devmgr::modulator::DEFAULT_TIMEOUT = 10000

constexpr

HW_ERRORS

const std::unordered_map<short, std::string> ifw::fcf::devmgr::modulator::HW_ERRORS

Initial value:

= {
    {HW_ERR_HW_NOT_OP,          "TwinCAT not in OP state or CouplerState not mapped."},
    {HW_ERR_INIT_FAILURE,       "init failure."},
    {HW_ERR_UNEXPECTED_CLOSED,  "unexpectedly closed."},
    {HW_ERR_UNEXPECTED_NONE,    "unexpectedly no open or closed signal active."},
    {HW_ERR_UNEXPECTED_OPENED , "unexpectedly opened."},
    {HW_ERR_FAULT_SIG,          "fault signal active."},
    {HW_ERR_BOTH_SIG_ACTIVE,    "both open and closed signals active."},
    {HW_ERR_TIMEOUT_ENABLE,     "enable timed out."},
    {HW_ERR_TIMEOUT_DISABLE,    "disable timed out."},
    {HW_ERR_TIMEOUT_INIT,       "init timed out."},
    {HW_ERR_TIMEOUT_CLOSE,      "close timed out."},
    {HW_ERR_TIMEOUT_OPEN,       "open timed out."}
  }

LOGGER_NAME

constexpr auto ifw::fcf::devmgr::modulator::LOGGER_NAME = "modulator"

constexpr

RPC_ERRORS

const std::unordered_map<short, std::string> ifw::fcf::devmgr::modulator::RPC_ERRORS

Initial value:

= {
      {RPC_ERR_NOT_OP,               "Cannot disable modulator. Not in OP state"},
      {RPC_ERR_NOT_OP_READY,    "Cannot enable modulator. Not in READY or FAILURE."},
      {RPC_ERR_STILL_OPENNING ,      "Not allowed to close the modulator while it is still openning"},
      {RPC_ERR_STILL_CLOSING,        "Not allowed to open the modulator while it is still closing"},
      {RPC_ERR_LOCAL,                "RPC calls are not allowed in Local mode"},
    }

RPC_SET_FREQUENCY

constexpr auto ifw::fcf::devmgr::modulator::RPC_SET_FREQUENCY = "rpcSetFrequency"

constexpr

RPC_SET_SCALE

constexpr auto ifw::fcf::devmgr::modulator::RPC_SET_SCALE = "rpcSetScale"

constexpr

RPC_SET_TRAJECTORY

constexpr auto ifw::fcf::devmgr::modulator::RPC_SET_TRAJECTORY = "rpcSetTrajectory"

constexpr

RPC_START_CTRL

constexpr auto ifw::fcf::devmgr::modulator::RPC_START_CTRL = "rpcStartCtrl"

constexpr

RPC_STOP_CTRL

constexpr auto ifw::fcf::devmgr::modulator::RPC_STOP_CTRL = "rpcStopCtrl"

constexpr

SUBSTATE_ERROR

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_ERROR = 107

constexpr

SUBSTATE_ERROR_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_ERROR_STR = "Error"

constexpr

SUBSTATE_MAP

const std::unordered_map<short, std::string> ifw::fcf::devmgr::modulator::SUBSTATE_MAP

Initial value:

= {
    {fcf::devmgr::common::SUBSTATE_NOTREADY,       ifw::fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
    {fcf::devmgr::common::SUBSTATE_READY,       ifw::fcf::devmgr::common::SUBSTATE_READY_STR},
    {fcf::devmgr::common::SUBSTATE_ERROR,       ifw::fcf::devmgr::common::SUBSTATE_ERROR_STR},
    {SUBSTATE_OP_IDLE,           SUBSTATE_OP_IDLE_STR},
    {SUBSTATE_OP_RAMP_DOWN,      SUBSTATE_OP_RAMP_DOWN_STR},
    {SUBSTATE_OP_RAMP_UP,        SUBSTATE_OP_RAMP_UP_STR},
    {SUBSTATE_OP_WAIT_START,     SUBSTATE_OP_WAIT_START_STR},
    {SUBSTATE_OP_ACTIVE,         SUBSTATE_OP_ACTIVE_STR},
    {fcf::devmgr::common::SUBSTATE_OP_ERROR,       ifw::fcf::devmgr::common::SUBSTATE_OP_ERROR_STR}
  }

SUBSTATE_NOTREADY

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_NOTREADY = 105

constexpr

SUBSTATE_NOTREADY_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_NOTREADY_STR = "NotReady"

constexpr

SUBSTATE_OP_ACTIVE

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_OP_ACTIVE = 214

constexpr

SUBSTATE_OP_ACTIVE_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_OP_ACTIVE_STR = "Actve"

constexpr

SUBSTATE_OP_ERROR

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_OP_ERROR = 215

constexpr

SUBSTATE_OP_ERROR_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_OP_ERROR_STR = "OprError"

constexpr

SUBSTATE_OP_IDLE

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_OP_IDLE = 201

constexpr

SUBSTATE_OP_IDLE_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_OP_IDLE_STR = "Idle"

constexpr

SUBSTATE_OP_RAMP_DOWN

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_OP_RAMP_DOWN = 202

constexpr

SUBSTATE_OP_RAMP_DOWN_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_OP_RAMP_DOWN_STR = "RampDown"

constexpr

SUBSTATE_OP_RAMP_UP

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_OP_RAMP_UP = 212

constexpr

SUBSTATE_OP_RAMP_UP_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_OP_RAMP_UP_STR = "RampUp"

constexpr

SUBSTATE_OP_WAIT_START

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_OP_WAIT_START = 213

constexpr

SUBSTATE_OP_WAIT_START_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_OP_WAIT_START_STR = "WaitStart"

constexpr

SUBSTATE_READY

constexpr short ifw::fcf::devmgr::modulator::SUBSTATE_READY = 106

constexpr

SUBSTATE_READY_STR

constexpr auto ifw::fcf::devmgr::modulator::SUBSTATE_READY_STR = "Ready"

constexpr