ExitGames.Diagnostics.Counter.CounterBase Class Reference

The base class for counters. More...

Inheritance diagram for ExitGames.Diagnostics.Counter.CounterBase:

Public Member Functions
abstract RawCounterSample	GetNextSample ()
	Gets the next sample. More...
abstract long	Decrement ()
	Decrements the counter. More...
abstract float	GetNextValue ()
	Gets the next value. More...
abstract long	Increment ()
	Increments the counter. More...
abstract long	IncrementBy (long value)
	Increments the counter by a value. More...

Protected Member Functions
	CounterBase ()
	Initializes a new instance of the CounterBase class. More...
	CounterBase (string name)
	Initializes a new instance of the CounterBase class. More...

Properties
abstract CounterType	CounterType [get]
	Gets the type of the counter. More...
string	Name [get]
	Gets Name. More...
bool	IsValid [get, protected set]
Properties inherited from ExitGames.Diagnostics.Counter.ICounter
CounterType	CounterType [get]
	Gets the type of the counter. More...
string	Name [get]
	Gets the name of the counter. More...
bool	IsValid [get]
	Returns whether counter is valid or not For WindowsPerfCounters this method may return value whether counter exists or not More...

Detailed Description

The base class for counters.

Constructor & Destructor Documentation

CounterBase() [1/2]

ExitGames.Diagnostics.Counter.CounterBase.CounterBase ( )

inlineprotected

Initializes a new instance of the CounterBase class.

CounterBase() [2/2]

ExitGames.Diagnostics.Counter.CounterBase.CounterBase ( string  name )

inlineprotected

Initializes a new instance of the CounterBase class.

Parameters

name	The counter name.

Member Function Documentation

Decrement()

abstract long ExitGames.Diagnostics.Counter.CounterBase.Decrement ( )

pure virtual

Decrements the counter.

Returns

The decremented value.

Implements ExitGames.Diagnostics.Counter.ICounter.

Implemented in ExitGames.Diagnostics.Counter.NumericCounter, ExitGames.Diagnostics.Counter.AverageCounter, ExitGames.Diagnostics.Counter.CountsPerSecondCounter, and ExitGames.Diagnostics.Counter.DummyCounter.

GetNextSample()

abstract RawCounterSample ExitGames.Diagnostics.Counter.CounterBase.GetNextSample ( )

pure virtual

Gets the next sample.

Returns

The next sample.

Implemented in ExitGames.Diagnostics.Counter.AverageCounter, ExitGames.Diagnostics.Counter.CountsPerSecondCounter, ExitGames.Diagnostics.Counter.NumericCounter, and ExitGames.Diagnostics.Counter.DummyCounter.

GetNextValue()

abstract float ExitGames.Diagnostics.Counter.CounterBase.GetNextValue ( )

pure virtual

Gets the next value.

Returns

The next value.

Implements ExitGames.Diagnostics.Counter.ICounter.

Implemented in ExitGames.Diagnostics.Counter.NumericCounter, ExitGames.Diagnostics.Counter.AverageCounter, ExitGames.Diagnostics.Counter.CountsPerSecondCounter, and ExitGames.Diagnostics.Counter.DummyCounter.

Increment()

abstract long ExitGames.Diagnostics.Counter.CounterBase.Increment ( )

pure virtual

Increments the counter.

Returns

The incremented counter.

Implements ExitGames.Diagnostics.Counter.ICounter.

Implemented in ExitGames.Diagnostics.Counter.AverageCounter, ExitGames.Diagnostics.Counter.CountsPerSecondCounter, ExitGames.Diagnostics.Counter.NumericCounter, and ExitGames.Diagnostics.Counter.DummyCounter.

IncrementBy()

abstract long ExitGames.Diagnostics.Counter.CounterBase.IncrementBy ( long  value )

pure virtual

Increments the counter by a value.

Parameters

value

The value.

Returns

The incremented counter.

Implements ExitGames.Diagnostics.Counter.ICounter.

Implemented in ExitGames.Diagnostics.Counter.AverageCounter, ExitGames.Diagnostics.Counter.CountsPerSecondCounter, ExitGames.Diagnostics.Counter.NumericCounter, and ExitGames.Diagnostics.Counter.DummyCounter.

Property Documentation

CounterType

abstract CounterType ExitGames.Diagnostics.Counter.CounterBase.CounterType

get

Gets the type of the counter.

The type of the counter.

IsValid

bool ExitGames.Diagnostics.Counter.CounterBase.IsValid

getprotected set

Name

string ExitGames.Diagnostics.Counter.CounterBase.Name

get

Gets Name.