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

Base class for all variables with a numeric value range. More...

Inheritance diagram for MHAParser::range_var_t:
Inheritance graph

Public Member Functions

 range_var_t (const std::string &, const std::string &="")
 
 range_var_t (const range_var_t &)
 
std::string query_range (const std::string &)
 
void set_range (const std::string &r)
 Change the valid range of a variable. More...
 
void validate (const int &)
 
void validate (const float &)
 
void validate (const mha_complex_t &)
 
void validate (const std::vector< int > &)
 
void validate (const std::vector< float > &)
 
void validate (const std::vector< mha_complex_t > &)
 
void validate (const std::vector< std::vector< int > > &)
 
void validate (const std::vector< std::vector< float > > &)
 
void validate (const std::vector< std::vector< mha_complex_t > > &)
 
- Public Member Functions inherited from MHAParser::variable_t
 variable_t (const std::string &)
 
std::string op_setval (expression_t &)
 
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_type (const std::string &)
 
virtual std::string query_val (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...
 

Protected Attributes

float low_limit
 Lower limit of range.
More...
 
float up_limit
 Upper limit of range.
More...
 
bool low_incl
 Lower limit is included (or excluded) in range. More...
 
bool up_incl
 Upper limit is included (or excluded) in range. More...
 
bool check_low
 Check lower limit. More...
 
bool check_up
 Check upper limit. More...
 
bool check_range
 Range checking is active. More...
 
- Protected Attributes inherited from MHAParser::base_t
query_map_t queries
 
bool data_is_initialized
 

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::base_t
void activate_query (const std::string &, query_t)
 
void notify ()
 

Detailed Description

Base class for all variables with a numeric value range.

Constructor & Destructor Documentation

◆ range_var_t() [1/2]

MHAParser::range_var_t::range_var_t ( const std::string &  h,
const std::string &  r = "" 
)

◆ range_var_t() [2/2]

MHAParser::range_var_t::range_var_t ( const range_var_t src)

Member Function Documentation

◆ query_range()

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

Reimplemented from MHAParser::base_t.

◆ set_range()

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

Change the valid range of a variable.

Parameters
rNew range of the variable (string representation)

◆ validate() [1/9]

void MHAParser::range_var_t::validate ( const int &  v)

◆ validate() [2/9]

void MHAParser::range_var_t::validate ( const float &  v)

◆ validate() [3/9]

void MHAParser::range_var_t::validate ( const mha_complex_t v)

◆ validate() [4/9]

void MHAParser::range_var_t::validate ( const std::vector< int > &  v)

◆ validate() [5/9]

void MHAParser::range_var_t::validate ( const std::vector< float > &  v)

◆ validate() [6/9]

void MHAParser::range_var_t::validate ( const std::vector< mha_complex_t > &  v)

◆ validate() [7/9]

void MHAParser::range_var_t::validate ( const std::vector< std::vector< int > > &  v)

◆ validate() [8/9]

void MHAParser::range_var_t::validate ( const std::vector< std::vector< float > > &  v)

◆ validate() [9/9]

void MHAParser::range_var_t::validate ( const std::vector< std::vector< mha_complex_t > > &  v)

Member Data Documentation

◆ low_limit

float MHAParser::range_var_t::low_limit
protected

Lower limit of range.

◆ up_limit

float MHAParser::range_var_t::up_limit
protected

Upper limit of range.

◆ low_incl

bool MHAParser::range_var_t::low_incl
protected

Lower limit is included (or excluded) in range.

◆ up_incl

bool MHAParser::range_var_t::up_incl
protected

Upper limit is included (or excluded) in range.

◆ check_low

bool MHAParser::range_var_t::check_low
protected

Check lower limit.

◆ check_up

bool MHAParser::range_var_t::check_up
protected

Check upper limit.

◆ check_range

bool MHAParser::range_var_t::check_range
protected

Range checking is active.


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