This is the documentation for Enlighten.

class Enlighten ProfileHistory

template<Geo::s32>
class Enlighten::ProfileHistory

A simple class for recording a history of double valued stats.

The default copy construction is usable.

Functions

Name Description
AddItem(Geo::s32, double)

Add a profile item to the history.

GetGuid()

Get the guid we relate to.

GetItem(Geo::s32)

Get the last added profile item.

GetItemAverage(Geo::s32)

Get the average of the profile items in the history.

GetItemCount(Geo::s32)

Get the number of profile items in the history.

GetItemMaximum(Geo::s32)

Get the max value of the profile items in the history.

GetItemMinimum(Geo::s32)

Get the min value of the profile items in the history.

operator<(const ProfileHistory< tNumProfileItems > &)

Less than comparison operator to allow us to sort ProfileHistory objects.

ProfileHistory()

Empty constructor.

ProfileHistory(const Geo::GeoGuid &)

Construct a history from a guid.

Reset()

Reset to empty (clear all history)

SetGuid(const Geo::GeoGuid &)

Set the guid we relate to.


void Enlighten::ProfileHistory< tNumProfileItems >::AddItem


public: void AddItem
(
    Geo::s32 item,
    double value
)


Add a profile item to the history.


const Geo::GeoGuid& Enlighten::ProfileHistory< tNumProfileItems >::GetGuid


public: const Geo::GeoGuid & GetGuid() const


Get the guid we relate to.


double Enlighten::ProfileHistory< tNumProfileItems >::GetItem


public: double GetItem
(
    Geo::s32 item
) const


Get the last added profile item.


double Enlighten::ProfileHistory< tNumProfileItems >::GetItemAverage


public: double GetItemAverage
(
    Geo::s32 item
) const


Get the average of the profile items in the history.


Geo::u64 Enlighten::ProfileHistory< tNumProfileItems >::GetItemCount


public: Geo::u64 GetItemCount
(
    Geo::s32 item
) const


Get the number of profile items in the history.


double Enlighten::ProfileHistory< tNumProfileItems >::GetItemMaximum


public: double GetItemMaximum
(
    Geo::s32 item
) const


Get the max value of the profile items in the history.


double Enlighten::ProfileHistory< tNumProfileItems >::GetItemMinimum


public: double GetItemMinimum
(
    Geo::s32 item
) const


Get the min value of the profile items in the history.


bool Enlighten::ProfileHistory< tNumProfileItems >::operator<


public: bool operator<
(
    const ProfileHistory< tNumProfileItems > & rhs
)


Less than comparison operator to allow us to sort ProfileHistory objects.


Enlighten::ProfileHistory< tNumProfileItems >::ProfileHistory


public: ProfileHistory()


Empty constructor.

You must either subsequently copy construct this object or assign a guid with SetGuid().


Enlighten::ProfileHistory< tNumProfileItems >::ProfileHistory


public: ProfileHistory
(
    const Geo::GeoGuid & systemGuid
)


Construct a history from a guid.


void Enlighten::ProfileHistory< tNumProfileItems >::Reset


public: void Reset()


Reset to empty (clear all history)


void Enlighten::ProfileHistory< tNumProfileItems >::SetGuid


public: void SetGuid
(
    const Geo::GeoGuid & g
)


Set the guid we relate to.