DtUUID Class Reference

UUID is a unique ID wrapper class. More...

Inheritance diagram for DtUUID:

Public Member Functions
	DtUUID (DtUUIDOwner *=0)
	CTOR. In order to create a UUID call generateUUID.
	DtUUID (const DtUUID &, DtUUIDOwner *=0)
	DtUUID (const boost::uuids::uuid &, DtUUIDOwner *=0)
	DtUUID (const DtString &, DtUUIDOwner *=0, bool blockMarkingTextLookup=false)
	If string is a UUID (VRF_UUID:) then sets a valid UUID from the string, else will have an invalid UUID.
	DtUUID (const std::string &, DtUUIDOwner *=0, bool blockMarkingTextLookup=false)
	DtUUID (const char *, DtUUIDOwner *=0, bool blockMarkingTextLookup=false)
DtUUID &	operator= (const DtUUID &orig)
DtUUID &	operator= (const boost::uuids::uuid &orig)
bool	operator< (const DtUUID &rhs) const
bool	operator> (const DtUUID &rhs) const
virtual	~DtUUID ()
virtual void	setUUID (const DtString &, bool blockMarkingTextLookup=false)
	Sets/Gets the UUID.
virtual const DtString &	uuidString () const
virtual const char *	string () const
	Returns the markingText() of this item.
virtual void	setMarkingText (const DtString &)
	Set this marking text to be the object marking text. This will be used if there is no information in the global map.
virtual void	setStringUUID (const DtString &)
	Replaces whatever boost UUID has been created (or not) with a string UUID.
virtual void	generateUUID ()
	Generates a new UUID.
virtual void	clearUUID ()
	Clears out the UUID and restores to starting state.
bool	operator== (const DtString &) const
bool	operator== (const std::string &) const
bool	operator== (const char *) const
bool	operator== (const DtUUID &) const
bool	operator== (const DtRwUUID &) const
bool	operator!= (const DtUUID &rhs) const
bool	operator!= (const DtString &rhs) const
bool	operator!= (const DtRwUUID &rhs) const
virtual bool	isValid () const
size_t	hashValue () const
bool	isVrfUUID () const
boost::uuids::uuid	uuid () const
virtual DtString	markingText () const
	Returns the markingText that is associated with this UUID.
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface.
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType.
virtual void	init (void *userData)
	This function is called right after the object is constructed during the deserialization process, but before deserialize() is called.

Static Public Member Functions
static bool	isVrfUUID (const DtString &)
	Returns true if the UUID contains the special VRF uuid marking.
static DtString	uuidMarking ()
	The special marking text used to identify this as a VRF UUID.
static DtUUID	makeStringUUID (const DtString &)
	Make the string a UUID marking text. Basically adds uuidMarking() to the given string.
static const DtUUID &	nullUUID ()
static DtObjectIdentificationResolver &	objectIdentificationResolver ()
	Returns the class that can be used to resovle UUID to marking text and entity identifier mappings.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.
virtual boost::uuids::uuid	convertToVrfUUID (const DtString &)
virtual boost::uuids::uuid	convertStringToBoostUUID (const DtString &, bool blockMarkingTextLookup=false)
virtual const char *	convertStringToStringUUID (const char *t) const

Protected Attributes
boost::uuids::uuid	myBoostUUID
	If the assignment is not a valid boost UUID then the string UUID is what is used.
std::string	myStringUUID
bool	myIsVrfUUID
DtString	myUUIDString
DtString	myMarkingText
DtUUIDOwner *	myOwner
DtString	myLastMarkingText
	Used for string call to prevent memory from being lost when the temporary markingText() is returned.

Static Protected Attributes
static DtObjectIdentificationResolver	theObjectIdentificationResolver

Friends
class	boost::serialization::access
DtString	objectType () const
	Inherited from DtAsciiSerializable.
DtString	serialize ()
	Returns a string serialized version of this class.
bool	deserialize (const DtString &data)
	Returns true if it could fill its members with the data contained in the string.
static DtAsciiSerializable *	creator ()
	Returns a new object of this type with default values.

Detailed Description

UUID is a unique ID wrapper class.

Constructor & Destructor Documentation

DtUUID::DtUUID

(

DtUUIDOwner *

= 0

)

CTOR. In order to create a UUID call generateUUID.

DtUUID::DtUUID	(	const DtUUID &	,
		DtUUIDOwner *	= 0
	)

DtUUID::DtUUID	(	const boost::uuids::uuid &	,
		DtUUIDOwner *	= 0
	)

DtUUID::DtUUID ( const DtString &  , DtUUIDOwner *  = 0, bool  blockMarkingTextLookup = false  )

explicit

If string is a UUID (VRF_UUID:) then sets a valid UUID from the string, else will have an invalid UUID.

Check isValid after the constructor is called to see if it is a valid UUID. If blockMarkingTextLookup is true, if the string given is an object marking text (not UUID) blocks the lookup to map the marking text to the UUID and keeps the uuid as the object marking text

DtUUID::DtUUID ( const std::string &  , DtUUIDOwner *  = 0, bool  blockMarkingTextLookup = false  )

explicit

