stage/include/ost/mol/coord_source.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2010 by the OpenStructure authors
//
// This library 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 3.0 of the License, or (at your option)
// any later version.
// This library 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 library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef OST_MOL_COORD_SOURCE_HH
#define OST_MOL_COORD_SOURCE_HH

/*
  Author: Marco Biasini
 */
#include <boost/shared_ptr.hpp>
#include <ost/mol/module_config.hh>
#include <ost/mol/coord_frame.hh>
#include <ost/mol/entity_handle.hh>


namespace ost { namespace mol {

class CoordSource;

typedef boost::shared_ptr<CoordSource> CoordSourcePtr;

class DLLEXPORT_OST_MOL CoordSource {
public:
  CoordSource(const AtomHandleList& atoms);
  
  virtual ~CoordSource();
  
  CoordSourcePtr Extract(int start=0, int stop=-1, int step=1);
  
  virtual uint GetFrameCount()=0;
  
  virtual CoordFramePtr GetFrame(uint frame_id) const = 0;
 
  int GetAtomCount() const;
  
  EntityHandle GetEntity() const;
  
  const AtomHandleList& GetAtomList() const;

  void SetAtomPos(uint frame, AtomHandle atom, const geom::Vec3& pos);

  geom::Vec3 GetAtomPos(uint frame, AtomHandle atom) const;

  void CopyFrame(uint frame);
  bool IsMutable() const;
  
  void Capture();
  void CaptureInto(int pos);
  void Capture(uint f);
  
  virtual void AddFrame(const std::vector<geom::Vec3>& coords) = 0;
  virtual void InsertFrame(int pos, const std::vector<geom::Vec3>& coords) = 0;
protected:
  void SetMutable(bool flag);
private:
  AtomHandleList atoms_;
  EntityHandle   entity_;
  bool           mutable_;
  std::map<long,uint> atom_dict_;
};

}}

#endif

---