OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation Class Reference

Prepare to write out an archive. More...

List of all members.

Public Member Functions
	ArchiveWriteRequestPreparation (Scene scene, string savePath, Guid requestId)
	Constructor.
	ArchiveWriteRequestPreparation (Scene scene, Stream saveStream, Guid requestId)
	Constructor.
void	ArchiveRegion (Dictionary< string, object > options)
	Archive the region requested.
string	CreateControlFile (Dictionary< string, object > options)
	Create the control file for the most up to date archive.
Static Public Attributes
static int	MIN_MAJOR_VERSION = 0
	The minimum major version of OAR that we can write.
static int	MAX_MAJOR_VERSION = 0
	The maximum major version of OAR that we can write.
Protected Member Functions
	ArchiveWriteRequestPreparation (Scene scene, Guid requestId)
Protected Attributes
Scene	m_scene
Stream	m_saveStream
Guid	m_requestId
Properties
bool	SaveAssets [get, set]
	Determine whether this archive will save assets. Default is true.

---

Detailed Description

Prepare to write out an archive.

---

Constructor & Destructor Documentation

OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::ArchiveWriteRequestPreparation	(	Scene	scene,
		string	savePath,
		Guid	requestId
	)			[inline]

Constructor.

Parameters:

	scene
	savePath	The path to which to save data.
	requestId	The id associated with this request

Exceptions:

System.IO.IOException

If there was a problem opening a stream for the file specified by the savePath

OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::ArchiveWriteRequestPreparation	(	Scene	scene,
		Stream	saveStream,
		Guid	requestId
	)			[inline]

Constructor.

Parameters:

	scene
	saveStream	The stream to which to save data.
	requestId	The id associated with this request

OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::ArchiveWriteRequestPreparation	(	Scene	scene,
		Guid	requestId
	)			[inline, protected]

---

Member Function Documentation

void OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::ArchiveRegion

(

Dictionary< string, object >

options

)

[inline]

Archive the region requested.

Exceptions:

System.IO.IOException

if there was an io problem with creating the file

string OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::CreateControlFile

(

Dictionary< string, object >

options

)

[inline]

Create the control file for the most up to date archive.

Returns:

---

Member Data Documentation

int OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::MIN_MAJOR_VERSION = 0 [static]

The minimum major version of OAR that we can write.

int OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::MAX_MAJOR_VERSION = 0 [static]

The maximum major version of OAR that we can write.

Scene OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::m_scene [protected]

Stream OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::m_saveStream [protected]

Guid OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::m_requestId [protected]

---

Property Documentation

bool OpenSim::Region::CoreModules::World::Archiver::ArchiveWriteRequestPreparation::SaveAssets [get, set]

Determine whether this archive will save assets. Default is true.

---

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

• /home/sdague/opensim-docsgit/opensim/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestPreparation.cs