GA_RTINull.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_RTINull.h ( GA Library, C++)
 *
 * COMMENTS:    This is like the "Python" range function.  That is, the end is
 *              non-inclusive:
 *                      GA_RTINull(list, 0, 3) = [0, 1, 2]
 */

#ifndef __GA_RTINull__
#define __GA_RTINull__

#include "GA_API.h"
#include "GA_RangeTypeInterface.h"
#include "GA_Types.h"


class GA_IndexMap;
class GA_IteratorState;
class GA_Range;


class GA_API GA_RTINull : public GA_RangeTypeInterface 
{
public:
    // Iterate over the entire range of the element list
    GA_RTINull(GA_IndexMap &list);
    GA_RTINull(const GA_IndexMap &list);

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

    ~GA_RTINull() override;

    /// @{
    /// RangeTypeInterface implementation
    GA_RangeTypeInterface       *copy() const override;
    bool        isSplittable() const override   { return true; }
    bool        isEmpty() const override                { return true; }
    GA_Size     getMaxEntries() const override  { return 0; }
    GA_Size     getEntries() const override     { return 0; }
    bool        isEqual(const GA_RangeTypeInterface &src) const override;
    void        iterateCopy(GA_IteratorState &dest,
                            const GA_IteratorState &src) const override;
    void        iterateRewind(GA_IteratorState &state,
                        GA_Offset &start, GA_Offset &end) const override;
    void        iterateNext(GA_IteratorState &state,
                        GA_Offset &start, GA_Offset &end) const override;
    bool        isOrdered() const override { return true; }
    bool        areTraversalDeletionsSafe() const override { return true; }
    bool        split(GA_RangeTypeInterface *list[2]) const override;
    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(); }
    /// @}

private:
};

#endif