Libosmium  2.10.3
Fast and flexible C++ library for working with OpenStreetMap data
Public Member Functions | List of all members
osmium::index::map::Dummy< TId, TValue > Class Template Reference

#include <dummy.hpp>

Inheritance diagram for osmium::index::map::Dummy< TId, TValue >:
Inheritance graph
[legend]
Collaboration diagram for osmium::index::map::Dummy< TId, TValue >:
Collaboration graph
[legend]

Public Member Functions

 Dummy ()=default
 
 ~Dummy () noexcept final=default
 
void set (const TId, const TValue) final
 Set the field with id to value. More...
 
const TValue get (const TId id) const final
 Retrieve value by id. Does not check for overflow or empty fields. More...
 
size_t size () const final
 
size_t used_memory () const final
 
void clear () final
 
- Public Member Functions inherited from osmium::index::map::Map< TId, TValue >
 Map ()=default
 
virtual ~Map () noexcept=default
 
virtual void reserve (const size_t)
 
virtual void sort ()
 
virtual void dump_as_list (const int)
 
virtual void dump_as_array (const int)
 

Additional Inherited Members

- Public Types inherited from osmium::index::map::Map< TId, TValue >
using key_type = TId
 The "key" type, usually osmium::unsigned_object_id_type. More...
 
using value_type = TValue
 The "value" type, usually a Location or size_t. More...
 
- Protected Member Functions inherited from osmium::index::map::Map< TId, TValue >
 Map (Map &&)=default
 
Mapoperator= (Map &&)=default
 

Detailed Description

template<typename TId, typename TValue>
class osmium::index::map::Dummy< TId, TValue >

Pseudo map. Use this class if you don't need a map, but you need an object that behaves like one.

Constructor & Destructor Documentation

§ Dummy()

template<typename TId , typename TValue >
osmium::index::map::Dummy< TId, TValue >::Dummy ( )
default

§ ~Dummy()

template<typename TId , typename TValue >
osmium::index::map::Dummy< TId, TValue >::~Dummy ( )
finaldefaultnoexcept

Member Function Documentation

§ clear()

template<typename TId , typename TValue >
void osmium::index::map::Dummy< TId, TValue >::clear ( )
inlinefinalvirtual

Clear memory used for this storage. After this you can not use the storage container any more.

Implements osmium::index::map::Map< TId, TValue >.

§ get()

template<typename TId , typename TValue >
const TValue osmium::index::map::Dummy< TId, TValue >::get ( const TId  id) const
inlinefinalvirtual

Retrieve value by id. Does not check for overflow or empty fields.

Implements osmium::index::map::Map< TId, TValue >.

§ set()

template<typename TId , typename TValue >
void osmium::index::map::Dummy< TId, TValue >::set ( const TId  id,
const TValue  value 
)
inlinefinalvirtual

Set the field with id to value.

Implements osmium::index::map::Map< TId, TValue >.

§ size()

template<typename TId , typename TValue >
size_t osmium::index::map::Dummy< TId, TValue >::size ( ) const
inlinefinalvirtual

Get the approximate number of items in the storage. The storage might allocate memory in blocks, so this size might not be accurate. You can not use this to find out how much memory the storage uses. Use used_memory() for that.

Implements osmium::index::map::Map< TId, TValue >.

§ used_memory()

template<typename TId , typename TValue >
size_t osmium::index::map::Dummy< TId, TValue >::used_memory ( ) const
inlinefinalvirtual

Get the memory used for this storage in bytes. Note that this is not necessarily entirely accurate but an approximation. For storage classes that store the data in memory, this is the main memory used, for storage classes storing data on disk this is the memory used on disk.

Implements osmium::index::map::Map< TId, TValue >.


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