ICU 74.1 74.1
Public Member Functions | Static Public Member Functions
icu::DateInterval Class Reference

This class represents a date interval. More...

#include <dtintrv.h>

Inheritance diagram for icu::DateInterval:
icu::UObject icu::UMemory

Public Member Functions

 DateInterval (UDate fromDate, UDate toDate)
 Construct a DateInterval given a from date and a to date. More...
 
virtual ~DateInterval ()
 destructor More...
 
UDate getFromDate () const
 Get the from date. More...
 
UDate getToDate () const
 Get the to date. More...
 
virtual UClassID getDynamicClassID (void) const override
 Returns a unique class ID POLYMORPHICALLY. More...
 
 DateInterval (const DateInterval &other)
 Copy constructor. More...
 
DateIntervaloperator= (const DateInterval &)
 Default assignment operator. More...
 
virtual bool operator== (const DateInterval &other) const
 Equality operator. More...
 
bool operator!= (const DateInterval &other) const
 Non-equality operator. More...
 
virtual DateIntervalclone () const
 clone this object. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 
virtual UClassID getDynamicClassID () const
 ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. More...
 

Static Public Member Functions

static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 

Detailed Description

This class represents a date interval.

It is a pair of UDate representing from UDate 1 to UDate 2.

Stable:
ICU 4.0

Definition at line 36 of file dtintrv.h.

Constructor & Destructor Documentation

◆ DateInterval() [1/2]

icu::DateInterval::DateInterval ( UDate  fromDate,
UDate  toDate 
)

Construct a DateInterval given a from date and a to date.

Parameters
fromDateThe from date in date interval.
toDateThe to date in date interval.
Stable:
ICU 4.0

◆ ~DateInterval()

virtual icu::DateInterval::~DateInterval ( )
virtual

destructor

Stable:
ICU 4.0

◆ DateInterval() [2/2]

icu::DateInterval::DateInterval ( const DateInterval other)

Copy constructor.

Stable:
ICU 4.0

Member Function Documentation

◆ clone()

virtual DateInterval * icu::DateInterval::clone ( ) const
virtual

clone this object.

The caller owns the result and should delete it when done.

Returns
a cloned DateInterval
Stable:
ICU 4.0

◆ getDynamicClassID()

virtual UClassID icu::DateInterval::getDynamicClassID ( void  ) const
overridevirtual

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.

Returns
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.0

Reimplemented from icu::UObject.

◆ getFromDate()

UDate icu::DateInterval::getFromDate ( ) const
inline

Get the from date.

Returns
the from date in dateInterval.
Stable:
ICU 4.0

Definition at line 143 of file dtintrv.h.

◆ getStaticClassID()

static UClassID icu::DateInterval::getStaticClassID ( void  )
static

Return the class ID for this class.

This is useful only for comparing to a return value from getDynamicClassID(). For example:

.   Base* polymorphic_pointer = createPolymorphicObject();
.   if (polymorphic_pointer->getDynamicClassID() ==
.       derived::getStaticClassID()) ...
Returns
The class ID for all objects of this class.
Stable:
ICU 4.0

◆ getToDate()

UDate icu::DateInterval::getToDate ( ) const
inline

Get the to date.

Returns
the to date in dateInterval.
Stable:
ICU 4.0

Definition at line 149 of file dtintrv.h.

◆ operator!=()

bool icu::DateInterval::operator!= ( const DateInterval other) const
inline

Non-equality operator.

Returns
true if the two DateIntervals are not the same
Stable:
ICU 4.0

Definition at line 155 of file dtintrv.h.

◆ operator=()

DateInterval & icu::DateInterval::operator= ( const DateInterval )

Default assignment operator.

Stable:
ICU 4.0

◆ operator==()

virtual bool icu::DateInterval::operator== ( const DateInterval other) const
virtual

Equality operator.

Returns
true if the two DateIntervals are the same
Stable:
ICU 4.0

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