OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Protected Attributes | Properties | List of all members
OpenSim.Services.Interfaces.GridRegion Class Reference

Public Member Functions

 GridRegion ()
 
 GridRegion (uint xcell, uint ycell)
 
 GridRegion (RegionInfo ConvertFrom)
 
 GridRegion (GridRegion ConvertFrom)
 
 GridRegion (Dictionary< string, object > kvp)
 
Dictionary< string, object > ToKeyValuePairs ()
 
bool Equals (GridRegion region)
 Define equality as two regions having the same, non-zero UUID. More...
 
override bool Equals (Object obj)
 
override int GetHashCode ()
 

Public Attributes

UUID RegionID = UUID.Zero
 
UUID ScopeID = UUID.Zero
 
UUID TerrainImage = UUID.Zero
 
UUID ParcelImage = UUID.Zero
 
byte Access
 
int Maturity
 
string RegionSecret = string.Empty
 
string Token = string.Empty
 

Protected Attributes

string m_serverURI
 
string m_regionName = String.Empty
 
string m_externalHostName
 
IPEndPoint m_internalEndPoint
 
int m_regionLocX
 
int m_regionLocY
 
UUID m_estateOwner
 

Properties

uint HttpPort [get, set]
 The port by which http communication occurs with the region More...
 
string ServerURI [get, set]
 A well-formed URI for the host region server (namely "http://" + ExternalHostName) More...
 
string RawServerURI [get, set]
 Provides direct access to the 'm_serverURI' field, without returning a generated URL if m_serverURI is missing. More...
 
string RegionName [get, set]
 
OpenSim.Framework.RegionFlags RegionFlags [get, set]
 Region flags. More...
 
int RegionCoordX [get]
 The co-ordinate of this region in region units. More...
 
int RegionCoordY [get]
 The co-ordinate of this region in region units More...
 
int RegionLocX [get, set]
 The location of this region in meters. DANGER DANGER! Note that this name means something different in RegionInfo. More...
 
int RegionSizeX [get, set]
 
int RegionSizeY [get, set]
 
int RegionLocY [get, set]
 The location of this region in meters. DANGER DANGER! Note that this name means something different in RegionInfo. More...
 
UUID EstateOwner [get, set]
 
IPEndPoint ExternalEndPoint [get]
 
string ExternalHostName [get, set]
 
IPEndPoint InternalEndPoint [get, set]
 
ulong RegionHandle [get]
 

Detailed Description

Definition at line 133 of file IGridService.cs.

Constructor & Destructor Documentation

OpenSim.Services.Interfaces.GridRegion.GridRegion ( )
inline

Definition at line 267 of file IGridService.cs.

OpenSim.Services.Interfaces.GridRegion.GridRegion ( uint  xcell,
uint  ycell 
)
inline

Definition at line 299 of file IGridService.cs.

OpenSim.Services.Interfaces.GridRegion.GridRegion ( RegionInfo  ConvertFrom)
inline

Definition at line 307 of file IGridService.cs.

OpenSim.Services.Interfaces.GridRegion.GridRegion ( GridRegion  ConvertFrom)
inline

Definition at line 327 of file IGridService.cs.

OpenSim.Services.Interfaces.GridRegion.GridRegion ( Dictionary< string, object >  kvp)
inline

Definition at line 348 of file IGridService.cs.

Member Function Documentation

bool OpenSim.Services.Interfaces.GridRegion.Equals ( GridRegion  region)
inline

Define equality as two regions having the same, non-zero UUID.

Definition at line 461 of file IGridService.cs.

override bool OpenSim.Services.Interfaces.GridRegion.Equals ( Object  obj)
inline

Definition at line 469 of file IGridService.cs.

override int OpenSim.Services.Interfaces.GridRegion.GetHashCode ( )
inline

Definition at line 476 of file IGridService.cs.

Dictionary<string, object> OpenSim.Services.Interfaces.GridRegion.ToKeyValuePairs ( )
inline

