This class provides a encapsulation of a GUID/UUID/CLSID/IID data structure (128 bit number). More...

#include <Guid.h>

Collaboration diagram for Guid:

Public Types
enum	GuidGenMethod { GuidGenDefault, GuidGenRandom, GuidGenByTime }

Public Member Functions
	Guid ()
	Standard constructor. More...

	Guid (bool assign)
	Standard constructor (With possible initialization) More...

	Guid (const char *s)
	Constructor for Guid from char*. More...

	Guid (const std::string &s)
	Constructor for Guid from string. More...

	Guid (const Guid &c)
	Copy constructor. More...

Guid &	operator= (const Guid &g)
	Assignment operator. More...

bool	operator< (const Guid &g) const
	Smaller operator. More...

bool	operator== (const Guid &g) const
	Equality operator. More...

bool	operator== (const std::string &g) const

bool	operator!= (const Guid &g) const
	Non-equality operator. More...

bool	operator!= (const std::string &g) const

const std::string	toString () const
	Automatic conversion to string representation. More...

const Guid &	fromString (const std::string &s)
	Automatic conversion from string representation. More...

unsigned int	data1 () const
	Allow accessors to member data. More...

unsigned short	data2 () const

unsigned short	data3 () const

unsigned char	data4 (unsigned int i) const

void	setData1 (unsigned int data)
	Allow modifiers for member data. More...

void	setData2 (unsigned short data)

void	setData3 (unsigned short data)

void	setData4 (unsigned char data, unsigned int i)

Static Public Member Functions
static const Guid &	null ()
	NULL-Guid: static class method. More...

static GuidGenMethod	initGuidGenMethod ()
	Checks for POOL_GUID_TIME or POOL_GUID_RANDOM env variables. More...

static void	create (Guid &guid, GuidGenMethod method=GuidGenDefault)
	Create a new Guid default method is currently Random, can be changed by param, API or environment. More...

Static Public Attributes
static const GuidGenMethod	m_guidGenMethod = Guid::initGuidGenMethod()

Private Attributes
unsigned int	m_data1

unsigned short	m_data2

unsigned short	m_data3

unsigned char	m_data4 [8]

Friends
bool	operator== (const std::string &str, const Guid &rhs)
	Equality operator. More...

bool	operator!= (const std::string &str, const Guid &rhs)
	Non-equality operator. More...

std::ostream &	operator<< (std::ostream &os, const Guid &rhs)
	Extraction operators. More...

Detailed Description

This class provides a encapsulation of a GUID/UUID/CLSID/IID data structure (128 bit number).

Definition at line 20 of file Guid.h.

Member Enumeration Documentation

◆ GuidGenMethod

enum Guid::GuidGenMethod

Enumerator
GuidGenDefault
GuidGenRandom
GuidGenByTime

Definition at line 67 of file Guid.h.

67 { GuidGenDefault, GuidGenRandom, GuidGenByTime };

Constructor & Destructor Documentation

◆ Guid() [1/5]

Guid::Guid ( )

inline

Standard constructor.

Definition at line 23 of file Guid.h.

23 : m_data1(0U), m_data2(0U), m_data3(0U), m_data4() {}

◆ Guid() [2/5]

Guid::Guid ( bool assign )

inlineexplicit

Standard constructor (With possible initialization)

Definition at line 25 of file Guid.h.

25 : Guid() { if (assign) create(*this); }

◆ Guid() [3/5]

Guid::Guid ( const char * s )

inlineexplicit

Constructor for Guid from char*.

Definition at line 27 of file Guid.h.

27 { fromString(s); }

◆ Guid() [4/5]

Guid::Guid ( const std::string & s )

inlineexplicit

Constructor for Guid from string.

Definition at line 29 of file Guid.h.

29 { fromString(s); }

◆ Guid() [5/5]

Guid::Guid ( const Guid & c )

inline

Copy constructor.

Definition at line 31 of file Guid.h.

31 { *this = c; }

