Classes
class	Shutter
	The Shutter class. More...

class	ShutterConfig
	Shutter Configuration class. More...

struct	ShutterControllerData
	The ShutterControllerData struct. More...

class	ShutterLcsIf
	Shutter 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_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_NOTREADY = -3, RPC_ERR_STILL_OPENNING = -4, RPC_ERR_STILL_CLOSING = -5, RPC_ERR_LOCAL = -6 }

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_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_NOTREADY = -3, RPC_ERR_STILL_OPENNING = -4, RPC_ERR_STILL_CLOSING = -5, RPC_ERR_LOCAL = -6 }

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_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_NOTREADY = -3, RPC_ERR_STILL_OPENNING = -4, RPC_ERR_STILL_CLOSING = -5, RPC_ERR_LOCAL = -6 }

Functions
	REGISTER_DEVICE (Shutter)

Variables
const std::string	CI_ACTIVE_LOW_CLOSED = "low_closed"

const std::string	CI_ACTIVE_LOW_FAULT = "low_fault"

const std::string	CI_ACTIVE_LOW_OPEN = "low_open"

const std::string	CI_ACTIVE_LOW_SWITCH = "low_switch"

const std::string	CI_IGNORE_CLOSED = "ignore_closed"

const std::string	CI_IGNORE_FAULT = "ignore_fault"

const std::string	CI_IGNORE_OPEN = "ignore_open"

const std::string	CI_INITIAL_STATE = "initial_state"

const std::string	CI_TIMEOUT = "timeout"

const bool	DEFAULT_ACTIVE_LOW_CLOSE = false

const bool	DEFAULT_ACTIVE_LOW_FAULT = false

const bool	DEFAULT_ACTIVE_LOW_OPEN = false

const bool	DEFAULT_ACTIVE_LOW_SWITCH = false

const bool	DEFAULT_IGNORE_CLOSED = false

const bool	DEFAULT_IGNORE_FAULT = false

const bool	DEFAULT_IGNORE_OPEN = false

const bool	DEFAULT_INITIAL_STATE = false

const unsigned int	DEFAULT_TIMEOUT = 10000

const std::string	RPC_OPEN = "rpcOpen"

const std::string	RPC_CLOSE = "rpcClose"

const short	SUBSTATE_NOTREADY = 100

const short	SUBSTATE_INITIALISING = 101

const short	SUBSTATE_READY_CLOSE = 102

const short	SUBSTATE_READY_OPEN = 103

const short	SUBSTATE_STANDBY_FAILURE = 104

const short	SUBSTATE_OP_DISABLING = 200

const short	SUBSTATE_OP_CLOSE = 201

const short	SUBSTATE_OP_CLOSING = 202

const short	SUBSTATE_OP_OPEN = 203

const short	SUBSTATE_OP_OPENING = 204

const short	SUBSTATE_OP_FAILURE = 205

const std::string	SUBSTATE_NOTREADY_STR = "NotReady"

const std::string	SUBSTATE_INITIALISING_STR = "Initialising"

const std::string	SUBSTATE_READY_CLOSE_STR = "Ready/Close"

const std::string	SUBSTATE_READY_OPEN_STR = "Ready/Open"

const std::string	SUBSTATE_FAILURE_STR = "Failure"

const std::string	SUBSTATE_OP_DISABLING_STR = "Disabling"

const std::string	SUBSTATE_OP_CLOSE_STR = "Close"

const std::string	SUBSTATE_OP_CLOSING_STR = "Closing"

const std::string	SUBSTATE_OP_OPEN_STR = "Open"

const std::string	SUBSTATE_OP_OPENING_STR = "Opening"

const std::string	SUBSTATE_OP_FAILURE_STR = "Failure"

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

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_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

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_STILL_OPENNING
RPC_ERR_STILL_CLOSING
RPC_ERR_LOCAL

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

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_STILL_OPENNING
RPC_ERR_STILL_CLOSING
RPC_ERR_LOCAL

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

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_STILL_OPENNING
RPC_ERR_STILL_CLOSING
RPC_ERR_LOCAL

Function Documentation

devmgr::shutter::REGISTER_DEVICE ( Shutter )

Variable Documentation

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

Initial value:

= {
      CI_ACTIVE_LOW_FAULT,
      CI_ACTIVE_LOW_OPEN,
    }

const std::string devmgr::shutter::CI_ACTIVE_LOW_CLOSED = "low_closed"

const std::string devmgr::shutter::CI_ACTIVE_LOW_FAULT = "low_fault"

const std::string devmgr::shutter::CI_ACTIVE_LOW_OPEN = "low_open"

const std::string devmgr::shutter::CI_ACTIVE_LOW_SWITCH = "low_switch"

const std::string devmgr::shutter::CI_IGNORE_CLOSED = "ignore_closed"

const std::string devmgr::shutter::CI_IGNORE_FAULT = "ignore_fault"

const std::string devmgr::shutter::CI_IGNORE_OPEN = "ignore_open"

