Parameter class for FunctionGenerator. More...

Inheritance diagram for DynExpInstr::FunctionGeneratorParams:

Public Member Functions
	FunctionGeneratorParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
	Constructs the parameters for a `FunctionGenerator` instance. More...

virtual	~FunctionGeneratorParams ()=0

virtual const char *	GetParamClassTag () const noexcept override
	This function is intended to be overridden once in each derived class returning the name of the respective class. Parameters defined in any class within the ParamsBase hierarchy will receive a 'this' pointer pointing to ParamsBase when their ParamBase constructors are called. The ParamBase constructors will register the respective parameter in ParamsBase::OwnedParams calling GetParamClassTag() on the given 'this' pointer. This allows the ParamBase constructor to obtain the name of the class where the respective parameter was declared in. The name is used as an XML tag containing related parameters in the project files. Here, it is fully intended that the virtual call to GetParamClassTag() leads only to a call of GetParamClassTag() of the current dynamic type of ParamsBase! More...

Public Member Functions inherited from DynExpInstr::DataStreamInstrumentParams
	DataStreamInstrumentParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
	Constructs the parameters for a `DataStreamInstrument` instance. More...

virtual	~DataStreamInstrumentParams ()=0

Public Member Functions inherited from DynExp::InstrumentParamsBase
	InstrumentParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the parameters for a `InstrumentBase` instance. More...

virtual	~InstrumentParamsBase ()=0

Public Member Functions inherited from DynExp::RunnableObjectParams
	RunnableObjectParams (ItemIDType ID, const DynExpCore &Core)
	Constructs the base class of an object parameter class. More...

virtual	~RunnableObjectParams ()=0

bool	ConfigureStartupType () const noexcept
	Determines whether the `Startup` parameter should be user-configurable in settings dialogs. Override `ConfigureStartupTypeChild()` in order to adjust. More...

Public Member Functions inherited from DynExp::ParamsBase
	ParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the base class of an object parameter class. More...

virtual	~ParamsBase ()=0

QDomElement	ConfigToXML (QDomDocument &Document) const
	Creates an XML node with a tag name as determined by GetParamClassTag() containing all parameters belonging to this ParamsBase instance. More...

void	ConfigFromXML (const QDomElement &XMLElement) const
	Retrieves all parameters belonging to this ParamsBase instance from an XML node with a tag name as determined by GetParamClassTag() More...

void	ConfigFromDialog (ParamsConfigDialog &Dialog)
	Adds all parameters belonging to this ParamsBase instance to a settings dialog to let the user configure the parameter values. More...

bool	Validate () const
	Refer to ParamBase::Validate(). More...

ItemIDType	GetID () const noexcept
	Returns the ID of the `Object` this parameter class instance belongs to. More...

const auto &	GetCore () const noexcept
	Returns a reference to DynExp's core. More...

const auto &	GetObjectLinkParams () const noexcept
	Returns a list of all object link parameters owned by this parameter class instance. More...

bool	ConfigureUsageType () const noexcept
	Determines whether the Usage parameter should be configurable in the settings dialog. Override ConfigureUsageTypeChild() in order to adjust. More...

const NetworkParamsExtension *	GetNetworkAddressParams () const noexcept
	Returns the network address parameters of a derived gRPC instrument. Override GetNetworkAddressParamsChild() in order to adjust. More...

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

INonCopyable &	operator= (const INonCopyable &)=delete

Public Attributes
Param< FunctionGeneratorDefs::WaveformTypes >	WaveformType = { *this, "WaveformTypes", FunctionGeneratorDefs::WaveformTypes::None }
	Parameter to store the waveform type. More...

Param< double >	FrequencyInHz
	Parameter to store waveform's frequency in Hz. Refer to FunctionGeneratorDefs::FunctionDescType::FrequencyInHz. More...

Param< double >	Amplitude
	Parameter to store waveform's amplitude. Refer to FunctionGeneratorDefs::FunctionDescType::Amplitude. More...

Param< double >	Offset
	Parameter to store waveform's offset to be added to each sample. Refer to FunctionGeneratorDefs::FunctionDescType::Offset. More...

