ElementsRange.h

// ElementsRange.h:
// ----------------
//

#ifndef __IPSDKBASEDATA_ELEMENTSRANGE_H__
#define __IPSDKBASEDATA_ELEMENTSRANGE_H__

#include <IPSDKBaseData/IPSDKBaseDataExports.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {


class IPSDKBASEDATA_API ElementsRange : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseData, ElementsRange)

public:
    ElementsRange();
    ElementsRange(const ipUInt64 startOffset,
                  const ipUInt64 nbElements);
    ~ElementsRange();

// methods
public:
    void            init(const ipUInt64 startOffset,
                         const ipUInt64 nbElements);
    void            setStartOffset(const ipUInt64 startOffset);
    void            setNbElements(const ipUInt64 nbElements);

    ipUInt64        getStartOffset() const;

    ipUInt64        getNbElements() const;

    ipUInt64        getEndOffset() const;

    bool            contains(const ipUInt64 index) const;

    bool            operator== (const ElementsRange& elementsRange) const;
    bool            operator!= (const ElementsRange& elementsRange) const;
    bool            operator< (const ElementsRange& elementsRange) const;

// attributes
protected:
    ipUInt64        _startOffset;

    ipUInt64        _nbElements;
};


inline void
ElementsRange::init(const ipUInt64 startOffset,
                    const ipUInt64 nbElements)
{
    _startOffset = startOffset;
    _nbElements = nbElements;
}

inline void
ElementsRange::setStartOffset(const ipUInt64 startOffset)
{
    _startOffset = startOffset;
}

inline void
ElementsRange::setNbElements(const ipUInt64 nbElements)
{
    _nbElements = nbElements;
}

inline ipUInt64
ElementsRange::getStartOffset() const
{
    return _startOffset;
}

inline ipUInt64
ElementsRange::getNbElements() const
{
    return _nbElements;
}

inline ipUInt64
ElementsRange::getEndOffset() const
{
    return _startOffset + _nbElements;
}

inline bool
ElementsRange::contains(const ipUInt64 index) const
{
    return (index >= _startOffset) &&
           (index < getEndOffset());
}


} // end of namespace ipsdk

#endif // __IPSDKBASEDATA_ELEMENTSRANGE_H__