Inheritance diagram for DynExpModule::ArbitraryFunctionFromCSVParams:

Public Member Functions
	ArbitraryFunctionFromCSVParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)

virtual	~ArbitraryFunctionFromCSVParams ()=default

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 DynExp::ModuleParamsBase
	ModuleParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the parameters for a `ModuleBase` instance. More...

virtual	~ModuleParamsBase ()=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< DynExp::ObjectLink< DynExpInstr::FunctionGenerator > >	FunctionGenerator

Param< ParamsConfigDialog::TextType >	CSVDataPath

Param< ParamsConfigDialog::NumberType >	SkipLines

Param< ParamsConfigDialog::NumberType >	TimeStretch

Param< ParamsConfigDialog::NumberType >	TimeOffset

Param< ParamsConfigDialog::NumberType >	ValueStretch

Param< ParamsConfigDialog::NumberType >	ValueOffset

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< ModuleParamsBase >) override final

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

Definition at line 34 of file ArbitraryFunctionFromCSV.h.

Constructor & Destructor Documentation

◆ ArbitraryFunctionFromCSVParams()

DynExpModule::ArbitraryFunctionFromCSVParams::ArbitraryFunctionFromCSVParams	(	DynExp::ItemIDType	ID,
		const DynExp::DynExpCore &	Core
	)

inline

Definition at line 37 of file ArbitraryFunctionFromCSV.h.

◆ ~ArbitraryFunctionFromCSVParams()

virtual DynExpModule::ArbitraryFunctionFromCSVParams::~ArbitraryFunctionFromCSVParams ( )

virtualdefault

Member Function Documentation

◆ ConfigureParamsImpl()

void DynExpModule::ArbitraryFunctionFromCSVParams::ConfigureParamsImpl ( dispatch_tag< ModuleParamsBase > )

inlinefinaloverrideprivate

Definition at line 63 of file ArbitraryFunctionFromCSV.h.

◆ GetParamClassTag()

virtual const char* DynExpModule::ArbitraryFunctionFromCSVParams::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 DynExp::ModuleParamsBase.

Definition at line 40 of file ArbitraryFunctionFromCSV.h.

Member Data Documentation

◆ CSVDataPath

Param<ParamsConfigDialog::TextType> DynExpModule::ArbitraryFunctionFromCSVParams::CSVDataPath

Initial value:

= { *this, "CSVDataPath", "CSV data path",

"Path to a CSV file containing the arbitrary function data as a single column (values) or as two columns (times;values)", true, "", DynExp::TextUsageType::Code }

DynExp::TextUsageType::Code

@ Code

Definition at line 44 of file ArbitraryFunctionFromCSV.h.

◆ FunctionGenerator

Param<DynExp::ObjectLink<DynExpInstr::FunctionGenerator> > DynExpModule::ArbitraryFunctionFromCSVParams::FunctionGenerator

Initial value:

= { *this, GetCore().GetInstrumentManager(),

"FunctionGenerator", "Function generator", "Underlying data stream instrument to be used as a function generator", DynExpUI::Icons::Instrument }

DynExp::ParamsBase::GetCore

const auto & GetCore() const noexcept

Returns a reference to DynExp's core.

Definition: Object.h:1677

DynExpUI::Icons::Instrument

constexpr auto Instrument

Definition: DynExpDefinitions.h.in:75

Definition at line 42 of file ArbitraryFunctionFromCSV.h.

◆ SkipLines

Param<ParamsConfigDialog::NumberType> DynExpModule::ArbitraryFunctionFromCSVParams::SkipLines

Initial value:

= { *this, "SkipLines", "Skip lines",
            "Number of (header) lines to skip at the beginning of the file", true,
            0, 0, std::numeric_limits<ParamsConfigDialog::NumberType>::max(), 1, 0 }

Definition at line 46 of file ArbitraryFunctionFromCSV.h.

◆ TimeOffset

Param<ParamsConfigDialog::NumberType> DynExpModule::ArbitraryFunctionFromCSVParams::TimeOffset

Initial value:

= { *this, "TimeOffset", "Time offset",
            "Offset to add to all times", true,
            0, std::numeric_limits<ParamsConfigDialog::NumberType>::lowest(), std::numeric_limits<ParamsConfigDialog::NumberType>::max(), .1, 3 }

Definition at line 52 of file ArbitraryFunctionFromCSV.h.

◆ TimeStretch

Param<ParamsConfigDialog::NumberType> DynExpModule::ArbitraryFunctionFromCSVParams::TimeStretch

Initial value:

= { *this, "TimeStretch", "Time stretch",
            "Factor to multiply all times with", true,
            1, std::numeric_limits<ParamsConfigDialog::NumberType>::lowest(), std::numeric_limits<ParamsConfigDialog::NumberType>::max(), .1, 3 }

Definition at line 49 of file ArbitraryFunctionFromCSV.h.

◆ ValueOffset

Param<ParamsConfigDialog::NumberType> DynExpModule::ArbitraryFunctionFromCSVParams::ValueOffset

Initial value:

= { *this, "ValueOffset", "Value offset",
            "Offset to add to all values", true,
            0, std::numeric_limits<ParamsConfigDialog::NumberType>::lowest(), std::numeric_limits<ParamsConfigDialog::NumberType>::max(), .1, 3 }

Definition at line 58 of file ArbitraryFunctionFromCSV.h.

◆ ValueStretch

Param<ParamsConfigDialog::NumberType> DynExpModule::ArbitraryFunctionFromCSVParams::ValueStretch

Initial value:

= { *this, "ValueStretch", "Value stretch",
            "Factor to multiply all values with", true,
            1, std::numeric_limits<ParamsConfigDialog::NumberType>::lowest(), std::numeric_limits<ParamsConfigDialog::NumberType>::max(), .1, 3 }

Definition at line 55 of file ArbitraryFunctionFromCSV.h.

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

ArbitraryFunctionFromCSV.h

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArbitraryFunctionFromCSVParams()

◆ ~ArbitraryFunctionFromCSVParams()

Member Function Documentation

◆ ConfigureParamsImpl()

◆ GetParamClassTag()

Member Data Documentation

◆ CSVDataPath

◆ FunctionGenerator

◆ SkipLines

◆ TimeOffset

◆ TimeStretch

◆ ValueOffset

◆ ValueStretch