CIFListStart Class Reference

#include <CIFListStart.h>

List of all members.

Public Member Functions
	CIFListStart (istream &inStream)
TID	getFeatureID () const
double	getCollectionFrequency () const
unsigned int	getNumberOfElements () const
unsigned int	getNumberOfReservedElements () const
Private Attributes
TID	mFeatureID
float	mCollectionFrequency
unsigned int	mNumberOfElements
unsigned int	mNumberOfReservedElements

---

Detailed Description

The chunk which starts a list in the inverted file, consisting of FeatureID, CollectionFrequency of the Feature and Number of Elements in the List

Definition at line 52 of file CIFListStart.h.

---

Constructor & Destructor Documentation

CIFListStart::CIFListStart

(

istream &

inStream

)

Definition at line 57 of file CIFListStart.cc.

References mCollectionFrequency, and mNumberOfElements.

                                           {
    inStream.read((char*)this,
      sizeof(*this));
    
    assert(mCollectionFrequency && mNumberOfElements);
};

---

Member Function Documentation

TID CIFListStart::getFeatureID

(

)

const

Definition at line 78 of file CIFListStart.cc.

References mFeatureID.

Referenced by CAcIFFileSystem::FeatureToList(), CAcIFFileSystem::findWithinStream(), and CAcIFFileSystem::init().

                                   {
  return mFeatureID;
};

double CIFListStart::getCollectionFrequency

(

)

const

Definition at line 96 of file CIFListStart.cc.

References mCollectionFrequency.

Referenced by CAcIFFileSystem::findWithinStream(), and CAcIFFileSystem::init().

                                                {
  return mCollectionFrequency;
};

unsigned int CIFListStart::getNumberOfElements

(

)

const

Definition at line 113 of file CIFListStart.cc.

References mNumberOfElements.

Referenced by CAcIFFileSystem::FeatureToList(), and CAcIFFileSystem::findWithinStream().

                                                   {
  return mNumberOfElements;
};

unsigned int CIFListStart::getNumberOfReservedElements

(

)

const

Definition at line 129 of file CIFListStart.cc.

References mNumberOfReservedElements.

                                                           {
  return mNumberOfReservedElements;
};

---

Member Data Documentation

TID CIFListStart::mFeatureID [private]

Definition at line 54 of file CIFListStart.h.

Referenced by getFeatureID().

float CIFListStart::mCollectionFrequency [private]

Definition at line 56 of file CIFListStart.h.

Referenced by CIFListStart(), and getCollectionFrequency().

unsigned int CIFListStart::mNumberOfElements [private]

The number of elements

Definition at line 58 of file CIFListStart.h.

Referenced by CIFListStart(), and getNumberOfElements().

unsigned int CIFListStart::mNumberOfReservedElements [private]

The total number of elements be in this list before rearranging the file

Definition at line 62 of file CIFListStart.h.

Referenced by getNumberOfReservedElements().

---

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

• gift/libGIFTAcInvertedFile/include/CIFListStart.h
• gift/libGIFTAcInvertedFile/cc/CIFListStart.cc