The Open Master Hearing Aid (openMHA)  openMHA
Open community platform for hearing aid algorithm research
MHAParser::kw_t Class Reference

Variable with keyword list value. More...

Inheritance diagram for MHAParser::kw_t:
Inheritance graph

Public Member Functions

 kw_t (const std::string &, const std::string &, const std::string &)
 Constructor of a keyword list openMHA configuration variable. More...
 
 kw_t (const kw_t &)
 Copy constructor. More...
 
void set_range (const std::string &)
 Set/change the list of valid entries. More...
 
bool isval (const std::string &) const
 Test if the given value is selected. 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_toperator= (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_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 op_subparse (expression_t &)
 
virtual std::string query_entries (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 Attributes

keyword_list_t data
 Variable data in its native type. 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

void validate (const keyword_list_t &)
 
std::string op_setval (expression_t &)
 
std::string query_range (const std::string &)
 
std::string query_val (const std::string &)
 
std::string query_type (const std::string &)
 
- Protected Member Functions inherited from MHAParser::base_t
void activate_query (const std::string &, query_t)
 
void notify ()
 

Additional Inherited Members

- Protected Attributes inherited from MHAParser::base_t
query_map_t queries
 
bool data_is_initialized
 

Detailed Description

Variable with keyword list value.

Constructor & Destructor Documentation

◆ kw_t() [1/2]

MHAParser::kw_t::kw_t ( const std::string &  h,
const std::string &  v,
const std::string &  rg 
)

Constructor of a keyword list openMHA configuration variable.

Parameters
hA help string describing the purpose of this variable.
vThe initial value, has to be a value from the list of possible values given in the last parameter.
rgA string containing the list of valid entries. The entries have to be separated by spaces. The list of entries has to be delimited by brackets "[", "]".

◆ kw_t() [2/2]

MHAParser::kw_t::kw_t ( const kw_t src)

Copy constructor.

Member Function Documentation

◆ set_range()

void MHAParser::kw_t::set_range ( const std::string &  r)

Set/change the list of valid entries.

Parameters
rA string containing the list of valid entries. The entries have to be separated by spaces. The list of entries has to be delimited by brackets "[", "]".

◆ isval()

bool MHAParser::kw_t::isval ( const std::string &  testval) const

Test if the given value is selected.

◆ validate()

void MHAParser::kw_t::validate ( const keyword_list_t s)
protected

◆ op_setval()

std::string MHAParser::kw_t::op_setval ( expression_t x)
protectedvirtual

Reimplemented from MHAParser::variable_t.

◆ query_range()

std::string MHAParser::kw_t::query_range ( const std::string &  )
protectedvirtual

Reimplemented from MHAParser::base_t.

◆ query_val()

std::string MHAParser::kw_t::query_val ( const std::string &  s)
protectedvirtual

Reimplemented from MHAParser::base_t.

◆ query_type()

std::string MHAParser::kw_t::query_type ( const std::string &  )
protectedvirtual

Reimplemented from MHAParser::base_t.

Member Data Documentation

◆ data

keyword_list_t MHAParser::kw_t::data

Variable data in its native type.


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