const std::string devmgr::shutter::CI_INITIAL_STATE = "initial_state"

const std::string devmgr::shutter::CI_TIMEOUT = "timeout"

const bool devmgr::shutter::DEFAULT_ACTIVE_LOW_CLOSE = false

const bool devmgr::shutter::DEFAULT_ACTIVE_LOW_FAULT = false

const bool devmgr::shutter::DEFAULT_ACTIVE_LOW_OPEN = false

const bool devmgr::shutter::DEFAULT_ACTIVE_LOW_SWITCH = false

const bool devmgr::shutter::DEFAULT_IGNORE_CLOSED = false

const bool devmgr::shutter::DEFAULT_IGNORE_FAULT = false

const bool devmgr::shutter::DEFAULT_IGNORE_OPEN = false

const bool devmgr::shutter::DEFAULT_INITIAL_STATE = false

const unsigned int devmgr::shutter::DEFAULT_TIMEOUT = 10000

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

Initial value:

= {
      {HW_ERR_HW_NOT_OP,          "not in operational state."},
      {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."}
    }

const std::string devmgr::shutter::RPC_CLOSE = "rpcClose"

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

Initial value:

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

const std::string devmgr::shutter::RPC_OPEN = "rpcOpen"

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

Initial value:

= {
      devmgr::common::RPC_INIT,
      devmgr::common::RPC_ENABLE,
      devmgr::common::RPC_DISABLE,
      devmgr::common::RPC_RESET,
      devmgr::common::RPC_STOP,
      RPC_CLOSE,
      RPC_OPEN
    }

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

Initial value:

= {
      devmgr::common::CI_STAT_SUBSTATE,
      devmgr::common::CI_STAT_STATE,
      devmgr::common::CI_STAT_LOCAL,
      devmgr::common::CI_STAT_ERROR_CODE
    }

const std::string devmgr::shutter::SUBSTATE_FAILURE_STR = "Failure"

const short devmgr::shutter::SUBSTATE_INITIALISING = 101

const std::string devmgr::shutter::SUBSTATE_INITIALISING_STR = "Initialising"

const short devmgr::shutter::SUBSTATE_NOTREADY = 100

const std::string devmgr::shutter::SUBSTATE_NOTREADY_STR = "NotReady"

const short devmgr::shutter::SUBSTATE_OP_CLOSE = 201

const std::string devmgr::shutter::SUBSTATE_OP_CLOSE_STR = "Close"

const short devmgr::shutter::SUBSTATE_OP_CLOSING = 202

const std::string devmgr::shutter::SUBSTATE_OP_CLOSING_STR = "Closing"

const short devmgr::shutter::SUBSTATE_OP_DISABLING = 200

const std::string devmgr::shutter::SUBSTATE_OP_DISABLING_STR = "Disabling"

const short devmgr::shutter::SUBSTATE_OP_FAILURE = 205

const std::string devmgr::shutter::SUBSTATE_OP_FAILURE_STR = "Failure"

const short devmgr::shutter::SUBSTATE_OP_OPEN = 203

const std::string devmgr::shutter::SUBSTATE_OP_OPEN_STR = "Open"

const short devmgr::shutter::SUBSTATE_OP_OPENING = 204

const std::string devmgr::shutter::SUBSTATE_OP_OPENING_STR = "Opening"

const short devmgr::shutter::SUBSTATE_READY_CLOSE = 102

const std::string devmgr::shutter::SUBSTATE_READY_CLOSE_STR = "Ready/Close"

const short devmgr::shutter::SUBSTATE_READY_OPEN = 103

const std::string devmgr::shutter::SUBSTATE_READY_OPEN_STR = "Ready/Open"

const short devmgr::shutter::SUBSTATE_STANDBY_FAILURE = 104

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

Initial value:

= {
      {SUBSTATE_NOTREADY,       SUBSTATE_NOTREADY_STR},
      {SUBSTATE_INITIALISING,   SUBSTATE_INITIALISING_STR},
      {SUBSTATE_READY_CLOSE,    SUBSTATE_READY_CLOSE_STR},
      {SUBSTATE_READY_OPEN,     SUBSTATE_READY_OPEN_STR},
      {SUBSTATE_STANDBY_FAILURE,SUBSTATE_FAILURE_STR},
      {SUBSTATE_OP_DISABLING,   SUBSTATE_OP_DISABLING_STR},
      {SUBSTATE_OP_CLOSE,       SUBSTATE_OP_CLOSE_STR},
      {SUBSTATE_OP_CLOSING,     SUBSTATE_OP_CLOSING_STR},
      {SUBSTATE_OP_OPEN,        SUBSTATE_OP_OPEN_STR},
      {SUBSTATE_OP_OPENING,     SUBSTATE_OP_OPENING_STR},
      {SUBSTATE_OP_FAILURE,     SUBSTATE_OP_FAILURE_STR},
    }

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

Function Documentation

Variable Documentation