Inheritance diagram for DynExpHardware::SIPulseStreamerHardwareAdapterParams:

Public Types
enum	OutputChannelType : uint8_t { DO0 = 0 , DO1 , DO2 , DO3 , DO4 , DO5 , DO6 , DO7 , AO0 , AO1 }

enum	TriggerEdgeType { Immediate , Software , RisingEdge , FallingEdge , RisingAndFallingEdge }

enum	TriggerModeType { Normal , Single }

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
	SIPulseStreamerHardwareAdapterParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)

virtual	~SIPulseStreamerHardwareAdapterParams ()=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 DynExpHardware::gRPCHardwareAdapterParams< pulse_streamer::PulseStreamer >
	gRPCHardwareAdapterParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
	Constructs the parameters for a `gRPCHardwareAdapter` instance. More...

virtual	~gRPCHardwareAdapterParams ()=default

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< OutputChannelType >	OutputChannelTypeStrList ()

static Util::TextValueListType< TriggerEdgeType >	TriggerEdgeTypeStrList ()

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
Param< TriggerEdgeType >	TriggerEdge

Param< TriggerModeType >	TriggerMode

Param< ParamsConfigDialog::NumberType >	NumRuns

Public Attributes inherited from DynExpHardware::gRPCHardwareAdapterParams< pulse_streamer::PulseStreamer >
DynExp::NetworkParamsExtension	NetworkParams
	Bundles several parameters to describe a network connection. Use in parameter classes. 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< gRPCHardwareAdapterParams >) override final

virtual void	ConfigureParamsImpl (dispatch_tag< SIPulseStreamerHardwareAdapterParams >)

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 21 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

Member Enumeration Documentation

◆ OutputChannelType

enum DynExpHardware::SIPulseStreamerHardwareAdapterParams::OutputChannelType : uint8_t

Enumerator
DO0
DO1
DO2
DO3
DO4
DO5
DO6
DO7
AO0
AO1

Definition at line 25 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ TriggerEdgeType

enum DynExpHardware::SIPulseStreamerHardwareAdapterParams::TriggerEdgeType

Enumerator
Immediate
Software
RisingEdge
FallingEdge
RisingAndFallingEdge

Definition at line 26 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ TriggerModeType

enum DynExpHardware::SIPulseStreamerHardwareAdapterParams::TriggerModeType

Enumerator
Normal
Single

Definition at line 27 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

Constructor & Destructor Documentation

◆ SIPulseStreamerHardwareAdapterParams()

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

inline

Definition at line 33 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ ~SIPulseStreamerHardwareAdapterParams()

virtual DynExpHardware::SIPulseStreamerHardwareAdapterParams::~SIPulseStreamerHardwareAdapterParams ( )

virtualdefault

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

void DynExpHardware::SIPulseStreamerHardwareAdapterParams::ConfigureParamsImpl ( dispatch_tag< gRPCHardwareAdapterParams > )

inlinefinaloverrideprivatevirtual

Reimplemented from DynExpHardware::gRPCHardwareAdapterParams< pulse_streamer::PulseStreamer >.

Definition at line 49 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ ConfigureParamsImpl() [2/2]

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

inlineprivatevirtual

Definition at line 50 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ GetParamClassTag()

virtual const char* DynExpHardware::SIPulseStreamerHardwareAdapterParams::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 DynExpHardware::gRPCHardwareAdapterParams< pulse_streamer::PulseStreamer >.

Definition at line 36 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ OutputChannelTypeStrList()

Util::TextValueListType< SIPulseStreamerHardwareAdapterParams::OutputChannelType > DynExpHardware::SIPulseStreamerHardwareAdapterParams::OutputChannelTypeStrList ( )

static

Definition at line 8 of file HardwareAdapterSwabianInstrumentsPulseStreamer.cpp.

◆ TriggerEdgeTypeStrList()

Util::TextValueListType< SIPulseStreamerHardwareAdapterParams::TriggerEdgeType > DynExpHardware::SIPulseStreamerHardwareAdapterParams::TriggerEdgeTypeStrList ( )

static

Definition at line 26 of file HardwareAdapterSwabianInstrumentsPulseStreamer.cpp.

◆ TriggerModeTypeStrList()

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

static

Definition at line 39 of file HardwareAdapterSwabianInstrumentsPulseStreamer.cpp.

Member Data Documentation

◆ NumRuns

Param<ParamsConfigDialog::NumberType> DynExpHardware::SIPulseStreamerHardwareAdapterParams::NumRuns

Initial value:

= { *this, "NumRuns", "Number of Runs",
            "Determines how often the stored pulse sequence should be repeated after triggering. -1 means indefinitely.",
            true, 1, -1 }

Definition at line 44 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ TriggerEdge

Param<TriggerEdgeType> DynExpHardware::SIPulseStreamerHardwareAdapterParams::TriggerEdge

Initial value:

= { *this, TriggerEdgeTypeStrList(), "TriggerEdge",
            "Trigger Edge", "Signal edge or event which triggers the pulse streamer.",
            true, TriggerEdgeType::Immediate }

Definition at line 38 of file HardwareAdapterSwabianInstrumentsPulseStreamer.h.

◆ TriggerMode

Param<TriggerModeType> DynExpHardware::SIPulseStreamerHardwareAdapterParams::TriggerMode

Initial value:

= { *this, TriggerModeTypeStrList(), "TriggerMode",
            "Trigger Mode", "Determines whether the puslse streamer waits for subsequent trigger events (normal) or only for one (single).",
            true, TriggerModeType::Normal }

Definition at line 41 of file HardwareAdapterSwabianInstrumentsPulseStreamer.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

◆ OutputChannelType

◆ TriggerEdgeType

◆ TriggerModeType

Constructor & Destructor Documentation

◆ SIPulseStreamerHardwareAdapterParams()

◆ ~SIPulseStreamerHardwareAdapterParams()

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

◆ ConfigureParamsImpl() [2/2]

◆ GetParamClassTag()

◆ OutputChannelTypeStrList()

◆ TriggerEdgeTypeStrList()

◆ TriggerModeTypeStrList()

Member Data Documentation

◆ NumRuns

◆ TriggerEdge

◆ TriggerMode