DynExp::ConfiguratorBase Class Reference

The configurator classes have the task to generate parameter objects (refer to DynExp::ParamsBase) of the corresponding type for DynExp objects DynExp::Object. For each class derived from DynExp::Object, there must be a respective configurator derived from ConfiguratorBase. More...

#include <Object.h>

Inheritance diagram for DynExp::ConfiguratorBase:

Classes
struct	UpdateConfigFromDialogResult
	Return type of ConfiguratorBase::UpdateConfigFromDialog() indicating the result of the configurator dialog shown to the user to configure an Object's parameters. More...

Public Types
using	ObjectType = Object
using	ParamsType = ParamsBase

Public Member Functions
	ConfiguratorBase ()=default
virtual	~ConfiguratorBase ()=0
ParamsBasePtrType	MakeConfigFromDialog (ItemIDType ID, const DynExpCore &Core, QWidget *const DialogParent) const
	Sets up and displays a configuration dialog. The user input is used to create an instance of the related Object's parameter class.
ParamsBasePtrType	MakeConfigFromXML (ItemIDType ID, const DynExpCore &Core, const QDomElement &XMLElement) const
	Retrieves the configuration from an XML node to create an instance of the related Object's parameter class. Refer to ParamsBase::ConfigFromXM().
UpdateConfigFromDialogResult	UpdateConfigFromDialog (Object *Obj, const DynExpCore &Core, QWidget *const DialogParent) const
	Updates an Object's Obj parameters from a configuration dialog. Sets up and displays this dialog.

Private Member Functions
virtual ParamsBasePtrType	MakeParams (ItemIDType ID, const DynExpCore &Core) const =0
	Override to make derived classes call DynExp::MakeParams with the correct configurator type derived from ConfiguratorBase. This lets this factory function create an instance of the correct parameter class.

Detailed Description

The configurator classes have the task to generate parameter objects (refer to DynExp::ParamsBase) of the corresponding type for DynExp objects DynExp::Object. For each class derived from DynExp::Object, there must be a respective configurator derived from ConfiguratorBase.

Definition at line 1878 of file Object.h.

Member Typedef Documentation

ObjectType

using DynExp::ConfiguratorBase::ObjectType = Object

Definition at line 1881 of file Object.h.

ParamsType

using DynExp::ConfiguratorBase::ParamsType = ParamsBase

Definition at line 1882 of file Object.h.

Constructor & Destructor Documentation

ConfiguratorBase()

DynExp::ConfiguratorBase::ConfiguratorBase ( )

default

~ConfiguratorBase()

DynExp::ConfiguratorBase::~ConfiguratorBase ( )

pure virtual

Definition at line 310 of file Object.cpp.

Member Function Documentation

MakeConfigFromDialog()

ParamsBasePtrType DynExp::ConfiguratorBase::MakeConfigFromDialog	(	ItemIDType	ID,
		const DynExpCore &	Core,
		QWidget *const	DialogParent
	)		const

Sets up and displays a configuration dialog. The user input is used to create an instance of the related Object's parameter class.

Parameters

ID	ID to assign to the new Object this configurator class instance belongs to
Core	Reference to DynExp's core
DialogParent	Qt QWidget acting as a parent of the modal configuration dialog

Returns

Pointer to the created parameter class instance

Definition at line 314 of file Object.cpp.

MakeConfigFromXML()

ParamsBasePtrType DynExp::ConfiguratorBase::MakeConfigFromXML	(	ItemIDType	ID,
		const DynExpCore &	Core,
		const QDomElement &	XMLElement
	)		const

Retrieves the configuration from an XML node to create an instance of the related Object's parameter class. Refer to ParamsBase::ConfigFromXM().

Parameters

ID	ID to assign to the new Object this configurator class instance belongs to
Core	Reference to DynExp's core
XMLElement	Refer to ParamsBase::ConfigFromXML().

Returns

Pointer to the created parameter class instance

Definition at line 324 of file Object.cpp.

MakeParams()

virtual ParamsBasePtrType DynExp::ConfiguratorBase::MakeParams ( ItemIDType  ID, const DynExpCore &  Core  ) const

