acmon plugin interface class More...

Inheritance diagram for acmon::acmon_t:

Public Member Functions
	acmon_t (MHA_AC::algo_comm_t &, const std::string &configured_name)
	Plugin interface constructor. More...

	~acmon_t ()=default
	Default destructor. More...

void	prepare (mhaconfig_t &)
	Prepare callback. More...

void	release ()
	Do-nothing release. More...

mha_spec_t *	process (mha_spec_t *)
	Process callback for frequency domain. More...

mha_wave_t *	process (mha_wave_t *)
	Process callback for time domain. More...

Public Member Functions inherited from MHAPlugin::plugin_t< int >
	plugin_t (const std::string &, MHA_AC::algo_comm_t &)
	Constructor of plugin template base class. More...

virtual	~plugin_t ()
	Destructor of plugin template base class. More...

void	prepare_ (mhaconfig_t &)

void	release_ ()

bool	is_prepared () const
	Flag, if the prepare method is successfully called (or currently evaluated) More...

mhaconfig_t	input_cfg () const
	Current input channel configuration. More...

mhaconfig_t	output_cfg () const
	Current output channel configuration. More...

Public Member Functions inherited from MHAParser::parser_t
	parser_t (const std::string &help_text="")
	Construct detached node to be used in the configuration tree. More...

	~parser_t ()

void	insert_item (const std::string &, base_t *)
	Register a parser item into this sub-parser. More...

void	remove_item (const std::string &)
	Remove an item by name. More...

void	force_remove_item (const std::string &)
	Remove an item by name. More...

void	remove_item (const base_t *)
	Remove an item by address. More...

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	query_perm (const std::string &)

virtual std::string	query_range (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< runtime_cfg_t >
	config_t ()

	~config_t ()

Private Member Functions
void	save_vars ()
	Save the current value of the AC variables into their corresponding monitors. More...

void	update_recmode ()
	Set/Re-Set the recording mode from continous to snapshot or vice versa. More...

Private Attributes
MHA_AC::algo_comm_t &	ac
	Handle to the AC space. More...

MHAParser::vstring_mon_t	varlist
	Monitor variable containing the AC variable names. More...

MHAParser::vstring_mon_t	dimensions
	Monitor variable containing the dimension strings of the AC variables. More...

MHAParser::kw_t	dispmode
	Configuration variable for the display mode. More...

MHAParser::kw_t	recmode
	Configuration variable for the record mode. More...

std::vector< std::unique_ptr< ac_monitor_t > >	vars
	Vector containing pointers to the ac to monitor bridge variables. More...

MHAEvents::patchbay_t< acmon_t >	patchbay
	Patchbay. More...

std::string	algo
	String saving the configured name of the plugin. More...

bool	b_cont
	Recording mode. More...

bool	b_snapshot
	Snapshot flag. More...

Additional Inherited Members
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::parser_t
std::string	op_subparse (expression_t &)

std::string	op_setval (expression_t &)

std::string	op_query (expression_t &)

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

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

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

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

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

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

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

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

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

void	set_id_string (const std::string &)

bool	has_entry (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< runtime_cfg_t >
runtime_cfg_t *	poll_config ()
	Receive the latest run time configuration. More...

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

void	push_config (runtime_cfg_t *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 MHAPlugin::plugin_t< int >
mhaconfig_t	tftype
	Member for storage of plugin interface configuration. More...

MHA_AC::algo_comm_t &	ac
	AC handle of the chain. More...

Protected Attributes inherited from MHAParser::base_t
query_map_t	queries

bool	data_is_initialized

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

Detailed Description

acmon plugin interface class

Constructor & Destructor Documentation

◆ acmon_t()

acmon::acmon_t::acmon_t	(	MHA_AC::algo_comm_t &	iac,
		const std::string &	configured_name
	)

Plugin interface constructor.

Parameters

configured_name Assigned name of the plugin within the configuration tree

◆ ~acmon_t()

acmon::acmon_t::~acmon_t ( )

default

Default destructor.

Member Function Documentation

◆ prepare()

void acmon::acmon_t::prepare ( mhaconfig_t & )

virtual

Prepare callback.

Initializes the AC to monitor bridges and variable list, leaves the signal dimensions untouched

Implements MHAPlugin::plugin_t< int >.

◆ release()

void acmon::acmon_t::release ( void )

inlinevirtual

Do-nothing release.

Reimplemented from MHAPlugin::plugin_t< int >.

◆ process() [1/2]

mha_spec_t * acmon::acmon_t::process ( mha_spec_t * s )

Process callback for frequency domain.

Calls save_vars() and returns the signal unmodified.

◆ process() [2/2]

mha_wave_t * acmon::acmon_t::process ( mha_wave_t * s )

Process callback for time domain.

Calls save_vars() and returns the signal unmodified.

◆ save_vars()

void acmon::acmon_t::save_vars ( )

private

Save the current value of the AC variables into their corresponding monitors.

◆ update_recmode()

void acmon::acmon_t::update_recmode ( )

private

Set/Re-Set the recording mode from continous to snapshot or vice versa.

Member Data Documentation

◆ ac

MHA_AC::algo_comm_t& acmon::acmon_t::ac

private

Handle to the AC space.

◆ varlist

MHAParser::vstring_mon_t acmon::acmon_t::varlist

private

Monitor variable containing the AC variable names.

◆ dimensions

MHAParser::vstring_mon_t acmon::acmon_t::dimensions

private

Monitor variable containing the dimension strings of the AC variables.

◆ dispmode

MHAParser::kw_t acmon::acmon_t::dispmode

private

Configuration variable for the display mode.

◆ recmode

MHAParser::kw_t acmon::acmon_t::recmode

private

Configuration variable for the record mode.

◆ vars

std::vector<std::unique_ptr<ac_monitor_t> > acmon::acmon_t::vars

private

Vector containing pointers to the ac to monitor bridge variables.

◆ patchbay

MHAEvents::patchbay_t<acmon_t> acmon::acmon_t::patchbay

private

Patchbay.

◆ algo

std::string acmon::acmon_t::algo

private

String saving the configured name of the plugin.

◆ b_cont

bool acmon::acmon_t::b_cont

private

Recording mode.

True for continous mode, false for snapshot mode

◆ b_snapshot

bool acmon::acmon_t::b_snapshot

private

Snapshot flag.

Set to true to request a snapshot in the next process() call

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

acmon.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ acmon_t()

◆ ~acmon_t()

Member Function Documentation

◆ prepare()

◆ release()

◆ process() [1/2]

◆ process() [2/2]

◆ save_vars()

◆ update_recmode()

Member Data Documentation

◆ ac

◆ varlist

◆ dimensions

◆ dispmode

◆ recmode

◆ vars

◆ patchbay

◆ algo

◆ b_cont

◆ b_snapshot