BTK::AtomGroupConcept Struct Reference

Interface class which allows atoms to get information from their container. More...

#include <atom_group_concept.h>

Inheritance diagram for BTK::AtomGroupConcept:

[legend]List of all members.

Public Types
typedef std::set< GROUP_VARIANT::index_t >	group_variant_container_t
Public Member Functions
virtual GROUP::index_t	group_index () const=0
virtual const group_variant_container_t &	group_variant_codes () const=0
virtual const std::string &	group_name3 () const=0
virtual int	group_num () const=0

---

Detailed Description

Interface class which allows atoms to get information from their container.

---

Member Typedef Documentation

typedef std::set<GROUP_VARIANT::index_t> BTK::AtomGroupConcept::group_variant_container_t

:

---

Member Function Documentation

virtual GROUP::index_t BTK::AtomGroupConcept::group_index (   )  const [pure virtual]

Implemented in BTK::AtomContainer< AtomType >, BTK::BuildableMonomer< AtomType >, BTK::Molecule< AtomType >, BTK::Monomer< AtomType >, BTK::AtomContainer< typename MonomerType::atom_type >, and BTK::Molecule< typename MonomerType::atom_type >.

virtual const std::string& BTK::AtomGroupConcept::group_name3 (   )  const [pure virtual]

Implemented in BTK::AtomContainer< AtomType >, BTK::BuildableMonomer< AtomType >, BTK::Monomer< AtomType >, and BTK::AtomContainer< typename MonomerType::atom_type >.

virtual int BTK::AtomGroupConcept::group_num (   )  const [pure virtual]

Implemented in BTK::AtomContainer< AtomType >, BTK::Monomer< AtomType >, and BTK::AtomContainer< typename MonomerType::atom_type >.

virtual const group_variant_container_t& BTK::AtomGroupConcept::group_variant_codes (   )  const [pure virtual]

Implemented in BTK::AtomContainer< AtomType >, and BTK::AtomContainer< typename MonomerType::atom_type >.

---

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

• atom_group_concept.h

---