libelemental  1.2.0
Public Member Functions | Public Attributes | List of all members
Elemental::Element Class Reference

A chemical element. More...

#include <element.hh>

Public Member Functions

const value_baseget_property_base (const PropertyBase &property) const throw (std::invalid_argument)
 Returns the value_base of the value for the given Property. More...
 
template<class T >
const T & get_property (const Property< T > &property) const throw (std::invalid_argument)
 Returns the value for the given Property. More...
 
void make_entries (EntriesView &view) const throw ()
 Generates entries for all properties. More...
 
void make_entries (EntriesView &view, const Category &category, bool all=false) const throw ()
 Generates entries for the properties in the given Category. More...
 
Phase get_phase (double tempK=STANDARD_TEMPERATURE) const throw ()
 Returns the phase of matter assumed by the element at a temperature. More...
 

Public Attributes

std::string symbol
 The chemical symbol for this element.
 
AtomicNumber number
 The atomic number of this element.
 

Detailed Description

A chemical element.

The element properties are named in the Properties module.

Member Function Documentation

Phase Elemental::Element::get_phase ( double  tempK = STANDARD_TEMPERATURE) const
throw (
)

Returns the phase of matter assumed by the element at a temperature.

Standard pressure is implied.

Parameters
tempKThe temperature, in Kelvin, at which to determine phase. By default, the IUPAC standard temperature.
Returns
The phase of matter determined.
template<class T >
const T& Elemental::Element::get_property ( const Property< T > &  property) const
throw (std::invalid_argument
)
inline

Returns the value for the given Property.

Parameters
propertyThe Element Property to be returned.
const value_base& Elemental::Element::get_property_base ( const PropertyBase property) const
throw (std::invalid_argument
)

Returns the value_base of the value for the given Property.

Parameters
propertyThe Element Property to be returned.
void Elemental::Element::make_entries ( EntriesView view) const
throw (
)

Generates entries for all properties.

Parameters
viewAn EntriesView to be populated.
void Elemental::Element::make_entries ( EntriesView view,
const Category category,
bool  all = false 
) const
throw (
)

Generates entries for the properties in the given Category.

Parameters
viewAn EntriesView to be populated.
categoryThe Category whose properties will be provided.
allFor C_GENERAL, controls whether the EntriesView will also receive the element's primary name, symbol, and atomic number.

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