BALL::GraphEdge

BALL::GraphEdge< Vertex, Edge, Face > Class Template Reference
[Molecular Surface Computation]

#include <BALL/STRUCTURE/graphEdge.h>

List of all members.


Public Member Functions

Constructors and Destructors
 GraphEdge ()
 GraphEdge (const GraphEdge< Vertex, Edge, Face > &edge, bool deep=false)
 GraphEdge (Vertex *vertex1, Vertex *vertex2, Face *face1, Face *face2, Index index)
virtual ~GraphEdge ()
Assignment
void set (const GraphEdge< Vertex, Edge, Face > &edge, bool deep=false)
GraphEdge< Vertex, Edge, Face > & operator= (const GraphEdge< Vertex, Edge, Face > &edge)
void set (Vertex *vertex0, Vertex *vertex1, Face *face0, Face *face1, Index index)
Accessors
void setVertex (Position i, Vertex *vertex)
Vertex * getVertex (Position i) const
void setFace (Position i, Face *face)
Face * getFace (Position i) const
void setIndex (Index index)
Index getIndex () const
Vertex * other (const Vertex *vertex) const throw (Exception::GeneralException)
Face * other (const Face *face) const throw (Exception::GeneralException)
bool substitute (const Vertex *old_vertex, Vertex *new_vertex)
bool substitute (const Face *old_vertex, Face *new_vertex)
Face * remove (const Face *face)
void revert ()
Predicates
virtual bool operator== (const Edge &) const
virtual bool operator!= (const Edge &) const
virtual bool operator*= (const Edge &) const

Protected Attributes

Vertex * vertex_ [2]
Face * face_ [2]
Index index_

Friends

Class friends
  • class GraphVertex<Vertex,Edge,Face>;
  • class GraphFace<Vertex,Edge,Face>;
  • class GraphTriangle<Vertex,Edge,Face>;


class GraphVertex< Vertex, Edge, Face >
class GraphFace< Vertex, Edge, Face >
class GraphTriangle< Vertex, Edge, Face >

Detailed Description

template<typename Vertex, typename Edge, typename Face>
class BALL::GraphEdge< Vertex, Edge, Face >

Generic GraphEdge Class.

Constructor & Destructor Documentation

template<typename Vertex , typename Edge , typename Face >
BALL::GraphEdge< Vertex, Edge, Face >::GraphEdge (  )  [inline]

Default constructor. This method creates a new GraphEdge object.

template<typename Vertex, typename Edge, typename Face>
BALL::GraphEdge< Vertex, Edge, Face >::GraphEdge ( const GraphEdge< Vertex, Edge, Face > &  edge,
bool  deep = false 
) [inline]

Copy constructor. Create a new GraphEdge object from another.

Parameters:
edge the GraphEdge object to be copied
deep if deep = false, all pointers are set to NULL (default). Otherwise the new GraphEdge object is linked to the neighbours of the old GraphEdge object.

References BALL::GraphEdge< Vertex, Edge, Face >::face_, and BALL::GraphEdge< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face>
BALL::GraphEdge< Vertex, Edge, Face >::GraphEdge ( Vertex *  vertex1,
Vertex *  vertex2,
Face *  face1,
Face *  face2,
Index  index 
) [inline]

Detailled constructor. Create a new GraphEdge object from a lot of nice objects

Parameters:
vertex1 assigned to the first vertex
vertex2 assigned to the second vertex
face1 assigned to the first face
face2 assigned to the second face
index assigned to the index
template<typename Vertex , typename Edge , typename Face >
BALL::GraphEdge< Vertex, Edge, Face >::~GraphEdge (  )  [inline, virtual]

Destructor. Destructs the GraphEdge object. The neighboured faces and vertices are {/bf not} destructed.

Member Function Documentation

template<typename Vertex , typename Edge , typename Face >
Face * BALL::GraphEdge< Vertex, Edge, Face >::getFace ( Position  i  )  const [inline]

Return one of the two faces of the GraphEdge.

Parameters:
i 
Returns:
Face* a pointer to the first face if i = 0, a pointer to the second face otherwise

References BALL::GraphEdge< Vertex, Edge, Face >::face_.

template<typename Vertex , typename Edge , typename Face >
Index BALL::GraphEdge< Vertex, Edge, Face >::getIndex (  )  const [inline]

