Typed.h

Go to the documentation of this file.

/**
 *  \file IMP/core/Typed.h     \brief A particle with a user-defined type.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPCORE_TYPED_H
#define IMPCORE_TYPED_H

#include <IMP/core/core_config.h>
#include <IMP/decorator_macros.h>

#include <IMP/Decorator.h>
#include <IMP/algebra/Vector3D.h>
#include <IMP/algebra/Transformation3D.h>
#include <vector>
#include <limits>

IMPCORE_BEGIN_NAMESPACE

// TODO: why this number? how can we tell it's unique?
#define IMP_PARTICLE_TYPE_INDEX 34897493

//! An IMP::Key object for identifying types of particles by strings.
/** The ParticleType key is used to type particles within
    the Typed decorator */
typedef Key<IMP_PARTICLE_TYPE_INDEX> ParticleType;
IMP_VALUES(ParticleType, ParticleTypes);

//! A decorator for classifying particles in your system.
/** \see ParticleType
 */
class IMPCOREEXPORT Typed : public Decorator {
  static void do_setup_particle(Model *m, ParticleIndex pi,
                                ParticleType t) {
    m->add_attribute(get_type_key(), pi, t.get_index());
  }

 public:
  inline static IntKey get_type_key();

  IMP_DECORATOR_METHODS(Typed, Decorator);
  IMP_DECORATOR_SETUP_1(Typed, ParticleType, t);

  static bool get_is_setup(Model *m, ParticleIndex pi) {
    return m->get_has_attribute(get_type_key(), pi);
  }

  ParticleType get_type() const {
    return ParticleType(
        get_model()->get_attribute(get_type_key(), get_particle_index()));
  }

  void set_type(ParticleType pt) const {
    get_model()->set_attribute(get_type_key(), get_particle_index(),
                               pt.get_index());
  }

};

// in header for faster access
IntKey Typed::get_type_key() {
  static IntKey k("particle type");
  return k;
}


IMP_DECORATORS(Typed, Typeds, ParticlesTemp);

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_TYPED_H */