ULMood Class Reference

An enhanced enumerated type used to represent the mood of verbs. More...

#include <ulmood.h>

Public Member Functions
	ULMood ()
	ULMood (const ULMood &other)
	ULMood (int id)
	ULMood (const char *otherStringID)
virtual	~ULMood ()
virtual void	clear ()
ULMood &	operator= (const ULMood &other)
ULMood &	operator= (int otherID)
ULMood &	operator= (const char *otherStringID)
bool	operator== (const ULMood &other) const
bool	operator== (const char *otherStringID) const
bool	operator!= (const ULMood &other) const
bool	operator!= (const char *otherStringID) const
bool	operator< (const ULMood &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 ULMood &	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 ULMood &	None = ULMood("nomood", "no mood")
static const ULMood &	Any = ULMood("anymood", "any mood")
static const ULMood &	Indicative = ULMood("indicativemood", "indicative")
static const ULMood &	Subjunctive = ULMood("subjunctivemood", "subjunctive")
static const ULMood &	Conditional = ULMood("conditionalmood", "conditional")
static const ULMood &	Imperative = ULMood("imperativemood", "imperative")
static const ULMood &	Jussive = ULMood("jussivemood", "jussive")

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 the mood of verbs.

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

Constructor & Destructor Documentation

ULMood::ULMood

(

)

Default constructor.

ULMood::ULMood

(

const ULMood &

other

)

Copy constructor.

ULMood::ULMood

(

int

otherID

)

Constructor by id.

ULMood::ULMood

(

const char *

otherStringID

)

Constructor.

Parameters

[in]

otherStringID

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

ULMood::~ULMood ( )

virtual

Destructor.

Member Function Documentation

void ULMood::clear ( )

virtual

Sets this ULMood object to its default state.

Reimplemented from ULEnum.

int ULMood::getEnumeratedValueCount ( )

static

Returns

the number of distinct enumerated values of this type.

const ULMood & ULMood::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 ULMood::operator!=

(

const ULMood &

other

)

const

Inequality operator.

bool ULMood::operator!=

(

const char *

stringID

)

const

Inequality operator.

Returns

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

Parameters

[in]

stringID

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

bool ULMood::operator<

(

const ULMood &

other

)

const

Comparison operator.

Returns

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

Parameters

[in]

other

The other ULMood object.

bool ULMood::operator<

(

const char *

stringID

)

const

Comparison operator.

Returns

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

Parameters

[in]

stringID

The string ID.

ULMood & ULMood::operator=

(

const ULMood &

other

)

Assignment operator.

Returns

a reference to this ULMood object.

ULMood & ULMood::operator=

(

int

otherID

)

Assignment operator.

Parameters

[in]

otherID

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

ULMood & ULMood::operator=

(

const char *

otherStringID

)

Assignment operator.

Returns

a reference to this ULMood object.

Parameters

[in]

stringID

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

bool ULMood::operator==

(

const ULMood &

other

)

const

Equality operator.

bool ULMood::operator==

(

const char *

stringID

)

const

Equality operator.

Returns

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

Parameters

[in]

stringID

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

Member Data Documentation

const ULMood & ULMood::Any = ULMood("anymood", "any mood")

static

const ULMood & ULMood::Conditional = ULMood("conditionalmood", "conditional")

static

const ULMood & ULMood::Imperative = ULMood("imperativemood", "imperative")

static

const ULMood & ULMood::Indicative = ULMood("indicativemood", "indicative")

static

const ULMood & ULMood::Jussive = ULMood("jussivemood", "jussive")

static

const ULMood & ULMood::None = ULMood("nomood", "no mood")

static

const ULMood & ULMood::Subjunctive = ULMood("subjunctivemood", "subjunctive")

static

---

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

• ulmood.h
• ulmood.cpp