Holds individual statistic details More...

Inheritance diagram for OpenSim.Framework.Monitoring.Stat:

Collaboration diagram for OpenSim.Framework.Monitoring.Stat:

Public Member Functions
	Stat (string shortName, string name, string description, string unitName, string category, string container, StatType type, Action< Stat > pullAction, StatVerbosity verbosity)

	Stat (string shortName, string name, string description, string unitName, string category, string container, StatType type, MeasuresOfInterest moi, Action< Stat > pullAction, StatVerbosity verbosity)
	Constructor More...

virtual void	Dispose ()

void	RecordValue ()
	Record a value in the sample set. More...

virtual string	ToConsoleString ()

virtual OSDMap	ToBriefOSDMap ()

virtual OSDMap	ToOSDMap ()

bool	ComputeMeasuresOfInterest (out double lastChangeOverTime, out double averageChangeOverTime)

Static Public Attributes
static readonly char[]	DisallowedShortNameCharacters = { '.' }

Protected Member Functions
void	AppendMeasuresOfInterest (StringBuilder sb)

Properties
string	Category `[get, set]`
	Category of this stat (e.g. cache, scene, etc). More...

string	Container `[get, set]`
	Containing name for this stat. FIXME: In the case of a scene, this is currently the scene name (though this leaves us with a to-be-resolved problem of non-unique region names). More...

StatType	StatType `[get, set]`

MeasuresOfInterest	MeasuresOfInterest `[get, set]`

Action< Stat >	PullAction `[get, set]`
	Action used to update this stat when the value is requested if it's a pull type. More...

StatVerbosity	Verbosity `[get, set]`

string	ShortName `[get, set]`

string	Name `[get, set]`

string	Description `[get, set]`

virtual string	UnitName `[get, set]`

virtual double	Value `[get, set]`

Detailed Description

Holds individual statistic details

Definition at line 41 of file Stat.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Monitoring.Stat.Stat	(	string	shortName,
		string	name,
		string	description,
		string	unitName,
		string	category,
		string	container,
		StatType	type,
		Action< Stat >	pullAction,
		StatVerbosity	verbosity
	)

inline

Definition at line 115 of file Stat.cs.

OpenSim.Framework.Monitoring.Stat.Stat	(	string	shortName,
		string	name,
		string	description,
		string	unitName,
		string	category,
		string	container,
		StatType	type,
		MeasuresOfInterest	moi,
		Action< Stat >	pullAction,
		StatVerbosity	verbosity
	)

inline

Constructor

Parameters

shortName	Short name for the stat. Must not contain spaces. e.g. "LongFrames"
name	Human readable name for the stat. e.g. "Long frames"
description	Description of stat
unitName	Unit name for the stat. Should be preceeded by a space if the unit name isn't normally appeneded immediately to the value. e.g. " frames"
category	Category under which this stat should appear, e.g. "scene". Do not capitalize.
container	Entity to which this stat relates. e.g. scene name if this is a per scene stat.
type	Push or pull
pullAction	Pull stats need an action to update the stat on request. Push stats should set null here.
moi	Measures of interest
verbosity	Verbosity of stat. Controls whether it will appear in short stat display or only full display.

Definition at line 155 of file Stat.cs.

Member Function Documentation

void OpenSim.Framework.Monitoring.Stat.AppendMeasuresOfInterest ( StringBuilder sb )

inlineprotected

Definition at line 321 of file Stat.cs.

bool OpenSim.Framework.Monitoring.Stat.ComputeMeasuresOfInterest	(	out double	lastChangeOverTime,
		out double	averageChangeOverTime
	)

inline

Definition at line 278 of file Stat.cs.

virtual void OpenSim.Framework.Monitoring.Stat.Dispose ( )

inlinevirtual

Definition at line 200 of file Stat.cs.

void OpenSim.Framework.Monitoring.Stat.RecordValue ( )

inline

Record a value in the sample set.

Do not call this if MeasuresOfInterest.None

Definition at line 211 of file Stat.cs.

virtual OSDMap OpenSim.Framework.Monitoring.Stat.ToBriefOSDMap ( )

inlinevirtual

Definition at line 242 of file Stat.cs.

virtual string OpenSim.Framework.Monitoring.Stat.ToConsoleString ( )

inlinevirtual

Reimplemented in OpenSim.Framework.Monitoring.ServerStatsAggregator, and OpenSim.Framework.Monitoring.PercentageStat.

Definition at line 226 of file Stat.cs.

virtual OSDMap OpenSim.Framework.Monitoring.Stat.ToOSDMap ( )

inlinevirtual

Reimplemented in OpenSim.Framework.Monitoring.ServerStatsAggregator, OpenSim.Framework.Monitoring.CounterStat, and OpenSim.Framework.Monitoring.PercentageStat.

Definition at line 253 of file Stat.cs.

Member Data Documentation

readonly char [] OpenSim.Framework.Monitoring.Stat.DisallowedShortNameCharacters = { '.' }

static

Definition at line 45 of file Stat.cs.

Property Documentation

string OpenSim.Framework.Monitoring.Stat.Category

getset

Category of this stat (e.g. cache, scene, etc).

Definition at line 50 of file Stat.cs.

string OpenSim.Framework.Monitoring.Stat.Container

getset

Containing name for this stat. FIXME: In the case of a scene, this is currently the scene name (though this leaves us with a to-be-resolved problem of non-unique region names).

The container.

Definition at line 60 of file Stat.cs.

string OpenSim.Framework.Monitoring.Stat.Description

getset

Definition at line 74 of file Stat.cs.

MeasuresOfInterest OpenSim.Framework.Monitoring.Stat.MeasuresOfInterest

getset

Definition at line 64 of file Stat.cs.

string OpenSim.Framework.Monitoring.Stat.Name

getset

Definition at line 73 of file Stat.cs.

Action<Stat> OpenSim.Framework.Monitoring.Stat.PullAction

getset

Action used to update this stat when the value is requested if it's a pull type.

Definition at line 69 of file Stat.cs.

string OpenSim.Framework.Monitoring.Stat.ShortName

getset

Definition at line 72 of file Stat.cs.

StatType OpenSim.Framework.Monitoring.Stat.StatType

getset

Definition at line 62 of file Stat.cs.

virtual string OpenSim.Framework.Monitoring.Stat.UnitName

getset

Definition at line 75 of file Stat.cs.

virtual double OpenSim.Framework.Monitoring.Stat.Value

getset

Definition at line 78 of file Stat.cs.

StatVerbosity OpenSim.Framework.Monitoring.Stat.Verbosity

getset

Definition at line 71 of file Stat.cs.

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

Framework/Monitoring/Stats/Stat.cs

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation