GA_RTIOffsetList.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.
 *
 * NAME:        GA_RTIOffsetList.h ( GA Library, C++)
 *
 * COMMENTS:    This is similar to GA_RangeOffset, except instead of
 *              specifying a range of offsets, we specify a list of offsets.
 */

#ifndef __GA_RTIOffsetList__
#define __GA_RTIOffsetList__

#include "GA_API.h"
#include "GA_OffsetList.h"
#include "GA_RTISingle.h"
#include "GA_Types.h"

class GA_IndexMap;
class GA_IteratorState;
class GA_Range;
class GA_RangeTypeInterface;


/// @brief Define a range based on a specific offset list
class GA_API GA_RTIOffsetList : public GA_RTISingle 
{
public:
    // Iterate over the entire range of the offset list.  If end is -1, it will
    // be set to the number of entries in the offset list.
    GA_RTIOffsetList(const GA_IndexMap &list, const GA_OffsetList &offsets,
                        GA_Size start=0, GA_Size end=-1);

    // Copy c-tor
    GA_RTIOffsetList(const GA_RTIOffsetList &src);

    ~GA_RTIOffsetList() override;

    /// @{
    /// RangeTypeInterface implementation
    GA_RangeTypeInterface       *copy() const override;
    bool        isSplittable() const override;
    bool        isEmpty() const override;
    GA_Size     getMaxEntries() const override;
    GA_Size     getEntries() const override;
    bool        split(GA_RangeTypeInterface *list[2]) const override;
    bool        isEqual(const GA_RangeTypeInterface &src) const override;
    void        iterateCopy(GA_IteratorState &dest,
                            const GA_IteratorState &src) const override;
    bool        areTraversalDeletionsSafe() const override { return true; }
    GA_Size     getPageCount() const override   { return -1; }
    bool        getPageElementRange(GA_Range &, GA_Size, GA_Size) const override
                            { return getPageElementRangeNonSplittable(); }
    GA_Offset   getFirstOffsetInPage(GA_Size) const override
                            { return getFirstOffsetInPageNonSplittable(); }
    /// @}

    /// Accessors for offset list.
    /// @{
    const GA_OffsetList &getOffsetList() const { return myOffsetList; }
    bool isFullList() const
    { return myStart == 0 && myEnd == myOffsetList.size(); }
    GA_Size getStart() const
    { return myStart; }
    GA_Size getEnd() const
    { return myEnd; }
    /// @}

    /// Rewind the iterator (i.e. reset the iterator state).  The start/offset
    /// should be initialized so that they define the first contiguous "block"
    /// for iteration.  If the range is empty, @c start should be greater than
    /// @c end
    void        iterateRewind(GA_IteratorState &state,
                        GA_Offset &start, GA_Offset &end) const override;

    /// Choose the next contiguous range.  If the iteration is complete,
    /// @c start should be set to a value greater than @c end.
    void        iterateNext(GA_IteratorState &state,
                        GA_Offset &start, GA_Offset &end) const override;

private:
    /// @{
    /// RangeTypeInterface implementation
    void        singleRewind(GA_IteratorState &state) const override;
    bool        singleGet(const GA_IteratorState &state,
                        GA_Offset &value) const override;
    void        singleNext(GA_IteratorState &state) const override;
    /// @}

    GA_OffsetList       myOffsetList;
    GA_Size             myStart, myEnd; // Range of offset list
};

#endif