Chain Class Template Reference

#include <chain.hpp>

Inheritance diagram for Chain:

AtomicStructure ChemicallyTypedObject BTKSequence< AtomType, StorageStrategy > boost::less_than_comparable BTKContainer Molecule List of all members.

Public Types

typedef base_type::chemical_type_system chemical_type_system
typedef base_type::dictionary dictionary
typedef base_type::id_type id_type
typedef base_type::value_type value_type
typedef base_type::iterator iterator
typedef base_type::const_iterator const_iterator
typedef base_type::reverse_iterator reverse_iterator
typedef base_type::const_reverse_iterator const_reverse_iterator
typedef base_type::reference reference
typedef base_type::const_reference const_reference
typedef base_type::pointer pointer
typedef base_type::const_pointer const_pointer
typedef base_type::difference_type difference_type
typedef base_type::size_type size_type
typedef base_type::atom_type atom_type
typedef base_type::atom_iterator atom_iterator
typedef base_type::const_atom_iterator const_atom_iterator
typedef base_type::reverse_atom_iterator reverse_atom_iterator
typedef base_type::const_reverse_atom_iterator const_reverse_atom_iterator
typedef base_type::structure_id_type structure_id_type
typedef base_type::atom_id_type atom_id_type

Public Member Functions

 Chain (self_type const &source)
virtual ~Chain ()
virtual std::ostream & print (std::ostream &os, size_type first_atom_num=1, size_type group_num=1) const
 Print a chain.
char chain_id () const
 Get the chain id.
void set_chain_id (char ch_id)
 Set the chain id.

Protected Member Functions

void swap (self_type &b)
 Swap the contents of two Chains.
self_type const & operator= (self_type const &rhs)
 Assignment operator.
bool operator< (self_type const &rhs) const
 Less-than comparison.
bool operator== (self_type const &rhs) const
 Equality comparison.
bool operator!= (self_type const &rhs) const
 Equality comparison.

template<typename AtomType, typename ChemicalTypeSystemType, typename DictionaryType, typename StorageStrategy = std::vector<AtomType>>
class BTK::MOLECULES::Chain< AtomType, ChemicalTypeSystemType, DictionaryType, StorageStrategy >


Member Typedef Documentation

typedef base_type ::chemical_type_system chemical_type_system

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::dictionary dictionary

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::id_type id_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::value_type value_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::iterator iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::const_iterator const_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::reverse_iterator reverse_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::const_reverse_iterator const_reverse_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::reference reference

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::const_reference const_reference

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::pointer pointer

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::const_pointer const_pointer

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::difference_type difference_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::size_type size_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::atom_type atom_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::atom_iterator atom_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::const_atom_iterator const_atom_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::reverse_atom_iterator reverse_atom_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::const_reverse_atom_iterator const_reverse_atom_iterator

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::structure_id_type structure_id_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

typedef base_type ::atom_id_type atom_id_type

Reimplemented from AtomicStructure.

Reimplemented in Molecule.


Constructor & Destructor Documentation

Chain ( self_type const &  source  ) 

virtual ~Chain (  )  [virtual]

Chain ( size_type  n = 0,
const_reference  t = atom_type(),
id_type  type = id_type(),
char  chain_id = ' ' 
) [protected]

Constructors that are not in the Chain concept, but will be useful in derived class types.

Chain ( AtomIterator  i,
AtomIterator  j,
id_type  type,
char  chain_id 
) [protected]

Constructors that are not in the Chain concept, but will be useful in derived class types.

Chain ( size_type  n = 0,
const_reference  t = atom_type(),
id_type  type = id_type(),
char  chain_id = ' ' 
) [protected]

Constructors that are not in the Chain concept, but will be useful in derived class types.

Chain ( AtomIterator  i,
AtomIterator  j,
id_type  type,
char  chain_id 
) [protected]

Constructors that are not in the Chain concept, but will be useful in derived class types.


Member Function Documentation

virtual std::ostream& print ( std::ostream &  os,
size_type  first_atom_num = 1,
size_type  group_num = 1 
) const [virtual]

Print a chain.

char chain_id (  )  const

Get the chain id.

void set_chain_id ( char  ch_id  ) 

Set the chain id.

void swap ( self_type b  )  [protected]

Swap the contents of two Chains.

Explicitly protected to prevent heterogenous type swapping.

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

self_type const& operator= ( self_type const &  rhs  )  [protected]

Assignment operator.

Explicitly protected to prevent heterogenous type assignments.

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

bool operator== ( self_type const &  rhs  )  const [protected]

Equality comparison.

Two Chain objects are equivalent iff their chain ids are equal, and their contained atoms are all equivalent.

Explicitly protected to prevent heterogenous type comparisons.

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

bool operator!= ( self_type const &  rhs  )  const [protected]

Equality comparison.

Two Chain objects are equivalent iff their chain ids are equal, and their contained atoms are all equivalent.

Explicitly protected to prevent heterogenous type comparisons.

Reimplemented from AtomicStructure.

Reimplemented in Molecule.

bool operator< ( self_type const &  rhs  )  const [protected]

Less-than comparison.

Chain A is less than Chain B if the chain id of A is less than the chain id of B, or if the chain ids are equivalent, and static_cast<AtomicStructure>(A) < static_cast<AtomicStructure>(B) is a true statement.

Explicitly protected to prevent heterogenous type comparisons.

Reimplemented from AtomicStructure.

Reimplemented in Molecule.


The documentation for this class was generated from the following file:
Generated on Sun Jul 15 20:46:39 2007 for BTK Core by  doxygen 1.5.1