Midas C++ API - mdev slow control framework
This page contains the full API reference for the mdev slow control framework (drivers/mdev/mdev.h) and the mdev drivers included in midas.
For the concepts and day-to-day use, see Slow control: overview.
For the ODB keys each driver creates, see Slow control: configuring.
For explanations and examples of writing an mdev frontend, see Slow control: programming.
For midas::mscb, which mdev_mscb uses to talk to MSCB nodes, see MSCB.
Base class
Defined in drivers/mdev/mdev.h:14
Methods
Note: this method has 2 different signatures.
void define_history_panel(std::string groupName, std::string panelName, std::vector<std::string> names, std::vector<std::string> labels = {}, std::vector<std::string> formula = {}, std::vector<std::string> color = {})
Defined in drivers/mdev/mdev.h:81
void define_history_panel(std::string panelName, std::vector<std::string> names, std::vector<std::string> labels = {}, std::vector<std::string> formula = {}, std::vector<std::string> color = {})
Defined in drivers/mdev/mdev.h:95
virtualpure virtual
virtual void exit() = 0
Defined in drivers/mdev/mdev.h:54
std::string get_equipment_name()
Defined in drivers/mdev/mdev.h:49
int get_event_id()
getters and setters
Defined in drivers/mdev/mdev.h:48
virtualpure virtual
virtual void init() = 0
Defined in drivers/mdev/mdev.h:53
bool isDisabled()
Defined in drivers/mdev/mdev.h:57
virtualpure virtual
virtual void loop() = 0
Defined in drivers/mdev/mdev.h:55
mdev(std::string equipment_name)
Defined in drivers/mdev/mdev.h:23
void static mdev_init(std::vector<mdev *> &mdev_table)
Call odb_setup for all devices
Defined in drivers/mdev/mdev.h:65
void static mdev_loop(std::vector<mdev *> &mdev_table)
Call loop() function of all devices to read data
Defined in drivers/mdev/mdev.h:73
void static mdev_odb_setup(std::vector<mdev *> &mdev_table)
Call odb_setup for all devices
Defined in drivers/mdev/mdev.h:59
virtualpure virtual
virtual void odb_setup() = 0
pure virtual functions
Defined in drivers/mdev/mdev.h:52
virtual
virtual int read_event(char *pevent, int off)
Defined in drivers/mdev/mdev.h:56
void set_readout_period(int period_ms)
Defined in drivers/mdev/mdev.h:105
virtual
virtual ~mdev()
Defined in drivers/mdev/mdev.h:45
Attributes
protected
bool m_disabled
Defined in drivers/mdev/mdev.h:20
protected
std::string m_equipment_name
Defined in drivers/mdev/mdev.h:17
protected
int m_event_id
Defined in drivers/mdev/mdev.h:16
protected
DWORD m_readout_last
Defined in drivers/mdev/mdev.h:19
protected
DWORD m_readout_period
Defined in drivers/mdev/mdev.h:18
MSCB driver
Defined in drivers/mdev/mdev_mscb.h:41
Methods
void add_group()
Defined in drivers/mdev/mdev_mscb.h:62
Note: this method has 4 different signatures.
void add_input(std::string var, std::string name, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:67
void add_input(int index, std::string name, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:72
void add_input(std::string var, std::string name, std::function<float(float)> f, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:77
void add_input(int index, std::string name, std::function<float(float)> f, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:82
Note: this method has 4 different signatures.
void add_output(std::string var, std::string name, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:87
void add_output(int index, std::string name, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:92
void add_output(std::string var, std::string name, std::function<bool(mscb_var, float)> f, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:97
void add_output(int index, std::string name, std::function<bool(mscb_var, float)> f, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_mscb.h:102
std::vector<bool> get_group()
Defined in drivers/mdev/mdev_mscb.h:109
Note: this method has 2 different signatures.
mscb_node(std::string d, int a, std::string pwd = "", bool e = true)
Defined in drivers/mdev/mdev_mscb.h:55
mscb_node(std::string n, std::string d, int a, std::string pwd = "", bool e = true)
Defined in drivers/mdev/mdev_mscb.h:59
void start_new_group()
Defined in drivers/mdev/mdev_mscb.h:107
Attributes
int m_address
Defined in drivers/mdev/mdev_mscb.h:46
std::string m_device
Defined in drivers/mdev/mdev_mscb.h:44
bool m_enabled
Defined in drivers/mdev/mdev_mscb.h:47
std::vector<bool> m_group
Defined in drivers/mdev/mdev_mscb.h:52
bool m_group_flag
Defined in drivers/mdev/mdev_mscb.h:49
midas::mscb* m_mscb
Defined in drivers/mdev/mdev_mscb.h:48
std::vector<mscb_var> m_mscb_var
Defined in drivers/mdev/mdev_mscb.h:51
std::string m_name
Defined in drivers/mdev/mdev_mscb.h:43
std::string m_pwd
Defined in drivers/mdev/mdev_mscb.h:45
class mdev_mscb : public mdev
Defined in drivers/mdev/mdev_mscb.h:112
Methods
void add_node(mscb_node n)
Defined in drivers/mdev/mdev_mscb.h:131
override
void exit() override
Declared in drivers/mdev/mdev_mscb.h:144, defined in drivers/mdev/mdev_mscb.cxx:234
void get_all(int i)
Defined in drivers/mdev/mdev_mscb.h:140
midas::mscb *get_mscb_node(int i)
Defined in drivers/mdev/mdev_mscb.h:138
override
void init() override
Make repeated or previously failed initialization start from clean state.
Declared in drivers/mdev/mdev_mscb.h:143, defined in drivers/mdev/mdev_mscb.cxx:105
override
void loop() override
read input values once per second
Declared in drivers/mdev/mdev_mscb.h:145, defined in drivers/mdev/mdev_mscb.cxx:246
mdev_mscb(std::string equipment_name)
Defined in drivers/mdev/mdev_mscb.h:126
override
void odb_setup() override
Declared in drivers/mdev/mdev_mscb.h:142, defined in drivers/mdev/mdev_mscb.cxx:17
override
int read_event(char *pevent, int off) override
Declared in drivers/mdev/mdev_mscb.h:146, defined in drivers/mdev/mdev_mscb.cxx:302
override
~mdev_mscb() override
Defined in drivers/mdev/mdev_mscb.h:129
Revolution Pi driver
class mdev_revpi : public mdev
Defined in drivers/mdev/mdev_revpi.h:51
Methods
void add_group()
group handling
Defined in drivers/mdev/mdev_revpi.h:81
Note: this method has 2 different signatures.
void add_input(std::string var, std::string name, REVPI_IOTYPE ioType = RPI_WORD, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_revpi.h:90
void add_input(std::string var, std::string name, std::function<float(float)> f, REVPI_IOTYPE ioType = RPI_WORD, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_revpi.h:101
Note: this method has 2 different signatures.
void add_output(std::string var, std::string name, REVPI_IOTYPE ioType = RPI_WORD, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_revpi.h:113
void add_output(std::string var, std::string name, std::function<float(float)> f, REVPI_IOTYPE ioType = RPI_WORD, std::string unit = "", std::string format = "")
Defined in drivers/mdev/mdev_revpi.h:124
override
void exit() override
Declared in drivers/mdev/mdev_revpi.h:76, defined in drivers/mdev/mdev_revpi.cxx:193
void get_all(int i)
Declared in drivers/mdev/mdev_revpi.h:71, defined in drivers/mdev/mdev_revpi.cxx:117
std::vector<bool> get_group()
Defined in drivers/mdev/mdev_revpi.h:86
override
void init() override
Declared in drivers/mdev/mdev_revpi.h:75, defined in drivers/mdev/mdev_revpi.cxx:120
override
void loop() override
read input values once per second
Declared in drivers/mdev/mdev_revpi.h:77, defined in drivers/mdev/mdev_revpi.cxx:198
mdev_revpi(std::string equipment_name)
Defined in drivers/mdev/mdev_revpi.h:65
override
void odb_setup() override
MPDC settings in ODB
Declared in drivers/mdev/mdev_revpi.h:74, defined in drivers/mdev/mdev_revpi.cxx:62
override
int read_event(char *pevent, int off) override
Declared in drivers/mdev/mdev_revpi.h:78, defined in drivers/mdev/mdev_revpi.cxx:243
void start_new_group()
Defined in drivers/mdev/mdev_revpi.h:85
~mdev_revpi()
Defined in drivers/mdev/mdev_revpi.h:69
enum REVPI_IOTYPE
| Enumerator | Value | Description |
|---|---|---|
RPI_ANALOG |
||
RPI_BOOL |
||
RPI_BYTE |
||
RPI_WORD |
Defined in drivers/mdev/mdev_revpi.h:27
TDK power supply driver
class mdev_tdk : public mdev
Defined in drivers/mdev/mdev_tdk.h:24
Type definitions
using output_check_t = std::function<bool(int, const std::string &, std::string &)>
Defined in drivers/mdev/mdev_tdk.h:51
Methods
void exit()
Declared in drivers/mdev/mdev_tdk.h:56, defined in drivers/mdev/mdev_tdk.cxx:306
void init()
Declared in drivers/mdev/mdev_tdk.h:55, defined in drivers/mdev/mdev_tdk.cxx:101
void loop()
Declared in drivers/mdev/mdev_tdk.h:57, defined in drivers/mdev/mdev_tdk.cxx:382
mdev_tdk(std::string equipment_name, const std::vector<TDK_DEVICE>& device)
Declared in drivers/mdev/mdev_tdk.h:46, defined in drivers/mdev/mdev_tdk.cxx:24
void odb_setup()
TDK settings in ODB
Declared in drivers/mdev/mdev_tdk.h:54, defined in drivers/mdev/mdev_tdk.cxx:34
int read_event(char *pevent, int off)
Declared in drivers/mdev/mdev_tdk.h:59, defined in drivers/mdev/mdev_tdk.cxx:397
void set_output_off_check(output_check_t f)
Defined in drivers/mdev/mdev_tdk.h:52
~mdev_tdk()
Declared in drivers/mdev/mdev_tdk.h:47, defined in drivers/mdev/mdev_tdk.cxx:32
Defined in drivers/mdev/mdev_tdk.h:19
Attributes
std::string hostname
Defined in drivers/mdev/mdev_tdk.h:20
std::string name
Defined in drivers/mdev/mdev_tdk.h:21