Member Function Documentation

◆ create()

void Guid::create	(	Guid &	guid,
		GuidGenMethod	method = `GuidGenDefault`
	)

static

Create a new Guid default method is currently Random, can be changed by param, API or environment.

Create a new Guid.

Definition at line 33 of file Guid.cxx.

                                                   {
    uuid_t me_;
    if (method == GuidGenDefault) method = m_guidGenMethod;
    switch(method) {
     case GuidGenRandom:
       ::uuid_generate(me_);
       break;
     case GuidGenByTime:
       ::uuid_generate_time(me_);
       break;
     default:
       ::uuid_generate(me_);
       break;
    }
    unsigned int *d1 = (unsigned int*)me_;
    unsigned short *d2 = (unsigned short*)(me_ + 4);
    unsigned short *d3 = (unsigned short*)(me_ + 6);
    guid.m_data1 = *d1;
    guid.m_data2 = *d2;
    guid.m_data3 = *d3;
    for (unsigned int i = 0; i < 8; i++) {
       guid.m_data4[i] = me_[i + 8];
    }
 }

◆ data1()

unsigned int Guid::data1 ( ) const

inline

Allow accessors to member data.

Definition at line 77 of file Guid.h.

77 { return m_data1; }

◆ data2()

unsigned short Guid::data2 ( ) const

inline

Definition at line 78 of file Guid.h.

78 { return m_data2; }

◆ data3()

unsigned short Guid::data3 ( ) const

inline

Definition at line 79 of file Guid.h.

79 { return m_data3; }

◆ data4()

unsigned char Guid::data4 ( unsigned int i ) const

inline

Definition at line 80 of file Guid.h.

80 { if (i < 8) return m_data4[i]; return 0; }

◆ fromString()

const Guid & Guid::fromString ( const std::string & s )

Automatic conversion from string representation.

Definition at line 65 of file Guid.cxx.

                                                     {
    if (::sscanf(source.c_str(), fmt_Guid, &m_data1, &m_data2, &m_data3,
         &m_data4[0], &m_data4[1], &m_data4[2], &m_data4[3], &m_data4[4], &m_data4[5], &m_data4[6], &m_data4[7]) != 11) {
       m_data1 = 0U;
       m_data2 = 0U;
       m_data3 = 0U;
       for (unsigned int i = 0; i < 8; i++) {
          m_data4[i] = '\0';
       }
    }
    return *this;
 }

◆ initGuidGenMethod()

Guid::GuidGenMethod Guid::initGuidGenMethod ( )

static

Checks for POOL_GUID_TIME or POOL_GUID_RANDOM env variables.

Definition at line 24 of file Guid.cxx.

                                           {
    char* envv = getenv("POOL_GUID_TIME");
    if (envv != 0 && *envv) return GuidGenByTime;
    envv = getenv("POOL_GUID_RANDOM");
    if (envv != 0 && *envv) return GuidGenRandom;
    return GuidGenDefault;
 }

◆ null()

const Guid & Guid::null ( )

static

NULL-Guid: static class method.

Definition at line 18 of file Guid.cxx.

                        {
    return clid_null;
 }

◆ operator!=() [1/2]

bool Guid::operator!= ( const Guid & g ) const

inline

Non-equality operator.

Definition at line 57 of file Guid.h.

57 { return !(this->operator==(g)); }

◆ operator!=() [2/2]

bool Guid::operator!= ( const std::string & g ) const

inline

Definition at line 58 of file Guid.h.

58 { return !(this->operator==(g)); }

◆ operator<()

bool Guid::operator< ( const Guid & g ) const

Smaller operator.

Definition at line 78 of file Guid.cxx.

                                         {
    return ::memcmp(&g.m_data1, &m_data1, 16) < 0;
 }

◆ operator=()

Guid& Guid::operator= ( const Guid & g )

inline

Assignment operator.

