BALL::PDBRecords Class Reference

#include <BALL/FORMAT/PDBRecords.h>

List of all members.

Public Types
typedef std::vector< String > ::iterator	Iterator
typedef std::vector< String > ::iterator	iterator
typedef std::vector< String > ::const_iterator	ConstIterator
typedef std::vector< String > ::const_iterator	const_iterator
typedef std::vector< String > ::reverse_iterator	ReverseIterator
typedef std::vector< String > ::reverse_iterator	reverse_iterator
typedef std::vector< String > ::const_reverse_iterator	ConstReverseIterator
typedef std::vector< String > ::const_reverse_iterator	const_reverse_iterator
typedef String	value_type
typedef String	ValueType
typedef String &	reference
typedef String &	Reference
typedef const String &	const_reference
typedef const String &	ConstReference
typedef std::vector< String > ::difference_type	difference_type
typedef std::vector< String > ::difference_type	DifferenceType
typedef std::vector< String > ::size_type	size_type
typedef std::vector< String > ::size_type	SizeType
Public Member Functions
Constructors and Destructor
	PDBRecords ()
	PDBRecords (const PDBRecords &pdbi)
virtual	~PDBRecords ()
PDBRecords &	operator= (const PDBRecords &rhs)
ConstIterator	begin () const
Iterator	begin ()
ConstIterator	end () const
Iterator	end ()
ConstReverseIterator	rbegin () const
ReverseIterator	rbegin ()
ConstReverseIterator	rend () const
ReverseIterator	rend ()
SizeType	size () const
SizeType	max_size () const
SizeType	capacity () const
bool	empty () const
void	clear ()
void	resize (SizeType sz, ValueType c=ValueType())
Reference	front ()
ConstReference	front () const
Reference	back ()
ConstReference	back () const
void	push_back (ConstReference x)
void	insert (Iterator pos, ConstReference value)
void	insert (Iterator pos, SizeType n, ConstReference value)
void	pop_back ()
Iterator	erase (Iterator pos)
Iterator	erase (Iterator first, Iterator last)
bool	operator== (const PDBRecords &rhs) const
bool	operator!= (const PDBRecords &rhs) const
bool	operator< (const PDBRecords &rhs) const
bool	operator> (const PDBRecords &rhs) const
bool	operator<= (const PDBRecords &rhs) const
bool	operator>= (const PDBRecords &rhs) const
void	swap (PDBRecords &rhs)
ConstReference	operator[] (SizeType n) const
Reference	operator[] (SizeType n)
ConstReference	at (SizeType n) const throw (std::out_of_range)
Reference	at (SizeType n) throw (std::out_of_range)
Protected Attributes
std::vector< String >	records_
	The PDB record buffer.

---

Detailed Description

PDB record class. This class contains PDB records in an undigested format and provides some means of digesting this format. It is meant to capture all records not parsed by GenericPDBFile and PDBFile.

The class fulfills the requirements of an STL container and behaves mostly like the vector of Strings it actually is.

---

Member Typedef Documentation

typedef std::vector<String>::const_iterator BALL::PDBRecords::const_iterator

typedef const String& BALL::PDBRecords::const_reference

typedef std::vector<String>::const_reverse_iterator BALL::PDBRecords::const_reverse_iterator

typedef std::vector<String>::const_iterator BALL::PDBRecords::ConstIterator

typedef const String& BALL::PDBRecords::ConstReference

typedef std::vector<String>::const_reverse_iterator BALL::PDBRecords::ConstReverseIterator

typedef std::vector<String>::difference_type BALL::PDBRecords::difference_type

typedef std::vector<String>::difference_type BALL::PDBRecords::DifferenceType

typedef std::vector<String>::iterator BALL::PDBRecords::iterator

typedef std::vector<String>::iterator BALL::PDBRecords::Iterator

typedef String& BALL::PDBRecords::Reference

typedef String& BALL::PDBRecords::reference

typedef std::vector<String>::reverse_iterator BALL::PDBRecords::reverse_iterator

typedef std::vector<String>::reverse_iterator BALL::PDBRecords::ReverseIterator

