Chemical Data Processing Library C++ API - Version 1.2.0
Classes | Public Types | Public Member Functions | List of all members
CDPL::Biomol::MMCIFData Class Reference

A data structure for the storage of imported MMCIF data (see [MMCIF]). More...

#include <MMCIFData.hpp>

Classes

class  Category
 
class  Item
 

Public Types

typedef std::shared_ptr< MMCIFDataSharedPointer
 
typedef CategoryList::const_iterator ConstCategoryIterator
 
typedef CategoryList::iterator CategoryIterator
 

Public Member Functions

 MMCIFData ()=default
 
 MMCIFData (const std::string &id)
 
void setID (const std::string &id)
 
const std::string & getID () const
 
void clear ()
 
std::size_t getNumCategories () const
 
CategorygetCategory (std::size_t index)
 
const CategorygetCategory (std::size_t index) const
 
CategorygetCategory (const std::string &name)
 
const CategorygetCategory (const std::string &name) const
 
const CategoryfindCategory (const std::string &name) const
 
CategoryfindCategory (const std::string &name)
 
const CategorylastCategory () const
 
CategorylastCategory ()
 
CategoryaddCategory (const std::string &name, bool front=false)
 
CategoryIterator removeCategory (const CategoryIterator &it)
 
bool removeCategory (const std::string &name)
 
void removeCategory (std::size_t index)
 
void swap (MMCIFData &data)
 
ConstCategoryIterator getCategoriesBegin () const
 
CategoryIterator getCategoriesBegin ()
 
ConstCategoryIterator getCategoriesEnd () const
 
CategoryIterator getCategoriesEnd ()
 
ConstCategoryIterator begin () const
 
CategoryIterator begin ()
 
ConstCategoryIterator end () const
 
CategoryIterator end ()
 

Detailed Description

A data structure for the storage of imported MMCIF data (see [MMCIF]).

Since
1.2

Member Typedef Documentation

◆ SharedPointer

◆ ConstCategoryIterator

typedef CategoryList::const_iterator CDPL::Biomol::MMCIFData::ConstCategoryIterator

◆ CategoryIterator

typedef CategoryList::iterator CDPL::Biomol::MMCIFData::CategoryIterator

Constructor & Destructor Documentation

◆ MMCIFData() [1/2]

CDPL::Biomol::MMCIFData::MMCIFData ( )
default

◆ MMCIFData() [2/2]

CDPL::Biomol::MMCIFData::MMCIFData ( const std::string &  id)

Member Function Documentation

◆ setID()

void CDPL::Biomol::MMCIFData::setID ( const std::string &  id)

◆ getID()

const std::string& CDPL::Biomol::MMCIFData::getID ( ) const

◆ clear()

void CDPL::Biomol::MMCIFData::clear ( )

◆ getNumCategories()

std::size_t CDPL::Biomol::MMCIFData::getNumCategories ( ) const

◆ getCategory() [1/4]

Category& CDPL::Biomol::MMCIFData::getCategory ( std::size_t  index)

◆ getCategory() [2/4]

const Category& CDPL::Biomol::MMCIFData::getCategory ( std::size_t  index) const

◆ getCategory() [3/4]

Category& CDPL::Biomol::MMCIFData::getCategory ( const std::string &  name)

◆ getCategory() [4/4]

const Category& CDPL::Biomol::MMCIFData::getCategory ( const std::string &  name) const

◆ findCategory() [1/2]

const Category* CDPL::Biomol::MMCIFData::findCategory ( const std::string &  name) const

◆ findCategory() [2/2]

Category* CDPL::Biomol::MMCIFData::findCategory ( const std::string &  name)

◆ lastCategory() [1/2]

const Category& CDPL::Biomol::MMCIFData::lastCategory ( ) const

◆ lastCategory() [2/2]

Category& CDPL::Biomol::MMCIFData::lastCategory ( )

◆ addCategory()

Category& CDPL::Biomol::MMCIFData::addCategory ( const std::string &  name,
bool  front = false 
)

◆ removeCategory() [1/3]

CategoryIterator CDPL::Biomol::MMCIFData::removeCategory ( const CategoryIterator it)

◆ removeCategory() [2/3]

bool CDPL::Biomol::MMCIFData::removeCategory ( const std::string &  name)

◆ removeCategory() [3/3]

void CDPL::Biomol::MMCIFData::removeCategory ( std::size_t  index)

◆ swap()

void CDPL::Biomol::MMCIFData::swap ( MMCIFData data)

◆ getCategoriesBegin() [1/2]

ConstCategoryIterator CDPL::Biomol::MMCIFData::getCategoriesBegin ( ) const

◆ getCategoriesBegin() [2/2]

CategoryIterator CDPL::Biomol::MMCIFData::getCategoriesBegin ( )

◆ getCategoriesEnd() [1/2]

ConstCategoryIterator CDPL::Biomol::MMCIFData::getCategoriesEnd ( ) const

◆ getCategoriesEnd() [2/2]

CategoryIterator CDPL::Biomol::MMCIFData::getCategoriesEnd ( )

◆ begin() [1/2]

ConstCategoryIterator CDPL::Biomol::MMCIFData::begin ( ) const

◆ begin() [2/2]

CategoryIterator CDPL::Biomol::MMCIFData::begin ( )

◆ end() [1/2]

ConstCategoryIterator CDPL::Biomol::MMCIFData::end ( ) const

◆ end() [2/2]

CategoryIterator CDPL::Biomol::MMCIFData::end ( )

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