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) throw ((Exception))
	Constructor.
	GYearMonth (const char *value) throw ((Exception))
	Constructor.
	GYearMonth (const String &value) throw ((Exception))
	Constructor.
	GYearMonth (const GYearMonth &copy)
	Copy constructor.
virtual	~GYearMonth ()
	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 the yearmonth represented by the instance.
void	from_string (const String &str) throw ((Exception))
	Sets the yearmonth represented by the instance.
short	getYear () const
	Returns a numeric representation of the year.
void	setYear (short wYear) throw ((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) throw ((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) throw ((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.
GYearMonth &	operator+= (const Duration &rhs) throw ((IT_Bus::Exception))
	Duration addition with assignment operator.
GYearMonth &	operator-= (const Duration &rhs) throw ((IT_Bus::Exception))
	Duration subtraction with assignment operator.
Private Attributes
GYearMonthImpl *	m_impl

---

Constructor & Destructor Documentation

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

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

)

throw ((Exception))

Constructor.

Parameters:

value

string representation of a gYearMonth instance

Exceptions:

Exception

IT_Bus::GYearMonth::GYearMonth

(

const String &

value

)

throw ((Exception))

Constructor.

Parameters:

value

string representation of a gYearMonth instance

Exceptions:

Exception

---

Member Function Documentation

virtual AnyType& IT_Bus::GYearMonth::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::GYearMonth::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::GYearMonth::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::GYearMonth::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::GYearMonth::get_type

(

)

const [virtual]

Returns the IT_Bus::QName for the type.

Returns:

NT_SCHEMA_GYMON.

Implements IT_Bus::AnyType.

virtual IT_Reflect::Reflection* IT_Bus::GYearMonth::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::GYearMonth::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::GYearMonth::to_string

(

)

const

Returns the yearmonth represented by the instance.

Returns:

IT_Bus::String.

void IT_Bus::GYearMonth::from_string

(

const String &

str

)

throw ((Exception))

Sets the yearmonth represented by the instance.

Parameters:

IT_Bus::String

short IT_Bus::GYearMonth::getYear

(

)

const

Returns a numeric representation of the year.

Returns:

short

void IT_Bus::GYearMonth::setYear

(

short

wYear

)

throw ((Exception))

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

Parameters:

short

short IT_Bus::GYearMonth::getMonth

(

)

const

Returns a numeric representation of the month.

Returns:

short

void IT_Bus::GYearMonth::setMonth

(

short

wMonth

)

throw ((Exception))

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

Parameters:

short

bool IT_Bus::GYearMonth::haveUTCTimeZoneOffset

(

)

const

Returns a flag indicating whether the UTC offset is set.

Returns:

bool

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.

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

Set the UTC offset.

Parameters:

	short	the hours offset
	short	the minutes offset

bool IT_Bus::GYearMonth::operator==

(

const GYearMonth &

other

)

const

The equality operator.

Returns:

bool

bool IT_Bus::GYearMonth::operator!=

(

const GYearMonth &

other

)

const

The inequality operator.

Returns:

bool

---