Data class for OutputPort. More...

#include <OutputPort.h>

Inheritance diagram for DynExpInstr::OutputPortData:

Public Member Functions
	OutputPortData (DataStreamBasePtrType &&SampleStream)
	Constructs a `DataStreamInstrumentData` instance.

virtual	~OutputPortData ()=default

Public Member Functions inherited from DynExpInstr::FunctionGeneratorData
	FunctionGeneratorData (DataStreamBasePtrType &&SampleStream)
	Constructs a `DataStreamInstrumentData` instance.

virtual	~FunctionGeneratorData ()=default

auto	GetCurrentWaveformType () const noexcept
	Returns CurrentWaveformType.

auto	GetCurrentFrequencyInHz () const noexcept
	Returns CurrentFrequencyInHz.

auto	GetCurrentAmplitude () const noexcept
	Returns CurrentAmplitude.

auto	GetCurrentOffset () const noexcept
	Returns CurrentOffset.

auto	GetCurrentPhaseInRad () const noexcept
	Returns CurrentPhaseInRad.

auto	GetCurrentDutyCycle () const noexcept
	Returns CurrentDutyCycle.

auto	GetCurrentTriggerMode () const noexcept
	Returns CurrentTriggerMode.

auto	GetCurrentTriggerEdge () const noexcept
	Returns CurrentTriggerEdge.

auto	GetShouldAutostart () const noexcept
	Returns ShouldAutostart.

auto	GetCurrentPulses () const noexcept
	Returns CurrentPulses.

Public Member Functions inherited from DynExpInstr::DataStreamInstrumentData
	DataStreamInstrumentData (DataStreamBasePtrType &&SampleStream)
	Constructs a `DataStreamInstrumentData` instance.

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.

template<typename T >
auto	GetCastSampleStream () const
	Casts the data stream instrument's sample stream to a derived data stream type.

ValueType	GetHardwareMinValue () const noexcept
	Returns HardwareMinValue.

ValueType	GetHardwareMaxValue () const noexcept
	Returns HardwareMaxValue.

UnitType	GetValueUnit () const noexcept
	Returns ValueUnit.

void	SetHardwareMinValue (ValueType Value) noexcept
	Sets HardwareMinValue.

void	SetHardwareMaxValue (ValueType Value) noexcept
	Sets HardwareMaxValue.

void	SetValueUnit (UnitType Unit) noexcept
	Sets ValueUnit.

Public Member Functions inherited from DynExp::InstrumentDataBase
	InstrumentDataBase ()

virtual	~InstrumentDataBase ()

auto	GetLastUpdateTime () const
	Getter for LastUpdate.

auto	GetException () const noexcept
	Getter for InstrumentDataBase::InstrumentException.

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.

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.

std::unique_ptr< TaskBase >	PopTaskFront ()
	Removes a task from the front of an instrument's task queue.

std::unique_ptr< TaskBase >	PopTaskBack ()
	Removes a task from the back of an instrument's task queue.

auto	GetTaskFront () noexcept
	Getter for first enqueued task.

auto	GetTaskBack () noexcept
	Getter for last enqueued task.

size_t	GetNumEnqueuedTasks () const noexcept
	Getter for the instrument task queue's length.

std::unique_ptr< TaskBase >	PopFinishedTask ()
	Removes a task from the front of an instrument's list of finished tasks.

size_t	GetNumFinishedTasks () const noexcept
	Getter for the length of the instrument's list of finished tasks.

bool	IsQueueClosed () const noexcept
	Determines whether the instrument task queue is closed.

Public Member Functions inherited from Util::INonCopyable
	INonCopyable (const INonCopyable &)=delete

INonCopyable &	operator= (const INonCopyable &)=delete

Private Member Functions
void	ResetImpl (dispatch_tag< FunctionGeneratorData >) override final

virtual void	ResetImpl (dispatch_tag< OutputPortData >)

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.

Public Types inherited from DynExp::InstrumentDataBase
using	TaskQueueType = std::list< std::unique_ptr< TaskBase > >
	Type of an instrument task queue owning the tasks within.

using	TaskQueueIteratorType = TaskQueueType::const_iterator
	Const iterator type to elements of `TaskQueueType`.

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.

Public Attributes inherited from DynExp::InstrumentDataBase
InstrumentBaseOnlyType	InstrumentBaseOnly
	Allow exclusive access to some of `InstrumentDataBase's` private methods to `InstrumentBase`.

InstrumenThreadOnlyType	InstrumentThreadOnly
	Allow exclusive access to some of `InstrumentDataBase's` private methods to the instrument thread `InstrumentThreadMain()`.

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

Data class for OutputPort.

Definition at line 97 of file OutputPort.h.

Constructor & Destructor Documentation

◆ OutputPortData()

DynExpInstr::OutputPortData::OutputPortData ( DataStreamBasePtrType && SampleStream )

inline

Constructs a DataStreamInstrumentData instance.

Parameters

SampleStream Data stream the related DataStreamInstrument instance operates on. The DataStreamInstrumentData instance takes ownership of the stream.

Exceptions

Util::InvalidArgException is thrown if SampleStream is nullptr.

Definition at line 103 of file OutputPort.h.

◆ ~OutputPortData()

virtual DynExpInstr::OutputPortData::~OutputPortData ( )

virtualdefault

Member Function Documentation

◆ ResetImpl() [1/2]

void DynExpInstr::OutputPortData::ResetImpl ( dispatch_tag< FunctionGeneratorData > )

finaloverrideprivatevirtual

Reimplemented from DynExpInstr::FunctionGeneratorData.

Definition at line 40 of file OutputPort.cpp.

◆ ResetImpl() [2/2]

virtual void DynExpInstr::OutputPortData::ResetImpl ( dispatch_tag< OutputPortData > )

inlineprivatevirtual

Reimplemented in DynExpInstr::AnalogOutData, and DynExpInstr::DigitalOutData.

Definition at line 109 of file OutputPort.h.

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

Public Member Functions

Private Member Functions