ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / unicode

/*
 *******************************************************************************
 * Copyright (C) 2009-2010, Google, International Business Machines Corporation and *
 * others. All Rights Reserved.                                                *
 *******************************************************************************
 */

#ifndef __TMUTAMT_H__
#define __TMUTAMT_H__

/**
 * \file
 * \brief C++ API: time unit amount object.
 */

#include "unicode/measure.h"
#include "unicode/tmunit.h"

#if !UCONFIG_NO_FORMATTING

U_NAMESPACE_BEGIN

/**
 * Express a duration as a time unit and number. Patterned after Currency.
 * @see TimeUnitAmount
 * @see TimeUnitFormat
 * @stable ICU 4.2
 */
class U_I18N_API TimeUnitAmount: public Measure {
public:
    /**
     * Construct TimeUnitAmount object with the given number and the
     * given time unit. 
     * @param number        a numeric object; number.isNumeric() must be TRUE
     * @param timeUnitField the time unit field of a time unit
     * @param status        the input-output error code. 
     *                      If the number is not numeric or the timeUnitField
     *                      is not valid,
     *                      then this will be set to a failing value:
     *                      U_ILLEGAL_ARGUMENT_ERROR.
     * @stable ICU 4.2
     */
    TimeUnitAmount(const Formattable& number, 
                   TimeUnit::UTimeUnitFields timeUnitField,
                   UErrorCode& status);

/**
     * Construct TimeUnitAmount object with the given numeric amount and the
     * given time unit. 
     * @param amount        a numeric amount.
     * @param timeUnitField the time unit field on which a time unit amount
     *                      object will be created.
     * @param status        the input-output error code. 
     *                      If the timeUnitField is not valid,
     *                      then this will be set to a failing value:
     *                      U_ILLEGAL_ARGUMENT_ERROR.
     * @stable ICU 4.2
     */
    TimeUnitAmount(double amount, TimeUnit::UTimeUnitFields timeUnitField,
                   UErrorCode& status);

/**
     * Copy constructor 
     * @stable ICU 4.2
     */
    TimeUnitAmount(const TimeUnitAmount& other);

/**
     * Assignment operator
     * @stable ICU 4.2
     */
    TimeUnitAmount& operator=(const TimeUnitAmount& other);

/**
     * Clone. 
     * @return a polymorphic clone of this object. The result will have the same               class as returned by getDynamicClassID().
     * @stable ICU 4.2
     */
    virtual UObject* clone() const;

/**
     * Destructor
     * @stable ICU 4.2
     */
    virtual ~TimeUnitAmount();

/** 
     * Equality operator.  
     * @param other  the object to compare to.
     * @return       true if this object is equal to the given object.
     * @stable ICU 4.2
     */
    virtual UBool operator==(const UObject& other) const;

/** 
     * Not-equality operator.  
     * @param other  the object to compare to.
     * @return       true if this object is not equal to the given object.
     * @stable ICU 4.2
     */
    UBool operator!=(const UObject& other) const;

/**
     * Return the class ID for this class. This is useful only for comparing to
     * a return value from getDynamicClassID(). For example:
     * <pre>
     * .   Base* polymorphic_pointer = createPolymorphicObject();
     * .   if (polymorphic_pointer->getDynamicClassID() ==
     * .       erived::getStaticClassID()) ...
     * </pre>
     * @return          The class ID for all objects of this class.
     * @stable ICU 4.2
     */
    static UClassID U_EXPORT2 getStaticClassID(void);

/**
     * Returns a unique class ID POLYMORPHICALLY. Pure virtual override. This
     * method is to implement a simple version of RTTI, since not all C++
     * compilers support genuine RTTI. Polymorphic operator==() and clone()
     * methods call this method.
     *
     * @return          The class ID for this object. All objects of a
     *                  given class have the same class ID.  Objects of
     *                  other classes have different class IDs.
     * @stable ICU 4.2
     */
    virtual UClassID getDynamicClassID(void) const;

/**
     * Get the time unit.
     * @return time unit object.
     * @stable ICU 4.2
     */
    const TimeUnit& getTimeUnit() const;

/**
     * Get the time unit field value.
     * @return time unit field value.
     * @stable ICU 4.2
     */
    TimeUnit::UTimeUnitFields getTimeUnitField() const;
};

inline UBool 
TimeUnitAmount::operator!=(const UObject& other) const {
    return !operator==(other);
}

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif // __TMUTAMT_H__
//eof
//