Definition at line 428 of file IGridService.cs.

Member Data Documentation

byte OpenSim.Services.Interfaces.GridRegion.Access

Definition at line 262 of file IGridService.cs.

UUID OpenSim.Services.Interfaces.GridRegion.m_estateOwner
protected

Definition at line 249 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.m_externalHostName
protected

Definition at line 210 of file IGridService.cs.

IPEndPoint OpenSim.Services.Interfaces.GridRegion.m_internalEndPoint
protected

Definition at line 212 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.m_regionLocX
protected

Definition at line 233 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.m_regionLocY
protected

Definition at line 247 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.m_regionName = String.Empty
protected

Definition at line 197 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.m_serverURI
protected

Definition at line 180 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.Maturity

Definition at line 263 of file IGridService.cs.

UUID OpenSim.Services.Interfaces.GridRegion.ParcelImage = UUID.Zero

Definition at line 261 of file IGridService.cs.

UUID OpenSim.Services.Interfaces.GridRegion.RegionID = UUID.Zero

Definition at line 257 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.RegionSecret = string.Empty

Definition at line 264 of file IGridService.cs.

UUID OpenSim.Services.Interfaces.GridRegion.ScopeID = UUID.Zero

Definition at line 258 of file IGridService.cs.

UUID OpenSim.Services.Interfaces.GridRegion.TerrainImage = UUID.Zero

Definition at line 260 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.Token = string.Empty

Definition at line 265 of file IGridService.cs.

Property Documentation

UUID OpenSim.Services.Interfaces.GridRegion.EstateOwner
getset

Definition at line 252 of file IGridService.cs.

IPEndPoint OpenSim.Services.Interfaces.GridRegion.ExternalEndPoint
get

This accessor can throw all the exceptions that Dns.GetHostAddresses can throw.

XXX Isn't this really doing too much to be a simple getter, rather than an explict method?

Definition at line 489 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.ExternalHostName
getset

Definition at line 532 of file IGridService.cs.

uint OpenSim.Services.Interfaces.GridRegion.HttpPort
getset

The port by which http communication occurs with the region

Definition at line 144 of file IGridService.cs.

IPEndPoint OpenSim.Services.Interfaces.GridRegion.InternalEndPoint
getset

Definition at line 538 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.RawServerURI
getset

Provides direct access to the 'm_serverURI' field, without returning a generated URL if m_serverURI is missing.

Definition at line 186 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.RegionCoordX
get

The co-ordinate of this region in region units.

Definition at line 217 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.RegionCoordY
get

The co-ordinate of this region in region units

Definition at line 222 of file IGridService.cs.

OpenSim.Framework.RegionFlags OpenSim.Services.Interfaces.GridRegion.RegionFlags
getset

Region flags.

If not set (chiefly if a robust service is running code pre OpenSim 0.8.1) then this will be null and should be ignored. If you require flags information please use the separate IGridService.GetRegionFlags() call XXX: This field is currently ignored when used in RegisterRegion, but could potentially be used to set flags at this point.

Definition at line 208 of file IGridService.cs.

ulong OpenSim.Services.Interfaces.GridRegion.RegionHandle
get

Definition at line 544 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.RegionLocX
getset

The location of this region in meters. DANGER DANGER! Note that this name means something different in RegionInfo.

Definition at line 229 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.RegionLocY
getset

The location of this region in meters. DANGER DANGER! Note that this name means something different in RegionInfo.

Definition at line 243 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.RegionName
getset

Definition at line 193 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.RegionSizeX
getset

Definition at line 235 of file IGridService.cs.

int OpenSim.Services.Interfaces.GridRegion.RegionSizeY
getset

Definition at line 236 of file IGridService.cs.

string OpenSim.Services.Interfaces.GridRegion.ServerURI
getset

A well-formed URI for the host region server (namely "http://" + ExternalHostName)

Definition at line 150 of file IGridService.cs.


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