OpenSim::Data::GridDataBase Class Reference

Inheritance diagram for OpenSim::Data::GridDataBase:

List of all members.

Public Member Functions
abstract RegionProfileData	GetProfileByHandle (ulong regionHandle)
	Returns a sim profile from a regionHandle.
abstract RegionProfileData	GetProfileByUUID (UUID UUID)
	Returns a sim profile from a UUID.
abstract RegionProfileData	GetProfileByString (string regionName)
	Returns a sim profile from a string match.
abstract RegionProfileData[]	GetProfilesInRange (uint Xmin, uint Ymin, uint Xmax, uint Ymax)
	Returns all profiles within the specified range.
abstract List< RegionProfileData >	GetRegionsByName (string namePrefix, uint maxNum)
	Returns up to maxNum profiles of regions that have a name starting with namePrefix.
abstract bool	AuthenticateSim (UUID UUID, ulong regionHandle, string simrecvkey)
	Authenticates a sim by use of its recv key. WARNING: Insecure.
abstract DataResponse	AddProfile (RegionProfileData profile)
	Adds a new profile to the database.
abstract ReservationData	GetReservationAtPoint (uint x, uint y)
	Function not used????
abstract DataResponse	UpdateProfile (RegionProfileData profile)
	Updates a profile in the database.
abstract DataResponse	DeleteProfile (string uuid)
	Remove a profile from the database.
abstract void	Initialise ()
	Default-initialises the plugin.
abstract void	Initialise (string connect)
	Initialises the interface.
abstract void	Dispose ()
Properties
abstract string	Name [get]
	Returns the plugin name.
abstract string	Version [get]
	Returns the plugin version.

---

Member Function Documentation

abstract RegionProfileData OpenSim::Data::GridDataBase::GetProfileByHandle

(

ulong

regionHandle

)

[pure virtual]

Returns a sim profile from a regionHandle.

Parameters:

regionHandle

A 64bit Region Handle

Returns:

A simprofile

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract RegionProfileData OpenSim::Data::GridDataBase::GetProfileByUUID

(

UUID

UUID

)

[pure virtual]

Returns a sim profile from a UUID.

Parameters:

UUID

A 128bit UUID

Returns:

A sim profile

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract RegionProfileData OpenSim::Data::GridDataBase::GetProfileByString

(

string

regionName

)

[pure virtual]

Returns a sim profile from a string match.

Parameters:

regionName

A string for a partial region name match

Returns:

A sim profile

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract RegionProfileData [] OpenSim::Data::GridDataBase::GetProfilesInRange	(	uint	Xmin,
		uint	Ymin,
		uint	Xmax,
		uint	Ymax
	)			[pure virtual]

Returns all profiles within the specified range.

Parameters:

	Xmin	Minimum sim coordinate (X)
	Ymin	Minimum sim coordinate (Y)
	Xmax	Maximum sim coordinate (X)
	Ymin	Maximum sim coordinate (Y)

Returns:

An array containing all the sim profiles in the specified range

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract List<RegionProfileData> OpenSim::Data::GridDataBase::GetRegionsByName	(	string	namePrefix,
		uint	maxNum
	)			[pure virtual]

Returns up to maxNum profiles of regions that have a name starting with namePrefix.

Parameters:

	name	The name to match against
	maxNum	Maximum number of profiles to return

Returns:

A list of sim profiles

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract bool OpenSim::Data::GridDataBase::AuthenticateSim	(	UUID	UUID,
		ulong	regionHandle,
		string	simrecvkey
	)			[pure virtual]

Authenticates a sim by use of its recv key. WARNING: Insecure.

Parameters:

	UUID	The UUID sent by the sim
	regionHandle	The regionhandle sent by the sim
	simrecvkey	The receiving key sent by the sim

Returns:

Whether the sim has been authenticated

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract DataResponse OpenSim::Data::GridDataBase::AddProfile

(

RegionProfileData

profile

)

[pure virtual]

Adds a new profile to the database.

Parameters:

profile

The profile to add

Returns:

RESPONSE_OK if successful, error if not.

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract ReservationData OpenSim::Data::GridDataBase::GetReservationAtPoint	(	uint	x,
		uint	y
	)			[pure virtual]

Function not used????

Parameters:

	x
	y

Returns:

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract DataResponse OpenSim::Data::GridDataBase::UpdateProfile

(

RegionProfileData

profile

)

[pure virtual]

Updates a profile in the database.

Parameters:

profile

Returns:

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract DataResponse OpenSim::Data::GridDataBase::DeleteProfile

(

string

uuid

)

[pure virtual]

Remove a profile from the database.

Parameters:

UUID

ID of profile to remove

Returns:

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract void OpenSim::Data::GridDataBase::Initialise

(

)

[pure virtual]

Default-initialises the plugin.

Implements OpenSim::Framework::IPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract void OpenSim::Data::GridDataBase::Initialise

(

string

connect

)

[pure virtual]

Initialises the interface.

Implements OpenSim::Data::IGridDataPlugin.

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract void OpenSim::Data::GridDataBase::Dispose

(

)

[pure virtual]

Implemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

---

Property Documentation

abstract string OpenSim::Data::GridDataBase::Name [get]

Returns the plugin name.

Returns:

Plugin name, eg MySQL User Provider

Implements OpenSim::Framework::IPlugin.

Reimplemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

abstract string OpenSim::Data::GridDataBase::Version [get]

Returns the plugin version.

Returns:

Plugin version in MAJOR.MINOR.REVISION.BUILD format

Implements OpenSim::Framework::IPlugin.

Reimplemented in OpenSim::Data::MSSQL::MSSQLGridData, OpenSim::Data::MySQL::MySQLGridData, and OpenSim::Data::SQLite::SQLiteGridData.

---

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

• /home/sdague/opensim-docs/OpenSim/Data/GridDataBase.cs

---