Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

std::money_get< _CharT, _InIter > Class Template Reference

Facet for parsing monetary amounts. More...

#include <locale_facets.h>

Inheritance diagram for std::money_get< _CharT, _InIter >:

std::locale::facet List of all members.

Public Types

typedef _CharT char_type
 Public typedefs.

typedef _InIter iter_type
typedef basic_string< _CharT > string_type

Public Member Functions

 money_get (size_t __refs=0)
 Constructor performs initialization.

iter_type get (iter_type __s, iter_type __end, bool __intl, ios_base &__io, ios_base::iostate &__err, long double &__units) const
 Read and parse a monetary value.

iter_type get (iter_type __s, iter_type __end, bool __intl, ios_base &__io, ios_base::iostate &__err, string_type &__digits) const
 Read and parse a monetary value.


Static Public Attributes

locale::id id
 Numpunct facet id.


Protected Member Functions

virtual ~money_get ()
 Destructor.

virtual iter_type do_get (iter_type __s, iter_type __end, bool __intl, ios_base &__io, ios_base::iostate &__err, long double &__units) const
 Read and parse a monetary value.

virtual iter_type do_get (iter_type __s, iter_type __end, bool __intl, ios_base &__io, ios_base::iostate &__err, string_type &__digits) const
 Read and parse a monetary value.

template<bool _Intl> iter_type _M_extract (iter_type __s, iter_type __end, ios_base &__io, ios_base::iostate &__err, string &__digits) const

Detailed Description

template<typename _CharT, typename _InIter>
class std::money_get< _CharT, _InIter >

Facet for parsing monetary amounts.

This facet encapsulates the code to parse and return a monetary amount from a string.

The money_get 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 the money_get facet.

Definition at line 4439 of file locale_facets.h.

Member Typedef Documentation

template<typename _CharT, typename _InIter>
typedef _CharT std::money_get< _CharT, _InIter >::char_type
 

Public typedefs.

Definition at line 4445 of file locale_facets.h.

template<typename _CharT, typename _InIter>
typedef _InIter std::money_get< _CharT, _InIter >::iter_type
 

Definition at line 4446 of file locale_facets.h.

template<typename _CharT, typename _InIter>
typedef basic_string<_CharT> std::money_get< _CharT, _InIter >::string_type
 

Definition at line 4447 of file locale_facets.h.

Constructor & Destructor Documentation

template<typename _CharT, typename _InIter>
std::money_get< _CharT, _InIter >::money_get (  size_t  __refs = 0  )  [inline, explicit]
 

Constructor performs initialization.

This is the constructor provided by the standard.

Parameters:
refs Passed to the base facet class.

Definition at line 4461 of file locale_facets.h.

References std::messages_byname< _CharT >::messages_byname(), and std::messages_byname< _CharT >::~messages_byname().

template<typename _CharT, typename _InIter>
virtual std::money_get< _CharT, _InIter >::~money_get (   )  [inline, protected, virtual]
 

Destructor.

Definition at line 4528 of file locale_facets.h.

Member Function Documentation

template<typename _CharT, typename _InIter>
template<bool _Intl>
_InIter std::money_get< _CharT, _InIter >::_M_extract (  iter_type  __s,
iter_type  __end,
ios_base &  __io,
ios_base::iostate &  __err,
string &  __digits
)  const [protected]
 

Definition at line 1247 of file locale_facets.tcc.

References std::__verify_grouping(), std::ios_base::_M_getloc(), std::basic_string< _CharT, _Traits, _Alloc >::empty(), std::basic_string< _CharT, _Traits, _Alloc >::erase(), std::money_base::pattern::field, std::basic_string< _CharT, _Traits, _Alloc >::find_first_not_of(), std::ios_base::flags(), std::basic_string< _CharT, _Traits, _Alloc >::insert(), std::ios_base::iostate, std::__ctype_abstract_base< _CharT >::is(), std::basic_string< _CharT, _Traits, _Alloc >::reserve(), std::basic_string< _CharT, _Traits, _Alloc >::size(), std::string, and std::basic_string< _CharT, _Traits, _Alloc >::swap().

template<typename _CharT, typename _InIter>
_InIter std::money_get< _CharT, _InIter >::do_get (  iter_type  __s,
iter_type  __end,
bool  __intl,
ios_base &  __io,
ios_base::iostate &  __err,
string_type &  __digits
)  const [protected, virtual]
 

Read and parse a monetary value.

This function reads and parses characters representing a monetary value. This function is a hook for derived classes to change the value returned.

See also:
get() for details.

Definition at line 1474 of file locale_facets.tcc.

References std::ios_base::_M_getloc(), std::basic_string< _CharT, _Traits, _Alloc >::data(), std::ios_base::iostate, std::basic_string< _CharT, _Traits, _Alloc >::size(), std::string, and std::__ctype_abstract_base< _CharT >::widen().

template<typename _CharT, typename _InIter>
_InIter std::money_get< _CharT, _InIter >::do_get (  iter_type  __s,
iter_type  __end,
bool  __intl,
ios_base &  __io,
ios_base::iostate &  __err,
long double &  __units
)  const [protected, virtual]
 

Read and parse a monetary value.

This function reads and parses characters representing a monetary value. This function is a hook for derived classes to change the value returned.

See also:
get() for details.

Definition at line 1459 of file locale_facets.tcc.

References std::__convert_to_v(), std::locale::facet::_S_get_c_locale(), std::basic_string< _CharT, _Traits, _Alloc >::c_str(), std::ios_base::iostate, and std::string.

template<typename _CharT, typename _InIter>
iter_type std::money_get< _CharT, _InIter >::get (  iter_type  __s,
iter_type  __end,
bool  __intl,
ios_base &  __io,
ios_base::iostate &  __err,
string_type &  __digits
)  const [inline]
 

Read and parse a monetary value.

This function reads characters from s, interprets them as a monetary value according to moneypunct and ctype facets retrieved from io.getloc(), and returns the result in digits. For example, the string $10.01 in a US locale would store "1001" in digits.

Any characters not part of a valid money amount are not consumed.

If a money value cannot be parsed from the input stream, sets err=(err|io.failbit). If the stream is consumed before finishing parsing, sets err=(err|io.failbit|io.eofbit).

This function works by returning the result of do_get().

Parameters:
s Start of characters to parse.
end End of characters to parse.
intl Parameter to use_facet<moneypunct<CharT,intl> >.
io Source of facets and io state.
err Error field to set if parsing fails.
digits Place to store result of parsing.
Returns:
Iterator referencing first character beyond valid money amount.

Definition at line 4521 of file locale_facets.h.

template<typename _CharT, typename _InIter>
iter_type std::money_get< _CharT, _InIter >::get (  iter_type  __s,
iter_type  __end,
bool  __intl,
ios_base &  __io,
ios_base::iostate &  __err,
long double &  __units
)  const [inline]
 

Read and parse a monetary value.

This function reads characters from s, interprets them as a monetary value according to moneypunct and ctype facets retrieved from io.getloc(), and returns the result in units as an integral value moneypunct::frac_digits() * the actual amount. For example, the string $10.01 in a US locale would store 1001 in units.

Any characters not part of a valid money amount are not consumed.

If a money value cannot be parsed from the input stream, sets err=(err|io.failbit). If the stream is consumed before finishing parsing, sets err=(err|io.failbit|io.eofbit). units is unchanged if parsing fails.

This function works by returning the result of do_get().

Parameters:
s Start of characters to parse.
end End of characters to parse.
intl Parameter to use_facet<moneypunct<CharT,intl> >.
io Source of facets and io state.
err Error field to set if parsing fails.
units Place to store result of parsing.
Returns:
Iterator referencing first character beyond valid money amount.

Definition at line 4491 of file locale_facets.h.

Member Data Documentation

template<typename _CharT, typename _InIter>
locale::id std::money_get< _CharT, _InIter >::id [static]
 

Numpunct facet id.

Definition at line 4559 of file locale_facets.h.

The documentation for this class was generated from the following files:
Generated on Tue Jan 30 17:32:15 2007 for GNU C++ STL by doxygen 1.3.6