The Gnome Chemistry Utils  0.14.16
Public Member Functions | List of all members
gcu::FormulaAtom Class Reference

#include <formula.h>

Inheritance diagram for gcu::FormulaAtom:
gcu::FormulaElt

Public Member Functions

 FormulaAtom (int Z)
 
virtual ~FormulaAtom ()
 
std::string Markup ()
 
std::string Text ()
 
void BuildRawFormula (std::map< int, int > &raw)
 
int GetValence ()
 
- Public Member Functions inherited from gcu::FormulaElt
 FormulaElt ()
 
virtual ~FormulaElt ()
 

Additional Inherited Members

- Public Attributes inherited from gcu::FormulaElt
int stoich
 
unsigned start
 
unsigned end
 

Detailed Description

class FormulaAtom gcu/formula.h Represents an atom in a formula.

Definition at line 151 of file formula.h.

Constructor & Destructor Documentation

§ FormulaAtom()

gcu::FormulaAtom::FormulaAtom ( int  Z)
Parameters
Z

§ ~FormulaAtom()

virtual gcu::FormulaAtom::~FormulaAtom ( )
virtual

The destructor.

Member Function Documentation

§ BuildRawFormula()

void gcu::FormulaAtom::BuildRawFormula ( std::map< int, int > &  raw)
virtual
Parameters
rawwhere to put the result

Adds the stoichiometry coefficient to the entry correponding to the element.

Implements gcu::FormulaElt.

§ GetValence()

int gcu::FormulaAtom::GetValence ( )
virtual
Returns
the (most probable) valence of the element.

Implements gcu::FormulaElt.

§ Markup()

std::string gcu::FormulaAtom::Markup ( )
virtual
Returns
the string representation of the element as a markup.

Reimplemented from gcu::FormulaElt.

§ Text()

std::string gcu::FormulaAtom::Text ( )
virtual
Returns
the string representation of the element as raw text.

Reimplemented from gcu::FormulaElt.


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