Plugin interface class for double2acvar. More...

Inheritance diagram for double2acvar::double2acvar_t:

Public Member Functions
	double2acvar_t (MHA_AC::algo_comm_t &iac, const std::string &configured_name)
	Standard plugin constructor. More...

	~double2acvar_t ()=default

template<class T >
T *	process (T *s)
	process() does not alter the signal and has same implementation regardless of signal domain. More...

void	poll_latest_value_and_reinsert ()
	Called from process() and, when allowed, also from on_configuration_update(). More...

void	prepare_ (mhaconfig_t &)
	Prepare method as expected by the plugin interface macros. More...

void	release_ ()
	Release method as expected by the plugin interface macros. More...

void	on_configuration_update ()
	Callback function on write access to the string configuration value. More...

Public Member Functions inherited from MHAParser::string_t
	string_t (const std::string &, const std::string &)
	Constructor of a openMHA configuration variable for string values. More...

Public Member Functions inherited from MHAParser::variable_t
	variable_t (const std::string &)

std::string	query_perm (const std::string &)

void	setlock (const bool &)
	Lock a variable against write access. More...

Public Member Functions inherited from MHAParser::monitor_t
	monitor_t (const std::string &)

	monitor_t (const monitor_t &)

monitor_t &	operator= (const monitor_t &)=default

std::string	op_query (expression_t &)

std::string	query_dump (const std::string &)

Public Member Functions inherited from MHAParser::base_t
	base_t (const std::string &)
	Constructor for base class of all parser nodes. More...

	base_t (const base_t &)
	Copy constructor for base_t. More...

base_t &	operator= (const base_t &)=default

	base_t (base_t &&)=delete

base_t &	operator= (base_t &&)=delete

virtual	~base_t ()

virtual std::string	parse (const std::string &)
	Causes this node to process a command in the openMHA configuration language. More...

virtual void	parse (const char , char , unsigned int)
	This function parses a command and writes the parsing result into a C character array. More...

virtual void	parse (const std::vector< std::string > &, std::vector< std::string > &)

virtual std::string	op_subparse (expression_t &)

virtual std::string	query_entries (const std::string &)

virtual std::string	query_range (const std::string &)

virtual std::string	query_readfile (const std::string &)

virtual std::string	query_savefile (const std::string &)

virtual std::string	query_savefile_compact (const std::string &)

virtual std::string	query_savemons (const std::string &)

virtual std::string	query_listids (const std::string &)

std::string	query_version (const std::string &)

std::string	query_id (const std::string &)

std::string	query_subst (const std::string &)

std::string	query_addsubst (const std::string &)

std::string	query_help (const std::string &)

std::string	query_cmds (const std::string &)

void	set_node_id (const std::string &)
	Set the identification string of this parser node. More...

void	set_help (const std::string &)
	Set the help comment of a variable or parser. More...

void	add_parent_on_insert (parser_t *, std::string)

void	rm_parent_on_remove (parser_t *)

const std::string &	fullname () const
	Return the full dot-separated path name of this parser node in the openMHA configuration tree. More...

Public Member Functions inherited from MHAPlugin::config_t< double >
	config_t ()

	~config_t ()

Private Attributes
MHA_AC::double_t	ac_double
	AC variable inserted by this plugin. More...

MHAEvents::patchbay_t< double2acvar_t >	patchbay
	Callback router. More...

bool	is_prepared
	Flag to keep track if we are currently prepared. More...

Additional Inherited Members
Public Attributes inherited from MHAParser::string_t
std::string	data
	Data field. More...

Public Attributes inherited from MHAParser::base_t
MHAEvents::emitter_t	writeaccess
	Event emitted on write access. More...

MHAEvents::emitter_t	valuechanged
	Event emitted if the value has changed. More...

MHAEvents::emitter_t	readaccess
	Event emitted on read access. More...

MHAEvents::emitter_t	prereadaccess
	Event emitted on read access, before the data field is accessed. More...

Protected Member Functions inherited from MHAParser::string_t
std::string	op_setval (expression_t &)

std::string	query_type (const std::string &)

std::string	query_val (const std::string &)

Protected Member Functions inherited from MHAParser::base_t
void	activate_query (const std::string &, query_t)

void	notify ()

Protected Member Functions inherited from MHAPlugin::config_t< double >
double *	poll_config ()
	Receive the latest run time configuration. More...

double *	peek_config () const
	Receive the latest run time configuration without changing the configuration pointer. More...

void	push_config (double *ncfg)
	Push a new run time configuration into the configuration fifo. More...

void	cleanup_unused_cfg ()
	To be called by the push_config() for housekeeping. More...

void	remove_all_cfg ()
	To be called on Plugin destruction, will delete all runtime configuration list nodes and objects regardless of their in_use flag. More...

Protected Attributes inherited from MHAParser::base_t
query_map_t	queries

bool	data_is_initialized

Protected Attributes inherited from MHAPlugin::config_t< double >
double *	cfg
	Pointer to the runtime configuration currently used by the signal processing thread. More...

Detailed Description

Plugin interface class for double2acvar.

Constructor & Destructor Documentation

◆ double2acvar_t()

double2acvar::double2acvar_t::double2acvar_t	(	MHA_AC::algo_comm_t &	iac,
		const std::string &	configured_name
	)

Standard plugin constructor.

Parameters

iac	Algorithm communication variable space.
configured_name	Configured name of this plugin, also used as name of the AC variable.

◆ ~double2acvar_t()

double2acvar::double2acvar_t::~double2acvar_t ( )

default

Member Function Documentation

◆ process()

template<class T >

T * double2acvar::double2acvar_t::process ( T * s )

process() does not alter the signal and has same implementation regardless of signal domain.

Parameters

s	Pointer to input signal structure, mha_wave_t or mha_spec_t.

Returns: s, unaltered.

◆ poll_latest_value_and_reinsert()

void double2acvar::double2acvar_t::poll_latest_value_and_reinsert ( )

Called from process() and, when allowed, also from on_configuration_update().

poll_latest_value_and_reinsert() retrieves the latest configured value and reinserts the AC variable into the AC space.

◆ prepare_()

void double2acvar::double2acvar_t::prepare_ ( mhaconfig_t & )

Prepare method as expected by the plugin interface macros.

Parameter is not used nor altered. Sets is_prepared flag.

◆ release_()

void double2acvar::double2acvar_t::release_ ( )

Release method as expected by the plugin interface macros.

Resets is_prepared flag.

◆ on_configuration_update()

void double2acvar::double2acvar_t::on_configuration_update ( )

Callback function on write access to the string configuration value.

Member Data Documentation

◆ ac_double

MHA_AC::double_t double2acvar::double2acvar_t::ac_double

private

AC variable inserted by this plugin.

◆ patchbay

MHAEvents::patchbay_t<double2acvar_t> double2acvar::double2acvar_t::patchbay

private

Callback router.

◆ is_prepared

bool double2acvar::double2acvar_t::is_prepared

private

Flag to keep track if we are currently prepared.

If we are, then signal processing is active and AC variables may only be accessed when MHA is currently executing out process() method.

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

double2acvar.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ double2acvar_t()

◆ ~double2acvar_t()

Member Function Documentation

◆ process()

◆ poll_latest_value_and_reinsert()

◆ prepare_()

◆ release_()

◆ on_configuration_update()

Member Data Documentation

◆ ac_double

◆ patchbay

◆ is_prepared