IT_Bus::GYearMonth Class Reference

#include <it_bus/gyearmonth.h>

Inheritance diagram for IT_Bus::GYearMonth:

List of all members.

---

Detailed Description

Class encapsulated within generated classes derived from gYearMonth type definitions in a WSDL or XSD file.

Definition at line 27 of file gyearmonth.h.

Public Types
typedef IT_Reflect::ValueRef< IT_Bus::GYearMonth >	IT_ReflectionType
Public Member Functions
	GYearMonth (short wYear=1, short wMonth=1) IT_THROW_DECL((Exception))
	Constructor.
	GYearMonth (const char *value) IT_THROW_DECL((Exception))
	Constructor.
	GYearMonth (const String &value) IT_THROW_DECL((Exception))
	Constructor.
	GYearMonth (const GYearMonth &copy)
	Copy constructor.
virtual	~GYearMonth ()
	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))
	Sets the yearmonth represented by the instance.
short	getYear () const
	Returns a numeric representation of the year.
void	setYear (short wYear) IT_THROW_DECL((Exception))
	Set the year represented by the instance from a numeric representation.
short	getMonth () const
	Returns a numeric representation of the month.
void	setMonth (short wMonth) IT_THROW_DECL((Exception))
	Set the month represented by the instance from a numeric representation.
bool	haveUTCTimeZoneOffset () const
	Returns a flag indicating whether the UTC offset is set.
void	setLocalTimeZone ()
	Sets the local time zone.
void	getUTCTimeZoneOffset (short &hour_offset, short &minute_offset) const
	Obtain the UTC offset.
void	setUTCTimeZoneOffset (short hour_offset, short minute_offset) IT_THROW_DECL((Exception))
	Set the UTC offset.
bool	operator== (const GYearMonth &other) const
	The equality operator.
bool	operator!= (const GYearMonth &other) const
	The inequality operator.
GYearMonth &	operator= (const GYearMonth &rhs)
	Assignment operator.
Static Public Member Functions
GYearMonth &operator+=(const Duration	get_static_type ()&rhs) IT_THROW_DECL((IT_Bus GYearMonth &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 the yearmonth represented by the instance.
Private Attributes
GYearMonthImpl *	m_impl

---

Constructor & Destructor Documentation

IT_Bus::GYearMonth::GYearMonth	(	short	wYear = 1,
		short	wMonth = 1
	)

Constructor.

Parameters:

	wYear	the year, including the century. The default is 1
	wMonth	the month (1-12). The default is 1

Exceptions:

Exception

IT_Bus::GYearMonth::GYearMonth

(

const char *

value

)

Constructor.

Parameters:

value

string representation of a gYearMonth instance

Exceptions:

Exception

IT_Bus::GYearMonth::GYearMonth

(

const String &

value

)

Constructor.

Parameters:

value

string representation of a gYearMonth instance

Exceptions:

Exception

---

Member Function Documentation

void IT_Bus::GYearMonth::from_string

(

const String &

str

)

Sets the yearmonth represented by the instance.

Parameters:

IT_Bus::String

virtual const QName& IT_Bus::GYearMonth::get_type

(

)

const [virtual]

Returns the IT_Bus::QName for the type.

Returns:

NT_SCHEMA_GYMON.

Implements IT_Bus::AnyType.

short IT_Bus::GYearMonth::getMonth

(

)

const

Returns a numeric representation of the month.

Returns:

short

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

Obtain the UTC offset.

Hour and minute offsets are returned via out parameters.

short IT_Bus::GYearMonth::getYear

(

)

const

Returns a numeric representation of the year.

Returns:

short

bool IT_Bus::GYearMonth::haveUTCTimeZoneOffset

(

)

const

Returns a flag indicating whether the UTC offset is set.

Returns:

bool

bool IT_Bus::GYearMonth::operator!=

(

const GYearMonth &

other

)

const

The inequality operator.

Returns:

bool

bool IT_Bus::GYearMonth::operator==

(

const GYearMonth &

other

)

const

The equality operator.

Returns:

bool

void IT_Bus::GYearMonth::setMonth

(

short

wMonth

)

Set the month represented by the instance from a numeric representation.

Parameters:

short

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

Set the UTC offset.

Parameters:

	short	the hours offset
	short	the minutes offset

void IT_Bus::GYearMonth::setYear

(

short

wYear

)

Set the year represented by the instance from a numeric representation.

Parameters:

short

---

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::GYearMonth::to_string)() const

Returns the yearmonth represented by the instance.

Returns:

IT_Bus::String.

---