The Open Master Hearing Aid (openMHA)  openMHA
Open community platform for hearing aid algorithm research

MHA configuration interface for a window function generator. More...

Inheritance diagram for MHAParser::window_t:
Inheritance graph

Public Types

enum  wtype_t {
  wnd_rect =0 , wnd_hann =1 , wnd_hamming =2 , wnd_blackman =3 ,
  wnd_bartlett =4 , wnd_user =5
}
 

Public Member Functions

 window_t (const std::string &help="Window type configuration.")
 Constructor to create parser class. More...
 
MHAWindow::base_t get_window (unsigned int len) const
 Create a window instance, use default parameters. More...
 
MHAWindow::base_t get_window (unsigned int len, float xmin) const
 Create a window instance. More...
 
MHAWindow::base_t get_window (unsigned int len, float xmin, float xmax) const
 Create a window instance. More...
 
MHAWindow::base_t get_window (unsigned int len, float xmin, float xmax, bool minincluded) const
 Create a window instance. More...
 
MHAWindow::base_t get_window (unsigned int len, float xmin, float xmax, bool minincluded, bool maxincluded) const
 Create a window instance. More...
 
MHAParser::window_t::wtype_t get_type () const
 Return currently selected window type. More...
 
void setlock (bool b)
 
- 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_toperator= (const base_t &)=default
 
 base_t (base_t &&)=delete
 
base_toperator= (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...
 

Private Attributes

MHAParser::kw_t wtype
 
MHAParser::vfloat_t user
 

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 Attributes inherited from MHAParser::base_t
query_map_t queries
 
bool data_is_initialized
 

Detailed Description

MHA configuration interface for a window function generator.

This class implements a configuration interface (sub-parser) for window type selection and user-defined window type. It provides member functions to generate an instance of MHAWindow::base_t based on the values provided by the configuration interface.

The configuration interface is derived from MHAParser::parser_t and can thus be inserted into the configuration tree using the insert_item() method of the parent parser.

If one of the pre-defined window types is used, then the window is generated using the MHAWindow::fun_t class constructor; for the user-defined type the values from the "user" variable are copied.

Member Enumeration Documentation

◆ wtype_t

Enumerator
wnd_rect 
wnd_hann 
wnd_hamming 
wnd_blackman 
wnd_bartlett 
wnd_user 

Constructor & Destructor Documentation

◆ window_t()

MHAParser::window_t::window_t ( const std::string &  help = "Window type configuration.")

Constructor to create parser class.

Member Function Documentation

◆ get_window() [1/5]

MHAWindow::base_t MHAParser::window_t::get_window ( unsigned int  len) const

Create a window instance, use default parameters.

◆ get_window() [2/5]

MHAWindow::base_t MHAParser::window_t::get_window ( unsigned int  len,
float  xmin 
) const

Create a window instance.

◆ get_window() [3/5]

MHAWindow::base_t MHAParser::window_t::get_window ( unsigned int  len,
float  xmin,
float  xmax 
) const

Create a window instance.

◆ get_window() [4/5]

MHAWindow::base_t MHAParser::window_t::get_window ( unsigned int  len,
float  xmin,
float  xmax,
bool  minincluded 
) const

Create a window instance.

◆ get_window() [5/5]

MHAWindow::base_t MHAParser::window_t::get_window ( unsigned int  len,
float  xmin,
float  xmax,
bool  minincluded,
bool  maxincluded 
) const

Create a window instance.

◆ get_type()

MHAParser::window_t::wtype_t MHAParser::window_t::get_type ( ) const

Return currently selected window type.

◆ setlock()

void MHAParser::window_t::setlock ( bool  b)
inline

Member Data Documentation

◆ wtype

MHAParser::kw_t MHAParser::window_t::wtype
private

◆ user

MHAParser::vfloat_t MHAParser::window_t::user
private

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