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

Detailed Description

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

Draft:
This API may be changed in the future versions and was introduced in ICU 50

Definition at line 36 of file gender.h.


Constructor & Destructor Documentation

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

Destructor.

Draft:
This API may be changed in the future versions and was introduced in ICU 50
Internal:
Do not use. This API is for internal use only.

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:
locale The locale for which a GenderInfo object is returned.
status Output 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.
Draft:
This API may be changed in the future versions and was introduced in 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:
genders the gender of each element in the list.
length the length of gender array.
status Output 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.
Draft:
This API may be changed in the future versions and was introduced in ICU 50

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

Generated on 27 Oct 2013 for ICU 50.1.2 by  doxygen 1.6.1