Param< double >	PhaseInRad = { this, "PhaseInRad", 0, 0, 2.0 std::numbers::pi }
	Parameter to store waveform's phase in radians. Refer to FunctionGeneratorDefs::SineFunctionDescType::PhaseInRad, FunctionGeneratorDefs::RectFunctionDescType::PhaseInRad, and FunctionGeneratorDefs::RampFunctionDescType::PhaseInRad. More...

Param< double >	DutyCycle = { *this, "DutyCycle", .5, 0, 1 }
	Parameter to store waveform's duty cycle or rise/fall ratio. Refer to FunctionGeneratorDefs::RectFunctionDescType::DutyCycle and FunctionGeneratorDefs::RampFunctionDescType::RiseFallRatio. More...

ListParam< double >	PulseStarts = { *this, "PulseStarts", {}, 0}
	Parameter to store the start times of the waveform's pulse segments. Refer to FunctionGeneratorDefs::PulsesDescType::PulsesDescType(const std::vector<double>&, const std::vector<double>&, double). More...

ListParam< double >	PulseAmplitudes = { *this, "PulseAmplitudes", {} }
	Parameter to store the amplitudes of the waveform's pulse segments. Refer to FunctionGeneratorDefs::PulsesDescType::PulsesDescType(const std::vector<double>&, const std::vector<double>&, double). More...

Param< FunctionGeneratorDefs::TriggerDescType::TriggerModeType >	TriggerMode = { *this, "TriggerMode", FunctionGeneratorDefs::TriggerDescType::TriggerModeType::Continuous }
	Parameter to store the trigger mode. More...

Param< FunctionGeneratorDefs::TriggerDescType::TriggerEdgeType >	TriggerEdge = { *this, "TriggerEdge", FunctionGeneratorDefs::TriggerDescType::TriggerEdgeType::Rise }
	Parameter to store the edge type to trigger on. More...

Param< bool >	Autostart = { *this, "Autostart", false }
	Determines whether to directly make the underlying hardware device start generating the waveform after the instrument's initialization (true) or whether to await a trigger/start signal (false). More...

Public Attributes inherited from DynExp::RunnableObjectParams
Param< StartupType >	Startup
	Determines when the runnable object is started. Refer to RunnableObjectParams::StartupType. More...

Public Attributes inherited from DynExp::ParamsBase
Param< ParamsConfigDialog::TextType >	ObjectName = { *this, "ObjectName", "Name", "Name to identify this item", false }
	String set by the user to identify the object this parameter class instance belongs to. More...

Param< UsageType >	Usage
	Determines whether an object can be used by only one other ("unique") or by multiple other ("shared") objects. More...

Private Member Functions
void	ConfigureParamsImpl (dispatch_tag< DataStreamInstrumentParams >) override final
	Called by DynExp::ParamsBase::ConfigureParams() as a starting point for the tag dispatch mechanism to descend the inheritance hierarchy. Override to add functionality to ConfigureParams(). Refer to DynExp::ParamsBase::dispatch_tag. More...

virtual void	ConfigureParamsImpl (dispatch_tag< FunctionGeneratorParams >)
	Called by DynExp::ParamsBase::ConfigureParams() as a starting point for the tag dispatch mechanism to descend the inheritance hierarchy. Override to add functionality to ConfigureParams(). Refer to DynExp::ParamsBase::dispatch_tag. More...

Additional Inherited Members
Public Types inherited from DynExp::RunnableObjectParams
enum	StartupType { OnCreation , Automatic , Manual }
	Determines when a `RunnableObject` instance is started. More...

Public Types inherited from DynExp::ParamsBase
enum	UsageType { Unique , Shared }
	Determines whether an `Object` can be linked to only one (unique) or multiple (shared) other objects. More...

using	ObjectLinkParamsType = std::vector< std::reference_wrapper< LinkBase > >
	Type of a list of all owned object link parameters. More...

using	EnumParamSignedIntegerType = intmax_t
	Parameter type to convert signed eumeration parameters to. More...

using	EnumParamUnsignedIntegerType = uintmax_t
	Parameter type to convert unsigned eumeration parameters to. More...

template<typename EnumType >
using	LargestEnumUnderlyingType = std::conditional_t< std::is_signed_v< std::underlying_type_t< EnumType > >, EnumParamSignedIntegerType, EnumParamUnsignedIntegerType >
	Type trait providing an integer type for enumeration types which allows to store the value of enumeration variables of that type in a file. More...

using	Text = Util::TextType
	String type of text-type parameters (DynExp::ParamsBase::Param) More...

template<typename ArithmeticType >
using	UnderlyingArithmeticParamType = TypedParamBase< ArithmeticType >

using	UnderlyingTextParamType = TypedParamBase< Util::TextType >

using	UnderlyingTextListParamType = TypedParamBase< Util::TextType >

using	UnderlyingIndexedTextListParamType = TypedParamBase< Util::TextListIndexType >

template<typename EnumType >
using	UnderlyingEnumParamType = TypedParamBase< LargestEnumUnderlyingType< EnumType > >
	If `ParamType` is an enum, then use largest signed/unsigned integral type as the underlying type since the enum's underlying type has to be integral. More...

using	UnderlyingLinkParamType = TypedParamBase< ItemIDType >

template<typename ArithmeticType >
using	UnderlyingArithmeticListParamType = TypedListParamBase< ArithmeticType >

using	UnderlyingLinkListParamType = TypedListParamBase< ItemIDType >

Static Public Member Functions inherited from DynExp::RunnableObjectParams
static Util::TextValueListType< StartupType >	AvlblStartupTypeStrList ()
	Maps description strings to the RunnableObjectParams::StartupType enum's items. More...

Static Public Member Functions inherited from DynExp::ParamsBase
static Util::TextValueListType< UsageType >	AvlblUsageTypeStrList ()
	Maps description strings to the ParamsBase::UsageType enum's items. More...

static void	DisableUserEditable (ParamBase &Param) noexcept
	Sets the `UserEditable` property of the parameter `Param` to false. Refer to ParamBase::UserEditable. 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

Parameter class for FunctionGenerator.

Definition at line 628 of file FunctionGenerator.h.

Constructor & Destructor Documentation

◆ FunctionGeneratorParams()

DynExpInstr::FunctionGeneratorParams::FunctionGeneratorParams	(	DynExp::ItemIDType	ID,
		const DynExp::DynExpCore &	Core
	)

inline

Constructs the parameters for a FunctionGenerator instance.

Parameters

ID	ID of the `Object` this parameter class instance belongs to
Core	Reference to DynExp's core

Definition at line 635 of file FunctionGenerator.h.

◆ ~FunctionGeneratorParams()

DynExpInstr::FunctionGeneratorParams::~FunctionGeneratorParams ( )

pure virtual

Definition at line 289 of file FunctionGenerator.cpp.

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

void DynExpInstr::FunctionGeneratorParams::ConfigureParamsImpl ( dispatch_tag< DataStreamInstrumentParams > )

inlinefinaloverrideprivatevirtual

Called by DynExp::ParamsBase::ConfigureParams() as a starting point for the tag dispatch mechanism to descend the inheritance hierarchy. Override to add functionality to ConfigureParams(). Refer to DynExp::ParamsBase::dispatch_tag.

Reimplemented from DynExpInstr::DataStreamInstrumentParams.

Definition at line 706 of file FunctionGenerator.h.

◆ ConfigureParamsImpl() [2/2]

virtual void DynExpInstr::FunctionGeneratorParams::ConfigureParamsImpl ( dispatch_tag< FunctionGeneratorParams > )

inlineprivatevirtual

Called by DynExp::ParamsBase::ConfigureParams() as a starting point for the tag dispatch mechanism to descend the inheritance hierarchy. Override to add functionality to ConfigureParams(). Refer to DynExp::ParamsBase::dispatch_tag.

Reimplemented in DynExpInstr::OutputPortParams, DynExpInstr::SwabianInstrumentsPulseStreamerParams, DynExpInstr::RS_SMC100AParams, DynExpInstr::RS_SMB100BParams, and DynExpInstr::DummyDataStreamInstrumentParams.

Definition at line 707 of file FunctionGenerator.h.

◆ GetParamClassTag()

