libelemental 2.0.2
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Elemental::Series Class Reference

A qualified value representing a chemical series. More...

#include <value-types.hh>

Inheritance diagram for Elemental::Series:
Inheritance graph
[legend]

Public Types

enum  Value {
  NONMETAL ,
  NOBLE_GAS ,
  ALKALI_METAL ,
  ALKALINE_EARTH_METAL ,
  SEMIMETAL ,
  HALOGEN ,
  POST_TRANSITION_METAL ,
  TRANSITION_METAL ,
  LANTHANIDE ,
  ACTINIDE
}
 The possible chemical series values. More...
 

Public Member Functions

 Series (const Value &source, Qualifier qualifier=Q_NEUTRAL) throw ()
 Constructs a new defined series.
 
 Series (Qualifier qualifier=Q_UNK) throw ()
 Constructs a new undefined or default series.
 
virtual int compare (const value_base &other) const throw ()
 Compares two qualified values.
 
virtual color get_color () const throw ()
 Returns a color representing the value.
 
- Public Member Functions inherited from Elemental::value_base
bool has_value () const throw ()
 Returns whether the value is defined.
 
virtual ustring get_string (const ustring &format=ustring()) const throw ()
 Returns a localized text representation of the value.
 
ustring get_tip () const throw ()
 Returns a localized message to be displayed as a tooltip.
 
void make_entry (EntriesView &view, const ustring &name, const ustring &format=ustring()) const throw ()
 Possibly adds the result of get_string() to an EntriesView.
 

Public Attributes

Value value
 The value, if defined.
 
- Public Attributes inherited from Elemental::value_base
Qualifier qualifier
 The qualification of the value's meaning.
 

Protected Member Functions

virtual ustring do_get_string (const ustring &format) const throw ()
 Returns a localized text representation of a defined value.
 
- Protected Member Functions inherited from Elemental::color_value_base
 color_value_base (Qualifier qualifier) throw ()
 
- Protected Member Functions inherited from Elemental::value_base
 value_base (Qualifier qualifier) throw ()
 
virtual int compare_base (const value_base &other) const throw ()
 Compares the qualifications of two values.
 

Additional Inherited Members

- Protected Attributes inherited from Elemental::value_base
bool always
 Whether an undefined value should make an entry.
 
- Static Protected Attributes inherited from Elemental::value_base
static const int YIELD_COMPARE
 Indicates that comparison should be based on values, not definedness.
 

Detailed Description

A qualified value representing a chemical series.

Member Enumeration Documentation

◆ Value

The possible chemical series values.

Enumerator
NONMETAL 

nonmetals

NOBLE_GAS 

noble gases

ALKALI_METAL 

alkali metals

ALKALINE_EARTH_METAL 

alkaline earth metals

SEMIMETAL 

semimetals

HALOGEN 

halogens

POST_TRANSITION_METAL 

post-transition metals

TRANSITION_METAL 

transition metals

LANTHANIDE 

lanthanides

ACTINIDE 

actinides

Constructor & Destructor Documentation

◆ Series() [1/2]

Elemental::Series::Series ( const Value source,
Qualifier  qualifier = Q_NEUTRAL 
)
throw (
)

Constructs a new defined series.

Parameters
sourceThe initial definition.
qualifierThe qualification of the initial value.

◆ Series() [2/2]

Elemental::Series::Series ( Qualifier  qualifier = Q_UNK)
throw (
)

Constructs a new undefined or default series.

Parameters
qualifierThe qualification of the initial value.

Member Function Documentation

◆ compare()

virtual int Elemental::Series::compare ( const value_base other) const
throw (
)
virtual

Compares two qualified values.

Derived classes may override this function, first calling compare_base, and use a dynamic_cast to check other.

Parameters
otherThe qualified value for comparison.
Returns
-1 if this value is undefined or is less than other; 0 if the values are equal; or 1 if other is undefined or this value is greater than other.

Reimplemented from Elemental::value_base.

◆ do_get_string()

virtual ustring Elemental::Series::do_get_string ( const ustring &  format) const
throw (
)
protectedvirtual

Returns a localized text representation of a defined value.

Derived classes must implement this function to produce a text representation based on the format. It will be called by get_string(), which will then decorate its output as appropriate for the current qualifier. If has_value() is false, the behavior is undefined.

Parameters
formatA compose-style format string. Derived classes may define the number of argument references expected in the string; the default is one. If format is empty, a minimal default should be used.
Returns
A UTF-8 string containing the localized representation.

Implements Elemental::value_base.

◆ get_color()

virtual color Elemental::Series::get_color ( ) const
throw (
)
virtual

Returns a color representing the value.

Derived classes must implement this function, returning a color that corresponds to the defined value. A special color should be returned if has_value() is false.

Returns
A color structure.

Implements Elemental::color_value_base.


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