libstdc++
std::numpunct Class Reference
Inheritance diagram for std::numpunct:

List of all members.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends


Detailed Description

Primary class template numpunct.

This facet stores several pieces of information related to printing and scanning numbers, such as the decimal point character. It takes a template parameter specifying the char type. The numpunct facet is used by streams for many I/O operations involving numbers.

The numpunct template uses protected virtual functions to provide the actual results. The public accessors forward the call to the virtual functions. These virtual functions are hooks for developers to implement the behavior they require from a numpunct facet.


Member Typedef Documentation

typedef _CharT std::numpunct::char_type

Public typedefs.

Reimplemented in std::numpunct_byname.

Definition at line 1648 of file locale_facets.h.

Public typedefs.

Reimplemented in std::numpunct_byname.

Definition at line 1649 of file locale_facets.h.


Constructor & Destructor Documentation

std::numpunct::numpunct ( size_t  __refs = 0) [inline, explicit]

Numpunct constructor.

Parameters:
refsRefcount to pass to the base class.

Definition at line 1666 of file locale_facets.h.

std::numpunct::numpunct ( __cache_type *  __cache,
size_t  __refs = 0 
) [inline, explicit]

Internal constructor. Not for general use.

This is a constructor for use by the library itself to set up the predefined locale facets.

Parameters:
cache__numpunct_cache object.
refsRefcount to pass to the base class.

Definition at line 1680 of file locale_facets.h.

std::numpunct::numpunct ( __c_locale  __cloc,
size_t  __refs = 0 
) [inline, explicit]

Internal constructor. Not for general use.

This is a constructor for use by the library itself to set up new locales.

Parameters:
clocThe C locale.
refsRefcount to pass to the base class.

Definition at line 1694 of file locale_facets.h.

virtual std::numpunct::~numpunct ( ) [protected, virtual]

Destructor.


Member Function Documentation

char_type std::numpunct::decimal_point ( ) const [inline]

Return decimal point character.

This function returns a char_type to use as a decimal point. It does so by returning returning numpunct<char_type>::do_decimal_point().

Returns:
char_type representing a decimal point.

Definition at line 1708 of file locale_facets.h.

virtual char_type std::numpunct::do_decimal_point ( ) const [inline, protected, virtual]

Return decimal point character.

Returns a char_type to use as a decimal point. This function is a hook for derived classes to change the value returned.

Returns:
char_type representing a decimal point.

Definition at line 1795 of file locale_facets.h.

virtual string_type std::numpunct::do_falsename ( ) const [inline, protected, virtual]

Return string representation of bool false.

Returns a string_type containing the text representation for false bool variables. This function is a hook for derived classes to change the value returned.

Returns:
string_type representing printed form of false.

Definition at line 1846 of file locale_facets.h.

virtual string std::numpunct::do_grouping ( ) const [inline, protected, virtual]

Return grouping specification.

Returns a string representing groupings for the integer part of a number. This function is a hook for derived classes to change the value returned.

See also:
grouping() for details.
Returns:
String representing grouping specification.

Definition at line 1820 of file locale_facets.h.

virtual char_type std::numpunct::do_thousands_sep ( ) const [inline, protected, virtual]

Return thousands separator character.

Returns a char_type to use as a thousands separator. This function is a hook for derived classes to change the value returned.

Returns:
char_type representing a thousands separator.

Definition at line 1807 of file locale_facets.h.

virtual string_type std::numpunct::do_truename ( ) const [inline, protected, virtual]

Return string representation of bool true.

Returns a string_type containing the text representation for true bool variables. This function is a hook for derived classes to change the value returned.

Returns:
string_type representing printed form of true.

Definition at line 1833 of file locale_facets.h.

string_type std::numpunct::falsename ( ) const [inline]

Return string representation of bool false.

This function returns a string_type containing the text representation for false bool variables. It does so by calling numpunct<char_type>::do_falsename().

Returns:
string_type representing printed form of false.

Definition at line 1778 of file locale_facets.h.

string std::numpunct::grouping ( ) const [inline]

Return grouping specification.

This function returns a string representing groupings for the integer part of a number. Groupings indicate where thousands separators should be inserted in the integer part of a number.

Each char in the return string is interpret as an integer rather than a character. These numbers represent the number of digits in a group. The first char in the string represents the number of digits in the least significant group. If a char is negative, it indicates an unlimited number of digits for the group. If more chars from the string are required to group a number, the last char is used repeatedly.

For example, if the grouping() returns "\003\002" and is applied to the number 123456789, this corresponds to 12,34,56,789. Note that if the string was "32", this would put more than 50 digits into the least significant group if the character set is ASCII.

The string is returned by calling numpunct<char_type>::do_grouping().

Returns:
string representing grouping specification.

Definition at line 1752 of file locale_facets.h.

char_type std::numpunct::thousands_sep ( ) const [inline]

Return thousands separator character.

This function returns a char_type to use as a thousands separator. It does so by returning returning numpunct<char_type>::do_thousands_sep().

Returns:
char_type representing a thousands separator.

Definition at line 1721 of file locale_facets.h.

string_type std::numpunct::truename ( ) const [inline]

Return string representation of bool true.

This function returns a string_type containing the text representation for true bool variables. It does so by calling numpunct<char_type>::do_truename().

Returns:
string_type representing printed form of true.

Definition at line 1765 of file locale_facets.h.


Member Data Documentation

Numpunct facet id.

Definition at line 1658 of file locale_facets.h.


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