C# Class Universe.Modules.Archivers.InventoryArchiveReadRequest

Show file Open project: Virtual-Universe/Virtual-Universe Class Usage Examples

Protected Properties

Property Type Description
archive Universe.Framework.Serialization.TarArchiveReader
m_assetsIncluded bool
m_creatorIdForAssetId UUID>.Dictionary
m_merge bool
m_registry IRegistryCore

Public Methods

Method Description
AddInventoryItem ( InventoryItemBase item ) : bool
Close ( ) : void
Execute ( bool loadAll ) : HashSet

Execute the request
InventoryArchiveReadRequest ( IRegistryCore registry, UserAccount userInfo, string invPath, string loadPath, bool merge, UUID overwriteCreator ) : System
LoadControlFile ( byte data ) : void

Loads the archive.xml control file.
ReplicateArchivePathToUserInventory ( string iarPath, InventoryFolderBase rootDestFolder, InventoryFolderBase>.Dictionary &resolvedFolders, HashSet &loadedNodes ) : InventoryFolderBase

Replicate the inventory paths in the archive to the user's inventory as necessary.

Protected Methods

Method Description
CreateFoldersForPath ( InventoryFolderBase destFolder, string iarPathExisting, string iarPathToReplicate, InventoryFolderBase>.Dictionary &resolvedFolders, HashSet &loadedNodes ) : void

Create a set of folders for the given path.
LoadItem ( byte data, InventoryFolderBase loadFolder ) : InventoryItemBase

Load an item from the archive
ResolveDestinationFolder ( InventoryFolderBase rootDestFolder, string &archivePath, InventoryFolderBase>.Dictionary &resolvedFolders ) : InventoryFolderBase

Resolve a destination folder

Private Methods

Method Description
InventoryArchiveReadRequest ( ) : System
LoadAsset ( string assetPath, byte data ) : bool

Load an asset

Method Details

AddInventoryItem() public method

public AddInventoryItem ( InventoryItemBase item ) : bool
item Universe.Framework.Services.ClassHelpers.Inventory.InventoryItemBase
return bool

Close() public method

public Close ( ) : void
return void

CreateFoldersForPath() protected method

Create a set of folders for the given path.
protected CreateFoldersForPath ( InventoryFolderBase destFolder, string iarPathExisting, string iarPathToReplicate, InventoryFolderBase>.Dictionary &resolvedFolders, HashSet &loadedNodes ) : void
destFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase /// The root folder from which the creation will take place. ///
iarPathExisting string /// the part of the iar path that already exists ///
iarPathToReplicate string /// The path to replicate in the user's inventory from iar ///
resolvedFolders InventoryFolderBase>.Dictionary /// The folders that we have resolved so far for a given archive path. ///
loadedNodes HashSet /// Track the inventory nodes created. ///
return void

Execute() public method

Execute the request
public Execute ( bool loadAll ) : HashSet
loadAll bool
return HashSet

InventoryArchiveReadRequest() public method

public InventoryArchiveReadRequest ( IRegistryCore registry, UserAccount userInfo, string invPath, string loadPath, bool merge, UUID overwriteCreator ) : System
registry IRegistryCore
userInfo Universe.Framework.Services.UserAccount
invPath string
loadPath string
merge bool
overwriteCreator UUID
return System

LoadControlFile() public method

Loads the archive.xml control file.
public LoadControlFile ( byte data ) : void
data byte Data.
return void

LoadItem() protected method

Load an item from the archive
protected LoadItem ( byte data, InventoryFolderBase loadFolder ) : InventoryItemBase
data byte The raw item data
loadFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase
return Universe.Framework.Services.ClassHelpers.Inventory.InventoryItemBase

ReplicateArchivePathToUserInventory() public method

Replicate the inventory paths in the archive to the user's inventory as necessary.
public ReplicateArchivePathToUserInventory ( string iarPath, InventoryFolderBase rootDestFolder, InventoryFolderBase>.Dictionary &resolvedFolders, HashSet &loadedNodes ) : InventoryFolderBase
iarPath string The item archive path to replicate
rootDestFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase The root folder for the inventory load
resolvedFolders InventoryFolderBase>.Dictionary /// The folders that we have resolved so far for a given archive path. /// This method will add more folders if necessary ///
loadedNodes HashSet /// Track the inventory nodes created. ///
return Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase

ResolveDestinationFolder() protected method

Resolve a destination folder
protected ResolveDestinationFolder ( InventoryFolderBase rootDestFolder, string &archivePath, InventoryFolderBase>.Dictionary &resolvedFolders ) : InventoryFolderBase
rootDestFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase /// The root folder for the inventory load ///
archivePath string /// The item archive path to resolve. The portion of the path passed back is that /// which corresponds to the resolved destination folder. ///
resolvedFolders InventoryFolderBase>.Dictionary /// The folders that we have resolved so far for a given archive path. ///
return Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase

Property Details

archive protected property

protected TarArchiveReader,Universe.Framework.Serialization archive
return Universe.Framework.Serialization.TarArchiveReader

m_assetsIncluded protected property

protected bool m_assetsIncluded
return bool

m_creatorIdForAssetId protected property

Record the creator id that should be associated with an asset. This is used to adjust asset creator ids after OSP resolution (since OSP creators are only stored in the item
protected Dictionary m_creatorIdForAssetId
return UUID>.Dictionary

m_merge protected property

Do we want to merge this load with existing inventory?
protected bool m_merge
return bool

m_registry protected property

protected IRegistryCore m_registry
return IRegistryCore