IIndexMetadataList Class Reference

Exposes a group of IIndexMetadata objects. More...

Inherited by DSIExtIndexMetadataList.

List of all members.

Public Member Functions

virtual simba_size_t GetIndexCount () const =0
 Returns the index count.
virtual const IIndexMetadataGetIndexMetadata (const simba_wstring &in_indexName) const =0
 Returns a reference to the desired index metadata.
virtual const IIndexMetadataGetIndexMetadata (simba_size_t in_index) const =0
 Returns a reference to the desired index metadata.
virtual ~IIndexMetadataList ()
 Destructor.

Protected Member Functions

 IIndexMetadataList ()
 Constructor.

Detailed Description

Exposes a group of IIndexMetadata objects.

A concrete implementation of IIndexMetadataList.

See also:

Constructor & Destructor Documentation

virtual ~IIndexMetadataList (  )  [inline, virtual]

Destructor.

IIndexMetadataList (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual simba_size_t GetIndexCount (  )  const [pure virtual]

Returns the index count.

Returns:
Index count.

Implemented in DSIExtIndexMetadataList.

virtual const IIndexMetadata* GetIndexMetadata ( const simba_wstring in_indexName  )  const [pure virtual]

Returns a reference to the desired index metadata.

Parameters:
in_indexName The unique name of the index for which to retrieve metadata.
Returns:
The metadata for the given index, or NULL if it was not found. (NOT OWN)

Implemented in DSIExtIndexMetadataList.

virtual const IIndexMetadata* GetIndexMetadata ( simba_size_t  in_index  )  const [pure virtual]

Returns a reference to the desired index metadata.

Parameters:
in_index The number of the index for which to retrieve metadata. Indexes are indexed starting with 0.
Exceptions:
SEInvalidArgumentException if in_index is out of range.
Returns:
The metadata for the given index. (NOT OWN)

Implemented in DSIExtIndexMetadataList.


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

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba