MGEdge Class Reference

Class for the edges of a IXMolecularGraph. More...

#include <indigox/graph/molecular.hpp>

Public Member Functions
	MGEdge ()=default
	MGEdge (const MGEdge &)=default
	MGEdge (MGEdge &&)=default
	~ MGEdge ()=default
const Bond &	GetBond () const
	Get the bond associated with this edge. More...
const MolecularGraph &	GetGraph () const
	Get the graph this edge is part of. More...
	operator bool () const
bool	operator!= (const MGEdge &e) const
bool	operator< (const MGEdge &e) const
bool	operator<= (const MGEdge &e) const
MGEdge &	operator= (MGEdge &&)=default
MGEdge &	operator= (const MGEdge &)=default
bool	operator== (const MGEdge &e) const
bool	operator> (const MGEdge &e) const
bool	operator>= (const MGEdge &e) const

Friends
class	cereal::access
	Friendship allows for serialisation. More...
class	MolecularGraph
	Friendship allows IXMolecularGraph to add edges. More...
std::ostream &	operator<< (std::ostream &os, const MGEdge &e)

Detailed Description

Class for the edges of a IXMolecularGraph.

Constructor & Destructor Documentation

MGEdge() [1/3]

MGEdge ( )

default

MGEdge() [2/3]

MGEdge ( const MGEdge &  )

default

MGEdge() [3/3]

MGEdge ( MGEdge &&  )

default

~ MGEdge()

~ MGEdge ( )

default

Member Function Documentation

GetBond()

const Bond& GetBond

(

)

const

Get the bond associated with this edge.

Returns

the bond associated with this edge, if it is still alive.

GetGraph()

const MolecularGraph& GetGraph

(

)

const

Get the graph this edge is part of.

Returns

the owning graph.

operator bool()

operator bool ( ) const

inline

operator!=()

bool operator!= ( const MGEdge &  e ) const

inline

operator<()

bool operator<

(

const MGEdge &

e

)

const

operator<=()

bool operator<= ( const MGEdge &  e ) const

inline

operator=() [1/2]

MGEdge& operator= ( MGEdge &&  )

default

operator=() [2/2]

MGEdge& operator= ( const MGEdge &  )

default

operator==()

bool operator==

(

const MGEdge &

e

)

const

operator>()

bool operator>

(

const MGEdge &

e

)

const

operator>=()

bool operator>= ( const MGEdge &  e ) const

inline

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Friendship allows for serialisation.

MolecularGraph

friend class MolecularGraph

friend

Friendship allows IXMolecularGraph to add edges.

operator<<

std::ostream& operator<< ( std::ostream &  os, const MGEdge &  e  )

friend

---

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

• include/indigox/graph/molecular.hpp