fcf::devmgr::sensor Namespace Reference

Classes
class	Sensor
	The Sensor class. More...
struct	Channel
class	SensorConfig
	sensor Configuration class More...
struct	ChannelData
	The ChannelData struct. More...
struct	SensorControllerData
	The sensorControllerData struct. More...
class	SensorLcsIf
	Sensor Local Control System (LCS) Interface (IF) class. More...

Enumerations
enum	{   HW_SUCCESS = 0, HW_ERR_HW_NOT_OP = 1, HW_ERR_WRONG_CMD = 2, HW_ERR_INCONSISTENT = 3,   HW_ERR_INIT_FAILURE = 4, HW_ERR_ENABLE_FAILURE = 5, HW_ERR_DISABLE_FAILURE = 6 }
enum	{ RPC_SUCCESS = 0, RPC_ERR_NOT_OP = -1, RPC_ERR_NOT_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_NOTREADY = -3 }

Functions
	REGISTER_DEVICE (Sensor)
std::ostream &	operator<< (std::ostream &dest, const ChannelData &obj)

Variables
constexpr auto	CI_READONLY = "readonly"
constexpr auto	CI_CHANNELS = "channels"
constexpr auto	CI_DESCRIPTION = "description"
constexpr auto	CI_ALIAS = "alias"
constexpr auto	CI_TYPE = "type"
constexpr auto	CI_HEADER = "header"
constexpr auto	CI_LOG = "log"
constexpr auto	CI_UNIT = "unit"
constexpr auto	CI_MAP = "map"
constexpr int	SUBSTATE_OP_MONITORING = 200
constexpr auto	SUBSTATE_OP_MONITORING_STR = "Monitoring"
const std::unordered_map < short, std::string >	SubstateMap
constexpr auto	DI_TYPE_STR = "DI"
constexpr auto	AI_TYPE_STR = "AI"
constexpr auto	II_TYPE_STR = "II"
constexpr auto	SI_TYPE_STR = "SI"
constexpr auto	DI_CAT_STR = "diChannels"
constexpr auto	AI_CAT_STR = "aiChannels"
constexpr auto	II_CAT_STR = "iiChannels"
constexpr auto	SI_CAT_STR = "siChannels"
const std::unordered_map < std::string, std::string >	ChannelTypeMap
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

Function Documentation

std::ostream& fcf::devmgr::sensor::operator<<	(	std::ostream &	dest,
		const ChannelData &	obj
	)

fcf::devmgr::sensor::REGISTER_DEVICE

(

Sensor

)

Variable Documentation

constexpr auto fcf::devmgr::sensor::AI_CAT_STR = "aiChannels"

constexpr auto fcf::devmgr::sensor::AI_TYPE_STR = "AI"

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

Initial value:

= {
  }

const std::unordered_map<std::string, std::string> fcf::devmgr::sensor::ChannelTypeMap

Initial value:

= {
    {DI_TYPE_STR, DI_CAT_STR},
    {AI_TYPE_STR, AI_CAT_STR},
    {II_TYPE_STR, II_CAT_STR},
    {SI_TYPE_STR, SI_CAT_STR},
  }

constexpr auto fcf::devmgr::sensor::CI_ALIAS = "alias"

constexpr auto fcf::devmgr::sensor::CI_CHANNELS = "channels"

constexpr auto fcf::devmgr::sensor::CI_DESCRIPTION = "description"

constexpr auto fcf::devmgr::sensor::CI_HEADER = "header"

constexpr auto fcf::devmgr::sensor::CI_LOG = "log"

constexpr auto fcf::devmgr::sensor::CI_MAP = "map"

constexpr auto fcf::devmgr::sensor::CI_READONLY = "readonly"

constexpr auto fcf::devmgr::sensor::CI_TYPE = "type"

constexpr auto fcf::devmgr::sensor::CI_UNIT = "unit"

constexpr auto fcf::devmgr::sensor::DI_CAT_STR = "diChannels"

constexpr auto fcf::devmgr::sensor::DI_TYPE_STR = "DI"

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

Initial value:

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

constexpr auto fcf::devmgr::sensor::II_CAT_STR = "iiChannels"

constexpr auto fcf::devmgr::sensor::II_TYPE_STR = "II"

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

Initial value:

= {
    {RPC_ERR_NOT_OP,               "Cannot disable Sensor. Not in OP state"},
    {RPC_ERR_NOT_STANDBY_READY,    "Cannot enable Sensor. Not in READY."},
    {RPC_ERR_NOT_STANDBY_NOTREADY, "Cannot init Sensor. Not in NOTREADY or FAILURE."}
  }

const std::vector<std::string> fcf::devmgr::sensor::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
  }

constexpr auto fcf::devmgr::sensor::SI_CAT_STR = "siChannels"

constexpr auto fcf::devmgr::sensor::SI_TYPE_STR = "SI"

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

Initial value:

= {
    fcf::devmgr::common::CI_STAT_SUBSTATE,
    fcf::devmgr::common::CI_STAT_STATE
  }

constexpr int fcf::devmgr::sensor::SUBSTATE_OP_MONITORING = 200

constexpr auto fcf::devmgr::sensor::SUBSTATE_OP_MONITORING_STR = "Monitoring"

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

Initial value:

= {
    {fcf::devmgr::common::SUBSTATE_NOTREADY,      fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
    {fcf::devmgr::common::SUBSTATE_READY,         fcf::devmgr::common::SUBSTATE_READY_STR},
    {fcf::devmgr::common::SUBSTATE_ERROR,         fcf::devmgr::common::SUBSTATE_ERROR_STR},
    {SUBSTATE_OP_MONITORING,                 SUBSTATE_OP_MONITORING_STR},
    {fcf::devmgr::common::SUBSTATE_OP_ERROR,      fcf::devmgr::common::SUBSTATE_OP_ERROR_STR},
  }