Essentia  2.1-beta5-dev
ParameterMap Class Reference

#include <parameter.h>

Inheritance diagram for ParameterMap:
EssentiaMap< std::string, Parameter, string_cmp >

Public Member Functions

void add (const std::string &name, const Parameter &value)
 
const Parameteroperator[] (const std::string &key) const
 
Parameteroperator[] (const std::string &key)
 
- Public Member Functions inherited from EssentiaMap< std::string, Parameter, string_cmp >
Parameteroperator[] (const std::string &key)
 
const Parameteroperator[] (const std::string &key) const
 
std::pair< typename BaseClass::iterator, bool > insert (const std::string &key, const Parameter &value)
 
std::vector< std::string > keys () const
 

Protected Types

typedef EssentiaMap< std::string, Parameter, string_cmp > ParameterMapBase
 

Additional Inherited Members

- Public Types inherited from EssentiaMap< std::string, Parameter, string_cmp >
typedef std::map< std::string, Parameter, string_cmp > BaseClass
 

Detailed Description

A ParameterMap is a map whose keys are strings and values are Parameter, and which uses a case-insensitive compare function. It also has two convenient functions for adding new values in it: add() with or without a default value.

Member Typedef Documentation

◆ ParameterMapBase

typedef EssentiaMap<std::string, Parameter, string_cmp> ParameterMapBase
protected

Member Function Documentation

◆ add()

void add ( const std::string &  name,
const Parameter value 
)

◆ operator[]() [1/2]

const Parameter& operator[] ( const std::string &  key) const

◆ operator[]() [2/2]

Parameter& operator[] ( const std::string &  key)

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