Inheritance diagram for OpenSim.Services.GridService.GridService:

Collaboration diagram for OpenSim.Services.GridService.GridService:

Public Member Functions
	GridService (IConfigSource config)

string	RegisterRegion (UUID scopeID, GridRegion regionInfos)
	Register a region with the grid service. More...

bool	DeregisterRegion (UUID regionID)
	Deregister a region with the grid service. More...

List< GridRegion >	GetNeighbours (UUID scopeID, UUID regionID)
	Get information about the regions neighbouring the given co-ordinates (in meters). More...

GridRegion	GetRegionByUUID (UUID scopeID, UUID regionID)

GridRegion	GetRegionByPosition (UUID scopeID, int x, int y)
	Get the region at the given position (in meters) More...

GridRegion	GetRegionByName (UUID scopeID, string name)
	Get information about a region which exactly matches the name given. More...

List< GridRegion >	GetRegionsByName (UUID scopeID, string name, int maxNumber)
	Get information about regions starting with the provided name. More...

List< GridRegion >	GetRegionRange (UUID scopeID, int xmin, int xmax, int ymin, int ymax)

RegionData	RegionInfo2RegionData (GridRegion rinfo)

GridRegion	RegionData2RegionInfo (RegionData rdata)

List< GridRegion >	GetDefaultRegions (UUID scopeID)

List< GridRegion >	GetDefaultHypergridRegions (UUID scopeID)

List< GridRegion >	GetFallbackRegions (UUID scopeID, int x, int y)

List< GridRegion >	GetHyperlinks (UUID scopeID)

int	GetRegionFlags (UUID scopeID, UUID regionID)
	Get internal OpenSimulator region flags. More...

Dictionary< string, object >	GetExtraFeatures ()
	Gets the grid extra service URls we wish for the region to send in OpenSimExtras to dynamically refresh parameters in the viewer used to access services like map, search and destination guides. More...

Public Member Functions inherited from OpenSim.Services.GridService.GridServiceBase
	GridServiceBase (IConfigSource config)

Public Member Functions inherited from OpenSim.Services.Base.ServiceBase
T	LoadPlugin< T > (string dllName)

T	LoadPlugin< T > (string dllName, Object[] args)

T	LoadPlugin< T > (string dllName, string className, Object[] args)

	ServiceBase (IConfigSource config)

Protected Member Functions
GridRegion	GetHypergridRegionByName (UUID scopeID, string name)
	Get a hypergrid region. More...

Protected Attributes
IConfigSource	m_config

IAuthenticationService	m_AuthenticationService = null

bool	m_AllowDuplicateNames = false

bool	m_AllowHypergridMapSearch = false

bool	m_SuppressVarregionOverlapCheckOnRegistration = false

Protected Attributes inherited from OpenSim.Services.GridService.GridServiceBase
IRegionData	m_Database = null

Static Protected Attributes
static HypergridLinker	m_HypergridLinker

Detailed Description

Definition at line 44 of file GridService.cs.

Constructor & Destructor Documentation

OpenSim.Services.GridService.GridService.GridService ( IConfigSource config )

inline

Definition at line 65 of file GridService.cs.

Member Function Documentation

bool OpenSim.Services.GridService.GridService.DeregisterRegion ( UUID regionID )

inline

Deregister a region with the grid service.

Parameters

regionID

Returns

Exceptions

System.Exception Thrown if region deregistration failed

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 451 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetDefaultHypergridRegions ( UUID scopeID )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 682 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetDefaultRegions ( UUID scopeID )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 666 of file GridService.cs.

Dictionary<string,object> OpenSim.Services.GridService.GridService.GetExtraFeatures ( )

inline

Gets the grid extra service URls we wish for the region to send in OpenSimExtras to dynamically refresh parameters in the viewer used to access services like map, search and destination guides.

see "SimulatorFeaturesModule"

Returns: The grid extra service URls.

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 999 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetFallbackRegions	(	UUID	scopeID,
		int	x,
		int	y
	)

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 709 of file GridService.cs.

GridRegion OpenSim.Services.GridService.GridService.GetHypergridRegionByName	(	UUID	scopeID,
		string	name
	)

inlineprotected

Get a hypergrid region.

Parameters

scopeID
name

Returns: null if no hypergrid region could be found.

Definition at line 608 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetHyperlinks ( UUID scopeID )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 725 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetNeighbours	(	UUID	scopeID,
		UUID	regionID
	)

inline

Get information about the regions neighbouring the given co-ordinates (in meters).

Parameters

x
y

Returns

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 483 of file GridService.cs.

GridRegion OpenSim.Services.GridService.GridService.GetRegionByName	(	UUID	scopeID,
		string	regionName
	)

inline

Get information about a region which exactly matches the name given.

Parameters

scopeID
regionName

Returns: Returns the region information if the name matched. Null otherwise.

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 557 of file GridService.cs.

GridRegion OpenSim.Services.GridService.GridService.GetRegionByPosition	(	UUID	scopeID,
		int	x,
		int	y
	)

inline

Get the region at the given position (in meters)

Parameters

scopeID
x
y

Returns

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 535 of file GridService.cs.

GridRegion OpenSim.Services.GridService.GridService.GetRegionByUUID	(	UUID	scopeID,
		UUID	regionID
	)

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 520 of file GridService.cs.

int OpenSim.Services.GridService.GridService.GetRegionFlags	(	UUID	scopeID,
		UUID	regionID
	)

inline

Get internal OpenSimulator region flags.

See OpenSimulator.Framework.RegionFlags. These are not returned in the GridRegion structure - they currently need to be requested separately. Possibly this should change to avoid multiple service calls in some situations.

Returns: The region flags.

Parameters

scopeID
regionID

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 741 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetRegionRange	(	UUID	scopeID,
		int	xmin,
		int	xmax,
		int	ymin,
		int	ymax
	)

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 616 of file GridService.cs.

List<GridRegion> OpenSim.Services.GridService.GridService.GetRegionsByName	(	UUID	scopeID,
		string	name,
		int	maxNumber
	)

inline

Get information about regions starting with the provided name.

Parameters

name	The name to match against.
maxNumber	The maximum number of results to return.

Returns: A list of RegionInfos of regions with matching name. If the grid-server couldn't be contacted or returned an error, return null.

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 573 of file GridService.cs.

GridRegion OpenSim.Services.GridService.GridService.RegionData2RegionInfo ( RegionData rdata )

inline

Definition at line 650 of file GridService.cs.

RegionData OpenSim.Services.GridService.GridService.RegionInfo2RegionData ( GridRegion rinfo )

inline

Definition at line 635 of file GridService.cs.

string OpenSim.Services.GridService.GridService.RegisterRegion	(	UUID	scopeID,
		GridRegion	regionInfos
	)

inline

Register a region with the grid service.

Parameters

regionInfos

Returns

Exceptions

System.Exception Thrown if region registration failed

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 198 of file GridService.cs.

Member Data Documentation

bool OpenSim.Services.GridService.GridService.m_AllowDuplicateNames = false

protected

Definition at line 57 of file GridService.cs.

bool OpenSim.Services.GridService.GridService.m_AllowHypergridMapSearch = false

protected

Definition at line 58 of file GridService.cs.

IAuthenticationService OpenSim.Services.GridService.GridService.m_AuthenticationService = null

protected

Definition at line 56 of file GridService.cs.

IConfigSource OpenSim.Services.GridService.GridService.m_config

protected

Definition at line 53 of file GridService.cs.

HypergridLinker OpenSim.Services.GridService.GridService.m_HypergridLinker

staticprotected

Definition at line 54 of file GridService.cs.

bool OpenSim.Services.GridService.GridService.m_SuppressVarregionOverlapCheckOnRegistration = false

protected

Definition at line 61 of file GridService.cs.

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

Services/GridService/GridService.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation