IT_Bus::GYear Class Reference

#include <it_bus/gyear.h>

Inheritance diagram for IT_Bus::GYear:

List of all members.

---

Detailed Description

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

Definition at line 27 of file gyear.h.

Public Member Functions
	GYear (short wYear=1) throw ((Exception))
	Constructor.
	GYear (const char *value) throw ((Exception))
	Constructor.
	GYear (const String &value) throw ((Exception))
	Constructor.
	GYear (const GYear &copy)
	Copy constructor.
virtual	~GYear ()
	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 year represented by the instance.
void	from_string (const String &str) throw ((Exception))
	Sets the year 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.
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 GYear &other) const
	The equality operator.
bool	operator!= (const GYear &other) const
	The inequality operator.
GYear &	operator= (const GYear &rhs)
	Assignment operator.
GYear &	operator+= (const Duration &rhs) throw ((IT_Bus::Exception))
	Duration addition with assignment operator.
GYear &	operator-= (const Duration &rhs) throw ((IT_Bus::Exception))
	Duration subtraction with assignment operator.

---

Constructor & Destructor Documentation

IT_Bus::GYear::GYear (  short  wYear = 1  )  throw ((Exception))

Constructor. Parameters: wYear  the year, including the century. The default is 1 Exceptions: Exception

IT_Bus::GYear::GYear (  const char *  value  )  throw ((Exception))

Constructor. Parameters: value  string representation of a gYear instance Exceptions: Exception

IT_Bus::GYear::GYear (  const String &  value  )  throw ((Exception))

Constructor. Parameters: value  string representation of a gYear instance Exceptions: Exception

IT_Bus::GYear::GYear (  const GYear &  copy  )

Copy constructor.

virtual IT_Bus::GYear::~GYear (   )  [virtual]

Destructor.

---

Member Function Documentation

virtual AnyType& IT_Bus::GYear::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.

void IT_Bus::GYear::from_string (  const String &  str  )  throw ((Exception))

Sets the year represented by the instance. Parameters: IT_Bus::String

virtual AnyType::Kind IT_Bus::GYear::get_kind (   )  const [virtual]

Returns the IT_Bus::AnyType::Kind for the type. Returns: AnyType::BUILT_IN. Reimplemented from IT_Bus::AnySimpleType.

virtual const IT_Reflect::Reflection* IT_Bus::GYear::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.

virtual IT_Reflect::Reflection* IT_Bus::GYear::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 QName& IT_Bus::GYear::get_type (   )  const [virtual]

Returns the IT_Bus::QName for the type. Returns: NT_SCHEMA_GYEAR. Implements IT_Bus::AnyType.

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

Obtain the UTC offset. Hour and minute offsets are returned via out parameters.

short IT_Bus::GYear::getYear (   )  const

Returns a numeric representation of the year. Returns: short

bool IT_Bus::GYear::haveUTCTimeZoneOffset (   )  const

Returns a flag indicating whether the UTC offset is set. Returns: bool

bool IT_Bus::GYear::operator!= (  const GYear &  other  )  const

The inequality operator. Returns: bool

GYear& IT_Bus::GYear::operator+= (  const Duration &  rhs  )  throw ((IT_Bus::Exception))

Duration addition with assignment operator.

GYear& IT_Bus::GYear::operator-= (  const Duration &  rhs  )  throw ((IT_Bus::Exception))

Duration subtraction with assignment operator.

GYear& IT_Bus::GYear::operator= (  const GYear &  rhs  )

Assignment operator.

bool IT_Bus::GYear::operator== (  const GYear &  other  )  const

The equality operator. Returns: bool

virtual void IT_Bus::GYear::read_value (  AnySimpleTypeReader &  reader  )  throw ((IT_Bus::DeserializationException)) [virtual]

Read the value into the instance. Derived classes implement this method. Implements IT_Bus::AnySimpleType.

void IT_Bus::GYear::setLocalTimeZone (   )

Sets the local time zone.

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

Set the UTC offset. Parameters: short  the hours offset short  the minutes offset

void IT_Bus::GYear::setYear (  short  wYear  )  throw ((Exception))

Set the year represented by the instance from a numeric representation. Parameters: short

String IT_Bus::GYear::to_string (   )  const

Returns the year represented by the instance. Returns: IT_Bus::String.

virtual void IT_Bus::GYear::write_value (  AnySimpleTypeWriter &  writer  )  const throw ((IT_Bus::SerializationException)) [virtual]

Write the instance value. Derived classes implement this method. Implements IT_Bus::AnySimpleType.

---