IMP logo
Public Member Functions | Static Public Member Functions
IMP::atom::Domain Class Reference

Detailed Description

A decorator to associate a particle with a part of a protein.

The decorator stores the indexes of the first and last residues in this domain.

+ Inheritance diagram for IMP::atom::Domain:

List of all members.

Public Member Functions

 Domain (::IMP::Particle *p)
 Domain (Model *m, ParticleIndex id)
Int get_begin_index () const
 Get the index of the first residue in the domain.
Int get_end_index () const
 Get the index of the first residue not in the domain.
IntRange get_index_range () const
void set_index_range (IntRange ir)
void show (std::ostream &out=std::cout) const
- Public Member Functions inherited from IMP::atom::Hierarchy
 Hierarchy (Particle *p)
 Hierarchy (Model *m, ParticleIndex pi)
 Hierarchy ()
 null constructor
 Hierarchy (IMP::core::Hierarchy h)
 The traits must match.
void add_child (Hierarchy o)
 Add a child and check that the types are appropriate.
Hierarchy get_child (unsigned int i) const
Hierarchies get_children () const
 Return the children in the order they were added.
template<class C >
get_children () const
 Get the children in a container of your choosing, eg ParticlesTemp.
bool get_is_valid (bool print_info) const
 Return true if the hierarchy is valid.
Hierarchy get_parent () 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
- Public Member Functions inherited from IMP::core::Hierarchy
 Hierarchy (Model *m, ParticleIndex id, const HierarchyTraits &tr)
 Hierarchy (::IMP::Particle *p, const HierarchyTraits &tr=get_default_traits())
 Hierarchy (const HierarchyTraits &tr)
void add_child (Hierarchy h) const
void add_child_at (Hierarchy h, unsigned int pos)
void clear_children ()
int get_child_index () const
const DecoratorTraitsget_decorator_traits () const
unsigned int get_number_of_children () const
const HierarchyTraitsget_traits () const
void remove_child (unsigned int i)
void remove_child (Hierarchy h)
- Public Member Functions inherited from IMP::Decorator
std::size_t __hash__ () const
ParticleIndex get_particle_index () const
Particleget_particle () const
Modelget_model () const
 Returns the Model containing the particle.
 Decorator (Particle *p)
 Decorator ()

Static Public Member Functions

static Domain decorate_particle (::IMP::Particle *p)
static bool particle_is_instance (Particle *p)
static Domain setup_particle (Particle *p, IntRange r)
 Create a domain covering the range [b, e)
static Domain setup_particle (Particle *p, Domain o)
 Create a domain by copying from o.
- Static Public Member Functions inherited from IMP::atom::Hierarchy
static Hierarchy decorate_particle (Particle *p)
 cast a particle which has the needed attributes
static const
IMP::core::HierarchyTraits
get_traits ()
 Get the molecular hierarchy HierararchyTraits.
static Hierarchy setup_particle (Particle *p, const ParticlesTemp &children=ParticlesTemp())
- Static Public Member Functions inherited from IMP::core::Hierarchy
static Hierarchy decorate_particle (::IMP::Particle *p, const HierarchyTraits &tr=get_default_traits())
static const DecoratorTraitsget_default_decorator_traits ()
static const HierarchyTraitsget_default_traits ()
 Get the default hierarchy traits.
static bool particle_is_instance (Particle *, HierarchyTraits=Hierarchy::get_default_traits())
static Hierarchy setup_particle (Particle *p, HierarchyTraits traits=Hierarchy::get_default_traits())
 Add the needed attributes to a particle.
static Hierarchy setup_particle (Particle *p, const Particles &children, HierarchyTraits traits=Hierarchy::get_default_traits())
 Add the needed attributes to a particle and add the particles as children.
static Decorator setup_particle (Particle *p, extra_arguments)

Additional Inherited Members

HD find_breadth_first (HD h, F f)
Out gather (H h, F f, Out out)
Out gather_by_attribute (H h, K k, V v, Out out)
Out gather_by_attributes (H h, K0 k0, V0 v0, K1 k1, V1 v1, Out out)
Out gather_slice (H h, F f, Out out)
std::ostream & show (Hierarchy h, std::ostream &out=std::cout)
visit_breadth_first (HD d, F f)
visit_breadth_first_with_data (HD d, F f, typename F::result_type i)
visit_depth_first (HD d, F f)
visit_depth_first_with_data (HD d, F f, typename F::result_type i)

Member Function Documentation

Int IMP::atom::Domain::get_begin_index ( ) const

Get the index of the first residue in the domain.

Int IMP::atom::Domain::get_end_index ( ) const

Get the index of the first residue not in the domain.

static bool IMP::atom::Domain::particle_is_instance ( Particle p)
static

Check if the particle has the needed attributes for a cast to succeed

Reimplemented from IMP::atom::Hierarchy.

static Domain IMP::atom::Domain::setup_particle ( Particle p,
IntRange  r 
)
static

Create a domain covering the range [b, e)

static Domain IMP::atom::Domain::setup_particle ( Particle p,
Domain  o 
)
static

Create a domain by copying from o.


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

Generated on Tue May 22 2012 23:33:26 for IMP by doxygen 1.8.1