Monday, January 4, 2010

moneypunct_byname











Class Name moneypunct_byname

Header File <locale>

Classification abstract data type



Class Relationship Diagram



Class Description

Member Classes



None





Methods




virtual string_type do_curr_symbol() const;


virtual charT do_decimal_point() const;


virtual int do_frac_digits() const;


virtual string do_grouping() const;


virtual pattern do_neg_format() const;


virtual string_type do_negative_sign() const;


virtual pattern do_pos_format() const;


virtual string_type do_positive_sign() const;


virtual charT do_thousands_sep() const;


explicit moneypunct_byname(const char*, size_t refs = 0);


~moneypunct_byname();



Class Description



The moneypunct_byname class describes a class used to provide money
punctuation for a named locale.










Method do_curr_symbol()

Access Protected

Classification Accessor

Syntax virtual string_type do_curr_symbol() const;

Parameters None

Returns This method returns a string_type used as the
currency symbol.



Description



The do_curr_symbol() method returns a sequence of elements used as the
currency symbol.







Method do_decimal_point()

Access Protected

Classification Accessor

Syntax virtual charT do_decimal_point() const;

Parameters None

Returns This method returns a charT used as the decimal point.



Description



The do_decimal_point() method returns a character used as the decimal point.







Method do_frac_digits()

Access Protected

Classification Accessor

Syntax virtual int do_frac_digits() const;

Parameters None

Return Type int



Description



The do_frac_digits() method returns the number of digits in the fractional part
(displayed to the right of the decimal point) of the monetary value.







Method do_grouping()

Access Protected

Classification Accessor

Syntax virtual string do_grouping() const;

Parameters None

Returns This method returns a string that is used as a
pattern of the number of digits in a particular
grouping.


Description



The do_grouping() method returns a string in which each character of the string
is used as an integer value which represents the number of digits in a particular
grouping, starting with the rightmost group. A group is the digits between the
adjacent thousands' separators. The returned value has the same result as the
numpunct<charT>::do_grouping().








Method do_neg_format()

Access Protected

Classification Accessor

Syntax virtual pattern do_neg_format() const;

Parameters None

Returns This method returns a pattern which is a four element
array that specifies the order in which syntactic
elements appear in the monetary format.



Description



The do_neg_format() method returns a pattern that is a four element array. The
array specifies the order in which syntactic elements appear in the monetary format.
Each enumeration value in the array (symbol, sign,
value, and either space or
none)
appears only once. none, if present, will never occupy the first position.
space,
if present, will not appear in the first or last position. Otherwise, the elements
may appear in any order.







Method do_negative_sign()

Access Protected

Classification Accessor

Syntax virtual string_type do_negative_sign() const;

Parameters None

Returns This method returns a string_type that is used to
indicate a negative monetary value.



Description



The do_negative_sign() methods returns a sequence of elements used as a negative sign.







Method do_pos_format()

Access Protected

Classification Accessor

Syntax virtual pattern do_pos_format() const;

Parameters None

Returns This method returns a pattern which is a four element
array that specifies the order in which syntactic
elements appear in the monetary format.



Description



The do_pos_format() method returns a pattern that is a four element array. The
array specifies the order in which syntactic elements appear in the monetary format.
Each enumeration value in the array (symbol, sign,
value, and either space or
none)
appears only once. none, if present, will never occupy the first position.
space,
if present, will not appear in the first or last position. Otherwise, the elements
may appear in any order.







Method do_positive_sign()

Access Protected

Classification Accessor

Syntax string_type do_positive_sign() const;

Parameters None

Returns This method returns a string_type that is used to
indicate a positive monetary value.



Description



The do_postive_sign() methods returns a sequence of elements used as a positive sign.







Method do_thousands_sep()

Access Protected

Classification Accessor

Syntax virtual charT do_thousands_sep() const;

Parameters None

Returns This method returns a charT that is used as a digit
group separator.



Description



The do_thousands_sep() method returns an element to use as a group separator to the
left of any decimal point. It is used when the do_grouping() method specifies a
digit grouping pattern.







Method moneypunct_byname()

Access Public

Classification Constructor

Syntax explicit moneypunct_byname(const char* name,
size_t refs = 0);

Parameters name is the name of the named locale.

refs, if the refs argument = 0 then the destruction
of the object is delegated to the locale or locales
which contain it. If refs = 1 then the object must
be explicitly deleted. The locale will not delete
it. The object can then be maintained across the
lifetime of multiple locales.


Returns None



Description



The constructor constructs a moneypunct_byname facet object. Uses the named locale
specified by name argument.







Method moneypunct_byname()

Access Public

Classification Destructor

Syntax ~moneypunct_byname();

Parameters None

Returns None



Description



The destructor destroys a moneypunct_byname facet object.






The Class Relationship Diagram for moneypunct_byname





No comments: