ICU 73.2  73.2
Public Member Functions | Static Public Member Functions | Friends
icu::GenderInfo Class Reference

GenderInfo computes the gender of a list as a whole given the gender of each element. More...

#include <gender.h>

Inheritance diagram for icu::GenderInfo:
icu::UObject icu::UMemory

Public Member Functions

UGender getListGender (const UGender *genders, int32_t length, UErrorCode &status) const
 Determines the gender of a list as a whole given the gender of each of the elements.
virtual ~GenderInfo ()
 Destructor.

Static Public Member Functions

static const GenderInfogetInstance (const Locale &locale, UErrorCode &status)
 Provides access to the predefined GenderInfo object for a given locale.

Friends

class ::GenderInfoTest
void GenderInfo_initCache (UErrorCode &status)

Detailed Description

GenderInfo computes the gender of a list as a whole given the gender of each element.

Stable:
ICU 50

Definition at line 48 of file gender.h.


Constructor & Destructor Documentation

virtual icu::GenderInfo::~GenderInfo ( ) [virtual]

Destructor.

Stable:
ICU 50

Member Function Documentation

static const GenderInfo* icu::GenderInfo::getInstance ( const Locale locale,
UErrorCode status 
) [static]

Provides access to the predefined GenderInfo object for a given locale.

Parameters:
localeThe locale for which a GenderInfo object is returned.
statusOutput param set to success/failure code on exit, which must not indicate a failure before the function call.
Returns:
The predefined GenderInfo object pointer for this locale. The returned object is immutable, so it is declared as const. Caller does not own the returned pointer, so it must not attempt to free it.
Stable:
ICU 50
UGender icu::GenderInfo::getListGender ( const UGender genders,
int32_t  length,
UErrorCode status 
) const

Determines the gender of a list as a whole given the gender of each of the elements.

Parameters:
gendersthe gender of each element in the list.
lengththe length of gender array.
statusOutput param set to success/failure code on exit, which must not indicate a failure before the function call.
Returns:
the gender of the whole list.
Stable:
ICU 50

Friends And Related Function Documentation

void GenderInfo_initCache ( UErrorCode status) [friend]
Internal:
Do not use.

This API is for internal use only. Forward Declaration


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