struct CCL::UID

Overview

Unique Identifier class with constructor. More…

#include <uid.h>

struct UID: public Core::UIDBytes
{
    // construction

    UID (int unused = 0);
    UID (UIDRef uid);

    UID (
        uint32 data1,
        uint16 data2,
        uint16 data3,
        uint8 a,
        uint8 b,
        uint8 c,
        uint8 d,
        uint8 e,
        uint8 f,
        uint8 g,
        uint8 h
    );

    // methods

    bool generate ();
    uint32 hash () const;
    void toCString (MutableCString& cString, int format = kStandard) const;
    void toString (String& string, int format = kStandard) const;
    bool fromString (StringRef string, int format = kStandard);
    void toBuffer (UIDBuffer& buffer) const;
    bool fromBuffer (const UIDBuffer& buffer);
    void toCString (char* cString, int cStringSize, int format = kStandard) const;
};

Inherited Members

public:
    // enums

    enum Format;

    // fields

    uint32 data1;
    uint16 data2;
    uint16 data3;
    uint8 data4 [8];

    // methods

    bool isValid () const;
    bool equals (UIDRef uid) const;
    UIDBytes& prepare ();
    UIDBytes& assign (UIDRef uid);
    UIDBytes& operator = (UIDRef uid);
    bool operator == (UIDRef uid) const;
    bool operator != (UIDRef uid) const;
    void toCString (char* cString, int cStringSize, int format = kStandard) const;
    bool fromCString (CStringPtr cString, int format = kStandard);
    static CStringPtr getFormatString (int format);

Detailed Documentation

Unique Identifier class with constructor.

Methods

void toCString (char* cString, int cStringSize, int format = kStandard) const

Print UID to C-string buffer in given format.