PDBInfo Class Documentation

Documentation for the following classes is available:

Class FootNote

/*********************************************************************
Class: FootNote

Method: FootNote()
Description: calls the defaults FootNote CTOR, null ititializes all members
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: FootNote(int i)
Description: same as defaults CTOR, but inits the footnote num. to i
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: FootNote(const FootNote&);
Description: COPY CTOR FootNote, does a Deep Copy of the FootNote
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: int MyNumber() const
Description: returns the FootNote number
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: NonLinearListMgr * MyAtoms() const
Description: returns its non linear atom list
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: LineBuffer * MyFootNote() const
Description: returns the actual text thru the linebuffer class
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: FootNote * Next() const
Description: returns the next FootNote
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: void AddAtom(const ATom&);
Description: Adds an atom to its Non Linear List of Atoms
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: void AddLineBuffer(LineBuffer&);
Description: Adds another LineBuffer, to its LineBuffer list
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNote

Method: void deleteMyAtoms()
Description: deletes its atom list
Usage:
Caution:
/*********************************************************************

Class FootNoteMgr

/*********************************************************************
Class: FootNoteMgr

Method: FootNoteMgr()
Description: Defaults CTOR for the FootNoteMgr, inits footNote list
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: FootNoteMgr(const FootNoteMgr&);
Description: Deep COPY CTOR
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: void AddFootNote(int, LineBuffer*, NonLinearListMgr* =0);
Description: Adds a FootNote to its FootNote list, by creating a FootNote
with a LineBuffer, and NonLinearList of Atoms
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: void AddFootNote(FootNote&);
Description: Adds the Footnote passed to it
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: void AddTxt(char*, int);
Description: Finds the FootNote with number i, but if it cant
adds a new FootNote, with the int num passed to it
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: void AddAtom(ATom *atm, int i);
Description: Adds an atom to the FootNote number i
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: FootNote * FootNotes() const
Description: returns its FootNote list
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: FootNoteMgr

Method: FootNote * FindFootNote(ATom *);
Description: Finds the FootNote whose Atom List contains the atm atom
Usage:
Caution:
/*********************************************************************

Class IntrInfo

/*********************************************************************
Class: IntrInfo

Method: IntrInfo();
Description: The PDBInfo Class which manages text based fields of the PDB
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: IntrInfo(const IntrInfo&);
Description: Deep Copy CTOR for the PDBInfo Class
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyHeader() const
Description: Returns the Header field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyObslte() const
Description: Returns the Obselete field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyCompnd() const
Description: Returns the Compound field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MySource() const
Description: Returns the Source field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyExpdta() const
Description: Returns the Expt. Data field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyAuthor() const
Description: Returns the Author field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyRevdat() const
Description: Returns the Revision Data field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MySprsde() const
Description: Returns the Supersede field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyJrnl() const
Description: Returns the Journal field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: LineBuffer * MyRemark() const
Description: Returns the Remark field in LineBuffer structure
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: float MyResolution() const;
Description: Returns the resolution of the compound as a float, which
it retrieves from the remark field
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void AssignSpaceGreoup(SpaceGroup& s)
Description: assigns s to the _spaceGroup member
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void AssignCompound(Compound& c)
Description: assigns c to the _compound member which it belongs to
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void AddCrystalLengthVector(Vector& vector)
Description: assigns vector to _crystalLength member
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void AddCrystalAngleVector(Vector& vector)
Description: assigns vector to _crystalAngle member
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: SpaceGroup * MySpaceGroup() const
Description: returns its SpaceGroup
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: Vector * MyCrystalLengthVector() const
Description: returns its CrystalLengthVector
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: Vector * MyCrystalAngleVector() const
Description: returns its CrystalAngleVector
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: NonCrystTransValueMgr * MyMatrixMgr() const
Description: returns the NonCrystTransValueMgr which manages the MTRX
record in the PDB file
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: FootNoteMgr * MyFootNoteMgr() const
Description: returns the FootNoteMgr, which manages the FootNotes
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: Compound * MyCompound() const
Description: returns the Compound which it belongs to
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: TranslationVectorMgr * MyTransVectorMgr() const
Description: returns the TranslationVectorMgr which manages the TVECT
record in the PDB file
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void AddOrigx(int, double, double, double, double);
Description: maintains the ORIGX record of the PDB file
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void AddScale(int, double, double, double, double);
Description: maintains the SCALE record of the PDB file
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void NewMatrixMgr()
Description: re allocates its NonCrystTransValueMgr, needed by the
Compound DEEP COPY CTOR
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void NewTransVectorMgr()
Description: allocates its TranslationVectorMgr,
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void NewFootNoteMgr()
Description: allocates its FootNoteMgr,
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void SetMyMatrixMgr(NonCrystTransValueMgr *mx)
Description: Sets MatrixMgr to mx,
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void SetMyTransVectorMgr(TranslationVectorMgr *tv)
Description: Sets TranslationVectorMgr to mx,
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void renewMatrix()
Description: deletes and news its MatrixMgr
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: void renewVector()
Description: deletes and news its TranslationVectorMgr.
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: double ORIGX_O(int i, int j) const
Description: returns the ORIGX sub i,j
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: double ORIGX_T(int i) const
Description: returns the ORIGX sub t, of the ith ORIGX entry
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: double SCALE_S(int i, int j) const
Description: returns the SCALE sub i,j
Usage:
Caution:
/*********************************************************************
/*********************************************************************
Class: IntrInfo

Method: double SCALE_U(int i) const
Description: returns the SCALE sub u, of the ith scale entry
Usage:
Caution:
/*********************************************************************

Back to The PDBlib

Back to The PDBInfo Class

Currently under Heavy Construction, please excuse the mess

jcooper@cuhhca.hhmi.columbia.edu