GB/GB_GenericDataIndex.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      George ElKoura
 *      Side Effects Software, Inc.
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GB_GenericData.h (C++)
 *
 * COMMENTS:
 *
 * This class represents an index for accessing data stored in a vector.
 * It abstracts away access to sparse representation of vectors as might
 * be found with GB_ATTRIB_INFO_INDEX_PAIR.
 *
 * The intended use of GB_GenericDataIndex is as follows:
 *
 *          
 *      GB_GenericData      data;
 *      ...
 *      GB_GenericDataIndex index = data.beginIterator();
 *      while (index.isValid())
 *      {
 *          index.setF(val)     // do some operation
 *          ++index;
 *      }
 *
 */
#ifndef __GB_GenericDataIndex_h__
#define __GB_GenericDataIndex_h__
#include "GB_API.h"
#include <SYS/SYS_Types.h>

class GB_GenericData;

class GB_API GB_GenericDataIndex
{
public:
    /// Returns true if this index represents a valid index in the data and
    /// false otherwise.
    bool            isValid() const;

    /// Increment to the next index
    const GB_GenericDataIndex &operator++() const;
    GB_GenericDataIndex       &operator++();

    /// Data accessors
    void                     setF(fpreal val);
    fpreal                   getF() const;

    void                     setI(int val);
    int                      getI() const;

private:

    GB_GenericDataIndex(GB_GenericData &data, int real_index, bool is_sparse): 
        myRealIndex(real_index), 
        myData(data),
        myIsSparse(is_sparse),
        myIsReadOnly(false)         {}

    GB_GenericDataIndex(const GB_GenericData &data, int real_index, 
                        bool is_sparse) :
        myRealIndex(real_index),
        myData((GB_GenericData &)data),
        myIsSparse(is_sparse),
        myIsReadOnly(true)          {}

    GB_GenericDataIndex(const GB_GenericDataIndex &d) :
        myRealIndex(d.myRealIndex),
        myData(d.myData),
        myIsSparse(d.myIsSparse),
        myIsReadOnly(d.myIsReadOnly){}
    


    /// This stores the real index of the data (data[myRealIndex+1] contains
    /// the index corresponding to that data.
    mutable int      myRealIndex;

    /// The data along which we are iterating
    GB_GenericData  &myData;

    /// A flag to say whether we are indexing into a sparse representation
    /// or a flat vector of data.
    bool             myIsSparse;

    bool             myIsReadOnly;

    friend class GB_GenericData;
};

#endif

---