An Information Portal to Biological Macromolecular Structures
PDB Home | Contact Us		Software Tools Home  |  Dictionary Home  |  PDBML Home

Read

NAME Read

PROTOTYPE

#include "CifFileObj.h"

int CifFileObj::Read(char * cifFileName, char *& diagnostics);
int CifFileObj::Read(char * cifFileName, char *& diagnostics,
                     int &err, int &warn);

EXAMPLE

#include "CifFileObj.h"
char *diags=NULL;
int err, warn;

CifFileObj * fobjR = new CifFileObj("./test/TESTFILE1", WRITE_MODE);
fobj->Read("./test/Test1.cif",diags, err, warn);
cout<<"diags = "<<diags<<endl;

PURPOSE

Read(char *, char *&) reads cif file, specified by cifFileName. Read(char *, char *&, int, int) reads cif file, specified by cifFileName, and returns number of errors err and number of warnings warn found in the cif file.

RECEIVES

CifFileObj()

No Arguments

CifFileObj(char * , char *&)

cifFileName	The name of cif file
diagnostics	Pointer to string

CifFileObj(char * , char *&, int, int)

cifFileName	The name of cif file
diagnostics	Pointer to string
err	Number of errors
war	Number of warnings

RETURN VALUE

Returns -1 if the cif file could not be opened, otherwise returns 0. diagnostics shows if the method could successfully parse the input file. In that case diagnostics is empty string, otherwise diagnostics contains description of error.

REMARKS

None

 

© RCSB PDB