IMP::example::ExampleDecorator Class Reference

A simple decorator which adds a name to a particle. More...

#include <IMP/example/ExampleDecorator.h>

Inheritance diagram for IMP::example::ExampleDecorator:

Detailed Description

A simple decorator which adds a name to a particle.

A decorator adds functionality to a particle and ensures that invariants are preserved. In this case, the functionality is the setting and access of a name for the Particle and the invariant is that the name is always non-empty.

The source code is as follows:

/**
 *  \file IMP/example/ExampleDecorator.h     \brief Add a name to a particle.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPEXAMPLE_EXAMPLE_DECORATOR_H
#define IMPEXAMPLE_EXAMPLE_DECORATOR_H

#include <IMP/example/example_config.h>

#include <IMP/Particle.h>
#include <IMP/Model.h>
#include <IMP/Decorator.h>
#include <IMP/decorator_macros.h>
#include <IMP/exception.h>

IMPEXAMPLE_BEGIN_NAMESPACE

//! A simple decorator which adds a name to a particle.
/** A decorator adds functionality to a particle and ensures that invariants
    are preserved. In this case, the functionality is the setting and access
    of a name for the Particle and the invariant is that the name is
   always
    non-empty.

    The source code is as follows:
    \include ExampleDecorator.h
    \include ExampleDecorator.cpp
*/
class IMPEXAMPLEEXPORT ExampleDecorator : public Decorator {
  /* Use a static variable in a static method to create the key
     so that it is only done once and is only done when it is first
     needed. Lazy initialization of keys makes \imp more efficient as
     Particles do not have to allocate memory for unused keys.
  */
  static StringKey get_name_key();
  //! Add a name to the particle
  /** The create function should take arguments which allow
      the initial state of the Decorator to be reasonable (i.e.
      make sure there is a non-empty name).
   */
  static void do_setup_particle(Model *m, ParticleIndex pi,
                                std::string name) {
    // use the usage check macro to make sure that arguments are correct
    IMP_USAGE_CHECK(!name.empty(), "The name cannot be empty.");
    m->add_attribute(get_name_key(), pi, name);
  }

 public:
  //! return true if the particle has a name
  static bool get_is_setup(Model *m, ParticleIndex pi) {
    return m->get_has_attribute(get_name_key(), pi);
  }

  //! Get the name added to the particle
  std::string get_decorator_name() const {
    return get_particle()->get_value(get_name_key());
  }

  //! Set the name added to the particle
  void set_decorator_name(std::string nm) {
    // use the usage check macro to check that functions are called properly
    IMP_USAGE_CHECK(!nm.empty(), "The name cannot be empty");
    get_particle()->set_value(get_name_key(), nm);
  }

  /* Declare the basic constructors and the cast function.*/
  IMP_DECORATOR_METHODS(ExampleDecorator, Decorator);
  IMP_DECORATOR_SETUP_1(ExampleDecorator, std::string, name);
};

/** Define a collection of them. Also look at example.i*/
IMP_DECORATORS(ExampleDecorator, ExampleDecorators, Particles);

IMPEXAMPLE_END_NAMESPACE

#endif /* IMPEXAMPLE_EXAMPLE_DECORATOR_H */

/**
 *  \file example/ExampleDecorator.cpp
 *  \brief Add a name to a particle.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#include <IMP/example/ExampleDecorator.h>

IMPEXAMPLE_BEGIN_NAMESPACE

StringKey ExampleDecorator::get_name_key() {
  /* the compiler will make sure this is initialized the first time the
   method is called. */
  static StringKey mykey("my name");
  return mykey;
}

void ExampleDecorator::show(std::ostream &out) const {
  out << get_decorator_name();
}

IMPEXAMPLE_END_NAMESPACE

Definition at line 32 of file ExampleDecorator.h.

Public Member Functions
	ExampleDecorator (::IMP::Model *m,::IMP::ParticleIndex id)
	ExampleDecorator (const IMP::ParticleAdaptor &d)
std::string	get_decorator_name () const
	Get the name added to the particle. More...
void	set_decorator_name (std::string nm)
	Set the name added to the particle. More...
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::Decorator
bool	get_is_valid () const
	Returns true if constructed with a non-default constructor. More...
Model *	get_model () const
	Returns the Model containing the particle. More...
Particle *	get_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
Particle *	operator-> () const

Static Public Member Functions
static bool	get_is_setup (Model *m, ParticleIndex pi)
	return true if the particle has a name More...
static bool	get_is_setup (const IMP::ParticleAdaptor &p)
static ExampleDecorator	setup_particle (Model *m, ParticleIndex pi, std::string name)
static ExampleDecorator	setup_particle (IMP::ParticleAdaptor pa, std::string name)

Additional Inherited Members
Protected Member Functions inherited from IMP::Decorator
	Decorator (Model *m, ParticleIndex pi)
	Decorator (ParticleAdaptor p)

Member Function Documentation

std::string IMP::example::ExampleDecorator::get_decorator_name

(

)

const

Get the name added to the particle.

Definition at line 58 of file ExampleDecorator.h.

Here is the call graph for this function:

static bool IMP::example::ExampleDecorator::get_is_setup ( Model *  m, ParticleIndex  pi  )

static

return true if the particle has a name

Definition at line 53 of file ExampleDecorator.h.

Here is the call graph for this function:

void IMP::example::ExampleDecorator::set_decorator_name

(

std::string

nm

)

Set the name added to the particle.

Definition at line 63 of file ExampleDecorator.h.

Here is the call graph for this function:

static ExampleDecorator IMP::example::ExampleDecorator::setup_particle ( IMP::ParticleAdaptor  pa, std::string  name  )

static

Returns

a ExampleDecorator object that decorates the particle specified by pa

See Also

setup_particle(m, pi, name )

Definition at line 71 of file ExampleDecorator.h.

static ExampleDecorator IMP::example::ExampleDecorator::setup_particle ( Model *  m, ParticleIndex  pi, std::string  name  )

static

Returns

a ExampleDecorator object that decorates particle pi

Definition at line 71 of file ExampleDecorator.h.

---

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

• ExampleDecorator.h