OpenSim::Framework::Serialization::ArchiveConstants Class Reference

Constants for the archiving module. More...

List of all members.

Static Public Member Functions
static string	CreateOarObjectFilename (string objectName, UUID uuid, Vector3 pos)
	Create the filename used to store an object in an OpenSim Archive.
static string	CreateOarObjectPath (string objectName, UUID uuid, Vector3 pos)
	Create the path used to store an object in an OpenSim Archives.
static string	ExtractPlainPathFromIarPath (string iarPath)
	Extract a plain path from an IAR path.
Public Attributes
const string	CONTROL_FILE_PATH = "archive.xml"
const string	ASSETS_PATH = "assets/"
const string	INVENTORY_PATH = "inventory/"
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.
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.

---

Member Function Documentation

static string OpenSim::Framework::Serialization::ArchiveConstants::CreateOarObjectFilename	(	string	objectName,
		UUID	uuid,
		Vector3	pos
	)			[inline, static]

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

Parameters:

	objectName
	uuid
	pos

Returns:

static string OpenSim::Framework::Serialization::ArchiveConstants::CreateOarObjectPath	(	string	objectName,
		UUID	uuid,
		Vector3	pos
	)			[inline, static]

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

Parameters:

	objectName
	uuid
	pos

Returns:

static string OpenSim::Framework::Serialization::ArchiveConstants::ExtractPlainPathFromIarPath

(

string

iarPath

)

[inline, static]

Extract a plain path from an IAR path.

Parameters:

iarPath

Returns:

---

Member Data Documentation

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

The location of the archive control file

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

Path for the assets held in an archive

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

Path for the inventory data

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

Path for the prims file

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.

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

Path for region settings.

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

Path for region settings.

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

Path for user profiles

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

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

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

Used to separate components in an inventory node name

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.

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

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

---

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

• /home/sdague/opensim-docsgit/opensim/OpenSim/Framework/Serialization/ArchiveConstants.cs