Return the index of the GraphEdge.

Returns:
Index the index of the GraphEdge

References BALL::GraphEdge< Vertex, Edge, Face >::index_.

template<typename Vertex , typename Edge , typename Face >
Vertex * BALL::GraphEdge< Vertex, Edge, Face >::getVertex ( Position  i  )  const [inline]

Return one of the two vertices of the GraphEdge.

Parameters:
i 
Returns:
Vertex* a pointer to the first vertex if i = 0, a pointer to the second vertex otherwise

References BALL::GraphEdge< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge, typename Face >
bool BALL::GraphEdge< Vertex, Edge, Face >::operator!= ( const Edge &   )  const [inline, virtual]

Inequality operator.

Returns:
bool false

Reimplemented in BALL::RSEdge, BALL::SASEdge, BALL::SESEdge, and BALL::TriangleEdge.

template<typename Vertex , typename Edge, typename Face >
bool BALL::GraphEdge< Vertex, Edge, Face >::operator*= ( const Edge &   )  const [inline, virtual]

Similarity operator.

Returns:
bool true

Reimplemented in BALL::RSEdge, BALL::SASEdge, BALL::SESEdge, and BALL::TriangleEdge.

template<typename Vertex, typename Edge, typename Face>
GraphEdge< Vertex, Edge, Face > & BALL::GraphEdge< Vertex, Edge, Face >::operator= ( const GraphEdge< Vertex, Edge, Face > &  edge  )  [inline]

Assign from another GraphEdge. The GraphEdge object is linked to the neighbours of the GraphEdge object to assign from.

Parameters:
edge the GraphEdge object to assign from

References BALL::GraphEdge< Vertex, Edge, Face >::face_, BALL::GraphEdge< Vertex, Edge, Face >::index_, and BALL::GraphEdge< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge, typename Face >
bool BALL::GraphEdge< Vertex, Edge, Face >::operator== ( const Edge &   )  const [inline, virtual]

Equality operator.

Returns:
bool, true

Reimplemented in BALL::RSEdge, BALL::SASEdge, BALL::SESEdge, and BALL::TriangleEdge.

template<typename Vertex, typename Edge , typename Face>
Face * BALL::GraphEdge< Vertex, Edge, Face >::other ( const Face *  face  )  const throw (Exception::GeneralException) [inline]

Return a pointer to the other face of the GraphEdge. If the given face is not neighboured to the GraphEdge, an exception is thrown.

Parameters:
face one of the faces of the GraphEdge
Returns:
Face* the other face
template<typename Vertex, typename Edge , typename Face >
Vertex * BALL::GraphEdge< Vertex, Edge, Face >::other ( const Vertex *  vertex  )  const throw (Exception::GeneralException) [inline]

Return a pointer to the other vertex of the GraphEdge. If the given vertex is not incident to the GraphEdge, an exception is thrown.

Parameters:
vertex one of the vertices of the GraphEdge
Returns:
Vertex* the other vertex
template<typename Vertex , typename Edge , typename Face>
Face * BALL::GraphEdge< Vertex, Edge, Face >::remove ( const Face *  face  )  [inline]

Delete a face of the GraphEdge. If the second face of the GraphEdge should be deleted, it is set to NULL. If the first one should be deleted, the second one is copied to first position and then set to NULL.

Parameters:
face the face to delete
Returns:
Face* a pointer to the other face

References BALL::GraphEdge< Vertex, Edge, Face >::face_.

template<typename Vertex , typename Edge , typename Face >
void BALL::GraphEdge< Vertex, Edge, Face >::revert (  )  [inline]

References BALL::GraphEdge< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face>
void BALL::GraphEdge< Vertex, Edge, Face >::set ( Vertex *  vertex0,
Vertex *  vertex1,
Face *  face0,
Face *  face1,
Index  index 
) [inline]

Assign from a lot of nice objects

Parameters:
vertex0 assigned to the first vertex
vertex1 assigned to the second vertex
face0 assigned to the first face
face1 assigned to the second face
index assigned to the index
template<typename Vertex, typename Edge, typename Face>
void BALL::GraphEdge< Vertex, Edge, Face >::set ( const GraphEdge< Vertex, Edge, Face > &  edge,
bool  deep = false 
) [inline]

