Parameter class for InstrumentBase. More...

Inheritance diagram for DynExp::InstrumentParamsBase:

Public Member Functions
	InstrumentParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the parameters for a `InstrumentBase` instance. More...

virtual	~InstrumentParamsBase ()=0

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::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

Private Member Functions
void	ConfigureParamsImpl (dispatch_tag< RunnableObjectParams >) 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< InstrumentParamsBase >)
	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...

Private Attributes
std::unique_ptr< InstrumentDataBase >	InstrumentData
	Just used temporarily during the construction of an instrument. Refer to `MakeInstrument()` and to InstrumentBase::InstrumentBase(). More...

DummyParam	Dummy = { *this }
	Dummy parameter which is to be owned once by parameter classes that do not contain any other parameter. It ensures the presence of the respective level in the XML hierarchy. Parameter is skipped when saving/loading because of its empty name. More...

Friends
class	InstrumentBase

template<typename >
InstrumentPtrType	MakeInstrument (const std::thread::id, ParamsBasePtrType &&)
	Factory function to generate an instrument of a specific type. More...

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 >

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 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...

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

Parameter class for InstrumentBase.

Definition at line 400 of file Instrument.h.

Constructor & Destructor Documentation

◆ InstrumentParamsBase()

DynExp::InstrumentParamsBase::InstrumentParamsBase	(	ItemIDType	ID,
		const DynExpCore &	Core
	)

inline

Constructs the parameters for a InstrumentBase instance.

Parameters

ID	ID of the `Object` this parameter class instance belongs to
Core	Reference to DynExp's core

Definition at line 412 of file Instrument.h.

◆ ~InstrumentParamsBase()

DynExp::InstrumentParamsBase::~InstrumentParamsBase ( )

pure virtual

Definition at line 202 of file Instrument.cpp.

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

virtual void DynExp::InstrumentParamsBase::ConfigureParamsImpl ( dispatch_tag< InstrumentParamsBase > )

inlineprivatevirtual

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 in DynExpInstr::InterModuleCommunicatorParams.

Definition at line 420 of file Instrument.h.

◆ ConfigureParamsImpl() [2/2]

void DynExp::InstrumentParamsBase::ConfigureParamsImpl ( dispatch_tag< RunnableObjectParams > )

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 DynExp::RunnableObjectParams.

Definition at line 419 of file Instrument.h.

◆ GetParamClassTag()

virtual const char* DynExp::InstrumentParamsBase::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::RunnableObjectParams.

Definition at line 416 of file Instrument.h.

Friends And Related Function Documentation

◆ InstrumentBase

friend class InstrumentBase

friend

Definition at line 402 of file Instrument.h.

◆ MakeInstrument

template<typename >

InstrumentPtrType MakeInstrument	(	const std::thread::id	OwnerThreadID,
		ParamsBasePtrType &&	Params
	)

friend

Factory function to generate an instrument of a specific type.

Template Parameters

InstrumentT Type of the instrument to generate

Parameters

OwnerThreadID	ID of the thread owning the instrument
Params	Reference to theinstrument's parameters to take ownership of

Returns: Pointer to the instrument of the specified type

Definition at line 47 of file Instrument.h.

Member Data Documentation

◆ Dummy

DummyParam DynExp::InstrumentParamsBase::Dummy = { *this }

private

Dummy parameter which is to be owned once by parameter classes that do not contain any other parameter. It ensures the presence of the respective level in the XML hierarchy. Parameter is skipped when saving/loading because of its empty name.

Definition at line 428 of file Instrument.h.

◆ InstrumentData

std::unique_ptr<InstrumentDataBase> DynExp::InstrumentParamsBase::InstrumentData

private

Just used temporarily during the construction of an instrument. Refer to MakeInstrument() and to InstrumentBase::InstrumentBase().

Definition at line 426 of file Instrument.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members