Inheritance diagram for DynExpHardware::NIDAQHardwareAdapterParams:

Public Types
enum	ChannelModeType { TaskPerChannel , CombineChannels }

enum	TriggerModeType { Disabled , RisingEdge , FallingEdge }

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 >

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

virtual	~NIDAQHardwareAdapterParams ()=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::HardwareAdapterParamsBase
	HardwareAdapterParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the parameters for a `HardwareAdapterBase` instance. More...

virtual	~HardwareAdapterParamsBase ()=0

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

Static Public Member Functions
static Util::TextValueListType< ChannelModeType >	ChannelModeTypeStrList ()

static Util::TextValueListType< TriggerModeType >	TriggerModeTypeStrList ()

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...

Public Attributes
DynExp::ParamsBase::Param< ChannelModeType >	ChannelMode

DynExpInstr::StreamSizeParamsExtension	StreamSizeParams

DynExpInstr::NumericSampleStreamParamsExtension	NumericSampleStreamParams

DynExp::ParamsBase::Param< TriggerModeType >	TriggerMode

DynExp::ParamsBase::Param< ParamsConfigDialog::TextType >	TriggerChannel

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

virtual void	ConfigureParamsImpl (dispatch_tag< NIDAQHardwareAdapterParams >)

Additional Inherited Members
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 57 of file HardwareAdapterNIDAQ.h.

Member Enumeration Documentation

◆ ChannelModeType

enum DynExpHardware::NIDAQHardwareAdapterParams::ChannelModeType

Enumerator
TaskPerChannel
CombineChannels

Definition at line 60 of file HardwareAdapterNIDAQ.h.

◆ TriggerModeType

enum DynExpHardware::NIDAQHardwareAdapterParams::TriggerModeType

Enumerator
Disabled
RisingEdge
FallingEdge

Definition at line 61 of file HardwareAdapterNIDAQ.h.

Constructor & Destructor Documentation

◆ NIDAQHardwareAdapterParams()

DynExpHardware::NIDAQHardwareAdapterParams::NIDAQHardwareAdapterParams	(	DynExp::ItemIDType	ID,
		const DynExp::DynExpCore &	Core
	)

inline

Definition at line 66 of file HardwareAdapterNIDAQ.h.

◆ ~NIDAQHardwareAdapterParams()

virtual DynExpHardware::NIDAQHardwareAdapterParams::~NIDAQHardwareAdapterParams ( )

virtualdefault

Member Function Documentation

◆ ChannelModeTypeStrList()

Util::TextValueListType< NIDAQHardwareAdapterParams::ChannelModeType > DynExpHardware::NIDAQHardwareAdapterParams::ChannelModeTypeStrList ( )

static

Definition at line 23 of file HardwareAdapterNIDAQ.cpp.

◆ ConfigureParamsImpl() [1/2]

void DynExpHardware::NIDAQHardwareAdapterParams::ConfigureParamsImpl ( dispatch_tag< HardwareAdapterParamsBase > )

inlinefinaloverrideprivate

Definition at line 85 of file HardwareAdapterNIDAQ.h.

◆ ConfigureParamsImpl() [2/2]

virtual void DynExpHardware::NIDAQHardwareAdapterParams::ConfigureParamsImpl ( dispatch_tag< NIDAQHardwareAdapterParams > )

inlineprivatevirtual

Definition at line 86 of file HardwareAdapterNIDAQ.h.

◆ GetParamClassTag()

virtual const char* DynExpHardware::NIDAQHardwareAdapterParams::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::HardwareAdapterParamsBase.

Definition at line 70 of file HardwareAdapterNIDAQ.h.

◆ TriggerModeTypeStrList()

Util::TextValueListType< NIDAQHardwareAdapterParams::TriggerModeType > DynExpHardware::NIDAQHardwareAdapterParams::TriggerModeTypeStrList ( )

static

Definition at line 33 of file HardwareAdapterNIDAQ.cpp.

Member Data Documentation

◆ ChannelMode

DynExp::ParamsBase::Param<ChannelModeType> DynExpHardware::NIDAQHardwareAdapterParams::ChannelMode

Initial value:

= { *this, ChannelModeTypeStrList(), "ChannelMode", "Channel mode",
            "If timing is configured for multiple channels (stream size > 1 sample), they have to be combined into a number of NI-DAQmx tasks limited by the amount of the respective device's clocks.",
            true, ChannelModeType::TaskPerChannel }

Definition at line 72 of file HardwareAdapterNIDAQ.h.

◆ NumericSampleStreamParams

DynExpInstr::NumericSampleStreamParamsExtension DynExpHardware::NIDAQHardwareAdapterParams::NumericSampleStreamParams

Definition at line 77 of file HardwareAdapterNIDAQ.h.

◆ StreamSizeParams

DynExpInstr::StreamSizeParamsExtension DynExpHardware::NIDAQHardwareAdapterParams::StreamSizeParams

Definition at line 76 of file HardwareAdapterNIDAQ.h.

◆ TriggerChannel

DynExp::ParamsBase::Param<ParamsConfigDialog::TextType> DynExpHardware::NIDAQHardwareAdapterParams::TriggerChannel

Initial value:

= { *this, "TriggerChannelName", "Trigger channel name",

"Path of the trigger channel to be used for triggering (ignored if triggering is disabled)", true, "/Dev1/PFI0" }

Definition at line 81 of file HardwareAdapterNIDAQ.h.

◆ TriggerMode

DynExp::ParamsBase::Param<TriggerModeType> DynExpHardware::NIDAQHardwareAdapterParams::TriggerMode

Initial value:

= { *this, TriggerModeTypeStrList(), "TriggerMode", "Trigger mode",

"Trigger assigned to this channel to start sample generation/acquisition", true, TriggerModeType::Disabled }

DynExpHardware::NIDAQHardwareAdapterParams::TriggerModeTypeStrList

static Util::TextValueListType< TriggerModeType > TriggerModeTypeStrList()

Definition: HardwareAdapterNIDAQ.cpp:33

Definition at line 79 of file HardwareAdapterNIDAQ.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ChannelModeType

◆ TriggerModeType

Constructor & Destructor Documentation

◆ NIDAQHardwareAdapterParams()

◆ ~NIDAQHardwareAdapterParams()

Member Function Documentation

◆ ChannelModeTypeStrList()

◆ ConfigureParamsImpl() [1/2]

◆ ConfigureParamsImpl() [2/2]

◆ GetParamClassTag()

◆ TriggerModeTypeStrList()

Member Data Documentation

◆ ChannelMode

◆ NumericSampleStreamParams

◆ StreamSizeParams

◆ TriggerChannel

◆ TriggerMode