librcsb-core-wrapper 1.005
CifFileUtil.h
Go to the documentation of this file.
1//$$FILE$$
2//$$VERSION$$
3//$$DATE$$
4//$$LICENSE$$
5
6
7#ifndef CIFFILEUTIL_H
8#define CIFFILEUTIL_H
9
10
11#include <string>
12
13#include <rcsb/DicFile.h>
14#include <rcsb/CifFile.h>
15
16
17DicFile* GetDictFile(DicFile* ddlFileP, const std::string& dictFileName,
18 const std::string& dictSdbFileName = std::string(), const bool verbose =
19 false, const eFileMode fileMode = READ_MODE);
20void CheckDict(DicFile* dictFileP, DicFile* ddlFileP,
21 const string& dictFileName, const bool extraDictChecks = false);
22void CheckCif(CifFile* cifFileP, DicFile* dictFileP,
23 const string& cifFileName, const bool extraCifChecks = false);
24
25DicFile* ParseDict(const std::string& dictFileName, DicFile* ddlFileP = NULL,
26 const bool verbose = false);
27CifFile* ParseCif(const std::string& fileName, const bool verbose = false,
29 const unsigned int maxLineLength = CifFile::STD_CIF_LINE_LENGTH,
30 const std::string& nullValue = CifString::UnknownValue,
31 const std::string& parseLogFileName = std::string());
32CifFile* ParseCifString(const std::string& cifString,
33 const bool verbose = false,
35 const unsigned int maxLineLength = CifFile::STD_CIF_LINE_LENGTH,
36 const std::string& nullValue = CifString::UnknownValue);
37
53void DataCorrection(CifFile& cifFile, DicFile& dicRef);
54
55#endif
Header file for CifFile class.
void CheckDict(DicFile *dictFileP, DicFile *ddlFileP, const string &dictFileName, const bool extraDictChecks=false)
CifFile * ParseCifString(const std::string &cifString, const bool verbose=false, const Char::eCompareType caseSense=Char::eCASE_SENSITIVE, const unsigned int maxLineLength=CifFile::STD_CIF_LINE_LENGTH, const std::string &nullValue=CifString::UnknownValue)
CifFile * ParseCif(const std::string &fileName, const bool verbose=false, const Char::eCompareType caseSense=Char::eCASE_SENSITIVE, const unsigned int maxLineLength=CifFile::STD_CIF_LINE_LENGTH, const std::string &nullValue=CifString::UnknownValue, const std::string &parseLogFileName=std::string())
DicFile * GetDictFile(DicFile *ddlFileP, const std::string &dictFileName, const std::string &dictSdbFileName=std::string(), const bool verbose=false, const eFileMode fileMode=READ_MODE)
DicFile * ParseDict(const std::string &dictFileName, DicFile *ddlFileP=NULL, const bool verbose=false)
void CheckCif(CifFile *cifFileP, DicFile *dictFileP, const string &cifFileName, const bool extraCifChecks=false)
void DataCorrection(CifFile &cifFile, DicFile &dicRef)
Header file for DicFile class.
eFileMode
Definition Serializer.h:34
@ READ_MODE
Definition Serializer.h:36
eCompareType
Definition GenString.h:27
@ eCASE_SENSITIVE
Definition GenString.h:28
Public class that represents a CIF file, composed of blocks with tables.
Definition CifFile.h:48
static const unsigned int STD_CIF_LINE_LENGTH
Definition CifFile.h:53
static const std::string UnknownValue
Definition CifString.h:128
Public class that represents a dictionary file, composed of blocks with tables.
Definition DicFile.h:37