DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpModule::Stage1DData Class Reference
+ Inheritance diagram for DynExpModule::Stage1DData:

Public Member Functions

 Stage1DData ()
 
virtual ~Stage1DData ()=default
 
- 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
 
INonCopyableoperator= (const INonCopyable &)=delete
 

Public Attributes

DynExp::LinkedObjectWrapperContainer< DynExpInstr::PositionerStagePositionerStage
 
double Velocity
 
double Position
 
bool IsUsingSIUnits
 
bool IsMoving
 
bool HasFailed
 
bool LabelsUpdated
 
- 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< Stage1DData >)
 
void Init ()
 

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 32 of file Stage1D.h.

Constructor & Destructor Documentation

◆ Stage1DData()

DynExpModule::Stage1DData::Stage1DData ( )
inline

Definition at line 35 of file Stage1D.h.

◆ ~Stage1DData()

virtual DynExpModule::Stage1DData::~Stage1DData ( )
virtualdefault

Member Function Documentation

◆ Init()

void DynExpModule::Stage1DData::Init ( )
private

Definition at line 23 of file Stage1D.cpp.

◆ ResetImpl() [1/2]

void DynExpModule::Stage1DData::ResetImpl ( dispatch_tag< QModuleDataBase )
finaloverrideprivate

Definition at line 18 of file Stage1D.cpp.

◆ ResetImpl() [2/2]

virtual void DynExpModule::Stage1DData::ResetImpl ( dispatch_tag< Stage1DData )
inlineprivatevirtual

Definition at line 49 of file Stage1D.h.

Member Data Documentation

◆ HasFailed

bool DynExpModule::Stage1DData::HasFailed

Definition at line 44 of file Stage1D.h.

◆ IsMoving

bool DynExpModule::Stage1DData::IsMoving

Definition at line 43 of file Stage1D.h.

◆ IsUsingSIUnits

bool DynExpModule::Stage1DData::IsUsingSIUnits

Definition at line 42 of file Stage1D.h.

◆ LabelsUpdated

bool DynExpModule::Stage1DData::LabelsUpdated

Definition at line 45 of file Stage1D.h.

◆ Position

double DynExpModule::Stage1DData::Position

Definition at line 41 of file Stage1D.h.

◆ PositionerStage

DynExp::LinkedObjectWrapperContainer<DynExpInstr::PositionerStage> DynExpModule::Stage1DData::PositionerStage

Definition at line 38 of file Stage1D.h.

◆ Velocity

double DynExpModule::Stage1DData::Velocity

Definition at line 40 of file Stage1D.h.


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