Definition at line 33 of file Guid.h.

                                   {
       if (this != &g) {
          m_data1 = g.m_data1;
          m_data2 = g.m_data2;
          m_data3 = g.m_data3;
          memcpy (m_data4, g.m_data4, sizeof (m_data4));
       }
       return *this;
    }

◆ operator==() [1/2]

bool Guid::operator== ( const Guid & g ) const

inline

Equality operator.

Definition at line 45 of file Guid.h.

                                         {
       if (this != & g)  {
          if (m_data1 != g.m_data1 ) return false;
          if (m_data2 != g.m_data2 ) return false;
          if (m_data3 != g.m_data3 ) return false;
          const unsigned int* p = (const unsigned int*)m_data4, *q = (const unsigned int*)g.m_data4;
          return *p++ == *q++ && *p == *q;
       }
       return true;
    }

◆ operator==() [2/2]

bool Guid::operator== ( const std::string & g ) const

inline

Definition at line 55 of file Guid.h.

55 { return (this->toString() == g); }

◆ setData1()

void Guid::setData1 ( unsigned int data )

inline

Allow modifiers for member data.

Definition at line 83 of file Guid.h.

83 { m_data1 = data; }

◆ setData2()

void Guid::setData2 ( unsigned short data )

inline

Definition at line 84 of file Guid.h.

84 { m_data2 = data; }

◆ setData3()

void Guid::setData3 ( unsigned short data )

inline

Definition at line 85 of file Guid.h.

85 { m_data3 = data; }

◆ setData4()

void Guid::setData4	(	unsigned char	data,
		unsigned int	i
	)

inline

Definition at line 86 of file Guid.h.

86 { if (i < 8) m_data4[i] = data; }

◆ toString()

const std::string Guid::toString ( ) const

Automatic conversion to string representation.

Definition at line 58 of file Guid.cxx.

                                      {
    char text[128];
    int s = ::sprintf(text, fmt_Guid, m_data1, m_data2, m_data3,
        m_data4[0], m_data4[1], m_data4[2], m_data4[3], m_data4[4], m_data4[5], m_data4[6], m_data4[7]);
    return std::string(text, s);
 }

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const std::string &	str,
		const Guid &	rhs
	)

friend

Non-equality operator.

Definition at line 91 of file Guid.h.

91 { return !(rhs.operator==(str)); }

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const Guid &	rhs
	)

friend

Extraction operators.

Definition at line 93 of file Guid.h.

93 { os << rhs.toString(); return os; }

◆ operator==

bool operator==	(	const std::string &	str,
		const Guid &	rhs
	)

friend

Equality operator.

Definition at line 89 of file Guid.h.

89 { return (rhs.operator==(str)); }

Member Data Documentation

◆ m_data1

unsigned int Guid::m_data1

private

Definition at line 96 of file Guid.h.

◆ m_data2

unsigned short Guid::m_data2

private

Definition at line 97 of file Guid.h.

◆ m_data3

unsigned short Guid::m_data3

private

Definition at line 98 of file Guid.h.

◆ m_data4

unsigned char Guid::m_data4[8]

private

Definition at line 99 of file Guid.h.

◆ m_guidGenMethod

const Guid::GuidGenMethod Guid::m_guidGenMethod = Guid::initGuidGenMethod()

static

Definition at line 68 of file Guid.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ GuidGenMethod

Constructor & Destructor Documentation

◆ Guid() [1/5]

◆ Guid() [2/5]

◆ Guid() [3/5]

◆ Guid() [4/5]

◆ Guid() [5/5]

Member Function Documentation

◆ create()

◆ data1()

◆ data2()

◆ data3()

◆ data4()

◆ fromString()

◆ initGuidGenMethod()

◆ null()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ setData1()

◆ setData2()

◆ setData3()

◆ setData4()

◆ toString()

Friends And Related Function Documentation

◆ operator!=

◆ operator<<

◆ operator==

Member Data Documentation

◆ m_data1

◆ m_data2

◆ m_data3

◆ m_data4

◆ m_guidGenMethod