BALL::PDBInfo Class Reference

#include <BALL/FORMAT/PDBInfo.h>

List of all members.

Public Member Functions

Constructors and Destructor

 PDBInfo ()
 PDBInfo (const PDBInfo &pdbi)
virtual ~PDBInfo ()
virtual void clear ()
 Reset all attributes to their initial state.

PDBInfooperator= (const PDBInfo &rhs)

bool operator== (const PDBInfo &rhs) const
 Equality operator.
bool operator!= (const PDBInfo &rhs) const
 Inequality operator.

PDBRecordsgetSkippedRecords ()
 Return the unparsed records.
const PDBRecordsgetSkippedRecords () const
 Return the unparsed records.
PDBRecordsgetInvalidRecords ()
 Return the unparsed records.
const PDBRecordsgetInvalidRecords () const
 Return the unparsed records.
const StringgetFilename () const
 Return the filename.
void setFilename (const String &filename)
 Set the filename.
const StringgetID () const
 Return the PDB ID.
void setID (const String &id)
 Set the PDB ID.
Size getNumberOfRecords () const
 Return the total number of records read.
void setNumberOfRecords (Size n)
 Set the number of records.
Size getNumberOfModels () const
 Return the number of models.
SizegetNumberOfModels ()
 Return the number of models.
void setNumberOfModels (Size n)
 Set the number of models.
Position getCurrentModel () const
 Return the number of the last model read.
PositiongetCurentModel ()
 Return the number of the last model read.
void setCurrentModel (Position n)
 Set the number of the model read.
Size getNumberOfATOMRecords () const
 Return the number of atom records read.
SizegetNumberOfATOMRecords ()
 Return the number of atom records read.
void setNumberOfATOMRecords (Size n)
 Set the number of atom records read.
Size getNumberOfHETATMRecords () const
 Return the number of hetatm records read.
SizegetNumberOfHETATMRecords ()
 Return the number of hetatm records read.
void setNumberOfHETATMRecords (Size n)
 Set the number of hetatm records read.
const StringgetName () const
 Return the name of the system as contained in the HEADER record.
void setName (const String &name)
 Set the name of the system. This is written to the HEADER record (truncated!).
std::list< PositiongetRecordIndices (PDB::RecordType record) const

Protected Attributes

PDBRecords skipped_records_
 Skipped PDB records (not parsed).
PDBRecords invalid_records_
 Invalid PDB records (tried to parse, but failed).
String filename_
 Filename.
String id_
 PDB ID.
String name_
 Name.
Size number_of_records_
 Total file size in bytes.
Size number_of_models_
 Total number of models.
Position model_read_
 Model last read.
Size number_of_atom_records_
 Number of ATOM records.
Size number_of_hetatm_records_
 Number of HETATM records.

Detailed Description

PDB information class. This class contains holds summary information on a PDB file read by GenericPDBFile or PDBFile as well as unparse records.

Definition at line 29 of file PDBInfo.h.


Constructor & Destructor Documentation

BALL::PDBInfo::PDBInfo (  ) 
BALL::PDBInfo::PDBInfo ( const PDBInfo pdbi  ) 
virtual BALL::PDBInfo::~PDBInfo (  )  [virtual]

Member Function Documentation

virtual void BALL::PDBInfo::clear (  )  [virtual]

Reset all attributes to their initial state.

Position& BALL::PDBInfo::getCurentModel (  )  [inline]

Return the number of the last model read.

Definition at line 93 of file PDBInfo.h.

Position BALL::PDBInfo::getCurrentModel (  )  const [inline]

Return the number of the last model read.

Definition at line 91 of file PDBInfo.h.

const String& BALL::PDBInfo::getFilename (  )  const [inline]

Return the filename.

Definition at line 73 of file PDBInfo.h.

const String& BALL::PDBInfo::getID (  )  const [inline]

Return the PDB ID.

Definition at line 77 of file PDBInfo.h.

const PDBRecords& BALL::PDBInfo::getInvalidRecords (  )  const [inline]

Return the unparsed records.

Definition at line 71 of file PDBInfo.h.

PDBRecords& BALL::PDBInfo::getInvalidRecords (  )  [inline]

Return the unparsed records.

Definition at line 69 of file PDBInfo.h.

