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

Read

NAME Read

PROTOTYPE

#include "DDLFileObj.h"

int DDLFileObj::Read(char * ddlFileName, 
                     ISTable *&format, 
                     char *& diagnostics);

EXAMPLE

#include "DDLFileObj.h"
char *diags=NULL;
DDLFileObj * fobjR = NULL;
ISTable *format;

format = new ISTable("format");
fobjR = new DDLFileObj("./test/TESTFILE6", WRITE_MODE, 80, "?", 1);
fobjR->Read("./test/ndb_ddl",format, diags);
cout<<"diags = "<<diags<<endl;

PURPOSE

Read(char *, ISTable *&, char *&) reads ddl file, specified by ddlFileName. Also, returns information about format of save frames in table format i.e. what information are relevant for category save frames what for item save frames. This informatin is needed when data have to be written back in ddl file in a same format.

RECEIVES

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

ddlFileName	The name of ddl file
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