osmium::util::Options Class Reference

#include <options.hpp>

Inheritance diagram for osmium::util::Options:

Public Types
typedef option_map::iterator	iterator
typedef option_map::const_iterator	const_iterator
typedef option_map::value_type	value_type

Public Member Functions
	Options ()=default
	Options (const std::initializer_list< value_type > &values)
	Options (const Options &)=default
Options &	operator= (const Options &)=default
	Options (Options &&)=default
Options &	operator= (Options &&)=default
	~Options ()=default
void	set (const std::string &key, const std::string &value)
void	set (const std::string &key, const char *value)
void	set (const std::string &key, bool value)
void	set (std::string data)
std::string	get (const std::string &key, const std::string &default_value="") const noexcept
bool	is_true (const std::string &key) const noexcept
size_t	size () const noexcept
iterator	begin () noexcept
iterator	end () noexcept
const_iterator	begin () const noexcept
const_iterator	end () const noexcept
const_iterator	cbegin () const noexcept
const_iterator	cend () const noexcept

Private Types
typedef std::map< std::string, std::string >	option_map

Private Attributes
option_map	m_options

Detailed Description

Stores key=value type options. This class can be used stand-alone or as a base class. Options are stored and retrieved by key using the different set() and get() methods.

You can iterate over all set options. Dereferencing an iterator yields a std::pair of the key and value strings.

Member Typedef Documentation

typedef option_map::const_iterator osmium::util::Options::const_iterator

typedef option_map::iterator osmium::util::Options::iterator

typedef std::map<std::string, std::string> osmium::util::Options::option_map

private

typedef option_map::value_type osmium::util::Options::value_type

Constructor & Destructor Documentation

osmium::util::Options::Options ( )

default

osmium::util::Options::Options ( const std::initializer_list< value_type > &  values )

inlineexplicit

osmium::util::Options::Options ( const Options &  )

default

osmium::util::Options::Options ( Options &&  )

default

osmium::util::Options::~Options ( )

default

Member Function Documentation

iterator osmium::util::Options::begin ( )

inlinenoexcept

const_iterator osmium::util::Options::begin ( ) const

inlinenoexcept

const_iterator osmium::util::Options::cbegin ( ) const

inlinenoexcept

const_iterator osmium::util::Options::cend ( ) const

inlinenoexcept

iterator osmium::util::Options::end ( )

inlinenoexcept

const_iterator osmium::util::Options::end ( ) const

inlinenoexcept

std::string osmium::util::Options::get ( const std::string &  key, const std::string &  default_value = ""  ) const

inlinenoexcept

Get value of "key" option. If not set the default_value (or empty string) is returned.

bool osmium::util::Options::is_true ( const std::string &  key ) const

inlinenoexcept

Is this option set to a true value ("true" or "yes")?

Options& osmium::util::Options::operator= ( const Options &  )

default

Options& osmium::util::Options::operator= ( Options &&  )

default

void osmium::util::Options::set ( const std::string &  key, const std::string &  value  )

inline

void osmium::util::Options::set ( const std::string &  key, const char *  value  )

inline

void osmium::util::Options::set ( const std::string &  key, bool  value  )

inline

void osmium::util::Options::set ( std::string  data )

inline

size_t osmium::util::Options::size ( ) const

inlinenoexcept

Member Data Documentation

option_map osmium::util::Options::m_options

private

---

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

• osmium/util/options.hpp