IMP logo

IMP::atom::Atom Class Reference
[Hierarchies of particles]


Detailed Description

A decorator for a particle representing an atom.

See also:
Hierarchy
Inheritance diagram for IMP::atom::Atom:

Inheritance graph
[legend]

Public Member Functions

 Atom (::IMP::Particle *p)
AtomType get_atom_type () const
Element get_element () const
Particleget_particle () const
void set_atom_type (AtomType t)
 Set the name and corresponding element and mass.
The atom index in the input file
This index is not necessarily unique over any particular set of atoms and so should never be used as an atom identifier except during I/O.

Int get_input_index () const
void set_input_index (Int t)

Static Public Member Functions

static Atom decorate_particle (::IMP::Particle *p)
static bool particle_is_instance (Particle *p)
 return true if the particle has the needed attributes
static Atom setup_particle (Particle *p, Atom o)
static Atom setup_particle (Particle *p, AtomType t)
Keys
These methods provide access to the various keys used to store things in the Atom. These can be used if you want to use an attribute to search a set of particles.

static IntKey get_atom_type_key ()
static IntKey get_element_key ()
static IntKey get_input_index_key ()

Member Function Documentation

static Atom IMP::atom::Atom::setup_particle ( Particle p,
Atom  o 
) [static]

Create a decorator by copying from o.

static Atom IMP::atom::Atom::setup_particle ( Particle p,
AtomType  t 
) [static]

Create a decorator with the passed type and coordinates.


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

Generated on Mon Mar 8 23:08:48 2010 for IMP by doxygen 1.5.8