DynExpModule::SpectrumViewer::SpectrumViewerData Class Reference

#include <SpectrumViewer.h>

Inheritance diagram for DynExpModule::SpectrumViewer::SpectrumViewerData:

Classes
struct	SampleDataType

Public Member Functions
	SpectrumViewerData ()
virtual	~SpectrumViewerData ()=default
bool	IsUIInitialized () const noexcept
void	SetUIInitialized () noexcept
auto &	GetSpectrometer ()
auto &	GetCommunicator ()
Public Member Functions inherited from DynExp::QMLModuleDataBase
	QMLModuleDataBase ()=default
virtual	~QMLModuleDataBase ()=default
Public Member Functions inherited from DynExp::QModuleDataBase
	QModuleDataBase ()=default
virtual	~QModuleDataBase ()=default
Public Member Functions inherited from DynExp::ModuleDataBase
	ModuleDataBase ()
virtual	~ModuleDataBase ()
bool	IsExceptionIndicated () const noexcept
	Getter for HasException. Only performs atomic operations. Hence, this module data instance does not need to be locked for this function call.
std::exception_ptr	GetException () const noexcept
	Getter for ModuleDataBase::ModuleException. If ModuleDataBase::ModuleException is nullptr and ModuleDataBase::HasException is still true, returns a pointer to a Util::Exception instance.
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.
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.
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.
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.
size_t	GetNumEnqueuedEvents () const noexcept
	Getter for the module event queue's length.
void	RunQueue ()
	Wakes up a module waiting for events and forces it to run its main loop once.
Public Member Functions inherited from Util::INonCopyable
	INonCopyable (const INonCopyable &)=delete
INonCopyable &	operator= (const INonCopyable &)=delete

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

Private Member Functions
void	ResetImpl (dispatch_tag< QMLModuleDataBase >) 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.
using	EventQueueType = std::queue< EventPtrType >
	A module's event queue is a FIFO queue owning the enqueued events.
Protected Member Functions inherited from Util::ISynchronizedPointerLockable
	ISynchronizedPointerLockable ()
	~ISynchronizedPointerLockable ()
	Object should never be destroyed before completely unlocked.
Protected Member Functions inherited from Util::INonCopyable
constexpr	INonCopyable ()=default
	~INonCopyable ()=default

Detailed Description

Definition at line 23 of file SpectrumViewer.h.

Constructor & Destructor Documentation

SpectrumViewerData()

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

inline

Definition at line 33 of file SpectrumViewer.h.

~SpectrumViewerData()

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

virtualdefault

Member Function Documentation

GetCommunicator()

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

inline

Definition at line 40 of file SpectrumViewer.h.

GetSpectrometer()

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

inline

Definition at line 39 of file SpectrumViewer.h.

Init()

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

private

Definition at line 29 of file SpectrumViewer.cpp.

IsUIInitialized()

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

inlinenoexcept

Definition at line 36 of file SpectrumViewer.h.

ResetImpl() [1/2]

void DynExpModule::SpectrumViewer::SpectrumViewerData::ResetImpl ( dispatch_tag< QMLModuleDataBase >  )

finaloverrideprivate

Definition at line 24 of file SpectrumViewer.cpp.

ResetImpl() [2/2]

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

inlineprivatevirtual

Definition at line 60 of file SpectrumViewer.h.

SetUIInitialized()

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

inlinenoexcept

Definition at line 37 of file SpectrumViewer.h.

Member Data Documentation

AutoSaveFilename

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

Definition at line 52 of file SpectrumViewer.h.

CapturingProgress

double DynExpModule::SpectrumViewer::SpectrumViewerData::CapturingProgress

Definition at line 51 of file SpectrumViewer.h.

CapturingState

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

Definition at line 50 of file SpectrumViewer.h.

Communicator

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

private

Definition at line 67 of file SpectrumViewer.h.

CurrentExposureTime

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

Definition at line 46 of file SpectrumViewer.h.

CurrentLowerFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentLowerFrequency

Definition at line 47 of file SpectrumViewer.h.

CurrentSpectrum

SampleDataType DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentSpectrum

Definition at line 56 of file SpectrumViewer.h.

CurrentUpperFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::CurrentUpperFrequency

Definition at line 48 of file SpectrumViewer.h.

MaxExposureTime

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

Definition at line 45 of file SpectrumViewer.h.

MaxFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::MaxFrequency

Definition at line 43 of file SpectrumViewer.h.

MinExposureTime

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

Definition at line 44 of file SpectrumViewer.h.

MinFrequency

double DynExpModule::SpectrumViewer::SpectrumViewerData::MinFrequency

Definition at line 42 of file SpectrumViewer.h.

PlotInfo

Graph::LineGraphPlotInfo DynExpModule::SpectrumViewer::SpectrumViewerData::PlotInfo

Definition at line 55 of file SpectrumViewer.h.

SilentModeEnabled

bool DynExpModule::SpectrumViewer::SpectrumViewerData::SilentModeEnabled

Definition at line 49 of file SpectrumViewer.h.

Spectrometer

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

private

Definition at line 66 of file SpectrumViewer.h.

SpectrumRecordingPaused

bool DynExpModule::SpectrumViewer::SpectrumViewerData::SpectrumRecordingPaused

Definition at line 53 of file SpectrumViewer.h.

UIInitialized

bool DynExpModule::SpectrumViewer::SpectrumViewerData::UIInitialized

private

Definition at line 64 of file SpectrumViewer.h.

---

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

• SpectrumViewer.h
• SpectrumViewer.cpp