Classes | Enumerations | Functions | Variables

mmdb::mmcif Namespace Reference

Classes

class  Category
 mmcif::Category is a base class for mmcif::Struct and mmcif::Loop, implementations of mmCIF's "structure" and "loop" categories. More...
class  Struct
 mmcif::Struct represents mmCIF's "structure" category, where data follows directly the corresponding tag. More...
class  Loop
 mmcif::Loop represents mmCIF's "loop" category, which keeps rows of data values associated with tags. More...
class  Data
 mmcif::Data represents mmCIF's "data" category, which keeps structures and loops and is mandatory element of mmCIF file. More...
class  File

Enumerations

enum  MMCIF_ITEM { MMCIF_Category = 0, MMCIF_Struct = 1, MMCIF_Loop = 2, MMCIF_Data = 3 }
enum  CIF_WARNING {
  CIFW_UnrecognizedItems = 0x00000020, CIFW_MissingField = 0x00000040, CIFW_EmptyLoop = 0x00000080, CIFW_UnexpectedEOF = 0x00000100,
  CIFW_LoopFieldMissing = 0x00000200, CIFW_NotAStructure = 0x00000400, CIFW_NotALoop = 0x00000800, CIFW_DuplicateTag = 0x00001000
}
enum  CIF_RC {
  CIFRC_Loop = 2, CIFRC_Structure = 1, CIFRC_Ok = 0, CIFRC_StructureNoTag = -1,
  CIFRC_LoopNoTag = -2, CIFRC_NoCategory = -3, CIFRC_WrongFormat = -4, CIFRC_NoTag = -5,
  CIFRC_NotAStructure = -6, CIFRC_NotALoop = -7, CIFRC_WrongIndex = -8, CIFRC_NoField = -9,
  CIFRC_Created = -12, CIFRC_CantOpenFile = -13, CIFRC_NoDataLine = -14, CIFRC_NoData = -15
}
enum  CIF_FLAG { CIFFL_PrintWarnings = 0x00000001, CIFFL_StopOnWarnings = 0x00000002, CIFFL_SuggestCategories = 0x00000004, CIFFL_SuggestTags = 0x00000008 }

Functions

void SortTags (psvector tag, int len, ivector index)
 MakeStreamFunctions (Category) Struct
 MakeStreamFunctions (Struct) Loop
 MakeStreamFunctions (Loop) Data
 MakeStreamFunctions (Data) File
pstr GetMMCIFInputBuffer (int &LineNo)
 MakeStreamFunctions (File) int isCIF(cpstr FName
f assign (FName, true, false, gzipMode)
 if (f.reset(true))
int isCIF (io::RFile f)
pstr GetCIFMessage (pstr M, int RC)
 DefineClass (Category)
 DefineStreamFunctions (Category)
 DefineClass (Struct)
 DefineStreamFunctions (Struct)
 DefineClass (Loop)
 DefineStreamFunctions (Loop)
 DefineClass (Data)
 DefineStreamFunctions (Data)
 DefineClass (File)
 DefineStreamFunctions (File)
int isCIF (cpstr FName, io::GZ_MODE gzipMode=io::GZM_CHECK)

Variables

const int CIF_NODATA_DOT = 0
 Constants used to specify mmCIF's "data not given" and "data not available" data types.
const int CIF_NODATA_QUESTION = 1
cpstr CIF_NODATA_DOT_FIELD = pstr("\x02" ".")
cpstr CIF_NODATA_QUESTION_FIELD = pstr("\x02" "?")
io::GZ_MODE gzipMode io::File f
int rc = -1

Enumeration Type Documentation

Enumerator:
CIFFL_PrintWarnings 
CIFFL_StopOnWarnings 
CIFFL_SuggestCategories 
CIFFL_SuggestTags 
Enumerator:
CIFRC_Loop 
CIFRC_Structure 
CIFRC_Ok 
CIFRC_StructureNoTag 
CIFRC_LoopNoTag 
CIFRC_NoCategory 
CIFRC_WrongFormat 
CIFRC_NoTag 
CIFRC_NotAStructure 
CIFRC_NotALoop 
CIFRC_WrongIndex 
CIFRC_NoField 
CIFRC_Created 
CIFRC_CantOpenFile 
CIFRC_NoDataLine 
CIFRC_NoData 
Enumerator:
CIFW_UnrecognizedItems 
CIFW_MissingField 
CIFW_EmptyLoop 
CIFW_UnexpectedEOF 
CIFW_LoopFieldMissing 
CIFW_NotAStructure 
CIFW_NotALoop 
CIFW_DuplicateTag 
Enumerator:
MMCIF_Category 
MMCIF_Struct 
MMCIF_Loop 
MMCIF_Data 

Function Documentation

f mmdb::mmcif::assign ( FName  ,
true  ,
false  ,
gzipMode   
)
mmdb::mmcif::DefineClass ( Loop   )
mmdb::mmcif::DefineClass ( Data   )
mmdb::mmcif::DefineClass ( File   )
mmdb::mmcif::DefineClass ( Category   )
mmdb::mmcif::DefineClass ( Struct   )
mmdb::mmcif::DefineStreamFunctions ( Loop   )
mmdb::mmcif::DefineStreamFunctions ( Data   )
mmdb::mmcif::DefineStreamFunctions ( File   )
mmdb::mmcif::DefineStreamFunctions ( Category   )
mmdb::mmcif::DefineStreamFunctions ( Struct   )
pstr mmdb::mmcif::GetCIFMessage ( pstr  M,
int  RC 
)
pstr mmdb::mmcif::GetMMCIFInputBuffer ( int &  LineNo )
mmdb::mmcif::if ( f.  resettrue )
int mmdb::mmcif::isCIF ( cpstr  FName,
io::GZ_MODE  gzipMode = io::GZM_CHECK 
)
int mmdb::mmcif::isCIF ( io::RFile  f )
mmdb::mmcif::MakeStreamFunctions ( File   )
mmdb::mmcif::MakeStreamFunctions ( Loop   )
mmdb::mmcif::MakeStreamFunctions ( Struct   )
mmdb::mmcif::MakeStreamFunctions ( Data   )
mmdb::mmcif::MakeStreamFunctions ( Category   )
void mmdb::mmcif::SortTags ( psvector  tag,
int  len,
ivector  index 
)

Variable Documentation

Constants used to specify mmCIF's "data not given" and "data not available" data types.

return mmdb::mmcif::rc = -1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines