bdlat_enumeratorinfo

Classes
struct	bdlat_EnumeratorInfo

Functions
bool	operator== (const bdlat_EnumeratorInfo &lhs, const bdlat_EnumeratorInfo &rhs)
bool	operator!= (const bdlat_EnumeratorInfo &lhs, const bdlat_EnumeratorInfo &rhs)
bsl::ostream &	operator<< (bsl::ostream &stream, const bdlat_EnumeratorInfo &enumeratorInfo)
const char *&	bdlat_EnumeratorInfo::annotation ()
const char *&	bdlat_EnumeratorInfo::name ()
int &	bdlat_EnumeratorInfo::nameLength ()
int &	bdlat_EnumeratorInfo::value ()
BSLS_KEYWORD_CONSTEXPR const char *	bdlat_EnumeratorInfo::annotation () const
	Return the non-modifiable annotation of this enumerator info object.
BSLS_KEYWORD_CONSTEXPR const char *	bdlat_EnumeratorInfo::name () const
	Return the non-modifiable name of this enumerator info object.
BSLS_KEYWORD_CONSTEXPR int	bdlat_EnumeratorInfo::nameLength () const
BSLS_KEYWORD_CONSTEXPR int	bdlat_EnumeratorInfo::value () const
	Return the index of this enumerator info object.

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Basic Usage

Purpose

Provide a container for enumerator information.

Classes

• bdlat_EnumeratorInfo: container for enumerator information

See also

Description

This component provides the bdlat_EnumeratorInfo class which is a container for holding information (properties) about an enumerator. The properties of an enumerator include its name and the length of its name, its value, and a brief annotation. Although each enumerator property is publicly accessible, a manipulator and accessor is also supplied for each.

Usage

This section illustrates intended use of this component.

Example 1: Basic Usage

TBD doc

Function Documentation

annotation() [1/2]

const char *& bdlat_EnumeratorInfo::annotation ( )

inline

Return a reference to the modifiable annotation of this enumerator info object.

annotation() [2/2]

BSLS_KEYWORD_CONSTEXPR const char * bdlat_EnumeratorInfo::annotation ( ) const

inline

name() [1/2]

const char *& bdlat_EnumeratorInfo::name ( )

inline

Return a reference to the modifiable name of this enumerator info object.

name() [2/2]

BSLS_KEYWORD_CONSTEXPR const char * bdlat_EnumeratorInfo::name ( ) const

inline

nameLength() [1/2]

int & bdlat_EnumeratorInfo::nameLength ( )

inline

Return a reference to the modifiable length of the name of this enumerator info object. Note that the 0-terminator is not included in the length.

nameLength() [2/2]

BSLS_KEYWORD_CONSTEXPR int bdlat_EnumeratorInfo::nameLength ( ) const

inline

Return the length of the name of this enumerator info object. Note that the 0-terminator is not included in the length.

operator!=()

bool operator!= ( const bdlat_EnumeratorInfo &  lhs, const bdlat_EnumeratorInfo &  rhs  )

inline

Return true if the specified lhs and rhs enumerator info objects do not have the same value, and false otherwise. Two enumerator info objects do not have the same value if at least one of their respective properties is not identical.

operator<<()

bsl::ostream & operator<<	(	bsl::ostream &	stream,
		const bdlat_EnumeratorInfo &	enumeratorInfo
	)

Write the value of the specified enumeratorInfo to the specified stream.

operator==()

bool operator== ( const bdlat_EnumeratorInfo &  lhs, const bdlat_EnumeratorInfo &  rhs  )

inline

Return true if the specified lhs and rhs enumerator info objects have the same value, and false otherwise. Two enumerator info objects have the same value if each of their respective properties are identical.

value() [1/2]

int & bdlat_EnumeratorInfo::value ( )

inline

Return a reference to the modifiable id of this enumerator info object.

value() [2/2]

BSLS_KEYWORD_CONSTEXPR int bdlat_EnumeratorInfo::value ( ) const

inline