CWE-ou-minkata/Sources/Plasma/PubUtilLib/plResMgr/plPageInfo.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////////////
//
//  plPageInfo - Pack of info about an individual page
//

#ifndef _plPageInfo_h
#define _plPageInfo_h

#include "HeadSpin.h"
#include "pnKeyedObject/plUoid.h"
#include <vector>

class hsStream;
class plLocation;
class plString;

class plPageInfo
{
public:
    struct ClassVersion { uint16_t Class; uint16_t Version; };
    typedef std::vector<ClassVersion> ClassVerVec;

protected:
    plLocation  fLocation;
    plString    fAge;
    plString    fPage;
    uint16_t    fMajorVersion;
    ClassVerVec fClassVersions;
    uint32_t    fChecksum;
    uint32_t    fDataStart, fIndexStart;

    void        IInit( void );
    void        ISetFrom( const plPageInfo &src );

public:

    plPageInfo();
    plPageInfo( const plLocation &loc );
    plPageInfo( const plPageInfo &src );
    virtual ~plPageInfo();

    const plString& GetAge() const  { return fAge; }
    const plString& GetPage() const { return fPage; }

    plPageInfo &operator=( const plPageInfo &src );

    void                ClearClassVersions() { fClassVersions.clear(); }
    void                AddClassVersion(uint16_t classIdx, uint16_t version);
    const ClassVerVec&  GetClassVersions() const { return fClassVersions; }

    void SetStrings(const plString& age, const plString& page);

    void                SetLocation(const plLocation& loc);
    const plLocation&   GetLocation() const { return fLocation; }

    uint16_t  GetMajorVersion() const { return fMajorVersion; }
    void    SetMajorVersion(uint16_t major) { fMajorVersion = major; }

    void    SetChecksum( uint32_t c ) { fChecksum = c; }
    uint32_t  GetChecksum( void ) const { return fChecksum; }

    void    Read( hsStream *s );
    void    Write( hsStream *s );

    bool    IsValid( void ) const;

    uint32_t  GetDataStart( void ) const { return fDataStart; }
    void    SetDataStart( uint32_t s ) { fDataStart = s; }

    uint32_t  GetIndexStart( void ) const { return fIndexStart; }
    void    SetIndexStart( uint32_t s ) { fIndexStart = s; }
};
#endif // _plPageInfo_h