Arp::System::Commons::Configuration::Uuid Class Reference

This is a small immutable wrapper around the boost::uuids::uuid class and represents a universal unique id. More...

#include <Uuid.hpp>

Public Types
using	BasicUuid = boost::uuids::uuid

Public Member Functions
	Uuid (void)
	Constructs an empty (zero'ed) Uuid instance. More...
	Uuid (const Uuid &arg)=default
	Copy constructor. More...
	Uuid (Uuid &&arg)=default
	Move constructor. More...
Uuid &	operator= (const Uuid &arg)=default
	Assignment operator. More...
	~Uuid (void)=default
	Destructs this instance and frees all resources. More...
bool	IsEmpty (void) const
	Checks if this uuid is emtpy (zero'ed). More...
String	ToString (void) const
	Creates a string representation of this uuid. More...
size_t	GetHashValue (void) const
	Gets the hash value for this uuid. More...
void	Clear (void)
	Cleas this instance to an empty/zero'ed uuid. More...
void	CopyTo (byte *pBuffer) const
	Copies the binary representation to the given buffer in big endian. More...
void	CopyLittleEndianTo (byte *pBuffer) const
	Copies the binary representation to the given buffer in little endian. More...

Static Public Member Functions
static Uuid	Empty (void)
	Returns an empty (zero'ed) Uuid instance. More...
static Uuid	CreateNew (void)
	Creates a new unique id. More...
static Uuid	Create (const byte *pBuffer)
	Creates a unique id from the as argument passed binary representation in big endian. More...
static Uuid	CreateFromLittleEndian (const byte *pBuffer)
	Creates a unique id from the as argument passed binary representation in little endian. More...
static Uuid	Parse (const String &input)
	Creates a new unique id from the given input string. More...
static bool	TryParse (const String &input, Uuid &result)
	Creates a new unique id. More...

Friends
bool	operator== (const Uuid &lhs, const Uuid &rhs) noexcept
bool	operator!= (const Uuid &lhs, const Uuid &rhs) noexcept
bool	operator< (const Uuid &lhs, const Uuid &rhs) noexcept
bool	operator> (const Uuid &lhs, const Uuid &rhs) noexcept
bool	operator<= (const Uuid &lhs, const Uuid &rhs) noexcept
bool	operator>= (const Uuid &lhs, const Uuid &rhs) noexcept
std::ostream &	operator<< (std::ostream &os, const Uuid &id)
std::istream &	operator>> (std::istream &is, Uuid &id)

Detailed Description

This is a small immutable wrapper around the boost::uuids::uuid class and represents a universal unique id.

See https://www.boost.org/doc/libs/1_70_0/libs/uuid/doc/uuid.html#boost/uuid/uuid.hpp

Constructor & Destructor Documentation

Uuid() [1/3]

Arp::System::Commons::Configuration::Uuid::Uuid

(

void

)

Constructs an empty (zero'ed) Uuid instance.

Uuid() [2/3]

Arp::System::Commons::Configuration::Uuid::Uuid ( const Uuid &  arg )

default

Copy constructor.

Uuid() [3/3]

Arp::System::Commons::Configuration::Uuid::Uuid ( Uuid &&  arg )

default

Move constructor.

~Uuid()

Arp::System::Commons::Configuration::Uuid::~Uuid ( void  )

default

Destructs this instance and frees all resources.

Member Function Documentation

Clear()

void Arp::System::Commons::Configuration::Uuid::Clear

(

void

)

Cleas this instance to an empty/zero'ed uuid.

CopyLittleEndianTo()

void Arp::System::Commons::Configuration::Uuid::CopyLittleEndianTo

(

byte *

pBuffer

)

const

Copies the binary representation to the given buffer in little endian.

Parameters

pBuffer

The buffer to be filled in little endian format. The count of copied bytes is always 16, thus the as argument passed buffer should have at least a size of 16.

CopyTo()

void Arp::System::Commons::Configuration::Uuid::CopyTo

(

byte *

pBuffer

)

const

Copies the binary representation to the given buffer in big endian.

Parameters

pBuffer

The buffer to be filled in big endian format. The count of copied bytes is always 16, thus the as argument passed buffer should have at least a size of 16.

Create()

static Uuid Arp::System::Commons::Configuration::Uuid::Create ( const byte *  pBuffer )

static

Creates a unique id from the as argument passed binary representation in big endian.

CreateFromLittleEndian()

static Uuid Arp::System::Commons::Configuration::Uuid::CreateFromLittleEndian ( const byte *  pBuffer )

static

Creates a unique id from the as argument passed binary representation in little endian.

CreateNew()

static Uuid Arp::System::Commons::Configuration::Uuid::CreateNew ( void  )

static

Creates a new unique id.

Empty()

static Uuid Arp::System::Commons::Configuration::Uuid::Empty ( void  )

static

Returns an empty (zero'ed) Uuid instance.

GetHashValue()

size_t Arp::System::Commons::Configuration::Uuid::GetHashValue

(

void

)

const

Gets the hash value for this uuid.

Returns

The hash value of this uuid.

IsEmpty()

bool Arp::System::Commons::Configuration::Uuid::IsEmpty ( void  ) const

inline

Checks if this uuid is emtpy (zero'ed).

Returns

true if it is empty, otherwise false.

operator=()

Uuid& Arp::System::Commons::Configuration::Uuid::operator= ( const Uuid &  arg )

default

Assignment operator.

Parse()

static Uuid Arp::System::Commons::Configuration::Uuid::Parse ( const String &  input )

static

Creates a new unique id from the given input string.

Parameters

input

The input string to parse

Exceptions

ArgumentException

If the input string has not a valid UUID format.

The following string formats a supported xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}

ToString()

String Arp::System::Commons::Configuration::Uuid::ToString

(

void

)

const

Creates a string representation of this uuid.

Returns

A string of this uuid in the format 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'.

TryParse()

static bool Arp::System::Commons::Configuration::Uuid::TryParse ( const String &  input, Uuid &  result  )

static

Creates a new unique id.

Parameters

input	The input string to parse
result	The resulting uuid.

Returns

true on success, otherwise false.

See also

Parse

For supported formats

---

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

• Arp/System/Commons/Configuration/Uuid.hpp