Inheritance diagram for DynExpHardware::QutoolsTDCHardwareAdapterParams:

Public Types
enum	EdgeType { 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
	QutoolsTDCHardwareAdapterParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)

virtual	~QutoolsTDCHardwareAdapterParams ()=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< EdgeType >	EdgeTypeStrList ()

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
Param< TextList >	DeviceDescriptor

Param< ParamsConfigDialog::NumberType >	DefaultTimestampBufferSize

Param< ParamsConfigDialog::NumberType >	DefaultThresholdInVolts

Param< EdgeType >	DefaultTriggerEdge

Param< ParamsConfigDialog::NumberType >	DefaultExposureTime

Param< ParamsConfigDialog::NumberType >	DefaultCoincidenceWindow

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< QutoolsTDCHardwareAdapterParams >)

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 35 of file HardwareAdapterQutoolsTDC.h.

Member Enumeration Documentation

◆ EdgeType

enum DynExpHardware::QutoolsTDCHardwareAdapterParams::EdgeType

Enumerator
RisingEdge
FallingEdge

Definition at line 38 of file HardwareAdapterQutoolsTDC.h.

Constructor & Destructor Documentation

◆ QutoolsTDCHardwareAdapterParams()

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

inline

Definition at line 42 of file HardwareAdapterQutoolsTDC.h.

◆ ~QutoolsTDCHardwareAdapterParams()

virtual DynExpHardware::QutoolsTDCHardwareAdapterParams::~QutoolsTDCHardwareAdapterParams ( )

virtualdefault

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

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

finaloverrideprivate

Definition at line 44 of file HardwareAdapterQutoolsTDC.cpp.

◆ ConfigureParamsImpl() [2/2]

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

inlineprivatevirtual

Definition at line 67 of file HardwareAdapterQutoolsTDC.h.

◆ EdgeTypeStrList()

Util::TextValueListType< QutoolsTDCHardwareAdapterParams::EdgeType > DynExpHardware::QutoolsTDCHardwareAdapterParams::EdgeTypeStrList ( )

static

Definition at line 34 of file HardwareAdapterQutoolsTDC.cpp.

◆ GetParamClassTag()

virtual const char* DynExpHardware::QutoolsTDCHardwareAdapterParams::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 45 of file HardwareAdapterQutoolsTDC.h.

Member Data Documentation

◆ DefaultCoincidenceWindow

Param<ParamsConfigDialog::NumberType> DynExpHardware::QutoolsTDCHardwareAdapterParams::DefaultCoincidenceWindow

Initial value:

= { *this, "DefaultCoincidenceWindowInPs", "Default coincidence window (ps)",
            "Time interval in which events are considered to be coincident (default value - can be changed by instruments).",
            false, 1000, 1, std::numeric_limits<ParamsConfigDialog::NumberType>::max(), 100, 0 }

Definition at line 61 of file HardwareAdapterQutoolsTDC.h.

◆ DefaultExposureTime

Param<ParamsConfigDialog::NumberType> DynExpHardware::QutoolsTDCHardwareAdapterParams::DefaultExposureTime

Initial value:

= { *this, "DefaultExposureTimeInMs", "Default exposure time (ms)",
            "Exposure time denoting an interval in which events are accumulated (default value - can be changed by instruments).",
            false, 1000, 1, 65535, 100, 0 }

Definition at line 58 of file HardwareAdapterQutoolsTDC.h.

◆ DefaultThresholdInVolts

Param<ParamsConfigDialog::NumberType> DynExpHardware::QutoolsTDCHardwareAdapterParams::DefaultThresholdInVolts

Initial value:

= { *this, "DefaultThresholdInVolts", "Default trigger threshold (V)",
            "Determines on which voltage of the connected signal to trigger (default value - can be changed by instruments).",
            false, 1, -2, 3, .1, 3 }

Definition at line 52 of file HardwareAdapterQutoolsTDC.h.

◆ DefaultTimestampBufferSize

Param<ParamsConfigDialog::NumberType> DynExpHardware::QutoolsTDCHardwareAdapterParams::DefaultTimestampBufferSize

Initial value:

= { *this, "DefaultTimestampBufferSize", "Default timestamp buffer size",
            "Size of the qutools TDC device's timestamp buffer in samples (default value - can be changed by instruments).",
            false, 1000, 1, 1000000, 1, 0 }

Definition at line 49 of file HardwareAdapterQutoolsTDC.h.

◆ DefaultTriggerEdge

Param<EdgeType> DynExpHardware::QutoolsTDCHardwareAdapterParams::DefaultTriggerEdge

Initial value:

= { *this, EdgeTypeStrList(), "DefaultTriggerEdge", "Default trigger edge",
            "Determines on which edges of the connected signal to trigger (default value - can be changed by instruments).",
            false, EdgeType::RisingEdge}

Definition at line 55 of file HardwareAdapterQutoolsTDC.h.

◆ DeviceDescriptor

Param<TextList> DynExpHardware::QutoolsTDCHardwareAdapterParams::DeviceDescriptor

Initial value:

= { *this, {}, "DeviceDescriptor", "Device serial",

"Serial of the qutools TDC device to connect with" }

Definition at line 47 of file HardwareAdapterQutoolsTDC.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

◆ EdgeType

Constructor & Destructor Documentation

◆ QutoolsTDCHardwareAdapterParams()

◆ ~QutoolsTDCHardwareAdapterParams()

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

◆ ConfigureParamsImpl() [2/2]

◆ EdgeTypeStrList()

◆ GetParamClassTag()

Member Data Documentation

◆ DefaultCoincidenceWindow

◆ DefaultExposureTime

◆ DefaultThresholdInVolts

◆ DefaultTimestampBufferSize

◆ DefaultTriggerEdge

◆ DeviceDescriptor