QDP++
QDP::MapObjectDiskMultiple< K, V > Class Template Reference

Class that holds multiple DBs. Can only be used in a read-only mode. More...

#include <qdp_map_obj_disk_multiple.h>

Public Member Functions

 MapObjectDiskMultiple ()
 Empty constructor.
 ~MapObjectDiskMultiple ()
 Finalizes object.
void setDebug (int level)
 Set debugging level.
int getDebug () const
 Get debugging level.
void open (const std::vector< std::string > &files)
 Open files.
bool fileExists (const std::vector< std::string > &files) const
 Check if a DB file exists before opening.
void close ()
 Close the files.
int get (const K &key, V &val) const
void keys (std::vector< K > &keys_) const
void flush ()
bool exist (const K &key) const
int getUserdata (std::string &user_data) const

Detailed Description

template<typename K, typename V>
class QDP::MapObjectDiskMultiple< K, V >

Class that holds multiple DBs. Can only be used in a read-only mode.

Definition at line 19 of file qdp_map_obj_disk_multiple.h.

Constructor & Destructor Documentation

◆ MapObjectDiskMultiple()

template<typename K, typename V>
QDP::MapObjectDiskMultiple< K, V >::MapObjectDiskMultiple ( )
inline

Empty constructor.

Definition at line 23 of file qdp_map_obj_disk_multiple.h.

◆ ~MapObjectDiskMultiple()

template<typename K, typename V>
QDP::MapObjectDiskMultiple< K, V >::~MapObjectDiskMultiple ( )
inline

Finalizes object.

Definition at line 26 of file qdp_map_obj_disk_multiple.h.

Member Function Documentation

◆ close()

template<typename K, typename V>
void QDP::MapObjectDiskMultiple< K, V >::close ( )
inline

Close the files.

Definition at line 67 of file qdp_map_obj_disk_multiple.h.

◆ exist()

template<typename K, typename V>
bool QDP::MapObjectDiskMultiple< K, V >::exist ( const K & key) const
inline

Does this key exist in the store

Parameters
keya key object
Returns
true if the answer is yes

Definition at line 147 of file qdp_map_obj_disk_multiple.h.

◆ fileExists()

template<typename K, typename V>
bool QDP::MapObjectDiskMultiple< K, V >::fileExists ( const std::vector< std::string > & files) const
inline

Check if a DB file exists before opening.

Definition at line 52 of file qdp_map_obj_disk_multiple.h.

◆ flush()

template<typename K, typename V>
void QDP::MapObjectDiskMultiple< K, V >::flush ( )
inline

Flush database in memory to disk

Definition at line 133 of file qdp_map_obj_disk_multiple.h.

◆ get()

template<typename K, typename V>
int QDP::MapObjectDiskMultiple< K, V >::get ( const K & key,
V & val ) const
inline

Get val for a given key

Parameters
keyuser supplied key
valafter the call val will be populated
Returns
0 on success, otherwise the key not found

Definition at line 83 of file qdp_map_obj_disk_multiple.h.

◆ getDebug()

template<typename K, typename V>
int QDP::MapObjectDiskMultiple< K, V >::getDebug ( ) const
inline

Get debugging level.

Definition at line 36 of file qdp_map_obj_disk_multiple.h.

◆ getUserdata()

template<typename K, typename V>
int QDP::MapObjectDiskMultiple< K, V >::getUserdata ( std::string & user_data) const
inline

Get user user data from the metadata database

Parameters
user_datauser supplied buffer to store user data
Returns
returns 0 if success. Otherwise failure.

Definition at line 167 of file qdp_map_obj_disk_multiple.h.

◆ keys()

template<typename K, typename V>
void QDP::MapObjectDiskMultiple< K, V >::keys ( std::vector< K > & keys_) const
inline

Return all available keys to user

Parameters
keysuser suppled an empty vector which is populated by keys after this call.

Definition at line 102 of file qdp_map_obj_disk_multiple.h.

References QDP::read(), QDP::BinaryBufferWriter::str(), and QDP::write().

◆ open()

template<typename K, typename V>
void QDP::MapObjectDiskMultiple< K, V >::open ( const std::vector< std::string > & files)
inline

Open files.

Definition at line 39 of file qdp_map_obj_disk_multiple.h.

◆ setDebug()

template<typename K, typename V>
void QDP::MapObjectDiskMultiple< K, V >::setDebug ( int level)
inline

Set debugging level.

Definition at line 29 of file qdp_map_obj_disk_multiple.h.

References setDebug().

Referenced by setDebug().


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