ExampleTemplateClass.h

Go to the documentation of this file.

/**
 *  \file IMP/example/ExampleTemplateClass.h
 *  \brief Show how to manage a template class with Python.
 *
 *  Copyright 2007-2014 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPEXAMPLE_EXAMPLE_TEMPLATE_CLASS_H
#define IMPEXAMPLE_EXAMPLE_TEMPLATE_CLASS_H

#include <IMP/example/example_config.h>

#include <IMP/utility.h>
#include <IMP/algebra/VectorD.h>

IMPEXAMPLE_BEGIN_NAMESPACE

//! A line segment templated on the dimension.
/** Like the underlying
    algebra::VectorD data, is not initialized when the default
    constructor is used. Since it is a small class, it is designed to
    be allocated on the stack and to be passed by value (or
    const &).

    The class should be named SegmentD, but it is an demostration.

    The source code is as follows:
    \include ExampleTemplateClass.h
*/
template <unsigned int D>
class ExampleTemplateClassD {
  IMP::algebra::VectorD<D> eps_[2];

 public:
  ExampleTemplateClassD() {}
  /** Since it is a simple object, there is no reason to provide
      methods to change the data.
  */
  ExampleTemplateClassD(const IMP::algebra::VectorD<D> &a,
                        const IMP::algebra::VectorD<D> &b) {
    eps_[0] = a;
    eps_[1] = b;
  }
  //! Get one of the endpoints
  const IMP::algebra::VectorD<D> &get_point(unsigned int i) const {
    IMP_USAGE_CHECK(i < 2, "The endpoint index can only be 0 or 1");
    return eps_[i];
  }

  IMP_SHOWABLE_INLINE(ExampleTemplateClassD, out << eps_[0] << " " << eps_[1];);
};

typedef ExampleTemplateClassD<3> ExampleTemplateClass3D;
typedef base::Vector<ExampleTemplateClassD<3> > ExampleTemplateClass3Ds;

IMPEXAMPLE_END_NAMESPACE

#endif /* IMPEXAMPLE_EXAMPLE_TEMPLATE_CLASS_H */