Assign from another GraphEdge.

Parameters:
edge the GraphEdge object to assign from
deep if deep = false, all pointers are set to NULL (default). Otherwise the GraphEdge object is linked to the neighbours of the GraphEdge object to assign from.

References BALL::GraphEdge< Vertex, Edge, Face >::face_, BALL::GraphEdge< Vertex, Edge, Face >::index_, and BALL::GraphEdge< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge , typename Face>
void BALL::GraphEdge< Vertex, Edge, Face >::setFace ( Position  i,
Face *  face 
) [inline]

Set one of the two faces of the GraphEdge.

Parameters:
i change the first face, if i = 0, the second otherwise
face a pointer to the new face

References BALL::GraphEdge< Vertex, Edge, Face >::face_.

template<typename Vertex , typename Edge , typename Face >
void BALL::GraphEdge< Vertex, Edge, Face >::setIndex ( Index  index  )  [inline]

Set the index of the GraphEdge.

Parameters:
index the new index

References BALL::GraphEdge< Vertex, Edge, Face >::index_.

template<typename Vertex, typename Edge , typename Face >
void BALL::GraphEdge< Vertex, Edge, Face >::setVertex ( Position  i,
Vertex *  vertex 
) [inline]

Set one of the two vertices of the GraphEdge.

Parameters:
i the first vertex is changed if i = 0, the second otherwise
vertex a pointer to the new vertex

References BALL::GraphEdge< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge , typename Face>
bool BALL::GraphEdge< Vertex, Edge, Face >::substitute ( const Face *  old_vertex,
Face *  new_vertex 
) [inline]

Substitute a face by an other one.

Parameters:
old_vertex the face that has to be substituted
new_vertex the new face
Returns:
bool true, if the face can be substituted, false otherwise
template<typename Vertex, typename Edge , typename Face >
bool BALL::GraphEdge< Vertex, Edge, Face >::substitute ( const Vertex *  old_vertex,
Vertex *  new_vertex 
) [inline]

Substitute a vertex by an other one.

Parameters:
old_vertex the vertex that has to be substituted
new_vertex the new vertex
Returns:
bool true, if the vertex can be substituted, false otherwise

Friends And Related Function Documentation

template<typename Vertex, typename Edge, typename Face>
friend class GraphFace< Vertex, Edge, Face > [friend]
template<typename Vertex, typename Edge, typename Face>
friend class GraphTriangle< Vertex, Edge, Face > [friend]
template<typename Vertex, typename Edge, typename Face>
friend class GraphVertex< Vertex, Edge, Face > [friend]

Member Data Documentation

template<typename Vertex, typename Edge, typename Face>
Face* BALL::GraphEdge< Vertex, Edge, Face >::face_[2] [protected]

Referenced by BALL::GraphEdge< Vertex, Edge, Face >::getFace(), BALL::GraphEdge< Vertex, Edge, Face >::GraphEdge(), BALL::GraphEdge< Vertex, Edge, Face >::operator=(), BALL::GraphEdge< Vertex, Edge, Face >::remove(), BALL::GraphEdge< Vertex, Edge, Face >::set(), and BALL::GraphEdge< Vertex, Edge, Face >::setFace().

template<typename Vertex, typename Edge, typename Face>
Index BALL::GraphEdge< Vertex, Edge, Face >::index_ [protected]

Referenced by BALL::GraphEdge< Vertex, Edge, Face >::getIndex(), BALL::GraphEdge< Vertex, Edge, Face >::operator=(), BALL::GraphEdge< Vertex, Edge, Face >::set(), and BALL::GraphEdge< Vertex, Edge, Face >::setIndex().

template<typename Vertex, typename Edge, typename Face>
Vertex* BALL::GraphEdge< Vertex, Edge, Face >::vertex_[2] [protected]

Referenced by BALL::GraphEdge< Vertex, Edge, Face >::getVertex(), BALL::GraphEdge< Vertex, Edge, Face >::GraphEdge(), BALL::GraphEdge< Vertex, Edge, Face >::operator=(), BALL::GraphEdge< Vertex, Edge, Face >::revert(), BALL::GraphEdge< Vertex, Edge, Face >::set(), and BALL::GraphEdge< Vertex, Edge, Face >::setVertex().