atom_view.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2020 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_ATOM_VIEW_HH
#define OST_ATOM_VIEW_HH

/*
   Author: Marco Biasini
 */
#include <ost/mol/module_config.hh>
#include <ost/mol/atom_base.hh>
#include <ost/mol/entity_visitor_fw.hh>
#include <ost/mol/view_type_fw.hh>
#include <ost/mol/handle_type_fw.hh>

namespace ost { namespace mol {

class DLLEXPORT_OST_MOL AtomView : public AtomBase {

  friend class EntityView;
public:
  

  operator bool() const { return this->IsValid(); }
  bool IsValid() const;
  // constructors  
  AtomView();
  AtomView(const ResidueView& residue_view,
           const AtomHandle& atom);

  ResidueView GetResidue() const;
  
  EntityView GetEntity() const;
  
  AtomHandle GetHandle() const;

  BondHandleList GetBondList() const;
  
  int GetBondCount() const;
  
  AtomViewList GetBondPartners() const;  

  void RemoveBonds();
  
  void Apply(EntityVisitor& visitor);
  void Apply(EntityViewVisitor& visitor);

  unsigned long GetHashCode() const;
  bool operator==(const AtomView& rhs) const;
  bool operator!=(const AtomView& rhs) const;
protected:
  bool AddBond(const BondHandle& bond);
  
  void RemoveBondInternal(const BondHandle& bond);
private:
  AtomViewDataPtr  data_;
};

}} // ns

#endif // OST_ATOM_VIEW_HH