entity_visitor.hh

Go to the documentation of this file.

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

#include "module_config.hh"
#include "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 EntityVisitor {
public:
  virtual ~EntityVisitor();

  virtual void OnEntry();
  virtual void OnExit();
  virtual bool VisitChain(const ChainHandle& c);
  
  virtual bool VisitResidue(const ResidueHandle& r);
  
  virtual bool VisitAtom(const AtomHandle& a);
  
  virtual bool VisitBond(const BondHandle& b);
  
  virtual bool VisitTorsion(const TorsionHandle& t);
};

class DLLEXPORT_OST_MOL EntityViewVisitor {
public:
  virtual ~EntityViewVisitor();

  virtual void OnEntry();
  virtual void OnExit();

  virtual bool VisitChain(const ChainView& c);
  
  virtual bool VisitResidue(const ResidueView& r);
  
  virtual bool VisitAtom(const AtomView& a);

  // is handle until bond view is implemented
  virtual bool VisitBond(const BondHandle& b);
};

}} //ns

#endif