libelemental 2.0.2
|
A floating-point property of the chemical elements. More...
#include <element.hh>
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. | |
![]() | |
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 | |
![]() | |
std::list< const Message * > | sources |
Citations for the sources of values for the property. | |
![]() | |
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. | |
A floating-point property of the chemical elements.
double Elemental::Property< Float >::get_maximum | ( | ) | const |
Returns the greatest value of this property for any element.
std::domain_error | if the property does not have a valid scale. |
double Elemental::Property< Float >::get_medium | ( | bool | logarithmic = false | ) | const |
Returns the value of this property that has a scale position of 0.5.
logarithmic | Whether to compute the value on a logarithmic scale. |
std::domain_error | if the property does not have a valid scale. |
double Elemental::Property< Float >::get_minimum | ( | ) | const |
Returns the least value of this property for any element.
std::domain_error | if the property does not have a valid scale. |
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.
instance | A defined value for this property. |
logarithmic | Whether to compute the position on a logarithmic instead of linear scale. |
std::domain_error | if the property does not have a valid scale. |
std::invalid_argument | if instance is not a defined value. |
|
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().
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.