atom_iterable_concept.hpp

Go to the documentation of this file.

// -*- mode: c++; indent-tabs-mode: nil; -*-
//
//The Biomolecule Toolkit (BTK) is a C++ library for use in the
//modeling, analysis, and design of biological macromolecules.
//Copyright (C) 2006, Tim Robertson <kid50@users.sourceforge.net>
//
//This program is free software; you can redistribute it and/or modify
//it under the terms of the GNU Lesser General Public License as published
//by the Free Software Foundation; either version 2.1 of the License, or (at
//your option) any later version.
//
//This program is distributed in the hope that it will be useful,  but
//WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//Lesser General Public License for more details.
//
//You should have received a copy of the GNU Lesser General Public License
//along with this program; if not, write to the Free Software Foundation,
//Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


#ifndef BTK_CONCEPTS_ATOM_ITERABLE_CONCEPT_HPP
#define BTK_CONCEPTS_ATOM_ITERABLE_CONCEPT_HPP


#ifndef DOXYGEN_SHOULD_SKIP_THIS

#include <boost/concept_check.hpp>

#include <btk/core/concepts/atom_iterator_concept.hpp>

namespace BTK {
namespace CONCEPTS {

template <typename T>
struct AtomIterableConcept
{
  typedef typename T::size_type st;
  typedef typename T::const_atom_iterator const_atom_it;
  typedef typename T::const_reverse_atom_iterator const_rev_atom_it;
  typedef typename T::atom_iterator atom_it;
  typedef typename T::reverse_atom_iterator rev_atom_it;

  void constraints() {
    boost::function_requires<AtomIterableConcept<T> >();
    boost::function_requires<MutableAtomIteratorConcept<atom_it> >();
    boost::function_requires<MutableAtomIteratorConcept<rev_atom_it> >();

    ai = obj.structure_begin();
    ai = obj.structure_end();
    rai = obj.structure_rbegin();
    rai = obj.structure_rend();

    const_constraints(obj);
  };

  void const_constraints(T const & ac) {
    boost::function_requires<AtomIteratorConcept<const_atom_it> >();
    boost::function_requires<AtomIteratorConcept<const_rev_atom_it> >();

    size = ac.num_atoms();

    cai = ac.structure_begin();
    cai = ac.structure_end();
    crai = ac.structure_rbegin();
    crai = ac.structure_rend();  
  }

  T obj;
  st size;
  const_atom_it cai;
  const_rev_atom_it crai;
  atom_it ai;
  rev_atom_it rai;  
};

} // namespace CONCEPTS
} // namespace BTK
#endif // DOXYGEN_SHOULD_SKIP_THIS

#endif // BTK_CONCEPTS_ATOM_ITERABLE_CONCEPT_HPP

---