MGVertex Class Reference

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

#include <indigox/graph/molecular.hpp>

Public Member Functions
	MGVertex ()=default
	MGVertex (const MGVertex &)=default
	MGVertex (MGVertex &&)=default
	~ MGVertex ()=default
const Atom &	GetAtom () const
	Get the atom associated with this vertex. More...
const MolecularGraph &	GetGraph () const
	Get the graph this vertex is part of. More...
	operator bool () const
bool	operator!= (const MGVertex &v) const
bool	operator< (const MGVertex &v) const
bool	operator<= (const MGVertex &v) const
MGVertex &	operator= (MGVertex &&)=default
MGVertex &	operator= (const MGVertex &)=default
bool	operator== (const MGVertex &v) const
bool	operator> (const MGVertex &v) const
bool	operator>= (const MGVertex &v) const

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

Detailed Description

Class for the vertices of a IXMolecularGraph.

Constructor & Destructor Documentation

MGVertex() [1/3]

MGVertex ( )

default

MGVertex() [2/3]

MGVertex ( const MGVertex &  )

default

MGVertex() [3/3]

MGVertex ( MGVertex &&  )

default

~ MGVertex()

~ MGVertex ( )

default

Member Function Documentation

GetAtom()

const Atom& GetAtom

(

)

const

Get the atom associated with this vertex.

Returns

the atom associated with this vertex, if it is still alive.

GetGraph()

const MolecularGraph& GetGraph

(

)

const

Get the graph this vertex is part of.

Returns

the owning graph.

operator bool()

operator bool ( ) const

inline

operator!=()

bool operator!= ( const MGVertex &  v ) const

inline

operator<()

bool operator<

(

const MGVertex &

v

)

const

operator<=()

bool operator<= ( const MGVertex &  v ) const

inline

operator=() [1/2]

MGVertex& operator= ( MGVertex &&  )

default

operator=() [2/2]

MGVertex& operator= ( const MGVertex &  )

default

operator==()

bool operator==

(

const MGVertex &

v

)

const

operator>()

bool operator>

(

const MGVertex &

v

)

const

operator>=()

bool operator>= ( const MGVertex &  v ) 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 vertices.

operator<<

std::ostream& operator<< ( std::ostream &  os, const MGVertex &  v  )

friend

---

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

• include/indigox/graph/molecular.hpp