IT_Bus::Date Class Reference

#include <it_bus/date.h>

Inheritance diagram for IT_Bus::Date:

List of all members.

---

Detailed Description

Base class for generated classes derived from xsd:date type definitions within a WSDL or XSD file.

Definition at line 27 of file date.h.

Public Types
typedef IT_Reflect::ValueRef< IT_Bus::Date >	IT_ReflectionType
Public Member Functions
	Date ()
	Default constructor.
	Date (short wYear, short wMonth, short wDay) IT_THROW_DECL((Exception))
	Constructor.
	Date (const char *value) IT_THROW_DECL((Exception))
	Constructor.
	Date (const String &value) IT_THROW_DECL((Exception))
	Constructor.
	Date (const Date &copy)
	Copy constructor.
virtual	~Date ()
	Destructor.
virtual const QName &	get_type () const
	Returns the IT_Bus::QName for the type.
void	from_string (const String &str) IT_THROW_DECL((Exception))
	Initializes this instance with the date corresponding to the string argument.
short	getYear () const
	Returns a numeric value for the year corresponding to the date this instance represents.
void	setYear (short wYear) IT_THROW_DECL((Exception))
	Sets the value for the year to the numeric value supplied as an argument.
short	getMonth () const
	Returns a numeric value for the month corresponding to the date this instance represents.
void	setMonth (short wMonth) IT_THROW_DECL((Exception))
	Sets the value for the month to the numeric value supplied as an argument.
short	getDay () const
	Returns a numeric value for the day corresponding to the date this instance represents.
void	setDay (short wDay) IT_THROW_DECL((Exception))
	Sets the value for the day to the numeric value supplied as an argument.
bool	haveUTCTimeZoneOffset () const
	Returns a bool indicating whether the instance has the UTC time zone offset set.
void	setLocalTimeZone ()
	Set the instance to the local time zone.
void	setUTCTimeZoneOffset (short hour_offset, short minute_offset) IT_THROW_DECL((Exception))
	Set the UTC time zone offset to the values supplied as arguments.
void	getUTCTimeZoneOffset (short &hour_offset, short &minute_offset) const
	Obtain the UTC time zone offset values.
bool	operator== (const Date &other) const
	Equality operator.
bool	operator!= (const Date &other) const
	Inequality operator.
Date &	operator= (const Date &rhs)
	Assignment operator.
Static Public Member Functions
Date &operator+=(const Duration	get_static_type ()&rhs) IT_THROW_DECL((IT_Bus Date &static operator-=(const Duration &rhs) IT_THROW_DECL((IT_Bus const QName &
	Duration subtraction with assignment operator.
Public Attributes
virtual IT_Reflect::Reflection *virtual get_reflection() IT_THROW_DECL((IT_Reflect const IT_Reflect::Reflection *get_reflection() const IT_THROW_DECL((IT_Reflect Strin	to_string )() const
	Returns a string representation of the date.
Private Attributes
DateImpl *	m_impl

---

Constructor & Destructor Documentation

IT_Bus::Date::Date	(	short	wYear,
		short	wMonth,
		short	wDay
	)

Constructor.

Parameters:

	wYear	the year, including the century
	wMonth	the month (1-12)
	wDay	the day of the month

Exceptions:

Exception

IT_Bus::Date::Date

(

const char *

value

)

Constructor.

Parameters:

value

string representation of a date instance

Exceptions:

Exception

IT_Bus::Date::Date

(

const String &

value

)

Constructor.

Parameters:

value

string representation of a date instance

Exceptions:

Exception

---

Member Function Documentation

void IT_Bus::Date::from_string

(

const String &

str

)

Initializes this instance with the date corresponding to the string argument.

Parameters:

String

representation of the date.

virtual const QName& IT_Bus::Date::get_type

(

)

const [virtual]

Returns the IT_Bus::QName for the type.

Derived subclasses implement this method and return their QName.

Returns:

NT_SCHEMA_DATE.

Implements IT_Bus::AnyType.

short IT_Bus::Date::getDay

(

)

const

Returns a numeric value for the day corresponding to the date this instance represents.

Returns:

short value for the day.

short IT_Bus::Date::getMonth

(

)

const

Returns a numeric value for the month corresponding to the date this instance represents.

Returns:

short value for the month.

void IT_Bus::Date::getUTCTimeZoneOffset	(	short &	hour_offset,
		short &	minute_offset
	)			const

Obtain the UTC time zone offset values.

The values are returned through the method arguments.

short IT_Bus::Date::getYear

(

)

const

Returns a numeric value for the year corresponding to the date this instance represents.

Returns:

short value for the year.

bool IT_Bus::Date::haveUTCTimeZoneOffset

(

)

const

Returns a bool indicating whether the instance has the UTC time zone offset set.

Returns:

bool indicating whether the offset is set.

bool IT_Bus::Date::operator!=

(

const Date &

other

)

const

Inequality operator.

Compares two dates.

bool IT_Bus::Date::operator==

(

const Date &

other

)

const

Equality operator.

Compares two dates.

void IT_Bus::Date::setDay

(

short

wDay

)

Sets the value for the day to the numeric value supplied as an argument.

Parameters:

short

representing the day.

void IT_Bus::Date::setMonth

(

short

wMonth

)

Sets the value for the month to the numeric value supplied as an argument.

Parameters:

short

representing the month.

void IT_Bus::Date::setUTCTimeZoneOffset	(	short	hour_offset,
		short	minute_offset
	)

Set the UTC time zone offset to the values supplied as arguments.

Parameters:

	short	numeric value for the hour offset.
	short	numeric value for the minute offset.

void IT_Bus::Date::setYear

(

short

wYear

)

Sets the value for the year to the numeric value supplied as an argument.

Parameters:

short

representing the year.

---

Member Data Documentation

virtual IT_Reflect::Reflection* virtual get_reflection () IT_THROW_DECL((IT_Reflect const IT_Reflect::Reflection* get_reflection () const IT_THROW_DECL((IT_Reflect Strin IT_Bus::Date::to_string)() const

Returns a string representation of the date.

Returns:

String representation of the date.

---