Class: TGregorianDateTimeFormatter

Declaration: DateTime.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPatternBasedDateTimeFormatter

Inherited By:

None.

Purpose:

A concrete derived class of TPatternBasedDateTimeFormatter that uses a Gregorian calendar for formatting and scanning dates.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TGregorianDateTimeFormatter is a concrete class designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::TGregorianDateTimeFormatter

TGregorianDateTimeFormatter ()
TGregorianDateTimeFormatter (const TGregorianDateTimeFormatter & format)
TGregorianDateTimeFormatter (const TCalendar & calendar)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructs a formatter containing the specified TCalendar.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Called to construct a formatter with a specific calendar.

Parameters:

Takes no parameters.
const TGregorianDateTimeFormatter & format -The object to copy.
const TCalendar & calendar -The calendar encapuslated by this formatter.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::~TGregorianDateTimeFormatter

virtual ~ TGregorianDateTimeFormatter ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::operator=

TGregorianDateTimeFormatter & operator =(const TGregorianDateTimeFormatter & format)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TGregorianDateTimeFormatter & format -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::GetCalendar

virtual TCalendar * GetCalendar () const

Interface Category:

API.

Purpose:

Returns the calendar used by this formatter, TGregorianCalendar.

Calling Context:

Called by Format and Scan.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to a TGregorianCalendar object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::SetCalendar

void SetCalendar (const TCalendar & calendar)

Interface Category:

API.

Purpose:

Sets the calendar for the formatter.

Calling Context:

Called to set the calendar for the formatter.

Parameters:

const TCalendar & calendar -The calendar to be used by the formatter.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGregorianDateTimeFormatter::InitDateOnlyFormat

virtual void InitDateOnlyFormat ()

Interface Category:

API.

Purpose:

Temporary way to construct the default format. Do not use this member function. Instead, use Locale to get the correct date time format.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function will be replaced in future versions of the CommonPoint application system.

Member Function: TGregorianDateTimeFormatter::InitTimeOnlyFormat

virtual void InitTimeOnlyFormat ()

Interface Category:

API.

Purpose:

Temporary way to construct the default format. Do not use this member function. Instead, use Locale to get the correct date time format.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function will be replaced in future versions of the CommonPoint application system.

Member Function: TGregorianDateTimeFormatter::InitShortFormat

virtual void InitShortFormat ()

Interface Category:

API.

Purpose:

Temporary way to construct the default format. Do not use this member function. Instead, use Locale to get the correct date time format.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function will be replaced in future versions of the CommonPoint application system.

Member Function: TGregorianDateTimeFormatter::InitLongFormat

virtual void InitLongFormat ()

Interface Category:

API.

Purpose:

Temporary way to construct the default format. Do not use this member function. Instead, use Locale to get the correct date time format.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function will be replaced in future versions of the CommonPoint application system.

Click the icon to mail questions or corrections about this material to Taligent personnel.