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

Public Member Functions

 QutoolsQuTAGData ()
 
virtual ~QutoolsQuTAGData ()=default
 
auto GetChannel () const noexcept
 
void SetChannel (DynExpHardware::QutoolsTDCHardwareAdapter::ChannelType Channel) noexcept
 
- Public Member Functions inherited from DynExpInstr::TimeTaggerData
 TimeTaggerData (size_t BufferSizeInSamples=1)
 Constructs a TimeTaggerData instance. More...
 
 TimeTaggerData (DataStreamBasePtrType &&SampleStream)
 Constructs a TimeTaggerData instance. More...
 
virtual ~TimeTaggerData ()=default
 
auto GetStreamMode () const noexcept
 Getter for StreamMode. More...
 
void SetStreamMode (StreamModeType StreamMode) const noexcept
 Setter for StreamMode. Adjustable by modules. Sets StreamModeChanged to true. More...
 
bool GetStreamModeChanged () const noexcept
 Getter for StreamModeChanged. More...
 
void ResetStreamMode () const noexcept
 Sets StreamModeChanged to true. Callable by modules. More...
 
void ClearStreamModeChanged () noexcept
 Sets StreamModeChanged to false. More...
 
auto & GetHBTResults () const noexcept
 Getter for HBTResults. More...
 
auto & GetHBTResults () noexcept
 Getter for HBTResults. More...
 
- Public Member Functions inherited from DynExpInstr::DataStreamInstrumentData
 DataStreamInstrumentData (DataStreamBasePtrType &&SampleStream)
 Constructs a DataStreamInstrumentData instance. More...
 
virtual ~DataStreamInstrumentData ()=default
 
DataStreamBasePtrType::element_type * GetSampleStream () const noexcept
 Getter for the data stream instrument's sample stream. Logical const-ness: always returns a non-const type to allow modules to directly manipulate the sample stream. More...
 
template<typename T >
auto GetCastSampleStream () const
 Casts the data stream instrument's sample stream to a derived data stream type. More...
 
ValueType GetHardwareMinValue () const noexcept
 Returns HardwareMinValue. More...
 
ValueType GetHardwareMaxValue () const noexcept
 Returns HardwareMaxValue. More...
 
UnitType GetValueUnit () const noexcept
 Returns ValueUnit. More...
 
void SetHardwareMinValue (ValueType Value) noexcept
 Sets HardwareMinValue. More...
 
void SetHardwareMaxValue (ValueType Value) noexcept
 Sets HardwareMaxValue. More...
 
void SetValueUnit (UnitType Unit) noexcept
 Sets ValueUnit. More...
 
- Public Member Functions inherited from DynExp::InstrumentDataBase
 InstrumentDataBase ()
 
virtual ~InstrumentDataBase ()
 
auto GetLastUpdateTime () const
 Getter for LastUpdate. More...
 
auto GetException () const noexcept
 Getter for InstrumentDataBase::InstrumentException. More...
 
void EnqueueTask (std::unique_ptr< TaskBase > &&Task)
 Enqueues a task at the back of an instrument's task queue and notifies the instrument about the new task. More...
 
void EnqueuePriorityTask (std::unique_ptr< TaskBase > &&Task)
 Enqueues a task at the front of an instrument's task queue and notifies the instrument about the new task. More...
 
std::unique_ptr< TaskBasePopTaskFront ()
 Removes a task from the front of an instrument's task queue. More...
 
std::unique_ptr< TaskBasePopTaskBack ()
 Removes a task from the back of an instrument's task queue. More...
 
auto GetTaskFront () noexcept
 Getter for first enqueued task. More...
 
auto GetTaskBack () noexcept
 Getter for last enqueued task. More...
 
size_t GetNumEnqueuedTasks () const noexcept
 Getter for the instrument task queue's length. More...
 
std::unique_ptr< TaskBasePopFinishedTask ()
 Removes a task from the front of an instrument's list of finished tasks. More...
 
size_t GetNumFinishedTasks () const noexcept
 Getter for the length of the instrument's list of finished tasks. More...
 
bool IsQueueClosed () const noexcept
 Determines whether the instrument task queue is closed. More...
 
- Public Member Functions inherited from Util::INonCopyable
 INonCopyable (const INonCopyable &)=delete
 
