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

Variable with float value. More...

Inheritance diagram for MHAParser::float_t:
Inheritance graph

Public Member Functions

 float_t (const std::string &help_text, const std::string &initial_value, const std::string &range="")
 Constructor for a configuration language variable for 32bit ieee floating-point values. More...
- Public Member Functions inherited from MHAParser::range_var_t
 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 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

float 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

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 ()

Additional Inherited Members

- Protected Attributes inherited from MHAParser::range_var_t
float low_limit
 Lower limit of range.
float up_limit
 Upper limit of range.
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

Detailed Description

Variable with float value.

Constructor & Destructor Documentation

◆ float_t()

MHAParser::float_t::float_t ( const std::string &  help_text,
const std::string &  initial_value,
const std::string &  range = "" 

Constructor for a configuration language variable for 32bit ieee floating-point values.

help_textA human-readable text describing the purpose of this configuration variable.
initial_valueThe initial value for this variable as a string (decimal representation of the floating-point variable). If a range is given in the third parameter, then the initial value has to be within the range. A human-readable text describing the purpose of this configuration variable.
rangeThe range of values that this variable can hold can be restricted. A range is a string of the form "[a,b]", where a and b are decimal representations of the inclusive boundaries of the range. a<=b. In a range of the form "]a,b[", both boundaries are excluded. Mixed forms are permitted. a or b can also be omitted if there is no lower or upper limit. The range of values is always restricted by the representable range of the underlying C data type.

Member Function Documentation

◆ op_setval()

std::string MHAParser::float_t::op_setval ( expression_t x)

Reimplemented from MHAParser::variable_t.

◆ query_type()

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

Reimplemented from MHAParser::base_t.

◆ query_val()

std::string MHAParser::float_t::query_val ( const std::string &  s)

Reimplemented from MHAParser::base_t.

Member Data Documentation

◆ data

float MHAParser::float_t::data

Data field.

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