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.IGuidContainer Interface Reference

Base interface for Guid containers, object that can store a unique identifier for a collection of object. More...

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

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. More...
 
Guid GetGuid (object obj)
 Gets the Guid for a given object, if available. 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. More...
 
bool UnregisterGuid (Guid guid)
 Removes a Guid that was previously registered. More...
 
void Clear ()
 Clear the IGuidContainer, removing everything it references. More...
 

Detailed Description

Base interface for Guid containers, object that can store a unique identifier for a collection of object.

Specialization of this interface will usually hold references on objects until they are unregistered or until the container is cleared.

Definition at line 11 of file IGuidContainer.cs.

Member Function Documentation

void SiliconStudio.Quantum.IGuidContainer.Clear ( )

Clear the IGuidContainer, removing everything it references.

Implemented in SiliconStudio.Quantum.GuidContainer.

Guid SiliconStudio.Quantum.IGuidContainer.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.

Implemented in SiliconStudio.Quantum.GuidContainer.

Guid SiliconStudio.Quantum.IGuidContainer.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.

Implemented in SiliconStudio.Quantum.GuidContainer.

void SiliconStudio.Quantum.IGuidContainer.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.

Implemented in SiliconStudio.Quantum.GuidContainer.

bool SiliconStudio.Quantum.IGuidContainer.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.

Implemented in SiliconStudio.Quantum.GuidContainer.

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