DtUUID::DtUUID ( const char *  , DtUUIDOwner *  = 0, bool  blockMarkingTextLookup = false  )

explicit

virtual DtUUID::~DtUUID ( )

virtual

Member Function Documentation

DtUUID& DtUUID::operator=

(

const DtUUID &

orig

)

DtUUID& DtUUID::operator=

(

const boost::uuids::uuid &

orig

)

bool DtUUID::operator<

(

const DtUUID &

rhs

)

const

bool DtUUID::operator>

(

const DtUUID &

rhs

)

const

static bool DtUUID::isVrfUUID ( const DtString &  )

static

Returns true if the UUID contains the special VRF uuid marking.

virtual void DtUUID::setUUID ( const DtString &  , bool  blockMarkingTextLookup = false  )

virtual

Sets/Gets the UUID.

virtual const DtString& DtUUID::uuidString ( ) const

virtual

Referenced by DtScriptedTaskVariable::serialize().

virtual const char* DtUUID::string ( ) const

virtual

Returns the markingText() of this item.

static DtString DtUUID::uuidMarking ( )

static

The special marking text used to identify this as a VRF UUID.

Attach this to any string to make this a string UUID. For example,

setUUID(DtUUID::uuidMarking() + "MyUUID");

static DtUUID DtUUID::makeStringUUID ( const DtString &  )

static

Make the string a UUID marking text. Basically adds uuidMarking() to the given string.

virtual void DtUUID::setMarkingText ( const DtString &  )

virtual

Set this marking text to be the object marking text. This will be used if there is no information in the global map.

virtual void DtUUID::setStringUUID ( const DtString &  )

virtual

Replaces whatever boost UUID has been created (or not) with a string UUID.

If the VRF_UUID: is not present will be considered marking text. Use only if you need to specifically set a UUID that is not a boost UUID

Referenced by makVrf::DtSelectionGroupManager::serialize().

virtual void DtUUID::generateUUID ( )

virtual

Generates a new UUID.

virtual void DtUUID::clearUUID ( )

virtual

Clears out the UUID and restores to starting state.

bool DtUUID::operator==

(

const DtString &

)

const

bool DtUUID::operator==

(

const std::string &

)

const

bool DtUUID::operator==

(

const char *

)

const

bool DtUUID::operator==

(

const DtUUID &

)

const

bool DtUUID::operator==

(

const DtRwUUID &

)

const

bool DtUUID::operator!= ( const DtUUID &  rhs ) const

inline

bool DtUUID::operator!= ( const DtString &  rhs ) const

inline

bool DtUUID::operator!= ( const DtRwUUID &  rhs ) const

inline

virtual bool DtUUID::isValid ( ) const

virtual

size_t DtUUID::hashValue

(

)

const

bool DtUUID::isVrfUUID ( ) const

inline

boost::uuids::uuid DtUUID::uuid ( ) const

inline

Referenced by DtTaskVisualization::taskedObject(), makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfAggregateOrbatStateListener::uuid(), and makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfEntityOrbatStateListener::uuid().

static const DtUUID& DtUUID::nullUUID ( )

static

Referenced by DtScriptVrfObject::nullObject(), and makVrf::DtSelectionGroupManager::serialize().

virtual DtString DtUUID::markingText ( ) const

virtual

Returns the markingText that is associated with this UUID.

static DtObjectIdentificationResolver& DtUUID::objectIdentificationResolver ( )

static

Returns the class that can be used to resovle UUID to marking text and entity identifier mappings.

DtString DtUUID::objectType ( ) const

virtual

Inherited from DtAsciiSerializable.

Returns "DtLocation3D"

Implements DtAsciiSerializable.

DtString DtUUID::serialize ( )

virtual

Returns a string serialized version of this class.

Implements DtAsciiSerializable.

bool DtUUID::deserialize ( const DtString &  data )

virtual

Returns true if it could fill its members with the data contained in the string.

False otherwise.

Implements DtAsciiSerializable.

static DtAsciiSerializable* DtUUID::creator ( )

static

Returns a new object of this type with default values.

template<class Archive >

void DtUUID::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

virtual boost::uuids::uuid DtUUID::convertToVrfUUID ( const DtString &  )

protectedvirtual

virtual boost::uuids::uuid DtUUID::convertStringToBoostUUID ( const DtString &  , bool  blockMarkingTextLookup = false  )

protectedvirtual

virtual const char* DtUUID::convertStringToStringUUID ( const char *  t ) const

protectedvirtual

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

boost::uuids::uuid DtUUID::myBoostUUID

mutableprotected

If the assignment is not a valid boost UUID then the string UUID is what is used.

std::string DtUUID::myStringUUID

mutableprotected

bool DtUUID::myIsVrfUUID

protected

DtString DtUUID::myUUIDString

mutableprotected

DtString DtUUID::myMarkingText

protected

DtUUIDOwner* DtUUID::myOwner

protected

DtObjectIdentificationResolver DtUUID::theObjectIdentificationResolver

staticprotected

DtString DtUUID::myLastMarkingText

mutableprotected

Used for string call to prevent memory from being lost when the temporary markingText() is returned.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwUUID.h