OpenSim.Framework.DAMap Class Reference

This class stores and retrieves dynamic attributes. More...

Inheritance diagram for OpenSim.Framework.DAMap:

Collaboration diagram for OpenSim.Framework.DAMap:

Public Member Functions
XmlSchema	GetSchema ()
void	ReadXml (XmlReader reader)
void	ReadXml (string rawXml)
void	WriteXml (XmlWriter writer)
string	ToXml ()
void	CopyFrom (DAMap other)
OSDMap	GetStore (string ns, string storeName)
	Retrieve a Dynamic Attribute store More...
void	SetStore (string ns, string storeName, OSDMap store)
	Saves a Dynamic attribute store More...
bool	ContainsStore (string ns, string storeName)
bool	TryGetStore (string ns, string storeName, out OSDMap store)
void	Clear ()
bool	RemoveStore (string ns, string storeName)

Static Public Member Functions
static DAMap	FromXml (string rawXml)
static void	SanitiseMap (DAMap daMap)
	Sanitise the map to remove any namespaces or stores that are not OSDMap. More...
static void	ValidateNamespace (string ns)
	Validate the key used for storing separate data stores. More...

Properties
OSDMap	TopLevelMap [get, set]
int	CountNamespaces [get]
	Get the number of namespaces More...
int	CountStores [get]
	Get the number of stores. More...

Detailed Description

This class stores and retrieves dynamic attributes.

Modules that want to use dynamic attributes need to do so in a private data store which is accessed using a unique name. DAMap provides access to the data stores, each of which is an OSDMap. Modules are free to store any type of data they want within their data store. However, avoid storing large amounts of data because that would slow down database access.

Definition at line 53 of file DAMap.cs.

Member Function Documentation

void OpenSim.Framework.DAMap.Clear ( )

inline

Definition at line 302 of file DAMap.cs.

bool OpenSim.Framework.DAMap.ContainsStore ( string  ns, string  storeName  )

inline

Definition at line 266 of file DAMap.cs.

void OpenSim.Framework.DAMap.CopyFrom ( DAMap  other )

inline

Definition at line 104 of file DAMap.cs.

static DAMap OpenSim.Framework.DAMap.FromXml ( string  rawXml )

inlinestatic

Definition at line 70 of file DAMap.cs.

XmlSchema OpenSim.Framework.DAMap.GetSchema ( )

inline

Definition at line 68 of file DAMap.cs.

OSDMap OpenSim.Framework.DAMap.GetStore ( string  ns, string  storeName  )

inline

Retrieve a Dynamic Attribute store

Parameters

ns	namespace for the store - use "OpenSim" for in-core modules
storeName	name of the store within the namespace

Returns

an OSDMap representing the stored data, or null if not found

Definition at line 212 of file DAMap.cs.

void OpenSim.Framework.DAMap.ReadXml ( XmlReader  reader )

inline

Definition at line 77 of file DAMap.cs.

void OpenSim.Framework.DAMap.ReadXml ( string  rawXml )

inline

Definition at line 82 of file DAMap.cs.

bool OpenSim.Framework.DAMap.RemoveStore ( string  ns, string  storeName  )

inline

Definition at line 308 of file DAMap.cs.

static void OpenSim.Framework.DAMap.SanitiseMap ( DAMap  daMap )

inlinestatic

Sanitise the map to remove any namespaces or stores that are not OSDMap.

Parameters

map

Definition at line 131 of file DAMap.cs.

void OpenSim.Framework.DAMap.SetStore ( string  ns, string  storeName, OSDMap  store  )

inline

Saves a Dynamic attribute store

Parameters

ns	namespace for the store - use "OpenSim" for in-core modules
storeName	name of the store within the namespace
store	an OSDMap representing the data to store

Definition at line 236 of file DAMap.cs.

string OpenSim.Framework.DAMap.ToXml ( )

inline

Definition at line 98 of file DAMap.cs.

bool OpenSim.Framework.DAMap.TryGetStore ( string  ns, string  storeName, out OSDMap  store  )

inline

Definition at line 281 of file DAMap.cs.

Here is the caller graph for this function:

static void OpenSim.Framework.DAMap.ValidateNamespace ( string  ns )

inlinestatic

Validate the key used for storing separate data stores.

Parameters

key

Definition at line 260 of file DAMap.cs.

void OpenSim.Framework.DAMap.WriteXml ( XmlWriter  writer )

inline

Definition at line 93 of file DAMap.cs.

Property Documentation

int OpenSim.Framework.DAMap.CountNamespaces

get

Get the number of namespaces

Definition at line 183 of file DAMap.cs.

int OpenSim.Framework.DAMap.CountStores

get

Get the number of stores.

Definition at line 189 of file DAMap.cs.

OSDMap OpenSim.Framework.DAMap.TopLevelMap

getset

Definition at line 63 of file DAMap.cs.

---

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

• Framework/DAMap.cs