virtual const char* DynExpInstr::FunctionGeneratorParams::GetParamClassTag ( ) const

inlineoverridevirtualnoexcept

This function is intended to be overridden once in each derived class returning the name of the respective class. Parameters defined in any class within the ParamsBase hierarchy will receive a 'this' pointer pointing to ParamsBase when their ParamBase constructors are called. The ParamBase constructors will register the respective parameter in ParamsBase::OwnedParams calling GetParamClassTag() on the given 'this' pointer. This allows the ParamBase constructor to obtain the name of the class where the respective parameter was declared in. The name is used as an XML tag containing related parameters in the project files. Here, it is fully intended that the virtual call to GetParamClassTag() leads only to a call of GetParamClassTag() of the current dynamic type of ParamsBase!

Returns: Name of the class this function is defined in

Reimplemented from DynExpInstr::DataStreamInstrumentParams.

Reimplemented in DynExpInstr::OutputPortParams, DynExpInstr::DigitalOutParams, DynExpInstr::AnalogOutParams, DynExpInstr::SwabianInstrumentsPulseStreamerParams, DynExpInstr::RS_SMC100AParams, DynExpInstr::RS_SMB100BParams, DynExpInstr::NIDAQDigitalOutParams, DynExpInstr::NIDAQAnalogOutParams, and DynExpInstr::DummyDataStreamInstrumentParams.

Definition at line 639 of file FunctionGenerator.h.

Member Data Documentation

◆ Amplitude

Param<double> DynExpInstr::FunctionGeneratorParams::Amplitude

Initial value:

= { *this, "Amplitude", FunctionGeneratorDefs::GetDefaultDefaultFunctionDesc().Amplitude,

FunctionGeneratorDefs::GetDefaultMinFunctionDesc().Amplitude, FunctionGeneratorDefs::GetDefaultMaxFunctionDesc().Amplitude }

DynExpInstr::FunctionGeneratorDefs::GetDefaultMinFunctionDesc

constexpr FunctionDescType GetDefaultMinFunctionDesc()

Determines minimal values assignable to a description of a generic periodic function.

Definition: FunctionGenerator.h:325

DynExpInstr::FunctionGeneratorDefs::GetDefaultMaxFunctionDesc

constexpr FunctionDescType GetDefaultMaxFunctionDesc()

Determines maximal values assignable to a description of a generic periodic function.

Definition: FunctionGenerator.h:331

DynExpInstr::FunctionGeneratorDefs::GetDefaultDefaultFunctionDesc

constexpr FunctionDescType GetDefaultDefaultFunctionDesc()

Determines default values to assign to a description of a generic periodic function.

Definition: FunctionGenerator.h:337

DynExpInstr::FunctionGeneratorDefs::FunctionDescType::Amplitude

double Amplitude

Amplitude of the function.

Definition: FunctionGenerator.h:51

Parameter to store waveform's amplitude. Refer to FunctionGeneratorDefs::FunctionDescType::Amplitude.

Definition at line 655 of file FunctionGenerator.h.

◆ Autostart

Param<bool> DynExpInstr::FunctionGeneratorParams::Autostart = { *this, "Autostart", false }

Determines whether to directly make the underlying hardware device start generating the waveform after the instrument's initialization (true) or whether to await a trigger/start signal (false).

Definition at line 703 of file FunctionGenerator.h.

◆ DutyCycle

Param<double> DynExpInstr::FunctionGeneratorParams::DutyCycle = { *this, "DutyCycle", .5, 0, 1 }

Parameter to store waveform's duty cycle or rise/fall ratio. Refer to FunctionGeneratorDefs::RectFunctionDescType::DutyCycle and FunctionGeneratorDefs::RampFunctionDescType::RiseFallRatio.

Definition at line 674 of file FunctionGenerator.h.

◆ FrequencyInHz

Param<double> DynExpInstr::FunctionGeneratorParams::FrequencyInHz

Initial value:

= { *this, "FrequencyInHz", FunctionGeneratorDefs::GetDefaultDefaultFunctionDesc().FrequencyInHz,

FunctionGeneratorDefs::GetDefaultMinFunctionDesc().FrequencyInHz, FunctionGeneratorDefs::GetDefaultMaxFunctionDesc().FrequencyInHz }

