Parameter class for StreamManipulator. More...

Inheritance diagram for DynExpModule::StreamManipulatorParams:

Public Member Functions
	StreamManipulatorParams (DynExp::ItemIDType ID, const DynExp::DynExpCore &Core)
	Constructs the parameters for a `StreamManipulator` instance. More...

virtual	~StreamManipulatorParams ()=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::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 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

Public Attributes
ListParam< DynExp::ObjectLink< DynExpInstr::DataStreamInstrument > >	InputDataStreams
	Parameter for data stream instruments containing input samples. Refer to StreamManipulatorData::InputDataStreams. More...

ListParam< DynExp::ObjectLink< DynExpInstr::DataStreamInstrument > >	OutputDataStreams
	Parameter for data stream instruments containing output samples. Refer to StreamManipulatorData::OutputDataStreams. More...

Param< ParamsConfigDialog::TextType >	PythonCodePath
	Path to the Python file containing the code, which performs the stream manipulation. 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< ModuleParamsBase >) 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...

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

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

Definition at line 133 of file StreamManipulator.h.

Constructor & Destructor Documentation

◆ StreamManipulatorParams()

DynExpModule::StreamManipulatorParams::StreamManipulatorParams	(	DynExp::ItemIDType	ID,
		const DynExp::DynExpCore &	Core
	)

inline

Constructs the parameters for a StreamManipulator instance.

Definition at line 139 of file StreamManipulator.h.

◆ ~StreamManipulatorParams()

virtual DynExpModule::StreamManipulatorParams::~StreamManipulatorParams ( )

virtualdefault

Member Function Documentation

◆ ConfigureParamsImpl()

void DynExpModule::StreamManipulatorParams::ConfigureParamsImpl ( dispatch_tag< ModuleParamsBase > )

inlinefinaloverrideprivate

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.

Definition at line 188 of file StreamManipulator.h.

◆ GetParamClassTag()

virtual const char* DynExpModule::StreamManipulatorParams::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::ModuleParamsBase.

Definition at line 143 of file StreamManipulator.h.

Member Data Documentation

◆ InputDataStreams

ListParam<DynExp::ObjectLink<DynExpInstr::DataStreamInstrument> > DynExpModule::StreamManipulatorParams::InputDataStreams

Initial value:

= { *this, GetCore().GetInstrumentManager(),

"InputDataStreams", "Input data stream instrument(s)", "Data stream instruments to be used as data sources", DynExpUI::Icons::Instrument, true }

DynExp::ParamsBase::GetCore

const auto & GetCore() const noexcept

Returns a reference to DynExp's core.

Definition: Object.h:1677

DynExpUI::Icons::Instrument

constexpr auto Instrument

Definition: DynExpDefinitions.h.in:75

Parameter for data stream instruments containing input samples. Refer to StreamManipulatorData::InputDataStreams.

Definition at line 149 of file StreamManipulator.h.

◆ OutputDataStreams

ListParam<DynExp::ObjectLink<DynExpInstr::DataStreamInstrument> > DynExpModule::StreamManipulatorParams::OutputDataStreams

Initial value:

= { *this, GetCore().GetInstrumentManager(),

"OutputDataStreams", "Output data stream instrument(s)", "Data stream instruments to be used as data sinks", DynExpUI::Icons::Instrument, true }

Parameter for data stream instruments containing output samples. Refer to StreamManipulatorData::OutputDataStreams.

Definition at line 156 of file StreamManipulator.h.

◆ PythonCodePath

Param<ParamsConfigDialog::TextType> DynExpModule::StreamManipulatorParams::PythonCodePath

Initial value:

= { *this, "PythonCodePath", "Python code path",

"Path to a Python file containing the function which writes samples to the output streams based on the input streams' data", true, "", DynExp::TextUsageType::Code }

DynExp::TextUsageType::Code

@ Code

Path to the Python file containing the code, which performs the stream manipulation.

The Python file can import Python modules at its beginning. Refer to the documentation main page for information on how to install Python modules.

Furthermore, the file can contain the functions on_init(input), on_step(input), and on_exit(input). input is the StreamManipulator::ManipulatorPyFuncInput instance and on_init() is expected to return an object assignable to StreamManipulator::ManipulatorPyFuncOutput. on_init() is called when the module is initialited, on_exit() is called when it is terminated, and on_step() is called periodically and as soon as new input samples are available according to PyStreamManipulatorOutputData::MinNextExecutionDelay and PyStreamManipulatorOutputData::MaxNextExecutionDelay.

To store local variables, they can be assigned to on_init() as attributes. Such attributes are accessible in on_step() and on_exit() as well.

Refer to the examples within this repository for different implementations of the Python functions described here.

Definition at line 181 of file StreamManipulator.h.

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

StreamManipulator.h

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StreamManipulatorParams()

◆ ~StreamManipulatorParams()

Member Function Documentation

◆ ConfigureParamsImpl()

◆ GetParamClassTag()

Member Data Documentation

◆ InputDataStreams

◆ OutputDataStreams

◆ PythonCodePath