IMP  2.4.0
The Integrative Modeling Platform
Public Member Functions | Static Public Member Functions | List of all members
IMP::atom::CHARMMAtom Class Reference

A decorator for an atom that has a defined CHARMM type. More...

#include <IMP/atom/CHARMMAtom.h>

+ Inheritance diagram for IMP::atom::CHARMMAtom:

Detailed Description

A decorator for an atom that has a defined CHARMM type.

Definition at line 24 of file CHARMMAtom.h.

Public Member Functions

 CHARMMAtom (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 CHARMMAtom (const IMP::kernel::ParticleAdaptor &d)
 
String get_charmm_type () const
 
void set_charmm_type (String t)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::atom::Atom
 Atom (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 Atom (const IMP::kernel::ParticleAdaptor &d)
 
AtomType get_atom_type () const
 
Element get_element () const
 get element More...
 
double get_occupancy () const
 
double get_temperature_factor () const
 
void set_atom_type (AtomType t)
 Set the name and corresponding element and mass. More...
 
void set_occupancy (double occupancy)
 
void set_temperature_factor (double tempFactor)
 
void show (std::ostream &out=std::cout) const
 
Int get_input_index () const
 
void set_input_index (Int t)
 
- Public Member Functions inherited from IMP::atom::Hierarchy
 Hierarchy (kernel::Model *m, kernel::ParticleIndex pi)
 
 Hierarchy (kernel::ParticleAdaptor pi)
 
 Hierarchy ()
 null constructor More...
 
 Hierarchy (IMP::core::Hierarchy h)
 The traits must match. More...
 
void add_child (Hierarchy o)
 Add a child and check that the types are appropriate. More...
 
Hierarchy get_child (unsigned int i) const
 
Hierarchies get_children () const
 Return the children in the order they were added. More...
 
template<class C >
get_children () const
 Get the children in a container of your choosing, eg kernel::ParticlesTemp. More...
 
bool get_is_valid (bool print_info) const
 Return true if the hierarchy is valid. More...
 
Hierarchy get_parent () const
 
void show (std::ostream &out=std::cout) const
 
Atom get_as_atom () const
 
Residue get_as_residue () const
 
Chain get_as_chain () const
 
Molecule get_as_molecule () const
 
Domain get_as_domain () const
 
Fragment get_as_fragment () const
 
core::XYZ get_as_xyz () const
 
core::XYZR get_as_xyzr () const
 
Mass get_as_mass () const
 
State get_as_state () const
 
- Public Member Functions inherited from IMP::core::Hierarchy
 Hierarchy (const IMP::kernel::ParticleAdaptor &d, const HierarchyTraits &tr=get_default_traits())
 
 Hierarchy (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id, const HierarchyTraits &tr=get_default_traits())
 
void add_child (Hierarchy h) const
 
void add_child_at (Hierarchy h, unsigned int pos)
 
void clear_children ()
 
Hierarchy get_child (unsigned int i) const
 
kernel::ParticleIndex get_child_index (unsigned int i) const
 
int get_child_index () const
 Return i such that get_parent().get_child(i) == this More...
 
GenericHierarchies get_children () const
 
kernel::ParticleIndexes get_children_indexes () const
 
const DecoratorTraitsget_decorator_traits () const
 
unsigned int get_number_of_children () const
 
Hierarchy get_parent () const
 
HierarchyTraits get_traits ()
 
void remove_child (unsigned int i)
 
void remove_child (Hierarchy h)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::kernel::Decorator
bool get_is_valid () const
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_particle () const
 Returns the particle decorated by this decorator. More...
 
ParticleIndex get_particle_index () const
 Returns the particle index decorated by this decorator. More...
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static StringKey get_charmm_type_key ()
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 Return true if the particle is an instance of a CHARMMAtom. More...
 
static CHARMMAtom setup_particle (IMP::kernel::ParticleAdaptor decorator, String charmm_type)
 
static CHARMMAtom setup_particle (kernel::Model *m, ParticleIndex pi, String charmm_type)
 
- Static Public Member Functions inherited from IMP::atom::Atom
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 
static Atom setup_particle (kernel::Model *m, ParticleIndex pi, Atom other)
 
static Atom setup_particle (IMP::kernel::ParticleAdaptor decorator, Atom other)
 
static Atom setup_particle (kernel::Model *m, ParticleIndex pi, AtomType atom_type)
 
static Atom setup_particle (IMP::kernel::ParticleAdaptor decorator, AtomType atom_type)
 
static IntKey get_atom_type_key ()
 
static IntKey get_element_key ()
 
static IntKey get_input_index_key ()
 
static FloatKey get_occupancy_key ()
 
static FloatKey get_temperature_factor_key ()
 
- Static Public Member Functions inherited from IMP::atom::Hierarchy
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex p)
 
static const
IMP::core::HierarchyTraits
get_traits ()
 Get the molecular hierarchy HierarchyTraits. More...
 
static Hierarchy setup_particle (kernel::Model *m, kernel::ParticleIndex pi, kernel::ParticleIndexesAdaptor children=kernel::ParticleIndexesAdaptor())
 
- Static Public Member Functions inherited from IMP::core::Hierarchy
static const DecoratorTraitsget_default_decorator_traits ()
 
static const HierarchyTraitsget_default_traits ()
 Get the default hierarchy traits. More...
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p, const HierarchyTraits &tr=get_default_traits())
 
static bool get_is_setup (kernel::Model *, kernel::ParticleIndex, HierarchyTraits=Hierarchy::get_default_traits())
 
static Hierarchy setup_particle (IMP::kernel::ParticleAdaptor d, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (kernel::Model *m, ParticleIndex pi, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (kernel::Model *m, ParticleIndex pi, kernel::ParticleIndexes children, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (IMP::kernel::ParticleAdaptor d, kernel::ParticleIndexes children, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (IMP::kernel::ParticleAdaptor d, kernel::ParticlesTemp children, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (kernel::Model *m, ParticleIndex pi, kernel::ParticlesTemp children, DecoratorTraits tr=get_default_decorator_traits())
 

Additional Inherited Members

- Public Types inherited from IMP::core::Hierarchy
typedef HierarchyTraits DecoratorTraits
 
- Protected Member Functions inherited from IMP::kernel::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

static bool IMP::atom::CHARMMAtom::get_is_setup ( kernel::Model m,
kernel::ParticleIndex  pi 
)
static

Return true if the particle is an instance of a CHARMMAtom.

Definition at line 42 of file CHARMMAtom.h.

static CHARMMAtom IMP::atom::CHARMMAtom::setup_particle ( IMP::kernel::ParticleAdaptor  decorator,
String  charmm_type 
)
static
See Also
setup_particle(m, pi, charmm_type )

Definition at line 37 of file CHARMMAtom.h.

static CHARMMAtom IMP::atom::CHARMMAtom::setup_particle ( kernel::Model m,
ParticleIndex  pi,
String  charmm_type 
)
static

Create a decorator with the passed CHARMM type. The particle is assumed to already have all atom attributes.Setup the particle so that it can be used with this decorator

Definition at line 37 of file CHARMMAtom.h.


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