libelemental 2.0.2
Public Member Functions | List of all members
Elemental::Property< Float > Class Reference

A floating-point property of the chemical elements. More...

#include <element.hh>

Inheritance diagram for Elemental::Property< Float >:
Inheritance graph
[legend]

Public Member Functions

 Property (const Message &name, const Message &format, const Message &description, const Message *sources[]) throw ()
 
bool is_scale_valid () const throw ()
 Returns whether the scale of values for this property is valid.
 
double get_scale_position (const Float &instance, bool logarithmic=false) const
 Returns the position on a normalized 0.0 to 1.0 scale for a value.
 
double get_minimum () const
 Returns the least value of this property for any element.
 
double get_medium (bool logarithmic=false) const
 Returns the value of this property that has a scale position of 0.5.
 
double get_maximum () const
 Returns the greatest value of this property for any element.
 
virtual bool is_colorable () const throw ()
 Returns whether values of the property have color representations.
 
- Public Member Functions inherited from Elemental::PropertyBase
 PropertyBase (const Message &name, const Message &format, const Message &description, const Message *sources[]) throw ()
 
ustring get_name () const throw ()
 Returns the translated name of the property.
 
bool has_format () const throw ()
 Returns whether a compose-style format for values is defined.
 
ustring get_format () const throw ()
 Returns a translated compose-style format for values of the property.
 
ustring get_description () const throw ()
 Returns a translated explanatory description of the property.
 
void make_entry (EntriesView &view, const value_base &value) const throw ()
 Possibly adds a value for this property to an EntriesView.
 
void make_entry (EntriesView &view, const ustring &value) const throw ()
 Adds a string representing a value for this property to an EntriesView.
 

Additional Inherited Members

- Public Attributes inherited from Elemental::PropertyBase
std::list< const Message * > sources
 Citations for the sources of values for the property.
 
- Protected Attributes inherited from Elemental::PropertyBase
Message name
 The untranslated name of the property.
 
Message format
 An untranslated compose-style format for values of the property.
 
Message description
 An untranslated explanatory description of the property.
 

Detailed Description

A floating-point property of the chemical elements.

Member Function Documentation

◆ get_maximum()

double Elemental::Property< Float >::get_maximum ( ) const

Returns the greatest value of this property for any element.

Exceptions
std::domain_errorif the property does not have a valid scale.

◆ get_medium()

double Elemental::Property< Float >::get_medium ( bool  logarithmic = false) const

Returns the value of this property that has a scale position of 0.5.

Parameters
logarithmicWhether to compute the value on a logarithmic scale.
Exceptions
std::domain_errorif the property does not have a valid scale.

◆ get_minimum()

double Elemental::Property< Float >::get_minimum ( ) const

Returns the least value of this property for any element.

Exceptions
std::domain_errorif the property does not have a valid scale.

◆ get_scale_position()

double Elemental::Property< Float >::get_scale_position ( const Float instance,
bool  logarithmic = false 
) const

Returns the position on a normalized 0.0 to 1.0 scale for a value.

Parameters
instanceA defined value for this property.
logarithmicWhether to compute the position on a logarithmic instead of linear scale.
Exceptions
std::domain_errorif the property does not have a valid scale.
std::invalid_argumentif instance is not a defined value.

◆ is_colorable()

virtual bool Elemental::Property< Float >::is_colorable ( ) const
throw (
)
virtual

Returns whether values of the property have color representations.

If true, values may or may not be color_value_base descendants.

Reimplemented from Elemental::PropertyBase.

References Elemental::initialize().

◆ is_scale_valid()

bool Elemental::Property< Float >::is_scale_valid ( ) const
throw (
)

Returns whether the scale of values for this property is valid.

The scale is valid if one or more elements has a defined value for this property and those values are not all equal.


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