DynExp
Highly flexible laboratory automation for dynamically changing experiments.
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
DynExpModule::SpectrumViewer::SpectrumViewerData Class Reference
+ Inheritance diagram for DynExpModule::SpectrumViewer::SpectrumViewerData:

Public Member Functions

 SpectrumViewerData ()
 
virtual ~SpectrumViewerData ()=default
 
bool IsUIInitialized () const noexcept
 
void SetUIInitialized () noexcept
 
auto & GetSpectrometer ()
 
auto & GetCommunicator ()
 
- Public Member Functions inherited from DynExp::QModuleDataBase
 QModuleDataBase ()=default
 
virtual ~QModuleDataBase ()=default
 
- Public Member Functions inherited from DynExp::ModuleDataBase
 ModuleDataBase ()
 
virtual ~ModuleDataBase ()
 
auto GetException () const noexcept
 Getter for ModuleException. More...
 
void EnqueueEvent (EventPtrType &&Event)
 Enqueues Event at the module event queue's back. Takes ownership of the event. Notifies the module owning the respective ModuleDataBase's instance that a new event has been enqueued. More...
 
EventPtrType PopEvent ()
 Removes one event from the event queue's front and returns the event. Ownership of the event is transferred to the caller of this method. More...
 
const auto & GetEventFront () const noexcept
 Returns a pointer to the event in the front of the module's event queue without transferring ownership and without removing the event from the queue. More...
 
auto & GetEventFront () noexcept
 Returns a pointer to the event in the front of the module's event queue without transferring ownership and without removing the event from the queue. More...
 
size_t GetNumEnqueuedEvents () const noexcept
 Getter for the module event queue's length. More...
 
- Public Member Functions inherited from Util::INonCopyable
 INonCopyable (const INonCopyable &)=delete
 
INonCopyable & operator= (const INonCopyable &)=delete
 

Public Attributes

DynExpInstr::SpectrometerData::FrequencyUnitType FrequencyUnit
 
DynExpInstr::SpectrometerData::IntensityUnitType IntensityUnit
 
double MinFrequency
 
double MaxFrequency
 
DynExpInstr::SpectrometerData::TimeType MinExposureTime
 
DynExpInstr::SpectrometerData::TimeType MaxExposureTime
 
DynExpInstr::SpectrometerData::TimeType CurrentExposureTime
 
DynExpInstr::SpectrometerData::TimeType AcquisitionExposureTime
 
double CurrentLowerFrequency
 
double CurrentUpperFrequency
 
bool SilentModeEnabled
 
DynExpInstr::SpectrometerData::CapturingStateType CapturingState
 
double CapturingProgress
 
std::string AutoSaveFilename
 
SpectrumViewerWidget::SampleDataType CurrentSpectrum
 
bool SpectrumRecordingPaused
 
- Public Attributes inherited from DynExp::ModuleDataBase
ModuleBaseOnlyType ModuleBaseOnly
 Allow exclusive access to some of ModuleDataBase's private methods to ModuleBase. More...
 
ModuleThreadOnlyType ModuleThreadOnly
 Allow exclusive access to some of ModuleDataBase's private methods to the module thread ModuleThreadMain(). More...
 

Private Member Functions

void ResetImpl (dispatch_tag< QModuleDataBase >) override final
 
virtual void ResetImpl (dispatch_tag< SpectrumViewerData >)
 
void Init ()
 

Private Attributes

bool UIInitialized
 
DynExp::LinkedObjectWrapperContainer< DynExpInstr::Spectrometer > Spectrometer
 
DynExp::LinkedObjectWrapperContainer< DynExpInstr::InterModuleCommunicator > Communicator
 

Additional Inherited Members

- Public Types inherited from DynExp::ModuleDataBase
using EventPtrType = std::unique_ptr< EventBase >
 Pointer owning an event. More...
 
using EventQueueType = std::queue< EventPtrType >
 A module's event queue is a FIFO queue owning the enqueued events. More...
 
- Protected Member Functions inherited from Util::ISynchronizedPointerLockable
 ISynchronizedPointerLockable ()
 
 ~ISynchronizedPointerLockable ()
 Object should never be destroyed before completely unlocked. More...
 
- Protected Member Functions inherited from Util::INonCopyable
constexpr INonCopyable ()=default
 
 ~INonCopyable ()=default
 

Detailed Description

Definition at line 77 of file SpectrumViewer.h.

Constructor & Destructor Documentation

◆ SpectrumViewerData()

DynExpModule::SpectrumViewer::SpectrumViewerData::SpectrumViewerData ( )
inline

Definition at line 80 of file SpectrumViewer.h.

◆ ~SpectrumViewerData()

virtual DynExpModule::SpectrumViewer::SpectrumViewerData::~SpectrumViewerData ( )
virtualdefault

Member Function Documentation

◆ GetCommunicator()

auto& DynExpModule::SpectrumViewer::SpectrumViewerData::GetCommunicator ( )
inline

