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

Public Member Functions

 RS_SMC100AData (size_t BufferSizeInSamples=0)
 
virtual ~RS_SMC100AData ()=default
 
bool IsRunning () const noexcept
 
auto GetCurrentSweepType () const noexcept
 
- Public Member Functions inherited from DynExpInstr::FunctionGeneratorData
 FunctionGeneratorData (DataStreamBasePtrType &&SampleStream)
 Constructs a DataStreamInstrumentData instance. More...
 
virtual ~FunctionGeneratorData ()=default
 
auto GetCurrentWaveformType () const noexcept
 Returns CurrentWaveformType. More...
 
auto GetCurrentFrequencyInHz () const noexcept
 Returns CurrentFrequencyInHz. More...
 
auto GetCurrentAmplitude () const noexcept
 Returns CurrentAmplitude. More...
 
auto GetCurrentOffset () const noexcept
 Returns CurrentOffset. More...
 
auto GetCurrentPhaseInRad () const noexcept
 Returns CurrentPhaseInRad. More...
 
auto GetCurrentDutyCycle () const noexcept
 Returns CurrentDutyCycle. More...
 
auto GetCurrentTriggerMode () const noexcept
 Returns CurrentTriggerMode. More...
 
auto GetCurrentTriggerEdge () const noexcept
 Returns CurrentTriggerEdge. More...
 
auto GetShouldAutostart () const noexcept
 Returns ShouldAutostart. More...
 
auto GetCurrentPulses () const noexcept
 Returns CurrentPulses. 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< DynExp::SerialCommunicationHardwareAdapterHardwareAdapter
 
- 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< FunctionGeneratorData >) override final
 
virtual void ResetImpl (dispatch_tag< RS_SMC100AData >)
 

Private Attributes

size_t NumFailedStatusUpdateAttempts = 0
 
bool Running = false
 
FunctionGeneratorDefs::SweepDescType::SweepType CurrentSweepType = FunctionGeneratorDefs::SweepDescType::SweepType::Disabled
 

Friends

class RS_SMC100ATasks::UpdateTask
 
class RS_SMC100ATasks::SetSweepTask
 

Additional Inherited Members

- 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 116 of file RS_SMC100A.h.

Constructor & Destructor Documentation

◆ RS_SMC100AData()

DynExpInstr::RS_SMC100AData::RS_SMC100AData ( size_t  BufferSizeInSamples = 0)
inline

Definition at line 122 of file RS_SMC100A.h.

◆ ~RS_SMC100AData()

virtual DynExpInstr::RS_SMC100AData::~RS_SMC100AData ( )
virtualdefault

Member Function Documentation

◆ GetCurrentSweepType()

auto DynExpInstr::RS_SMC100AData::GetCurrentSweepType ( ) const
inlinenoexcept

Definition at line 126 of file RS_SMC100A.h.

◆ IsRunning()

bool DynExpInstr::RS_SMC100AData::IsRunning ( ) const
inlinenoexcept

Definition at line 125 of file RS_SMC100A.h.

◆ ResetImpl() [1/2]

void DynExpInstr::RS_SMC100AData::ResetImpl ( dispatch_tag< FunctionGeneratorData )
finaloverrideprivatevirtual

Reimplemented from DynExpInstr::FunctionGeneratorData.

Definition at line 268 of file RS_SMC100A.cpp.

◆ ResetImpl() [2/2]

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

Definition at line 132 of file RS_SMC100A.h.

Friends And Related Function Documentation

◆ RS_SMC100ATasks::SetSweepTask

friend class RS_SMC100ATasks::SetSweepTask
friend

Definition at line 119 of file RS_SMC100A.h.

◆ RS_SMC100ATasks::UpdateTask

friend class RS_SMC100ATasks::UpdateTask
friend

Definition at line 118 of file RS_SMC100A.h.

Member Data Documentation

◆ CurrentSweepType

Definition at line 136 of file RS_SMC100A.h.

◆ HardwareAdapter

Definition at line 128 of file RS_SMC100A.h.

◆ NumFailedStatusUpdateAttempts

size_t DynExpInstr::RS_SMC100AData::NumFailedStatusUpdateAttempts = 0
private

Definition at line 134 of file RS_SMC100A.h.

◆ Running

bool DynExpInstr::RS_SMC100AData::Running = false
private

Definition at line 135 of file RS_SMC100A.h.


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