RSVertex.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
 
#ifndef BALL_STRUCTURE_RSVERTEX_H
#define BALL_STRUCTURE_RSVERTEX_H
 
#ifndef BALL_STRUCTURE_GRAPHVERTEX_H
# include <BALL/STRUCTURE/graphVertex.h>
#endif
 
 
namespace BALL
{
  class RSEdge;
  class RSFace;
  class ReducedSurface;
  class RSComputer;
  class SESEdge;
  class SESFace;
  class SESVertex;
  class SolventExcludedSurface;
  class SESComputer;
  class SESSingularityCleaner;
  class TriangulatedSES;
  class SESTriangulator;
  class SASEdge;
  class SASFace;
  class SASVertex;
  class SolventAccessibleSurface;
  class TriangulatedSAS;
  class SASTriangulator;

  class BALL_EXPORT RSVertex  : public GraphVertex< RSVertex,RSEdge,RSFace >
  {
    public:

    friend class RSEdge;
    friend class RSFace;
    friend class ReducedSurface;
    friend class RSComputer;
    friend class SESEdge;
    friend class SESFace;
    friend class SESVertex;
    friend class SolventExcludedSurface;
    friend class SESComputer;
    friend class SESSingularityCleaner;
    friend class TriangulatedSES;
    friend class SESTriangulator;
    friend class SASEdge;
    friend class SASFace;
    friend class SASVertex;
    friend class SolventAccessibleSurface;
    friend class TriangulatedSAS;
    friend class SASTriangulator;
 
    BALL_CREATE(RSVertex)
 
    

    RSVertex();

    RSVertex(const RSVertex& rsvertex, bool deep = false);

    RSVertex(Index atom);

    virtual ~RSVertex();


    void set(const RSVertex& rsvertex, bool deep = false);

    RSVertex& operator = (const RSVertex& rsvertex);



    void setAtom(Index atom);

    Index getAtom() const;



    virtual bool operator == (const RSVertex& rsvertex) const;

    virtual bool operator != (const RSVertex& rsvertex) const;

    virtual bool operator *= (const RSVertex& rsvertex) const;

 
    protected:
 
    /*_ @name Attributes
    */
 
    /*_ The index of the atom represented by the RSVertex
    */
    Index atom_;

 
  };


  BALL_EXPORT std::ostream& operator << (std::ostream& s, const RSVertex& rsvertex);

 
   
} // namespace BALL
 
#endif // BALL_STRUCTURE_RSVERTEX_H