Chemical Data Processing Library C++ API - Version 1.2.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CDPL::ConfGen::FragmentLibrary Class Reference

#include <FragmentLibrary.hpp>

Public Types

typedef std::shared_ptr< FragmentLibrarySharedPointer
 
typedef HashToEntryMap::value_type Entry
 
typedef HashToEntryMap::const_iterator ConstEntryIterator
 
typedef HashToEntryMap::iterator EntryIterator
 

Public Member Functions

 FragmentLibrary ()
 
 FragmentLibrary (const FragmentLibrary &lib)
 
 ~FragmentLibrary ()
 
FragmentLibraryoperator= (const FragmentLibrary &lib)
 
void addEntries (const FragmentLibrary &lib)
 
bool addEntry (const FragmentLibraryEntry::SharedPointer &entry)
 
const FragmentLibraryEntry::SharedPointergetEntry (std::uint64_t hash_code) const
 
bool containsEntry (std::uint64_t hash_code) const
 
std::size_t getNumEntries () const
 
void clear ()
 
bool removeEntry (std::uint64_t hash_code)
 
EntryIterator removeEntry (const EntryIterator &it)
 
ConstEntryIterator getEntriesBegin () const
 
ConstEntryIterator getEntriesEnd () const
 
EntryIterator getEntriesBegin ()
 
EntryIterator getEntriesEnd ()
 
ConstEntryIterator begin () const
 
ConstEntryIterator end () const
 
EntryIterator begin ()
 
EntryIterator end ()
 
void load (std::istream &is)
 
void save (std::ostream &os) const
 
void loadDefaults ()
 
std::mutex & getMutex ()
 

Static Public Member Functions

static void set (const SharedPointer &lib)
 
static const SharedPointerget ()
 

Member Typedef Documentation

◆ SharedPointer

◆ Entry

typedef HashToEntryMap::value_type CDPL::ConfGen::FragmentLibrary::Entry

◆ ConstEntryIterator

typedef HashToEntryMap::const_iterator CDPL::ConfGen::FragmentLibrary::ConstEntryIterator

◆ EntryIterator

typedef HashToEntryMap::iterator CDPL::ConfGen::FragmentLibrary::EntryIterator

Constructor & Destructor Documentation

◆ FragmentLibrary() [1/2]

CDPL::ConfGen::FragmentLibrary::FragmentLibrary ( )

◆ FragmentLibrary() [2/2]

CDPL::ConfGen::FragmentLibrary::FragmentLibrary ( const FragmentLibrary lib)

◆ ~FragmentLibrary()

CDPL::ConfGen::FragmentLibrary::~FragmentLibrary ( )

Member Function Documentation

◆ operator=()

FragmentLibrary& CDPL::ConfGen::FragmentLibrary::operator= ( const FragmentLibrary lib)

◆ addEntries()

void CDPL::ConfGen::FragmentLibrary::addEntries ( const FragmentLibrary lib)

◆ addEntry()

bool CDPL::ConfGen::FragmentLibrary::addEntry ( const FragmentLibraryEntry::SharedPointer entry)

◆ getEntry()

const FragmentLibraryEntry::SharedPointer& CDPL::ConfGen::FragmentLibrary::getEntry ( std::uint64_t  hash_code) const

◆ containsEntry()

bool CDPL::ConfGen::FragmentLibrary::containsEntry ( std::uint64_t  hash_code) const

◆ getNumEntries()

std::size_t CDPL::ConfGen::FragmentLibrary::getNumEntries ( ) const

◆ clear()

void CDPL::ConfGen::FragmentLibrary::clear ( )

◆ removeEntry() [1/2]

bool CDPL::ConfGen::FragmentLibrary::removeEntry ( std::uint64_t  hash_code)

◆ removeEntry() [2/2]

EntryIterator CDPL::ConfGen::FragmentLibrary::removeEntry ( const EntryIterator it)

◆ getEntriesBegin() [1/2]

ConstEntryIterator CDPL::ConfGen::FragmentLibrary::getEntriesBegin ( ) const

◆ getEntriesEnd() [1/2]

ConstEntryIterator CDPL::ConfGen::FragmentLibrary::getEntriesEnd ( ) const

◆ getEntriesBegin() [2/2]

EntryIterator CDPL::ConfGen::FragmentLibrary::getEntriesBegin ( )

◆ getEntriesEnd() [2/2]

EntryIterator CDPL::ConfGen::FragmentLibrary::getEntriesEnd ( )

◆ begin() [1/2]

ConstEntryIterator CDPL::ConfGen::FragmentLibrary::begin ( ) const

◆ end() [1/2]

ConstEntryIterator CDPL::ConfGen::FragmentLibrary::end ( ) const

◆ begin() [2/2]

EntryIterator CDPL::ConfGen::FragmentLibrary::begin ( )

◆ end() [2/2]

EntryIterator CDPL::ConfGen::FragmentLibrary::end ( )

◆ load()

void CDPL::ConfGen::FragmentLibrary::load ( std::istream &  is)

◆ save()

void CDPL::ConfGen::FragmentLibrary::save ( std::ostream &  os) const

◆ loadDefaults()

void CDPL::ConfGen::FragmentLibrary::loadDefaults ( )

◆ getMutex()

std::mutex& CDPL::ConfGen::FragmentLibrary::getMutex ( )

◆ set()

static void CDPL::ConfGen::FragmentLibrary::set ( const SharedPointer lib)
static

◆ get()

static const SharedPointer& CDPL::ConfGen::FragmentLibrary::get ( )
static

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