Monomer Class Template Reference

#include <monomer.hpp>

Inheritance diagram for Monomer:

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
typedef id_type	monomer_id_type
Public Member Functions
	Monomer (unsigned n=0, atom_type const &a=atom_type(), id_type type=id_type(), int number=0)
template<typename AtomIterator>
	Monomer (AtomIterator i, AtomIterator j, monomer_id_type type, int number)
	Monomer (self_type const &source)
virtual	~Monomer ()
atom_iterator	monomer_begin ()
const_atom_iterator	monomer_begin () const
atom_iterator	monomer_end ()
const_atom_iterator	monomer_end () const
reverse_atom_iterator	monomer_rbegin ()
const_reverse_atom_iterator	monomer_rbegin () const
reverse_atom_iterator	monomer_rend ()
const_reverse_atom_iterator	monomer_rend () const
int	number () const
void	set_number (int number)
bool	selected () const
void	select (bool s=true) const
virtual dictionary const &	get_dictionary () const
virtual dictionary &	get_dictionary ()
void	swap (self_type &b)
	Swap method.
self_type const &	operator= (self_type const &rhs)
	Assignment operator.
bool	operator== (self_type const &rhs) const
	Equality comparison.
bool	operator!= (self_type const &rhs) const
	Equality comparison.
bool	operator< (self_type const &rhs) const
	Less-than comparision.

---

Detailed Description

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

Examples:

gyration_radius.cpp.

---

Member Typedef Documentation

typedef base_type ::chemical_type_system chemical_type_system

Reimplemented from AtomicStructure.

typedef base_type ::dictionary dictionary

Reimplemented from AtomicStructure.

typedef base_type ::id_type id_type

Reimplemented from AtomicStructure.

typedef base_type ::value_type value_type

Reimplemented from AtomicStructure.

typedef base_type ::iterator iterator

Reimplemented from AtomicStructure.

typedef base_type ::const_iterator const_iterator

Reimplemented from AtomicStructure.

typedef base_type ::reverse_iterator reverse_iterator

Reimplemented from AtomicStructure.

typedef base_type ::const_reverse_iterator const_reverse_iterator

Reimplemented from AtomicStructure.

typedef base_type ::reference reference

Reimplemented from AtomicStructure.

typedef base_type ::const_reference const_reference

Reimplemented from AtomicStructure.

typedef base_type ::pointer pointer

Reimplemented from AtomicStructure.

typedef base_type ::const_pointer const_pointer

Reimplemented from AtomicStructure.

typedef base_type ::difference_type difference_type

Reimplemented from AtomicStructure.

typedef base_type ::size_type size_type

Reimplemented from AtomicStructure.

typedef base_type ::atom_type atom_type

Reimplemented from AtomicStructure.

typedef base_type ::atom_iterator atom_iterator

Reimplemented from AtomicStructure.

typedef base_type ::const_atom_iterator const_atom_iterator

Reimplemented from AtomicStructure.

typedef base_type ::reverse_atom_iterator reverse_atom_iterator

Reimplemented from AtomicStructure.

typedef base_type ::const_reverse_atom_iterator const_reverse_atom_iterator

Reimplemented from AtomicStructure.

typedef base_type ::structure_id_type structure_id_type

Reimplemented from AtomicStructure.

typedef base_type ::atom_id_type atom_id_type

Reimplemented from AtomicStructure.

typedef id_type monomer_id_type

---

Constructor & Destructor Documentation

Monomer	(	unsigned	n = 0,
		atom_type const &	a = atom_type(),
		id_type	type = id_type(),
		int	number = 0
	)

Monomer	(	AtomIterator	i,
		AtomIterator	j,
		monomer_id_type	type,
		int	number
	)

Monomer

(

self_type const &

source

)

virtual ~Monomer

(

)

[virtual]

---

Member Function Documentation

atom_iterator monomer_begin

(

)

const_atom_iterator monomer_begin

(

)

const

atom_iterator monomer_end

(

)

const_atom_iterator monomer_end

(

)

const

reverse_atom_iterator monomer_rbegin

(

)

const_reverse_atom_iterator monomer_rbegin

(

)

const

reverse_atom_iterator monomer_rend

(

)

const_reverse_atom_iterator monomer_rend

(

)

const

int number

(

)

const

void set_number

(

int

number

)

bool selected

(

)

const

void select

(

bool

s = true

)

const

virtual dictionary const& get_dictionary

(

)

const [virtual]

Implements AtomicStructure.

virtual dictionary& get_dictionary

(

)

[virtual]

Implements AtomicStructure.

void swap

(

self_type &

b

)

Swap method.

Swaps this AtomicStructure with another.

Reimplemented from AtomicStructure.

self_type const& operator=

(

self_type const &

rhs

)

Assignment operator.

The contents of this AtomicStructure are replaced with those of rhs.

Reimplemented from AtomicStructure.

bool operator==

(

self_type const &

rhs

)

const

Equality comparison.

Two AtomicStructures are equivalent iff their types are equivalent, and all of their contained atoms are equivalent.

Reimplemented from AtomicStructure.

bool operator!=

(

self_type const &

rhs

)

const

Equality comparison.

Two AtomicStructures are equivalent iff their types are equivalent, and all of their contained atoms are equivalent.

Reimplemented from AtomicStructure.

bool operator<

(

self_type const &

rhs

)

const

Less-than comparision.

AtomicStructure A is less than AtomicStructure B if the type of A is less than the type of B, or if the types of A and B are equal, and the atoms of A are less than B using lexicographical ordering rules.

Reimplemented from AtomicStructure.

---

The documentation for this class was generated from the following file:

• monomer.hpp

---