privatepure virtual

Override to make derived classes call DynExp::MakeParams with the correct configurator type derived from ConfiguratorBase. This lets this factory function create an instance of the correct parameter class.

Parameters

ID	ID to assign to the new Object this configurator class instance belongs to
Core	Reference to DynExp's core

Returns

Pointer to the created parameter class instance

Implemented in DynExpHardware::gRPCHardwareAdapterConfigurator< gRPCStub >, DynExpHardware::gRPCHardwareAdapterConfigurator< pulse_streamer::PulseStreamer >, DynExpHardware::NIDAQHardwareAdapterConfigurator, DynExpHardware::PVCamHardwareAdapterConfigurator, DynExpHardware::QutoolsTDCHardwareAdapterConfigurator, DynExpHardware::SmarActHardwareAdapterConfigurator, DynExpHardware::SIPulseStreamerHardwareAdapterConfigurator, DynExpHardware::ZILabOneHardwareAdapterConfigurator, DynExpInstr::DummyCameraConfigurator, DynExpInstr::DummyDataStreamInstrumentConfigurator, DynExpInstr::InterModuleCommunicatorConfigurator, DynExpInstr::NenionLeakvalveF3Configurator, DynExpInstr::NIDAQAnalogInConfigurator, DynExpInstr::NIDAQAnalogOutConfigurator, DynExpInstr::NIDAQDigitalInConfigurator, DynExpInstr::NIDAQDigitalOutConfigurator, DynExpInstr::PI_C_862_Configurator, DynExpInstr::PVCamConfigurator, DynExpInstr::QutoolsQuTAGConfigurator, DynExpInstr::RS_SMB100BConfigurator, DynExpInstr::RS_SMC100AConfigurator, DynExpInstr::SmarActConfigurator, DynExpInstr::SwabianInstrumentsPulseStreamerConfigurator, DynExpInstr::ZI_MFLIConfigurator, DynExpModule::NetworkAnalogInConfigurator< gRPCServices >, DynExpModule::NetworkAnalogOutConfigurator< gRPCServices >, DynExpModule::NetworkDataStreamInstrumentConfigurator< gRPCServices >, DynExpModule::NetworkDataStreamInstrumentConfigurator< gRPCServices... >, DynExpModule::NetworkDigitalInConfigurator< gRPCServices >, DynExpModule::NetworkDigitalOutConfigurator< gRPCServices >, DynExpModule::NetworkTimeTaggerConfigurator< gRPCServices >, DynExpModule::ArbitraryFunctionFromCSVConfigurator, DynExpModule::ImageViewer::ImageViewerConfigurator, DynExpModule::InputPortReaderConfigurator, DynExpModule::LockinAmplifierControlConfigurator, DynExpModule::ODMR::ODMRConfigurator, DynExpModule::OutputPortWriterConfigurator, DynExpModule::SignalDesignerConfigurator, DynExpModule::SignalPlotterConfigurator, DynExpModule::SpectrumViewer::SpectrumViewerConfigurator, DynExpModule::Stage1DConfigurator, DynExpModule::StreamManipulatorConfigurator, DynExpModule::Trajectory1DConfigurator, DynExpModule::Widefield::WidefieldMicroscopeConfigurator, DynExp::HardwareAdapterTcpSocketConfigurator, and DynExp::HardwareAdapterSerialPortConfigurator.

UpdateConfigFromDialog()

ConfiguratorBase::UpdateConfigFromDialogResult DynExp::ConfiguratorBase::UpdateConfigFromDialog	(	Object *	Obj,
		const DynExpCore &	Core,
		QWidget *const	DialogParent
	)		const

Updates an Object's Obj parameters from a configuration dialog. Sets up and displays this dialog.

Parameters

Obj	Object whose parameters are to be reconfigured
Core	Reference to DynExp's core
DialogParent	Qt QWidget acting as a parent of the modal configuration dialog

Returns

Refer to ConfiguratorBase::UpdateConfigFromDialogResult.

Definition at line 333 of file Object.cpp.

---

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

• Object.h
• Object.cpp