typedef std::vector<String>::size_type BALL::PDBRecords::size_type

typedef std::vector<String>::size_type BALL::PDBRecords::SizeType

typedef String BALL::PDBRecords::value_type

typedef String BALL::PDBRecords::ValueType

---

Constructor & Destructor Documentation

BALL::PDBRecords::PDBRecords

(

)

BALL::PDBRecords::PDBRecords

(

const PDBRecords &

pdbi

)

virtual BALL::PDBRecords::~PDBRecords

(

)

[virtual]

---

Member Function Documentation

Reference BALL::PDBRecords::at

(

SizeType

n

)

throw (std::out_of_range) [inline]

ConstReference BALL::PDBRecords::at

(

SizeType

n

)

const throw (std::out_of_range) [inline]

ConstReference BALL::PDBRecords::back

(

)

const [inline]

Reference BALL::PDBRecords::back

(

)

[inline]

Iterator BALL::PDBRecords::begin

(

)

[inline]

ConstIterator BALL::PDBRecords::begin

(

)

const [inline]

STL container compatibility interface. These methods just wrap the corresponding methods of std::vector. Refer to STL documentation for details.

SizeType BALL::PDBRecords::capacity

(

)

const [inline]

void BALL::PDBRecords::clear

(

)

[inline]

bool BALL::PDBRecords::empty

(

)

const [inline]

Iterator BALL::PDBRecords::end

(

)

[inline]

ConstIterator BALL::PDBRecords::end

(

)

const [inline]

Iterator BALL::PDBRecords::erase	(	Iterator	first,
		Iterator	last
	)			[inline]

Iterator BALL::PDBRecords::erase

(

Iterator

pos

)

[inline]

ConstReference BALL::PDBRecords::front

(

)

const [inline]

Reference BALL::PDBRecords::front

(

)

[inline]

void BALL::PDBRecords::insert	(	Iterator	pos,
		SizeType	n,
		ConstReference	value
	)			[inline]

void BALL::PDBRecords::insert	(	Iterator	pos,
		ConstReference	value
	)			[inline]

SizeType BALL::PDBRecords::max_size

(

)

const [inline]

bool BALL::PDBRecords::operator!=

(

const PDBRecords &

rhs

)

const [inline]

References records_.

bool BALL::PDBRecords::operator<

(

const PDBRecords &

rhs

)

const [inline]

References records_.

bool BALL::PDBRecords::operator<=

(

const PDBRecords &

rhs

)

const [inline]

References records_.

PDBRecords& BALL::PDBRecords::operator=

(

const PDBRecords &

rhs

)

Assignment

bool BALL::PDBRecords::operator==

(

const PDBRecords &

rhs

)

const [inline]

References records_.

bool BALL::PDBRecords::operator>

(

const PDBRecords &

rhs

)

const [inline]

References records_.

bool BALL::PDBRecords::operator>=

(

const PDBRecords &

rhs

)

const [inline]

References records_.

Reference BALL::PDBRecords::operator[]

(

SizeType

n

)

[inline]

ConstReference BALL::PDBRecords::operator[]

(

SizeType

n

)

const [inline]

void BALL::PDBRecords::pop_back

(

)

[inline]

void BALL::PDBRecords::push_back

(

ConstReference

x

)

[inline]

ReverseIterator BALL::PDBRecords::rbegin

(

)

[inline]

ConstReverseIterator BALL::PDBRecords::rbegin

(

)

const [inline]

ReverseIterator BALL::PDBRecords::rend

(

)

[inline]

ConstReverseIterator BALL::PDBRecords::rend

(

)

const [inline]

void BALL::PDBRecords::resize	(	SizeType	sz,
		ValueType	c = ValueType()
	)			[inline]

References BALL::Constants::c.

SizeType BALL::PDBRecords::size

(

)

const [inline]

void BALL::PDBRecords::swap

(

PDBRecords &

rhs

)

[inline]

References records_.

---

Member Data Documentation

std::vector<String> BALL::PDBRecords::records_ [protected]

The PDB record buffer.

Referenced by operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=(), and swap().