#include <NetworkAnalogInModule.h>

Inheritance diagram for DynExpModule::NetworkAnalogInParams< gRPCServices >:

Public Member Functions
	NetworkAnalogInParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)

virtual	~NetworkAnalogInParams ()=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!

Public Member Functions inherited from DynExpModule::NetworkDataStreamInstrumentParams< gRPCServices... >
	NetworkDataStreamInstrumentParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)

virtual	~NetworkDataStreamInstrumentParams ()=default

Public Member Functions inherited from DynExpModule::gRPCModuleParams< gRPCServices... >
	gRPCModuleParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
	Constructs the parameters for a `gRPCModule` instance.

virtual	~gRPCModuleParams ()=default

Public Member Functions inherited from DynExp::ModuleParamsBase
	ModuleParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the parameters for a `ModuleBase` instance.

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.

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.

Public Member Functions inherited from DynExp::ParamsBase
	ParamsBase (ItemIDType ID, const DynExpCore &Core)
	Constructs the base class of an object parameter class.

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.

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

void	ConfigFromDialog (ParamsConfigDialog &Dialog)
	Adds all parameters belonging to this ParamsBase instance to a settings dialog to let the user configure the parameter values.

bool	Validate () const
	Refer to ParamBase::Validate().

ItemIDType	GetID () const noexcept
	Returns the ID of the `Object` this parameter class instance belongs to.

const auto &	GetCore () const noexcept
	Returns a reference to DynExp's core.

const auto &	GetObjectLinkParams () const noexcept
	Returns a list of all object link parameters owned by this parameter class instance.

bool	ConfigureUsageType () const noexcept
	Determines whether the Usage parameter should be configurable in the settings dialog. Override ConfigureUsageTypeChild() in order to adjust.

const NetworkParamsExtension *	GetNetworkAddressParams () const noexcept
	Returns the network address parameters of a derived gRPC instrument. Override GetNetworkAddressParamsChild() in order to adjust.

Public Member Functions inherited from Util::INonCopyable
	INonCopyable (const INonCopyable &)=delete

INonCopyable &	operator= (const INonCopyable &)=delete

Private Member Functions
void	ConfigureParamsImpl (DynExp::ParamsBase::dispatch_tag< NetworkDataStreamInstrumentParams< gRPCServices... > >) override final

virtual void	ConfigureParamsImpl (DynExp::ParamsBase::dispatch_tag< NetworkAnalogInParams >)

Private Attributes
DynExp::ParamsBase::DummyParam	Dummy = { *this }

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.

using	EnumParamSignedIntegerType = intmax_t
	Parameter type to convert signed eumeration parameters to.

using	EnumParamUnsignedIntegerType = uintmax_t
	Parameter type to convert unsigned eumeration parameters to.

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.

using	Text = Util::TextType
	" String type of text-type parameters (DynExp::ParamsBase::Param) "

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.

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.

Static Public Member Functions inherited from DynExp::ParamsBase
static Util::TextValueListType< UsageType >	AvlblUsageTypeStrList ()
	Maps description strings to the ParamsBase::UsageType enum's items.

static void	DisableUserEditable (ParamBase &Param) noexcept
	Sets the `UserEditable` property of the parameter `Param` to false. Refer to ParamBase::UserEditable.

Public Attributes inherited from DynExpModule::NetworkDataStreamInstrumentParams< gRPCServices... >
DynExp::ParamsBase::Param< DynExp::ObjectLink< DynExpInstr::DataStreamInstrument > >	DataStreamInstrument

Public Attributes inherited from DynExpModule::gRPCModuleParams< gRPCServices... >
DynExp::NetworkParamsExtension	NetworkParams
	Network address the gRPC server listens on.

Public Attributes inherited from DynExp::RunnableObjectParams
Param< StartupType >	Startup
	Determines when the runnable object is started. Refer to RunnableObjectParams::StartupType.

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.

Param< UsageType >	Usage
	Determines whether an object can be used by only one other ("unique") or by multiple other ("shared") objects.

Protected Member Functions inherited from Util::ISynchronizedPointerLockable
	ISynchronizedPointerLockable ()

	~ISynchronizedPointerLockable ()
	Object should never be destroyed before completely unlocked.

Protected Member Functions inherited from Util::INonCopyable
constexpr	INonCopyable ()=default

	~INonCopyable ()=default

Detailed Description

template<typename... gRPCServices>
class DynExpModule::NetworkAnalogInParams< gRPCServices >

Definition at line 41 of file NetworkAnalogInModule.h.

Constructor & Destructor Documentation

◆ NetworkAnalogInParams()

template<typename... gRPCServices>

DynExpModule::NetworkAnalogInParams< gRPCServices >::NetworkAnalogInParams	(	DynExp::ItemIDType	ID,
		const DynExp::DynExpCore &	Core
	)

inline

Definition at line 44 of file NetworkAnalogInModule.h.

◆ ~NetworkAnalogInParams()

template<typename... gRPCServices>

virtual DynExpModule::NetworkAnalogInParams< gRPCServices >::~NetworkAnalogInParams ( )

virtualdefault

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

template<typename... gRPCServices>

virtual void DynExpModule::NetworkAnalogInParams< gRPCServices >::ConfigureParamsImpl ( DynExp::ParamsBase::dispatch_tag< NetworkAnalogInParams< gRPCServices > > )

inlineprivatevirtual

Definition at line 51 of file NetworkAnalogInModule.h.

◆ ConfigureParamsImpl() [2/2]

template<typename... gRPCServices>

void DynExpModule::NetworkAnalogInParams< gRPCServices >::ConfigureParamsImpl ( DynExp::ParamsBase::dispatch_tag< NetworkDataStreamInstrumentParams< gRPCServices... > > )

inlinefinaloverrideprivate

Definition at line 50 of file NetworkAnalogInModule.h.

◆ GetParamClassTag()

template<typename... gRPCServices>

virtual const char * DynExpModule::NetworkAnalogInParams< gRPCServices >::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 DynExpModule::NetworkDataStreamInstrumentParams< gRPCServices... >.

Definition at line 47 of file NetworkAnalogInModule.h.

Member Data Documentation

◆ Dummy

template<typename... gRPCServices>

DynExp::ParamsBase::DummyParam DynExpModule::NetworkAnalogInParams< gRPCServices >::Dummy = { *this }

private

Definition at line 53 of file NetworkAnalogInModule.h.

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

NetworkAnalogInModule.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NetworkAnalogInParams()

◆ ~NetworkAnalogInParams()

Member Function Documentation

◆ ConfigureParamsImpl() [1/2]

◆ ConfigureParamsImpl() [2/2]

◆ GetParamClassTag()

Member Data Documentation

◆ Dummy