Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Public Member Functions | List of all members
SiliconStudio.Quantum.GuidContainer Class Reference

Handles Guid generation and storage for model nodes. More...

Inheritance diagram for SiliconStudio.Quantum.GuidContainer:
SiliconStudio.Quantum.IGuidContainer

Public Member Functions

Guid GetOrCreateGuid (object obj)
 Gets or or create a Guid for a given object. If the object is null, a new Guid will be returned.
Parameters
objThe object.
Returns
The Guid associated to the given object, or a newly registered Guid if the object was not previously registered.
More...
 
Guid GetGuid (object obj)
 Gets the Guid for a given object, if available.
Parameters
objThe object.
Returns
The Guid associated to the given object, or Guid.Empty if the object was not previously registered.
More...
 
void RegisterGuid (Guid guid, object obj)
 Register the given Guid to the given object. If a Guid is already associated to this object, it is replaced by the new one.
Parameters
guidThe Guid to register.
objThe object to register.
More...
 
bool UnregisterGuid (Guid guid)
 Removes a Guid that was previously registered.
Parameters
guidThe Guid to remove.
Returns
true if a Guid has been actually removed, false otherwise.
More...
 
void Clear ()
 Clear the IGuidContainer, removing everything it references. More...
 

Detailed Description

Handles Guid generation and storage for model nodes.

This class will hold references on objects until they are unregistered or until the container is cleared.

This class is thread safe.

Definition at line 14 of file GuidContainer.cs.

Member Function Documentation

void SiliconStudio.Quantum.GuidContainer.Clear ( )

Clear the IGuidContainer, removing everything it references.

Implements SiliconStudio.Quantum.IGuidContainer.

Definition at line 66 of file GuidContainer.cs.

Guid SiliconStudio.Quantum.GuidContainer.GetGuid ( object  obj)

Gets the Guid for a given object, if available.

Parameters
objThe object.
Returns
The Guid associated to the given object, or Guid.Empty if the object was not previously registered.

Implements SiliconStudio.Quantum.IGuidContainer.

Definition at line 35 of file GuidContainer.cs.

Guid SiliconStudio.Quantum.GuidContainer.GetOrCreateGuid ( object  obj)

Gets or or create a Guid for a given object. If the object is null, a new Guid will be returned.

Parameters
objThe object.
Returns
The Guid associated to the given object, or a newly registered Guid if the object was not previously registered.

Implements SiliconStudio.Quantum.IGuidContainer.

Definition at line 19 of file GuidContainer.cs.

void SiliconStudio.Quantum.GuidContainer.RegisterGuid ( Guid  guid,
object  obj 
)

Register the given Guid to the given object. If a Guid is already associated to this object, it is replaced by the new one.

Parameters
guidThe Guid to register.
objThe object to register.

Implements SiliconStudio.Quantum.IGuidContainer.

Definition at line 45 of file GuidContainer.cs.

bool SiliconStudio.Quantum.GuidContainer.UnregisterGuid ( Guid  guid)

Removes a Guid that was previously registered.

Parameters
guidThe Guid to remove.
Returns
true if a Guid has been actually removed, false otherwise.

Implements SiliconStudio.Quantum.IGuidContainer.

Definition at line 56 of file GuidContainer.cs.

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