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) throw ((Exception))
	Constructor.
	Date (const char *value) throw ((Exception))
	Constructor.
	Date (const String &value) throw ((Exception))
	Constructor.
	Date (const Date &copy)
	Copy constructor.
virtual	~Date ()
	Destructor.
virtual AnyType &	copy (const AnyType &rhs)
	Returns a reference to an AnyType that is a copy of the AnyType parameter.
virtual void	write_value (AnySimpleTypeWriter &writer) const throw ((IT_Bus::SerializationException))
	Write the instance value.
virtual void	read_value (AnySimpleTypeReader &reader) throw ((IT_Bus::DeserializationException))
	Read the value into the instance.
virtual AnyType::Kind	get_kind () const
	Returns the IT_Bus::AnyType::Kind for the type.
virtual const QName &	get_type () const
	Returns the IT_Bus::QName for the type.
virtual IT_Reflect::Reflection *	get_reflection () throw ((IT_Reflect::ReflectException))
	Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.
virtual const IT_Reflect::Reflection *	get_reflection () const throw ((IT_Reflect::ReflectException))
	Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.
String	to_string () const
	Returns a string representation of the date.
void	from_string (const String &str) throw ((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) throw ((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) throw ((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) throw ((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) throw ((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.
Date &	operator+= (const Duration &rhs) throw ((IT_Bus::Exception))
	Duration addition with assignment operator.
Date &	operator-= (const Duration &rhs) throw ((IT_Bus::Exception))
	Duration subtraction with assignment operator.
Private Attributes
DateImpl *	m_impl

---

Constructor & Destructor Documentation

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

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

)

throw ((Exception))

Constructor.

Parameters:

value

string representation of a date instance

Exceptions:

Exception

IT_Bus::Date::Date

(

const String &

value

)

throw ((Exception))

Constructor.

Parameters:

value

string representation of a date instance

Exceptions:

Exception

---

Member Function Documentation

virtual AnyType& IT_Bus::Date::copy

(

const AnyType &

rhs

)

[virtual]

Returns a reference to an AnyType that is a copy of the AnyType parameter.

Derived classes override this method, providing an appropriate implementation. In this base class, this method is not supported; an exception is always thrown.

Parameters:

AnyType

to be copied.

Returns:

A reference to AnyType.

Exceptions:

IT_Bus::Exception

with message "Copy not supported"

Reimplemented from IT_Bus::AnyType.

virtual void IT_Bus::Date::write_value

(

AnySimpleTypeWriter &

writer

)

const throw ((IT_Bus::SerializationException)) [virtual]

Write the instance value.

Derived classes implement this method.

Implements IT_Bus::AnySimpleType.

virtual void IT_Bus::Date::read_value

(

AnySimpleTypeReader &

reader

)

throw ((IT_Bus::DeserializationException)) [virtual]

Read the value into the instance.

Derived classes implement this method.

Implements IT_Bus::AnySimpleType.

virtual AnyType::Kind IT_Bus::Date::get_kind

(

)

const [virtual]

Returns the IT_Bus::AnyType::Kind for the type.

Returns:

AnyType::BUILT_IN.

Reimplemented from IT_Bus::AnySimpleType.

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.

virtual IT_Reflect::Reflection* IT_Bus::Date::get_reflection

(

)

throw ((IT_Reflect::ReflectException)) [virtual]

Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.

Returns:

IT_Reflect::Reflection

Exceptions:

IT_Reflect::ReflectException

Reimplemented from IT_Bus::AnyType.

virtual const IT_Reflect::Reflection* IT_Bus::Date::get_reflection

(

)

const throw ((IT_Reflect::ReflectException)) [virtual]

Return an instance of the IT_Reflect::Reflection type that encapsulates this instance.

Returns:

IT_Reflect::Reflection

Exceptions:

IT_Reflect::ReflectException

Reimplemented from IT_Bus::AnyType.

String IT_Bus::Date::to_string

(

)

const

Returns a string representation of the date.

Returns:

String representation of the date.

void IT_Bus::Date::from_string

(

const String &

str

)

throw ((Exception))

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

Parameters:

String

representation of the date.

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.

void IT_Bus::Date::setYear

(

short

wYear

)

throw ((Exception))

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

Parameters:

short

representing the year.

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::setMonth

(

short

wMonth

)

throw ((Exception))

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

Parameters:

short

representing the month.

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.

void IT_Bus::Date::setDay

(

short

wDay

)

throw ((Exception))

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

Parameters:

short

representing the day.

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.

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

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::getUTCTimeZoneOffset	(	short &	hour_offset,
		short &	minute_offset
	)			const

Obtain the UTC time zone offset values.

The values are returned through the method arguments.

bool IT_Bus::Date::operator==

(

const Date &

other

)

const

Equality operator.

Compares two dates.

bool IT_Bus::Date::operator!=

(

const Date &

other

)

const

Inequality operator.

Compares two dates.

---