OBEdgeBase Class Reference

Edge Base Class. More...

#include <base.h>

Inheritance diagram for OBEdgeBase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 OBEdgeBase ()
 Constructor.
 OBEdgeBase (OBNodeBase *bgn, OBNodeBase *end)
 Constructor (populate from two OBNodeBase objects).
virtual ~OBEdgeBase ()
 Destructor.
virtual OBGraphBaseGetParent ()
void SetParent (OBGraphBase *)
unsigned int GetIdx ()
void SetIdx (int idx)
void SetBgn (OBNodeBase *n)
void SetEnd (OBNodeBase *n)
void SwapEnds ()
OBNodeBaseGetBgn ()
OBNodeBaseGetEnd ()
void Error (int f)
virtual OBBaseDoTransformations (const std::map< std::string, std::string > *pOptions)
Nonfunctional members
Nonfunctional or unused members of OpenBabel::OBEdgeBase are to be added by a derived class (e.g., OpenBabel::OBBond)

virtual void SetClosure ()
virtual bool IsAromatic () const
virtual bool IsInRing () const
virtual bool IsClosure ()
virtual bool Eval (OBEdgeBase *)
virtual unsigned int GetBO () const

Static Public Member Functions

static const char * ClassDescription ()

Public Attributes

bool Visit

Protected Attributes

unsigned short int _idx
 What is my unique edge index? GetIdx(), SetIdx(int idx).
OBNodeBase_bgn
 I connect one node.
OBNodeBase_end
OBGraphBase_parent
 To which graph do I belong? GetParent(), SetParent(OBGraphBase*).

Detailed Description

Edge Base Class.

The base class for edges (e.g. bonds) in a graph-theoretical representation.


Constructor & Destructor Documentation

OBEdgeBase (  )  [inline]

Constructor.

OBEdgeBase ( OBNodeBase bgn,
OBNodeBase end 
) [inline]

Constructor (populate from two OBNodeBase objects).

virtual ~OBEdgeBase (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual OBGraphBase* GetParent (  )  [inline, virtual]

void SetParent ( OBGraphBase  ) 

unsigned int GetIdx (  )  [inline]

void SetIdx ( int  idx  )  [inline]

Reimplemented in OBBond.

void SetBgn ( OBNodeBase n  )  [inline]

void SetEnd ( OBNodeBase n  )  [inline]

void SwapEnds (  )  [inline]

OBNodeBase* GetBgn (  )  [inline]

OBNodeBase* GetEnd (  )  [inline]

void Error ( int  f  )  [inline]

virtual void SetClosure (  )  [inline, virtual]

Reimplemented in OBBond.

virtual bool IsAromatic (  )  const [inline, virtual]

Reimplemented in OBBond.

virtual bool IsInRing (  )  const [inline, virtual]

Reimplemented in OBBond.

virtual bool IsClosure (  )  [inline, virtual]

Reimplemented in OBBond.

virtual bool Eval ( OBEdgeBase  )  [inline, virtual]

virtual unsigned int GetBO (  )  const [inline, virtual]

Reimplemented in OBBond.

virtual OBBase* DoTransformations ( const std::map< std::string, std::string > *  pOptions  )  [inline, virtual, inherited]

Reimplemented in OBMol.

static const char* ClassDescription (  )  [inline, static, inherited]

Reimplemented in OBMol.


Member Data Documentation

unsigned short int _idx [protected]

What is my unique edge index? GetIdx(), SetIdx(int idx).

OBNodeBase* _bgn [protected]

I connect one node.

OBNodeBase* _end [protected]

to another node

OBGraphBase* _parent [protected]

To which graph do I belong? GetParent(), SetParent(OBGraphBase*).

bool Visit


The documentation for this class was generated from the following files: