|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
|
DynExp
Highly flexible laboratory automation for dynamically changing experiments.
|
Inheritance diagram for DynExpInstr::ZI_MFLIParams:Public Member Functions | |
| ZI_MFLIParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core) | |
| virtual | ~ZI_MFLIParams ()=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 DynExpInstr::LockinAmplifierParams | |
| LockinAmplifierParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core) | |
Constructs the parameters for a LockinAmplifier instance. More... | |
| virtual | ~LockinAmplifierParams ()=0 |
| 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 |
Static Public Member Functions | |
| static Util::TextValueListType< DynExpHardware::ZILabOneHardwareAdapter::SignalInputType > | SignalInputTypeStrList () |
| Static Public Member Functions inherited from DynExpInstr::LockinAmplifierParams | |
| static Util::TextValueListType< AutoApplyParamsType > | AutoApplyParamsTypeStrList () |
Maps description strings to the AutoApplyParamsType enum's items. More... | |
| 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... | |
Public Attributes | |
| Param< DynExp::ObjectLink< DynExpHardware::ZILabOneHardwareAdapter > > | HardwareAdapter |
| Param< DynExpHardware::ZILabOneHardwareAdapter::SignalInputType > | SignalInput |
| Param< ParamsConfigDialog::NumberType > | Demodulator |
| Param< ParamsConfigDialog::NumberType > | TriggerChannel |
| Public Attributes inherited from DynExpInstr::LockinAmplifierParams | |
| Param< AutoApplyParamsType > | AutoApplyParams |
| Parameter to indicate whether to apply parameters stored here to the instrument when it is started. Refer to LockinAmplifier::ApplyFromParams(). More... | |
| Param< double > | Sensitivity { *this, "Sensitivity", 1, 0 } |
| Parameter to store the lock-in amplifier's sensitivity/amplification setting. More... | |
| Param< double > | Phase { *this, "Phase", 0, 0, 2.0 * std::numbers::pi } |
| Parameter to store the phase in rad of the lock-in amplifier's demodulator. More... | |
| Param< double > | TimeConstant { *this, "TimeConstant", 1e-3, 0 } |
| Parameter to store the time constant in seconds of the lock-in amplifier's low-poss filter. More... | |
| Param< unsigned int > | FilterOrder { *this, "FilterOrder", 1, 1, 10 } |
| Parameter to store the filter order/quality of the lock-in amplifier's low-poss filter. More... | |
| Param< LockinAmplifierDefs::TriggerModeType > | TriggerMode { *this, "TriggerMode", LockinAmplifierDefs::TriggerModeType::ExternSingle } |
| Parameter to store the lock-in amplifier's trigger mode. More... | |
| Param< LockinAmplifierDefs::TriggerEdgeType > | TriggerEdge { *this, "TriggerEdge", LockinAmplifierDefs::TriggerEdgeType::Fall } |
| Parameter to store the lock-in amplifier's trigger edge. More... | |
| Param< LockinAmplifierDefs::SignalType > | Signal { *this, "Signal", LockinAmplifierDefs::SignalType::R } |
| Parameter to store the lock-in amplifier's signal coordinate type to write to the data stream. More... | |
| Param< double > | SamplingRate { *this, "SamplingRate", 1000, 1 } |
| Parameter to store the lock-in amplifier's sampling rate in samples/s. More... | |
| Param< bool > | Enable { *this, "Enable", false } |
| Parameter to store whether the lock-in amplifier's demodulator is enabled. 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< LockinAmplifierParams >) 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< ZI_MFLIParams >) |
Additional Inherited Members | |
| Public Types inherited from DynExpInstr::LockinAmplifierParams | |
| enum | AutoApplyParamsType { DoNotApply , AutoApply } |
| Type to determine whether to apply parameters stored here to the lock-in amplifier when the instrument is started. More... | |
| 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 > |
| 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 | |
|
inline |
|
virtualdefault |
|
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::LockinAmplifierParams.
|
inlineprivatevirtual |
|
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!
Reimplemented from DynExpInstr::LockinAmplifierParams.
|
static |
Definition at line 265 of file ZI_MFLI.cpp.
| Param<ParamsConfigDialog::NumberType> DynExpInstr::ZI_MFLIParams::Demodulator |
| Param<DynExp::ObjectLink<DynExpHardware::ZILabOneHardwareAdapter> > DynExpInstr::ZI_MFLIParams::HardwareAdapter |
| Param<DynExpHardware::ZILabOneHardwareAdapter::SignalInputType> DynExpInstr::ZI_MFLIParams::SignalInput |
| Param<ParamsConfigDialog::NumberType> DynExpInstr::ZI_MFLIParams::TriggerChannel |
1.9.1