INonCopyableoperator= (const INonCopyable &)=delete
 

Public Attributes

DynExp::LinkedObjectWrapperContainer< DynExpHardware::QutoolsTDCHardwareAdapterHardwareAdapter
 
- Public Attributes inherited from DynExp::InstrumentDataBase
InstrumentBaseOnlyType InstrumentBaseOnly
 Allow exclusive access to some of InstrumentDataBase's private methods to InstrumentBase. More...
 
InstrumenThreadOnlyType InstrumentThreadOnly
 Allow exclusive access to some of InstrumentDataBase's private methods to the instrument thread InstrumentThreadMain(). More...
 

Private Member Functions

void ResetImpl (dispatch_tag< TimeTaggerData >) override final
 
virtual void ResetImpl (dispatch_tag< QutoolsQuTAGData >)
 

Private Attributes

DynExpHardware::QutoolsTDCHardwareAdapter::ChannelType Channel
 

Additional Inherited Members

- Public Types inherited from DynExpInstr::TimeTaggerData
enum  StreamModeType { Counts , Events }
 Type to determine whether the instrument reads out all time-tagged events or summarized count rates. Not a strongly-typed enum to allow using the enumeration in a DynExp::ParamsBase::Param in class DynExpInstr::TimeTaggerParams. More...
 
using SampleStreamType = BasicSampleStream
 Data stream type this data stream instrument operates on. More...
 
- Public Types inherited from DynExpInstr::DataStreamInstrumentData
enum class  UnitType {
  Arbitrary , LogicLevel , Counts , Volt ,
  Ampere , Power_W , Power_dBm
}
 Units which can be used for data stream instruments. More...
 
using ValueType = double
 Data type to represent hardware limits on the sample values to write to the hardware adapter assigned to the related DataStreamInstrument instance. More...
 
- Public Types inherited from DynExp::InstrumentDataBase
using TaskQueueType = std::list< std::unique_ptr< TaskBase > >
 Type of an instrument task queue owning the tasks within. More...
 
using TaskQueueIteratorType = TaskQueueType::const_iterator
 Const iterator type to elements of TaskQueueType. More...
 
- Static Public Member Functions inherited from DynExpInstr::DataStreamInstrumentData
static const char * UnitTypeToStr (const UnitType &Unit)
 Returns a descriptive string of a respective unit to be e.g. used in plots. 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 152 of file QutoolsQuTAG.h.

Constructor & Destructor Documentation

◆ QutoolsQuTAGData()

DynExpInstr::QutoolsQuTAGData::QutoolsQuTAGData ( )
inline

Definition at line 155 of file QutoolsQuTAG.h.

◆ ~QutoolsQuTAGData()

virtual DynExpInstr::QutoolsQuTAGData::~QutoolsQuTAGData ( )
virtualdefault

Member Function Documentation

◆ GetChannel()

auto DynExpInstr::QutoolsQuTAGData::GetChannel ( ) const
inlinenoexcept

Definition at line 160 of file QutoolsQuTAG.h.

◆ ResetImpl() [1/2]

virtual void DynExpInstr::QutoolsQuTAGData::ResetImpl ( dispatch_tag< QutoolsQuTAGData )
inlineprivatevirtual

Definition at line 165 of file QutoolsQuTAG.h.

◆ ResetImpl() [2/2]

void DynExpInstr::QutoolsQuTAGData::ResetImpl ( dispatch_tag< TimeTaggerData )
finaloverrideprivatevirtual

Reimplemented from DynExpInstr::TimeTaggerData.

Definition at line 182 of file QutoolsQuTAG.cpp.

◆ SetChannel()

void DynExpInstr::QutoolsQuTAGData::SetChannel ( DynExpHardware::QutoolsTDCHardwareAdapter::ChannelType  Channel)
inlinenoexcept

Definition at line 161 of file QutoolsQuTAG.h.

Member Data Documentation

◆ Channel

DynExpHardware::QutoolsTDCHardwareAdapter::ChannelType DynExpInstr::QutoolsQuTAGData::Channel
private

Definition at line 167 of file QutoolsQuTAG.h.

◆ HardwareAdapter

Definition at line 158 of file QutoolsQuTAG.h.


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