const String& BALL::PDBInfo::getName (  )  const [inline]

Return the name of the system as contained in the HEADER record.

Definition at line 109 of file PDBInfo.h.

Size& BALL::PDBInfo::getNumberOfATOMRecords (  )  [inline]

Return the number of atom records read.

Definition at line 99 of file PDBInfo.h.

Size BALL::PDBInfo::getNumberOfATOMRecords (  )  const [inline]

Return the number of atom records read.

Definition at line 97 of file PDBInfo.h.

Size& BALL::PDBInfo::getNumberOfHETATMRecords (  )  [inline]

Return the number of hetatm records read.

Definition at line 105 of file PDBInfo.h.

Size BALL::PDBInfo::getNumberOfHETATMRecords (  )  const [inline]

Return the number of hetatm records read.

Definition at line 103 of file PDBInfo.h.

Size& BALL::PDBInfo::getNumberOfModels (  )  [inline]

Return the number of models.

Definition at line 87 of file PDBInfo.h.

Size BALL::PDBInfo::getNumberOfModels (  )  const [inline]

Return the number of models.

Definition at line 85 of file PDBInfo.h.

Size BALL::PDBInfo::getNumberOfRecords (  )  const [inline]

Return the total number of records read.

Definition at line 81 of file PDBInfo.h.

std::list<Position> BALL::PDBInfo::getRecordIndices ( PDB::RecordType  record  )  const

Return a list of indices matchin a specific record type. This list is constructed by a linear search over all records currently stored in the skipped indices.

const PDBRecords& BALL::PDBInfo::getSkippedRecords (  )  const [inline]

Return the unparsed records.

Definition at line 67 of file PDBInfo.h.

PDBRecords& BALL::PDBInfo::getSkippedRecords (  )  [inline]

Return the unparsed records.

Accessors

Definition at line 65 of file PDBInfo.h.

bool BALL::PDBInfo::operator!= ( const PDBInfo rhs  )  const

Inequality operator.

PDBInfo& BALL::PDBInfo::operator= ( const PDBInfo rhs  ) 

Assignment

bool BALL::PDBInfo::operator== ( const PDBInfo rhs  )  const

Equality operator.

Predicates

void BALL::PDBInfo::setCurrentModel ( Position  n  )  [inline]

Set the number of the model read.

Definition at line 95 of file PDBInfo.h.

void BALL::PDBInfo::setFilename ( const String filename  )  [inline]

Set the filename.

Definition at line 75 of file PDBInfo.h.

void BALL::PDBInfo::setID ( const String id  )  [inline]

Set the PDB ID.

Definition at line 79 of file PDBInfo.h.

void BALL::PDBInfo::setName ( const String name  )  [inline]

Set the name of the system. This is written to the HEADER record (truncated!).

Definition at line 111 of file PDBInfo.h.

void BALL::PDBInfo::setNumberOfATOMRecords ( Size  n  )  [inline]

Set the number of atom records read.

Definition at line 101 of file PDBInfo.h.

void BALL::PDBInfo::setNumberOfHETATMRecords ( Size  n  )  [inline]

Set the number of hetatm records read.

Definition at line 107 of file PDBInfo.h.

void BALL::PDBInfo::setNumberOfModels ( Size  n  )  [inline]

Set the number of models.

Definition at line 89 of file PDBInfo.h.

void BALL::PDBInfo::setNumberOfRecords ( Size  n  )  [inline]

Set the number of records.

Definition at line 83 of file PDBInfo.h.


Member Data Documentation

Filename.

Definition at line 125 of file PDBInfo.h.

PDB ID.

Definition at line 127 of file PDBInfo.h.

Invalid PDB records (tried to parse, but failed).

Definition at line 123 of file PDBInfo.h.

Model last read.

Definition at line 135 of file PDBInfo.h.

Name.

Definition at line 129 of file PDBInfo.h.

Number of ATOM records.

Definition at line 137 of file PDBInfo.h.

Number of HETATM records.

Definition at line 139 of file PDBInfo.h.

Total number of models.

Definition at line 133 of file PDBInfo.h.

Total file size in bytes.

Definition at line 131 of file PDBInfo.h.

Skipped PDB records (not parsed).

Definition at line 121 of file PDBInfo.h.

Generated by  doxygen 1.6.3