Commit 2b9089c7 authored by Samuel Debionne's avatar Samuel Debionne

Fix the HwInterface doc (see #93 on Github)

parent d6bbd2a6
Pipeline #8461 passed with stages
in 9 minutes and 54 seconds
......@@ -46,7 +46,7 @@ Hardware Interface
The :cpp:func:`lima::HwInterface::getStatus` member function should return the following information:
.. doxygenstruct:: lima::HwInterface::StatusType
.. doxygenstruct:: lima::HwInterface::Status
:project: hardware
:members:
......
......@@ -39,15 +39,23 @@ class LIMACORE_API HwInterface
public:
typedef std::vector<HwCap> CapList;
/// A tuple of status with acquisition and detector status / mask
/// A tuple of status with acquisition and detector status / mask
typedef struct Status
{
enum Basic {Fault, Ready, Exposure, Readout, Latency, Config};
/// Basic detector states (some detectors may have additional states)
enum Basic {
Fault, //!< Fault
Ready, //!< Ready for acquisition
Exposure, //!< Counting photons
Readout, //!< Reading data from the chip
Latency, //!< Latency between exposures
Config //!< Fault
};
inline void set(Basic);
AcqStatus acq; //!< Global acquisition status.
DetStatus det; //!< Compound bit flags specifying the current detector status.
DetStatus det_mask; //!< A mask specifying the detector status bits that are supported by the hardware.
DetStatus det_mask; //!< A mask specifying the detector status bits that are supported by the hardware.
} StatusType;
enum ResetLevel {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment