Photon Server API
Public Member Functions | Properties | List of all members
ExitGames.Diagnostics.Counter.NumericCounter Class Reference

A numeric counter. More...

Inheritance diagram for ExitGames.Diagnostics.Counter.NumericCounter:
ExitGames.Diagnostics.Counter.CounterBase ExitGames.Diagnostics.Counter.ICounter

Public Member Functions

 NumericCounter ()
 Initializes a new instance of the NumericCounter class. More...
 
 NumericCounter (string name)
 Initializes a new instance of the NumericCounter class. More...
 
override RawCounterSample GetNextSample ()
 Gets the next sample. More...
 
override long Decrement ()
 Decrements the counter by one. More...
 
override float GetNextValue ()
 Gets the next value. More...
 
override long Increment ()
 Increments the counter by one and returns the new value. More...
 
override long IncrementBy (long value)
 Increments the counter by a given value. More...
 

Properties

override CounterType CounterType [get]
 Gets the type of the counter. More...
 
long RawValue [get, set]
 Gets or sets RawValue. More...
 
- Properties inherited from ExitGames.Diagnostics.Counter.CounterBase
abstract CounterType CounterType [get]
 Gets the type of the counter. More...
 
string Name [get]
 Gets Name. More...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from ExitGames.Diagnostics.Counter.CounterBase
 CounterBase ()
 Initializes a new instance of the CounterBase class. More...
 
 CounterBase (string name)
 Initializes a new instance of the CounterBase class. More...
 

Detailed Description

A numeric counter.

Constructor & Destructor Documentation

ExitGames.Diagnostics.Counter.NumericCounter.NumericCounter ( )
inline

Initializes a new instance of the NumericCounter class.

ExitGames.Diagnostics.Counter.NumericCounter.NumericCounter ( string  name)
inline

Initializes a new instance of the NumericCounter class.

Parameters
nameThe name.

Member Function Documentation

override long ExitGames.Diagnostics.Counter.NumericCounter.Decrement ( )
inlinevirtual

Decrements the counter by one.

Returns
The decremented value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

override RawCounterSample ExitGames.Diagnostics.Counter.NumericCounter.GetNextSample ( )
inlinevirtual

Gets the next sample.

Returns
A new RawCounterSample.

Implements ExitGames.Diagnostics.Counter.CounterBase.

override float ExitGames.Diagnostics.Counter.NumericCounter.GetNextValue ( )
inlinevirtual

Gets the next value.

Returns
The get next value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

override long ExitGames.Diagnostics.Counter.NumericCounter.Increment ( )
inlinevirtual

Increments the counter by one and returns the new value.

Returns
The incremented value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

override long ExitGames.Diagnostics.Counter.NumericCounter.IncrementBy ( long  value)
inlinevirtual

Increments the counter by a given value.

Parameters
valueThe value to be added to the counter.
Returns
The incremented value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

Property Documentation

override CounterType ExitGames.Diagnostics.Counter.NumericCounter.CounterType
get

Gets the type of the counter.

The type of the counter.

long ExitGames.Diagnostics.Counter.NumericCounter.RawValue
getset

Gets or sets RawValue.