Element Class Reference

Read only class for storing elemental information. More...

#include <indigox/classes/periodictable.hpp>

Public Member Functions
	Element ()
	Element (const Element &)
	Element (Element &&)
double	GetAtomicMass () const
	Get atomic mass. More...
int32_t	GetAtomicNumber () const
	Get atomic number. More...
double	GetAtomicRadius () const
	Get atomic radius. More...
double	GetCovalentRadius () const
	Get covalent radius. More...
double	GetElectronegativity () const
	Get electronegativity. More...
int32_t	GetGroup () const
	Get element group number. More...
int32_t	GetHypervalentOctet () const
	Get full outer shell octet whne allowing for hypervalency. More...
std::string	GetName () const
	Get element name. More...
int32_t	GetOctet () const
	Get full outer shell octet. More...
int32_t	GetPeriod () const
	Get element period. More...
std::string	GetSymbol () const
	Get element symbol. More...
int32_t	GetValenceElectronCount () const
	Get number of valence electrons. More...
double	GetVanDerWaalsRadius () const
	Get van der Waals radius. More...
	operator bool ()
bool	operator!= (int32_t Z) const
bool	operator!= (const std::string &name) const
bool	operator!= (const Element &element) const
bool	operator< (const Element &element) const
bool	operator<= (const Element &element) const
Element &	operator= (const Element &)
Element &	operator= (Element &&)
bool	operator== (int32_t Z) const
bool	operator== (const std::string &name) const
bool	operator== (const Element &element) const
bool	operator> (const Element &element) const
bool	operator>= (const Element &element) const

Friends
struct	indigox::test::TestElement
	Friendship allows testing. More...
class	PeriodicTable
	Friendship allows IXPeriodicTable to create new IXElement instances. More...

Detailed Description

Read only class for storing elemental information.

Contains a large amount of relevant information pertaining to elements. Information includes atomic mass, atomic number, atomic radius, covalent radius, van der Waals radius, name, symbol, IUPAC group number, period number, number of valence electrons, octet, hypervalency octet and electronegativity. No public constructors are provided, so instances can only be generated by the IXPeriodicTable class. Like most other classes in the indigoX library, usage is primarily intended through the use of smart pointers.

Constructor & Destructor Documentation

Element() [1/3]

Element

(

)

Element() [2/3]

Element

(

const Element &

)

Element() [3/3]

Element

(

Element &&

)

Member Function Documentation

GetAtomicMass()

double GetAtomicMass

(

)

const

Get atomic mass.

Returns

the atomic mass of the element.

GetAtomicNumber()

int32_t GetAtomicNumber

(

)

const

Get atomic number.

Returns

the atomic number of the element.

GetAtomicRadius()

double GetAtomicRadius

(

)

const

Get atomic radius.

Radius is in angstroms.

Returns

the atomic radius of the element.

GetCovalentRadius()

double GetCovalentRadius

(

)

const

Get covalent radius.

Radius is in angstroms.

Returns

the covalent radius of the element.

GetElectronegativity()

double GetElectronegativity

(

)

const

Get electronegativity.

Returns

the electronegativity of the element on the Pauling scale.

GetGroup()

int32_t GetGroup

(

)

const

Get element group number.

Returns

the IUPAC group number of the element.

GetHypervalentOctet()

int32_t GetHypervalentOctet

(

)

const

Get full outer shell octet whne allowing for hypervalency.

Returns

the number of electrons required for a full outer shell in a hypervalent state.

GetName()

std::string GetName

(

)

const

Get element name.

Returns

the name of the element.

GetOctet()

int32_t GetOctet

(

)

const

Get full outer shell octet.

Returns

the number of electrons required for a full outer shell.

GetPeriod()

int32_t GetPeriod

(

)

const

Get element period.

Returns

the period of the periodic table the element is in.

GetSymbol()

std::string GetSymbol

(

)

const

Get element symbol.

Returns

the symbol of the element.

GetValenceElectronCount()

int32_t GetValenceElectronCount

(

)

const

Get number of valence electrons.

Returns

the number of valence electrons the element contains.

GetVanDerWaalsRadius()

double GetVanDerWaalsRadius

(

)

const

Get van der Waals radius.

Radius is in angstroms.

Returns

the van der Waals radius of the element.

operator bool()

operator bool

(

)

operator!=() [1/3]

bool operator!=

(

int32_t

Z

)

const

operator!=() [2/3]

bool operator!=

(

const std::string &

name

)

const

operator!=() [3/3]

bool operator!=

(

const Element &

element

)

const

operator<()

bool operator<

(

const Element &

element

)

const

operator<=()

bool operator<=

(

const Element &

element

)

const

operator=() [1/2]

Element& operator=

(

const Element &

)

operator=() [2/2]

Element& operator=

(

Element &&

)

operator==() [1/3]

bool operator==

(

int32_t

Z

)

const

operator==() [2/3]

bool operator==

(

const std::string &

name

)

const

operator==() [3/3]

bool operator==

(

const Element &

element

)

const

operator>()

bool operator>

(

const Element &

element

)

const

operator>=()

bool operator>=

(

const Element &

element

)

const

Friends And Related Function Documentation

indigox::test::TestElement

friend struct indigox::test::TestElement

friend

Friendship allows testing.

PeriodicTable

friend class PeriodicTable

friend

Friendship allows IXPeriodicTable to create new IXElement instances.

---

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

• include/indigox/classes/periodictable.hpp