IndexTopicEntry Class Reference

#include <IndexTopicEntry.h>

Public Types
typedef object_type	data_type

Public Member Functions
	IndexTopicEntry ()
	IndexTopicEntry (const IndexTopicEntry &other)
bool16	operator== (const IndexTopicEntry &other) const
IndexTopicEntry &	operator= (const IndexTopicEntry &other)
const int16 &	GetNumNodes () const
int16 &	GetNumNodes ()
IndexTopicEntryNode &	GetTopicEntryNode (int16 number)
const IndexTopicEntryNode &	GetTopicEntryNode (int16 number) const

Protected Attributes
int16	fNumNodes
IndexTopicEntryNode	fNodes [kIDXMaxTopicLevel]

Detailed Description

Models a topic entry which can have up to kIDXMaxTopicLevel topic nodes.

See Also

IndexTopicEntryNode

Constructor & Destructor Documentation

IndexTopicEntry::IndexTopicEntry ( )

inline

Constructs an empty topic entry.

IndexTopicEntry::IndexTopicEntry ( const IndexTopicEntry &  other )

inline

Copy constructor. Copies the content of the specified topic entry.

Parameters

other

[IN] - topic entry to be copied.

Member Function Documentation

const int16& IndexTopicEntry::GetNumNodes ( ) const

inline

Accessor for the number of topic nodes.

Returns

the number of topics contained in this topic entry.

int16& IndexTopicEntry::GetNumNodes ( )

inline

Accessor for the number of topic nodes.

Returns

a modifiable reference to the number of topics property.

IndexTopicEntryNode& IndexTopicEntry::GetTopicEntryNode ( int16  number )

inline

Accessor for a topic node.

Parameters

number

[IN] - the index (level) of the topic node within this entry.

Returns

a modifiable reference to the topic node at the specified index.

const IndexTopicEntryNode& IndexTopicEntry::GetTopicEntryNode ( int16  number ) const

inline

Accessor for a topic node.

Parameters

number

[IN] - the index (level) of the topic node within this entry.

Returns

the topic node at the specified index.

IndexTopicEntry& IndexTopicEntry::operator= ( const IndexTopicEntry &  other )

inline

Assignment operator.

bool16 IndexTopicEntry::operator== ( const IndexTopicEntry &  other ) const

inline

Equality test operator.