ULGender Class Reference

An enhanced enumerated type used to represent genders. More...

#include <ulgender.h>

Public Member Functions
	ULGender ()
	ULGender (const ULGender &other)
	ULGender (int id)
	ULGender (const char *otherStringID)
virtual	~ULGender ()
virtual void	clear ()
ULGender &	operator= (const ULGender &other)
ULGender &	operator= (int otherID)
ULGender &	operator= (const char *otherStringID)
bool	operator== (const ULGender &other) const
bool	operator== (const char *otherStringID) const
bool	operator!= (const ULGender &other) const
bool	operator!= (const char *otherStringID) const
bool	operator< (const ULGender &other) const
bool	operator< (const char *otherStringID) const
Public Member Functions inherited from ULEnum
	ULEnum ()
	ULEnum (const ULEnum &other)
virtual	~ULEnum ()
virtual ULEnum &	operator= (const ULEnum &other)
	operator int () const
uluint32	hash (uluint32 tableSize) const
int	getID () const
const char *	getStringID () const
virtual const char *	getDisplayString () const

Static Public Member Functions
static int	getEnumeratedValueCount ()
static const ULGender &	getInstance (int id)
Static Public Member Functions inherited from ULEnum
static bool	isEnumeratedFeature (const ULString &featureName)
static uluint32	getRunTimeFeatureID (const ULString &featureName)

Static Public Attributes
static const ULGender &	None = ULGender("nogender", "no gender")
static const ULGender &	Any = ULGender("anygender", "any gender")
static const ULGender &	Masculine = ULGender("masculine", "masculine")
static const ULGender &	Feminine = ULGender("feminine", "feminine")
static const ULGender &	Neuter = ULGender("neuter", "neuter")
static const ULGender &	Common = ULGender("common", "common")

Additional Inherited Members
Protected Attributes inherited from ULEnum
int	id
const char *	stringID
const char *	displayString
Static Protected Attributes inherited from ULEnum
static ULHashTable< ULString, uluint32 >	featureNameToRunTimeID

Detailed Description

An enhanced enumerated type used to represent genders.

See ULEnum for a discussion of enhanced enumerated types in ULAPI.

Constructor & Destructor Documentation

ULGender::ULGender

(

)

Default constructor.

ULGender::ULGender

(

const ULGender &

other

)

Copy constructor.

ULGender::ULGender

(

int

otherID

)

Constructor by id.

ULGender::ULGender

(

const char *

otherStringID

)

Constructor.

Parameters

[in]

otherStringID

The string ID corresponding to the ULGender value this ULGender should be copied from.

ULGender::~ULGender ( )

virtual

Destructor.

Member Function Documentation

void ULGender::clear ( )

virtual

Sets this ULGender object to its default state.

Reimplemented from ULEnum.

int ULGender::getEnumeratedValueCount ( )

static

Returns

the number of distinct enumerated values of this type.

const ULGender & ULGender::getInstance ( int  id )

static

Returns

the statically allocated instance of this type corresponding to the specified integer id.

Parameters

[in]

id

the desired integer id.

bool ULGender::operator!=

(

const ULGender &

other

)

const

Inequality operator.

bool ULGender::operator!=

(

const char *

stringID

)

const

Inequality operator.

Returns

true if the specified string is not equal to this ULGender's string ID.

Parameters

[in]

stringID

The string to compare to this object's string ID.

bool ULGender::operator<

(

const ULGender &

other

)

const

Comparison operator.

Returns

true if this ULGender's integer ID is strictly less than other's.

Parameters

[in]

other

The other ULGender object.

bool ULGender::operator<

(

const char *

stringID

)

const

Comparison operator.

Returns

true if this ULGender's integer ID is is strictly less the integer ID of the ULGender value corresponding to the specified string ID.

Parameters

[in]

stringID

The string ID.

ULGender & ULGender::operator=

(

const ULGender &

other

)

Assignment operator.

Returns

a reference to this ULGender object.

ULGender & ULGender::operator=

(

int

otherID

)

Assignment operator.

Parameters

[in]

otherID

The ID of the enumerated value of ULGender to assign to this ULGender.

ULGender & ULGender::operator=

(

const char *

otherStringID

)

Assignment operator.

Returns

a reference to this ULGender object.

Parameters

[in]

stringID

If stringID is the string ID of one of the ULGender enumerated values, then this object is copied from that ULGender. Otherwise, this object is assigned the default value.

bool ULGender::operator==

(

const ULGender &

other

)

const

Equality operator.

bool ULGender::operator==

(

const char *

stringID

)

const

Equality operator.

Returns

true if the specified string is equal to this ULGender's string ID.

Parameters

[in]

stringID

The string to compare to this object's string ID.

Member Data Documentation

const ULGender & ULGender::Any = ULGender("anygender", "any gender")

static

const ULGender & ULGender::Common = ULGender("common", "common")

static

const ULGender & ULGender::Feminine = ULGender("feminine", "feminine")

static

const ULGender & ULGender::Masculine = ULGender("masculine", "masculine")

static

const ULGender & ULGender::Neuter = ULGender("neuter", "neuter")

static

const ULGender & ULGender::None = ULGender("nogender", "no gender")

static

---

The documentation for this class was generated from the following files:

• ulgender.h
• ulgender.cpp