Element Class Reference
[Periodic Table of Elements, Miscellaneous]

Element class. More...

#include <PTE.h>

List of all members.

Operators
bool	operator== (const Element &element) const throw ()
	Equality operator.
bool	operator!= (const Element &element) const throw ()
	Inequality operator.
bool	operator< (const Element &element) const throw ()
	Less operator.
bool	operator<= (const Element &element) const throw ()
	Less or equal operator.
bool	operator>= (const Element &element) const throw ()
	Greater or equal operator.
bool	operator> (const Element &element) const throw ()
	Greater operator.
BALL_EXPORT friend std::ostream &	operator<< (std::ostream &s, const Element &element) throw ()
	Output operator Prints this instance of Element.
Public Types
typedef short	Group
	Group.
typedef short	Period
	Period.
typedef short	AtomicNumber
	AtomicNumber.
enum	Name {   ACTINIUM = 0, ALUMINUM, AMERICIUM, ANTIMONY,   STIBIUM = ANTIMONY, ARGON, ARSENIC, ASTATINE,   BARIUM, BERKELIUM, BERYLLIUM, BISMUTH,   WISMUT = BISMUTH, BOHRIUM, BORON, BROMINE,   CADMIUM, CAESIUM, CALCIUM, CALIFORNIUM,   CARBON, CARBONEUM = CARBON, CERIUM, CHLORINE,   CHROMIUM, COBALT, COPPER, CUPRUM = COPPER,   CURIUM, DUBNIUM, DYSPROSIUM, EINSTEINIUM,   ERBIUM, EUROPIUM, FERMIUM, FLUORINE,   FRANCIUM, GADOLINIUM, GALLIUM, GERMANIUM,   GOLD, AURUM = GOLD, HAFNIUM, HAHNIUM,   HELIUM, HOLMIUM, HYDROGEN, HYDROGENIUM = HYDROGEN,   INDIUM, IODINE, JOD = IODINE, IRIDIUM,   IRON, FERRUM = IRON, JOLIOTIUM, KRYPTON,   LANTHANUM, LAWRENCIUM, LEAD, PLUMBUM = LEAD,   LITHIUM, LUTETIUM, MAGNESIUM, MANGANESE,   MANGAN = MANGANESE, MEITNERIUM, MENDELEVIUM, MERCURY,   HYDRARGYRUM = MERCURY, MERCURIUM = MERCURY, MOLYBDENUM, NEODYMIUM,   NEON, NEPTUNIUM, NICKEL, NIOBIUM,   NITROGEN, NITROGENIUM = NITROGEN, NOBELIUM, OSMIUM,   OXYGEN, OXYGENIUM = OXYGEN, PALLADIUM, PHOSPHORUS,   PLATINUM, PLUTONIUM, POLONIUM, POTASSIUM,   KALIUM = POTASSIUM, PRASEODYMIUM, PROMETHIUM, PROTACTINIUM,   RADIUM, RADON, RHENIUM, RHODIUM,   RUBIDIUM, RUTHENIUM, RUTHERFORDIUM, SAMARIUM,   SCANDIUM, SELENIUM, SILICON, SILICIUM = SILICON,   SILVER, ARGENTUM = SILVER, SODIUM, NATRIUM = SODIUM,   STRONTIUM, SULPHUR, SULFUR = SULPHUR, TANTALUM,   TECHNETIUM, TELLURIUM, TERBIUM, THALLIUM,   THORIUM, THULIUM, TIN, STANNUM = TIN,   TITANIUM, TUNGSTEN, WOLFRAM = TUNGSTEN, UNUNBIUM,   UNUNNILIUM, UNUNNINIUM, URANIUM, VANADIUM,   XENON, YTTERBIUM, YTTRIUM, ZINC,   ZINCUM = ZINC, ZIRCONIUM, NUMBER_OF_ELEMENTS }
	Name Element names. More...