DynExpInstr::FunctionGeneratorDefs::FunctionDescType::FrequencyInHz

double FrequencyInHz

Frequency of the function in Hz.

Definition: FunctionGenerator.h:50

Parameter to store waveform's frequency in Hz. Refer to FunctionGeneratorDefs::FunctionDescType::FrequencyInHz.

Definition at line 649 of file FunctionGenerator.h.

◆ Offset

Param<double> DynExpInstr::FunctionGeneratorParams::Offset

Initial value:

= { *this, "Offset", FunctionGeneratorDefs::GetDefaultDefaultFunctionDesc().Offset,

FunctionGeneratorDefs::GetDefaultMinFunctionDesc().Offset, FunctionGeneratorDefs::GetDefaultMaxFunctionDesc().Offset }

DynExpInstr::FunctionGeneratorDefs::FunctionDescType::Offset

double Offset

Offset of the function to be added to each sample.

Definition: FunctionGenerator.h:52

Parameter to store waveform's offset to be added to each sample. Refer to FunctionGeneratorDefs::FunctionDescType::Offset.

Definition at line 661 of file FunctionGenerator.h.

◆ PhaseInRad

Param<double> DynExpInstr::FunctionGeneratorParams::PhaseInRad = { *this, "PhaseInRad", 0, 0, 2.0 * std::numbers::pi }

Parameter to store waveform's phase in radians. Refer to FunctionGeneratorDefs::SineFunctionDescType::PhaseInRad, FunctionGeneratorDefs::RectFunctionDescType::PhaseInRad, and FunctionGeneratorDefs::RampFunctionDescType::PhaseInRad.

Definition at line 668 of file FunctionGenerator.h.

◆ PulseAmplitudes

ListParam<double> DynExpInstr::FunctionGeneratorParams::PulseAmplitudes = { *this, "PulseAmplitudes", {} }

Parameter to store the amplitudes of the waveform's pulse segments. Refer to FunctionGeneratorDefs::PulsesDescType::PulsesDescType(const std::vector<double>&, const std::vector<double>&, double).

Definition at line 686 of file FunctionGenerator.h.

◆ PulseStarts

ListParam<double> DynExpInstr::FunctionGeneratorParams::PulseStarts = { *this, "PulseStarts", {}, 0}

Parameter to store the start times of the waveform's pulse segments. Refer to FunctionGeneratorDefs::PulsesDescType::PulsesDescType(const std::vector<double>&, const std::vector<double>&, double).

Definition at line 680 of file FunctionGenerator.h.

◆ TriggerEdge

Param<FunctionGeneratorDefs::TriggerDescType::TriggerEdgeType> DynExpInstr::FunctionGeneratorParams::TriggerEdge = { *this, "TriggerEdge", FunctionGeneratorDefs::TriggerDescType::TriggerEdgeType::Rise }

Parameter to store the edge type to trigger on.

Definition at line 696 of file FunctionGenerator.h.

◆ TriggerMode

Param<FunctionGeneratorDefs::TriggerDescType::TriggerModeType> DynExpInstr::FunctionGeneratorParams::TriggerMode = { *this, "TriggerMode", FunctionGeneratorDefs::TriggerDescType::TriggerModeType::Continuous }

Parameter to store the trigger mode.

Definition at line 691 of file FunctionGenerator.h.

◆ WaveformType

Param<FunctionGeneratorDefs::WaveformTypes> DynExpInstr::FunctionGeneratorParams::WaveformType = { *this, "WaveformTypes", FunctionGeneratorDefs::WaveformTypes::None }

Parameter to store the waveform type.

Definition at line 644 of file FunctionGenerator.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FunctionGeneratorParams()

◆ ~FunctionGeneratorParams()

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

◆ ConfigureParamsImpl() [2/2]

◆ GetParamClassTag()

Member Data Documentation

◆ Amplitude

◆ Autostart

◆ DutyCycle

◆ FrequencyInHz

◆ Offset

◆ PhaseInRad

◆ PulseAmplitudes

◆ PulseStarts

◆ TriggerEdge

◆ TriggerMode

◆ WaveformType