[-] tzrule.h [edit]
[-] utrans.h [edit]
[-] ucnv.h [edit]
[-] dtrule.h [edit]
[-] format.h [edit]
[-] uvernum.h [edit]
[-] utf32.h [edit]
[-] ubidi.h [edit]
[-] enumset.h [edit]
[-] normlzr.h [edit]
[-] measfmt.h [edit]
[-] ubrk.h [edit]
[-] upluralrules.h [edit]
[-] sortkey.h [edit]
[-] bytestrie.h [edit]
[-] fpositer.h [edit]
[-] utf_old.h [edit]
[-] tmutamt.h [edit]
[-] uconfig.h [edit]
[-] alphaindex.h [edit]
[-] vtzone.h [edit]
[-] locdspnm.h [edit]
[-] numsys.h [edit]
[-] simpletz.h [edit]
[-] tznames.h [edit]
[-] stringpiece.h [edit]
[-] parseerr.h [edit]
[-] ucsdet.h [edit]
[-] appendable.h [edit]
[+] ..
[-] dtptngen.h [edit]
[-] dtintrv.h [edit]
[-] resbund.h [edit]
[-] ptypes.h [edit]
[-] ustdio.h [edit]
[-] symtable.h [edit]
[-] ucnv_err.h [edit]
[-] utypes.h [edit]
[-] bytestream.h [edit]
[-] dtfmtsym.h [edit]
[-] unorm2.h [edit]
[-] udateintervalformat.h [edit]
[-] ucat.h [edit]
[-] usearch.h [edit]
[-] platform.h [edit]
[-] unum.h [edit]
[-] locid.h [edit]
[-] uversion.h [edit]
[-] regex.h [edit]
[-] strenum.h [edit]
[-] ucasemap.h [edit]
[-] utmscale.h [edit]
[-] decimfmt.h [edit]
[-] messagepattern.h [edit]
[-] brkiter.h [edit]
[-] ucurr.h [edit]
[-] uset.h [edit]
[-] tztrans.h [edit]
[-] udata.h [edit]
[-] currpinf.h [edit]
[-] datefmt.h [edit]
[-] rbbi.h [edit]
[-] parsepos.h [edit]
[-] rbtz.h [edit]
[-] ucnv_cb.h [edit]
[-] ucoleitr.h [edit]
[-] udat.h [edit]
[-] putil.h [edit]
[-] coll.h [edit]
[-] gender.h [edit]
[-] ucharstriebuilder.h [edit]
[-] unimatch.h [edit]
[-] currunit.h [edit]
[-] ugender.h [edit]
[-] colldata.h [edit]
[-] uchriter.h [edit]
[-] tmunit.h [edit]
[-] ulocdata.h [edit]
[-] timezone.h [edit]
[-] unirepl.h [edit]
[-] umisc.h [edit]
[-] tmutfmt.h [edit]
[-] ushape.h [edit]
[-] dtitvinf.h [edit]
[-] usetiter.h [edit]
[-] uniset.h [edit]
[-] listformatter.h [edit]
[-] umsg.h [edit]
[-] ustream.h [edit]
[-] ustringtrie.h [edit]
[-] icudataver.h [edit]
[-] bytestriebuilder.h [edit]
[-] bms.h [edit]
[-] uldnames.h [edit]
[-] uregex.h [edit]
[-] schriter.h [edit]
[-] uenum.h [edit]
[-] uclean.h [edit]
[-] bmsearch.h [edit]
[-] utf16.h [edit]
[-] normalizer2.h [edit]
[-] calendar.h [edit]
[-] udatpg.h [edit]
[-] unifunct.h [edit]
[-] dbbi.h [edit]
[-] utext.h [edit]
[-] uchar.h [edit]
[-] tzfmt.h [edit]
[-] urep.h [edit]
[-] uscript.h [edit]
[-] urename.h [edit]
[-] std_string.h [edit]
[-] choicfmt.h [edit]
[-] rep.h [edit]
[-] idna.h [edit]
[-] unorm.h [edit]
[-] dtitvfmt.h [edit]
[-] utrace.h [edit]
[-] uidna.h [edit]
[-] search.h [edit]
[-] uobject.h [edit]
[-] basictz.h [edit]
[-] dcfmtsym.h [edit]
[-] coleitr.h [edit]
[-] translit.h [edit]
[-] ures.h [edit]
[-] unistr.h [edit]
[-] udisplaycontext.h [edit]
[-] fmtable.h [edit]
[-] rbnf.h [edit]
[-] gregocal.h [edit]
[-] uiter.h [edit]
[-] umachine.h [edit]
[-] plurrule.h [edit]
[-] plurfmt.h [edit]
[-] ucnvsel.h [edit]
[-] curramt.h [edit]
[-] ucal.h [edit]
[-] measure.h [edit]
[-] utf8.h [edit]
[-] uspoof.h [edit]
[-] icuplug.h [edit]
[-] chariter.h [edit]
[-] stringtriebuilder.h [edit]
[-] caniter.h [edit]
[-] utf.h [edit]
[-] fieldpos.h [edit]
[-] ucharstrie.h [edit]
[-] tblcoll.h [edit]
[-] ustring.h [edit]
[-] errorcode.h [edit]
[-] stsearch.h [edit]
[-] localpointer.h [edit]
[-] usprep.h [edit]
[-] docmain.h [edit]
[-] msgfmt.h [edit]
[-] selfmt.h [edit]
[-] unifilt.h [edit]
[-] uloc.h [edit]
[-] measunit.h [edit]
[-] ucol.h [edit]
[-] numfmt.h [edit]
[-] smpdtfmt.h [edit]