DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpModule::Trajectory1DParams Class Reference
+ Inheritance diagram for DynExpModule::Trajectory1DParams:

Public Member Functions

 Trajectory1DParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
 
virtual ~Trajectory1DParams ()=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::QModuleParamsBase
 QModuleParamsBase (ItemIDType ID, const DynExpCore &Core)
 Constructs the parameters for a QModuleBase instance. More...
 
virtual ~QModuleParamsBase ()=0
 
- 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 NetworkParamsExtensionGetNetworkAddressParams () 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
 
INonCopyableoperator= (const INonCopyable &)=delete
 

Static Public Member Functions

static Util::TextValueListType< Trajectory1DData::TriggerModeTypeTriggerModeTypeStrList ()
 
- Static Public Member Functions inherited from DynExp::RunnableObjectParams
static Util::TextValueListType< StartupTypeAvlblStartupTypeStrList ()
 Maps description strings to the RunnableObjectParams::StartupType enum's items. More...
 
- Static Public Member Functions inherited from DynExp::ParamsBase
static Util::TextValueListType< UsageTypeAvlblUsageTypeStrList ()
 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< DynExpInstr::DataStreamInstrument > > TrajectoryDataInstr
 
Param< DynExp::ObjectLink< DynExpInstr::PositionerStage > > PositionerStage
 
Param< DynExp::ObjectLink< DynExpInstr::InterModuleCommunicator > > Communicator
 
Param< Trajectory1DData::TriggerModeTypeTriggerMode
 
Param< ParamsConfigDialog::NumberTypeRepeatCount
 
Param< ParamsConfigDialog::NumberTypeDwellTime
 
- Public Attributes inherited from DynExp::QModuleParamsBase
WindowStyleParamsExtension WindowStyleParams
 Bundles several parameters to describe a UI window's style. Use in parameter classes. More...
 
- Public Attributes inherited from DynExp::RunnableObjectParams
Param< StartupTypeStartup
 Determines when the runnable object is started. Refer to RunnableObjectParams::StartupType. More...
 
- Public Attributes inherited from DynExp::ParamsBase
Param< ParamsConfigDialog::TextTypeObjectName = { *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< UsageTypeUsage
 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< QModuleParamsBase >) 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 >
 
- 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 100 of file Trajectory1D.h.

Constructor & Destructor Documentation

◆ Trajectory1DParams()

DynExpModule::Trajectory1DParams::Trajectory1DParams ( DynExp::ItemIDType  ID,
const DynExp::DynExpCore Core 
)
inline

Definition at line 105 of file Trajectory1D.h.

◆ ~Trajectory1DParams()

virtual DynExpModule::Trajectory1DParams::~Trajectory1DParams ( )
virtualdefault

Member Function Documentation

◆ ConfigureParamsImpl()

void DynExpModule::Trajectory1DParams::ConfigureParamsImpl ( dispatch_tag< QModuleParamsBase )
inlinefinaloverrideprivate

Definition at line 125 of file Trajectory1D.h.

◆ GetParamClassTag()

virtual const char* DynExpModule::Trajectory1DParams::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::QModuleParamsBase.

Definition at line 108 of file Trajectory1D.h.

◆ TriggerModeTypeStrList()

Util::TextValueListType< Trajectory1DData::TriggerModeType > DynExpModule::Trajectory1DParams::TriggerModeTypeStrList ( )
static

Definition at line 34 of file Trajectory1D.cpp.

Member Data Documentation

◆ Communicator

Param<DynExp::ObjectLink<DynExpInstr::InterModuleCommunicator> > DynExpModule::Trajectory1DParams::Communicator
Initial value:
= { *this, GetCore().GetInstrumentManager(),
"InterModuleCommunicator", "Inter-module communicator", "Inter-module communicator to control this module with", DynExpUI::Icons::Instrument, true }
const auto & GetCore() const noexcept
Returns a reference to DynExp's core.
Definition: Object.h:1677
constexpr auto Instrument

Definition at line 114 of file Trajectory1D.h.

◆ DwellTime

Param<ParamsConfigDialog::NumberType> DynExpModule::Trajectory1DParams::DwellTime
Initial value:
= { *this, "DwellTime", "Dwell time in ms",
"Dwell time used for data streams containing samples without time data", true, 100, 1 }

Definition at line 121 of file Trajectory1D.h.

◆ PositionerStage

Param<DynExp::ObjectLink<DynExpInstr::PositionerStage> > DynExpModule::Trajectory1DParams::PositionerStage
Initial value:
= { *this, GetCore().GetInstrumentManager(),
"PositionerStage", "Positioner", "Underlying positioner to be controlled by this module", DynExpUI::Icons::Instrument }

Definition at line 112 of file Trajectory1D.h.

◆ RepeatCount

Param<ParamsConfigDialog::NumberType> DynExpModule::Trajectory1DParams::RepeatCount
Initial value:
= { *this, "RepeatCount", "Number of repetitions",
"Determines how many times the trajectory data stream should be played back after a trigger event has occurred", true, 1, 1 }

Definition at line 119 of file Trajectory1D.h.

◆ TrajectoryDataInstr

Param<DynExp::ObjectLink<DynExpInstr::DataStreamInstrument> > DynExpModule::Trajectory1DParams::TrajectoryDataInstr
Initial value:
= { *this, GetCore().GetInstrumentManager(),
"TrajectoryDataInstr", "Trajectory data stream", "Data stream instrument to stream position data from", DynExpUI::Icons::Instrument }

Definition at line 110 of file Trajectory1D.h.

◆ TriggerMode

Param<Trajectory1DData::TriggerModeType> DynExpModule::Trajectory1DParams::TriggerMode
Initial value:
= { *this, TriggerModeTypeStrList(), "TriggerMode", "Trigger mode",
"Trigger action which starts streaming the position data", true, Trajectory1DData::TriggerModeType::Manual }
static Util::TextValueListType< Trajectory1DData::TriggerModeType > TriggerModeTypeStrList()

Definition at line 117 of file Trajectory1D.h.


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