Symbol
Element symbols.
enum	Symbol {   Ac = 0, Al, Am, Sb,   Ar, As, At, Ba,   Bk, Be, Bi, Bh,   B, Br, Cd, Cs,   Ca, Cf, C, Ce,   Cl, Cr, Co, Cu,   Cm, Db, Dy, Es,   Er, Eu, Fm, F,   Fr, Gd, Ga, Ge,   Au, Hf, Hn, He,   Ho, H, In, I,   Ir, Fe, Jl, Kr,   La, Lr, Pb, Li,   Lu, Mg, Mn, Mt,   Md, Hg, Mo, Nd,   Ne, Np, Ni, Nb,   N, No, Os, O,   Pd, P, Pt, Pu,   Po, K, Pr, Pm,   Pa, Ra, Rn, Re,   Rh, Rb, Ru, Rf,   Sm, Sc, Se, Si,   Ag, Na, Sr, S,   Ta, Tc, Te, Tb,   Tl, Th, Tm, Sn,   Ti, W, Uub, Uun,   Uuu, U, V, Xe,   Yb, Y, Zn, Zr }
Public Member Functions
Constructors and Destructors.
	Element () throw ()
	Default constructor The instance is set to the default values (= UNKNOWN element).
	Element (const Element &element) throw ()
	Constructor.
	Element (const String &name, const String &symbol, Group group, Period period, AtomicNumber atomic_umber, float atomic_weight, float atomic_radius, float covalent_radius, float van_der_waals_radius, float electronegativity) throw ()
	Detailed constructor.
virtual	~Element () throw ()
	Destructor.
virtual void	clear () throw ()
	Clear method.
Assignment
Element &	operator= (const Element &element) throw ()
	Assignment operator.
Inspectors and Mutators
void	setName (const String &name) throw ()
	Set the name.
const String &	getName () const throw ()
	Get the name.
void	setSymbol (const String &symbol) throw ()
	Set the atomic symbol.
const String &	getSymbol () const throw ()
	Get the atomic symbol.
void	setGroup (Group group) throw ()
	Set the atomic group.
Group	getGroup () const throw ()
	Get the atomic group.
void	setPeriod (Period period) throw ()
	Set the atomic period.
Period	getPeriod () const throw ()
	Get the atomic period.
void	setAtomicNumber (AtomicNumber atomic_number) throw ()
	Set the atomic number.
AtomicNumber	getAtomicNumber () const throw ()
	Get the atomic number.
void	setAtomicWeight (float atomic_weight) throw ()
	Set the atomic weight.
float	getAtomicWeight () const throw ()
	Get the atomic weight.
void	setAtomicRadius (float atomic_radius) throw ()
	Set the atomic radius.
float	getAtomicRadius () const throw ()
	Get the atomic radius.
void	setCovalentRadius (float covalent_radius) throw ()
	Set the covalent radius.
float	getCovalentRadius () const throw ()
	Get the covalent radius.
void	setVanDerWaalsRadius (float van_der_waals_radius) throw ()
	Set the VanDerWaals radius.
float	getVanDerWaalsRadius () const throw ()
	Get the VanDerWaals radius.
void	setElectronegativity (float electronegativity) throw ()
	Set the electronegativity.
float	getElectronegativity () const throw ()
	Get the electronegativity.
Predicates
bool	isUnknown () const throw ()
	Test if this instance is unknown.
Static Public Attributes
Element	UNKNOWN
	Standard element.

---

Detailed Description

Element class.

---

Member Enumeration Documentation

enum Element::Name

Name Element names.

---

Constructor & Destructor Documentation

Element::Element (   )  throw ()

Default constructor The instance is set to the default values (= UNKNOWN element).

---

Member Function Documentation

virtual void Element::clear (   )  throw () [virtual]

Clear method. The instance is set to the default values (= UNKNOWN element).

AtomicNumber Element::getAtomicNumber (   )  const throw ()

Get the atomic number. Returns: AtomicNumber (short) - the atomic number

float Element::getAtomicRadius (   )  const throw ()

Get the atomic radius. Returns: float the atomic radius (in Angstrom)

float Element::getAtomicWeight (   )  const throw ()

Get the atomic weight. Returns: float - the atomic weight