Definition at line 86 of file SpectrumViewer.h.

◆ GetSpectrometer()

auto& DynExpModule::SpectrumViewer::SpectrumViewerData::GetSpectrometer ( )
inline

Definition at line 85 of file SpectrumViewer.h.

◆ Init()

void DynExpModule::SpectrumViewer::SpectrumViewerData::Init ( )
private

Definition at line 191 of file SpectrumViewer.cpp.

◆ IsUIInitialized()

bool DynExpModule::SpectrumViewer::SpectrumViewerData::IsUIInitialized ( ) const
inlinenoexcept

Definition at line 83 of file SpectrumViewer.h.

◆ ResetImpl() [1/2]

void DynExpModule::SpectrumViewer::SpectrumViewerData::ResetImpl ( dispatch_tag< QModuleDataBase >  )
finaloverrideprivate

Definition at line 186 of file SpectrumViewer.cpp.

◆ ResetImpl() [2/2]

virtual void DynExpModule::SpectrumViewer::SpectrumViewerData::ResetImpl ( dispatch_tag< SpectrumViewerData >  )
inlineprivatevirtual

Definition at line 108 of file SpectrumViewer.h.

◆ SetUIInitialized()

void DynExpModule::SpectrumViewer::SpectrumViewerData::SetUIInitialized ( )
inlinenoexcept

Definition at line 84 of file SpectrumViewer.h.

Member Data Documentation

◆ AcquisitionExposureTime

DynExpInstr::SpectrometerData::TimeType DynExpModule::SpectrumViewer::SpectrumViewerData::AcquisitionExposureTime

Definition at line 95 of file SpectrumViewer.h.

◆ AutoSaveFilename

std::string DynExpModule::SpectrumViewer::SpectrumViewerData::AutoSaveFilename

Definition at line 101 of file SpectrumViewer.h.

◆ CapturingProgress

double DynExpModule::SpectrumViewer::SpectrumViewerData::CapturingProgress

Definition at line 100 of file SpectrumViewer.h.

◆ CapturingState

DynExpInstr::SpectrometerData::CapturingStateType DynExpModule::SpectrumViewer::SpectrumViewerData::CapturingState

Definition at line 99 of file SpectrumViewer.h.

◆ Communicator

DynExp::LinkedObjectWrapperContainer<DynExpInstr::InterModuleCommunicator> DynExpModule::SpectrumViewer::SpectrumViewerData::Communicator
private

Definition at line 115 of file SpectrumViewer.h.

◆ CurrentExposureTime

DynExpInstr::SpectrometerData::TimeType DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentExposureTime

Definition at line 94 of file SpectrumViewer.h.

◆ CurrentLowerFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentLowerFrequency

Definition at line 96 of file SpectrumViewer.h.

◆ CurrentSpectrum

SpectrumViewerWidget::SampleDataType DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentSpectrum

Definition at line 103 of file SpectrumViewer.h.

◆ CurrentUpperFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentUpperFrequency

Definition at line 97 of file SpectrumViewer.h.

◆ FrequencyUnit

DynExpInstr::SpectrometerData::FrequencyUnitType DynExpModule::SpectrumViewer::SpectrumViewerData::FrequencyUnit

Definition at line 88 of file SpectrumViewer.h.

◆ IntensityUnit

DynExpInstr::SpectrometerData::IntensityUnitType DynExpModule::SpectrumViewer::SpectrumViewerData::IntensityUnit

Definition at line 89 of file SpectrumViewer.h.

◆ MaxExposureTime

DynExpInstr::SpectrometerData::TimeType DynExpModule::SpectrumViewer::SpectrumViewerData::MaxExposureTime

Definition at line 93 of file SpectrumViewer.h.

◆ MaxFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::MaxFrequency

Definition at line 91 of file SpectrumViewer.h.

◆ MinExposureTime

DynExpInstr::SpectrometerData::TimeType DynExpModule::SpectrumViewer::SpectrumViewerData::MinExposureTime

Definition at line 92 of file SpectrumViewer.h.

◆ MinFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::MinFrequency

Definition at line 90 of file SpectrumViewer.h.

◆ SilentModeEnabled

bool DynExpModule::SpectrumViewer::SpectrumViewerData::SilentModeEnabled

Definition at line 98 of file SpectrumViewer.h.

◆ Spectrometer

DynExp::LinkedObjectWrapperContainer<DynExpInstr::Spectrometer> DynExpModule::SpectrumViewer::SpectrumViewerData::Spectrometer
private

Definition at line 114 of file SpectrumViewer.h.

◆ SpectrumRecordingPaused

bool DynExpModule::SpectrumViewer::SpectrumViewerData::SpectrumRecordingPaused

Definition at line 104 of file SpectrumViewer.h.

◆ UIInitialized

bool DynExpModule::SpectrumViewer::SpectrumViewerData::UIInitialized
private

Definition at line 112 of file SpectrumViewer.h.

The documentation for this class was generated from the following files: