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

Read

NAME Read

PROTOTYPE

#include "DICFileObj.h"

int DICFileObj::Read(char * dicFileName, TblFileObj * ddl,
                     ISTable *&format,char *& diagnostics);

EXAMPLE

#include "DICFileObj.h"
#include "DDLFileObj.h"
char *diags=NULL;
ISTable *format;
ISTable *ddlformat;
DDLFileObj * ddl = NULL;

ddl = new DDLFileObj("ddl", WRITE_MODE, 80, "?", 1);
ddlformat = new ISTable("ddlformat");
ddl->Read("./test/ddl-mm",ddlformat, diags);
cout<<"diags = "<<diags<<endl;

format = new ISTable("format");
DICFileObj * fobjR = new DICFileObj("./test/TESTFILE1", WRITE_MODE);
fobj->Read("./test/Test1.cif",ddl , format,diags);
cout<<"diags = "<<diags<<endl;

PURPOSE

Read(char *, TblFileObj *, ISTable *&, char *&) reads dictionary, specified by dicFileName. Implicit values determines from ddl. Return format of save frames in format.

RECEIVES

Read(char *, TblFileObj *, ISTable *&, char *&)

dicFileName	The name of dictionary file
ddl	Pointer to TblFileObj that keeps information from ddl
format	Pointer ISTable that keep information of save frame format
diagnostics	Pointer to string

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