kyguid.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/base/endianness.h"
#include "gwnavruntime/blob/blobtypes.h"
#include "gwnavruntime/navdata/navdatablobcategory.h"
#include <string.h>

namespace Kaim
{

class KyGuid
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
    KY_ROOT_BLOB_CLASS(NavData, KyGuid, 0)
public:
    static const KyGuid& GetDefaultGuid(); 
    static const KyGuid& GetInvalidGuid(); 

    KyGuid();

    explicit KyGuid(const char guidString[/*37*/]);

    KyGuid(const KyGuid& rhs) { *this = rhs; }

    explicit KyGuid(KyUInt8 values[16]);

    explicit KyGuid(KyUInt16 values[8]);

    explicit KyGuid(KyUInt32 values[4]);

    explicit KyGuid(KyUInt64 values[2]);

    explicit KyGuid(void* src); //will memcpy from src to &m_uuid on sizeof(m_uuid)

    KyGuid(KyUInt32 a, KyUInt32 b, KyUInt32 c, KyUInt32 d);
    void Init(KyUInt32 a, KyUInt32 b, KyUInt32 c, KyUInt32 d);

    bool operator < (const KyGuid& rhs) const { return memcmp(m_uuid, rhs.m_uuid, sizeof (m_uuid)) < 0; }
    bool operator <=(const KyGuid& rhs) const { return memcmp(m_uuid, rhs.m_uuid, sizeof (m_uuid)) <= 0; }
    bool operator > (const KyGuid& rhs) const { return !operator<=(rhs); }
    bool operator >=(const KyGuid& rhs) const { return !operator<(rhs); }
    bool operator ==(const KyGuid& rhs) const { return memcmp(m_uuid, rhs.m_uuid, sizeof (m_uuid)) == 0; }
    bool operator !=(const KyGuid& rhs) const { return !operator==(rhs); }

    KyGuid& operator = (const KyGuid& rhs) { memcpy(m_uuid, rhs.m_uuid, sizeof (m_uuid)); return *this; }

    bool IsValid() const { return *this != GetInvalidGuid(); }

    void ToString(char guidString[/*37*/]) const;

    void InitFromString(const char guidString[/*37*/]);


private:
    // set [... a, b, c, d ...] a = value_most_significant_byte d = value_least_significant_byte
    //          |
    //        idx*4     idx must be in [0..3]
    void SetUInt32(KyUInt32 idx, KyUInt32 value);

    // set [... a, b, ...] a = value_most_significant_byte d = value_least_significant_byte
    //          |
    //        idx*2     idx must be in [0..7]
    void SetUInt16(KyUInt32 idx, KyUInt16 value);

private:
    KyUInt8 m_uuid[16];
};

inline void SwapEndianness(Endianness::Target /*e*/, KyGuid& /*self*/)
{
    //no swap needed on guid
}

bool IsValidGuidString(const char guidStr[/*37*/]);

template <class OSTREAM>
inline OSTREAM& operator<<(OSTREAM& os, const KyGuid& guid)
{
    char guidString[37];
    guid.ToString(guidString);
    os << guidString;
    return os;
}


} // namespace Kaim