float Element::getCovalentRadius (   )  const throw ()

Get the covalent radius. Returns: float the covalent radius (in Angstrom)

float Element::getElectronegativity (   )  const throw ()

Get the electronegativity. Returns: float the electronegativity (according to the Pauling scale)

Group Element::getGroup (   )  const throw ()

Get the atomic group. Returns: Group (short) - the group

const String& Element::getName (   )  const throw ()

Get the name. Returns: String - the name

Period Element::getPeriod (   )  const throw ()

Get the atomic period. Returns: Period (short) the period

const String& Element::getSymbol (   )  const throw ()

Get the atomic symbol. Returns: String the symbol

float Element::getVanDerWaalsRadius (   )  const throw ()

Get the VanDerWaals radius. Returns: float the VanDerWaals radius (in Angstrom)

bool Element::isUnknown (   )  const throw ()

Test if this instance is unknown. Returns true if instance is equal the static Element UNKNOWN (The default constructor returns such an element). Returns: bool

bool Element::operator!= (  const Element &  element  )  const throw ()

Inequality operator. Tests if the atomic number of two elements are inequal. Parameters: element  the Element to compare with Returns: bool

bool Element::operator< (  const Element &  element  )  const throw ()

Less operator. Tests if the atomic number of this instance is less compared with element . Parameters: element  the Element to compare with Returns: bool

bool Element::operator<= (  const Element &  element  )  const throw ()

Less or equal operator. Tests if the atomic number of this instance is less or equal compared with element . Parameters: element,the  Element to compare with Returns: bool

Element& Element::operator= (  const Element &  element  )  throw ()

Assignment operator. Parameters: element  the Element to be copied (cloned) Returns: Element& - this instance

bool Element::operator== (  const Element &  element  )  const throw ()

Equality operator. Tests if the atomic number of two elements are equal. Parameters: element  the Element to compare with Returns: bool

bool Element::operator> (  const Element &  element  )  const throw ()

Greater operator. Tests if the atomic number of this instance is greater than element . Parameters: element  the Element to compare with Returns: bool

bool Element::operator>= (  const Element &  element  )  const throw ()

Greater or equal operator. Tests if the atomic number of this instance is greater or equal compared with element . Parameters: element  the Element to compare with Returns: bool

void Element::setAtomicNumber (  AtomicNumber  atomic_number  )  throw ()

Set the atomic number. Parameters: atomic_number  the new atomic number

void Element::setAtomicRadius (  float  atomic_radius  )  throw ()

Set the atomic radius. Parameters: atomic_radius  the new atomic radius (in Angstrom)

void Element::setAtomicWeight (  float  atomic_weight  )  throw ()

Set the atomic weight. Parameters: atomic_weight  the new atomic weight

void Element::setCovalentRadius (  float  covalent_radius  )  throw ()

Set the covalent radius. Parameters: covalent_radius  the new covalent radius (in Angstrom)

void Element::setElectronegativity (  float  electronegativity  )  throw ()

Set the electronegativity. Parameters: electronegativity  the new electronegativity (according to the Pauling scale)

void Element::setGroup (  Group  group  )  throw ()

Set the atomic group. Parameters: group  (short) the new group

void Element::setName (  const String &  name  )  throw ()

Set the name. Parameters: name  the new name

void Element::setPeriod (  Period  period  )  throw ()

Set the atomic period. Parameters: period  (short) the new period

void Element::setSymbol (  const String &  symbol  )  throw ()

Set the atomic symbol. Parameters: symbol  the new symbol

void Element::setVanDerWaalsRadius (  float  van_der_waals_radius  )  throw ()

Set the VanDerWaals radius. Parameters: van_der_waals_radius  the new VanDerWaals radius (in Angstrom)

---

Friends And Related Function Documentation

BALL_EXPORT friend std::ostream& operator<< (  std::ostream &  s, const Element &  element )  throw () [friend]

Output operator Prints this instance of Element. Prints the contents of an instance of Element to an ostream.

---

Member Data Documentation

Element Element::UNKNOWN [static]

Standard element. (The default constructor returns such an element).