OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
OpenSim.Framework.Serialization.ArchiveConstants Class Reference

Constants for the archiving module More...

Static Public Member Functions

static string CreateOarLandDataPath (LandData ld)
 
static string CreateOarObjectFilename (string objectName, UUID uuid, Vector3 pos)
 Create the filename used to store an object in an OpenSim Archive. More...
 
static string CreateOarObjectPath (string objectName, UUID uuid, Vector3 pos)
 Create the path used to store an object in an OpenSim Archives. More...
 
static string ExtractPlainPathFromIarPath (string iarPath)
 Extract a plain path from an IAR path More...
 

Public Attributes

const string CONTROL_FILE_PATH = "archive.xml"
 
const string ASSETS_PATH = "assets/"
 
const string INVENTORY_PATH = "inventory/"
 
const string REGIONS_PATH = "regions/"
 
const string OBJECTS_PATH = "objects/"
 
const string TERRAINS_PATH = "terrains/"
 
const string SETTINGS_PATH = "settings/"
 
const string LANDDATA_PATH = "landdata/"
 
const string USERS_PATH = "userprofiles/"
 
const string ASSET_EXTENSION_SEPARATOR = "_"
 
const string INVENTORY_NODE_NAME_COMPONENT_SEPARATOR = "__"
 
const string OAR_OBJECT_FILENAME_TEMPLATE = "{0}_{1:000}-{2:000}-{3:000}__{4}.xml"
 Template used for creating filenames in OpenSim Archives. More...
 

Static Public Attributes

static readonly IDictionary
< sbyte, string > 
ASSET_TYPE_TO_EXTENSION = new Dictionary<sbyte, string>()
 
static readonly IDictionary
< string, sbyte > 
EXTENSION_TO_ASSET_TYPE = new Dictionary<string, sbyte>()
 

Detailed Description

Constants for the archiving module

Definition at line 39 of file ArchiveConstants.cs.

Member Function Documentation

static string OpenSim.Framework.Serialization.ArchiveConstants.CreateOarLandDataPath ( LandData  ld)
inlinestatic

Definition at line 152 of file ArchiveConstants.cs.

static string OpenSim.Framework.Serialization.ArchiveConstants.CreateOarObjectFilename ( string  objectName,
UUID  uuid,
Vector3  pos 
)
inlinestatic

Create the filename used to store an object in an OpenSim Archive.

Parameters
objectName
uuid
pos
Returns

Definition at line 164 of file ArchiveConstants.cs.

static string OpenSim.Framework.Serialization.ArchiveConstants.CreateOarObjectPath ( string  objectName,
UUID  uuid,
Vector3  pos 
)
inlinestatic

Create the path used to store an object in an OpenSim Archives.

Parameters
objectName
uuid
pos
Returns

Definition at line 179 of file ArchiveConstants.cs.

static string OpenSim.Framework.Serialization.ArchiveConstants.ExtractPlainPathFromIarPath ( string  iarPath)
inlinestatic

Extract a plain path from an IAR path

Parameters
iarPath
Returns

Definition at line 189 of file ArchiveConstants.cs.

Member Data Documentation

const string OpenSim.Framework.Serialization.ArchiveConstants.ASSET_EXTENSION_SEPARATOR = "_"

The character the separates the uuid from extension information in an archived asset filename

Definition at line 89 of file ArchiveConstants.cs.

readonly IDictionary<sbyte, string> OpenSim.Framework.Serialization.ArchiveConstants.ASSET_TYPE_TO_EXTENSION = new Dictionary<sbyte, string>()
static

Extensions used for asset types in the archive

Definition at line 104 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.ASSETS_PATH = "assets/"

Path for the assets held in an archive

Definition at line 49 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.CONTROL_FILE_PATH = "archive.xml"

The location of the archive control file

Definition at line 44 of file ArchiveConstants.cs.

readonly IDictionary<string, sbyte> OpenSim.Framework.Serialization.ArchiveConstants.EXTENSION_TO_ASSET_TYPE = new Dictionary<string, sbyte>()
static

Definition at line 105 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.INVENTORY_NODE_NAME_COMPONENT_SEPARATOR = "__"

Used to separate components in an inventory node name

Definition at line 94 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.INVENTORY_PATH = "inventory/"

Path for the inventory data

Definition at line 54 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.LANDDATA_PATH = "landdata/"

Path for region settings.

Definition at line 79 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.OAR_OBJECT_FILENAME_TEMPLATE = "{0}_{1:000}-{2:000}-{3:000}__{4}.xml"

Template used for creating filenames in OpenSim Archives.

Definition at line 99 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.OBJECTS_PATH = "objects/"

Path for the prims file

Definition at line 64 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.REGIONS_PATH = "regions/"

Path for regions in a multi-region archive

Definition at line 59 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.SETTINGS_PATH = "settings/"

Path for region settings.

Definition at line 74 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.TERRAINS_PATH = "terrains/"

Path for terrains. Technically these may be assets, but I think it's quite nice to split them out.

Definition at line 69 of file ArchiveConstants.cs.

const string OpenSim.Framework.Serialization.ArchiveConstants.USERS_PATH = "userprofiles/"

Path for user profiles

Definition at line 84 of file ArchiveConstants.cs.


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