libelemental  2.0.0
Classes | Typedefs | Enumerations | Functions | Variables
Elemental Namespace Reference

A periodic table library with detailed information on elements. More...

Classes

class  Block
 A qualified value representing a periodic table block. More...
 
class  Category
 A category of properties of the chemical elements. More...
 
struct  color
 A color description. More...
 
class  color_value_base
 A base class for qualified values which have representative colors. More...
 
class  ColorValue
 A qualified value representing a display color. More...
 
class  Element
 A chemical element. More...
 
class  EntriesStream
 An adapter for the display of value entries on an output stream. More...
 
class  EntriesView
 An interface for the display of value entries. More...
 
class  Event
 A qualified value representing the time and location of an event. More...
 
class  LatticeType
 A qualified value representing a Bravais lattice type. More...
 
class  Message
 A qualified UTF-8 string value that requires translation. More...
 
class  Phase
 A qualified value representing a phase of matter. More...
 
class  Property
 A typed property of the chemical elements. More...
 
class  Property< Float >
 A floating-point property of the chemical elements. More...
 
class  PropertyBase
 A property of the chemical elements. More...
 
class  Series
 A qualified value representing a chemical series. More...
 
class  Value
 A qualified value of a generic type. More...
 
class  value_base
 A base class for qualified values. More...
 
class  ValueList
 A qualified list of values of a generic type. More...
 

Typedefs

typedef unsigned int AtomicNumber
 An atomic number.
 
typedef Value< double > Float
 A qualified floating-point value.
 
typedef Value< long > Int
 A qualified integer value.
 
typedef Value< ustring > String
 A qualified UTF-8 string value that does not require translation.
 
typedef ValueList< double > FloatList
 A qualified list of floating-point values.
 
typedef ValueList< long > IntList
 A qualified list of integer values.
 
typedef Property< FloatFloatProperty
 A floating-point property of the chemical elements.
 
typedef std::vector< const Element * > Table
 The periodic table of elements.
 

Enumerations

enum  Qualifier {
  Q_NEUTRAL,
  Q_UNK,
  Q_NA,
  Q_EST,
  Q_CA,
  Q_ISO
}
 A qualification of the meaning of a value. More...
 

Functions

void initialize () throw ()
 Initializes libelemental. More...
 
const Tableget_table () throw ()
 Returns the periodic table of elements. More...
 
const Elementget_element (AtomicNumber number) throw (std::out_of_range)
 Returns the element with a given atomic number. More...
 
const Elementget_element (const std::string &which) throw (std::invalid_argument)
 Returns the element with a given symbol or atomic number. More...
 

Variables

const double STANDARD_TEMPERATURE
 The standard temperature, in Kelvin, as defined by IUPAC.
 
std::list< Category * > CATEGORIES
 The categories of available properties of the chemical elements.
 

Detailed Description

A periodic table library with detailed information on elements.

Enumeration Type Documentation

◆ Qualifier

A qualification of the meaning of a value.

Enumerator
Q_NEUTRAL 

Indicates a presumably valid value.

Q_UNK 

Indicates that a value is unknown or unavailable.

Q_NA 

Indicates that a value is not applicable for an element.

Q_EST 

Indicates that a value is estimated or calculated.

Q_CA 

Indicates that a value is approximate.

Q_ISO 

Indicates a value for the most stable isotope of an element.

Function Documentation

◆ get_element() [1/2]

const Element& Elemental::get_element ( AtomicNumber  number)
throw (std::out_of_range
)

Returns the element with a given atomic number.

Parameters
numberThe atomic number of an element.
Returns
A reference to the corresponding element.
Exceptions
std::out_of_rangeif the atomic number is invalid.

◆ get_element() [2/2]

const Element& Elemental::get_element ( const std::string &  which)
throw (std::invalid_argument
)

Returns the element with a given symbol or atomic number.

Parameters
whichThe standard symbol of an element, or the string representation of the atomic number of an element.
Returns
A reference to the corresponding element.
Exceptions
std::invalid_argumentif the symbol or number is invalid.

◆ get_table()

const Table& Elemental::get_table ( )
throw (
)

Returns the periodic table of elements.

The table is a singleton.

◆ initialize()

void Elemental::initialize ( )
throw (
)

Initializes libelemental.

This function may be called more than once. This function, or one of the get_table() or get_element() functions, which call it, should be called before any other features in the library are used.