C4TableGraph Class Reference

#include <C4Network2Stats.h>

Inheritance diagram for C4TableGraph:

Collaboration diagram for C4TableGraph:

Public Types
enum	{ DefaultBlockLength = 256 }
typedef float	ValueType
typedef int	TimeType

Public Member Functions
	C4TableGraph (int iBackLogLength=DefaultBlockLength, TimeType iStartTime=0)
	~C4TableGraph () override
void	Reset (TimeType iToTime)
void	SetDumpFile (StdStrBuf &szFile)
TimeType	GetStartTime () const override
TimeType	GetEndTime () const override
ValueType	GetValue (TimeType iAtTime) const override
ValueType	GetAtValue (TimeType iAtTime) const
void	SetAvgValue (TimeType iAtTime, ValueType iValue) const
ValueType	GetMedianValue (TimeType iStartTime, TimeType iEndTime) const override
ValueType	GetMinValue () const override
ValueType	GetMaxValue () const override
void	RecordValue (ValueType iValue)
virtual bool	DumpToFile (const StdStrBuf &rszFilename, bool fAppend) const
int	GetSeriesCount () const override
const C4Graph *	GetSeries (int iIndex) const override
void	SetAverageTime (int iToTime) override
void	Update () const override
void	SetMultiplier (ValueType fToVal) override
void	SetTitle (const char *szNewTitle)
void	SetColorDw (DWORD dwClr)
DWORD	GetColorDw () const
const char *	GetTitle () const

Detailed Description

Definition at line 66 of file C4Network2Stats.h.

Member Typedef Documentation

TimeType

typedef int C4Graph::TimeType

inherited

Definition at line 28 of file C4Network2Stats.h.

ValueType

typedef float C4Graph::ValueType

inherited

Definition at line 27 of file C4Network2Stats.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
DefaultBlockLength

Definition at line 86 of file C4Network2Stats.h.

{ DefaultBlockLength = 256 }; // default backlog

Constructor & Destructor Documentation

C4TableGraph()

C4TableGraph::C4TableGraph	(	int	iBackLogLength = DefaultBlockLength,
		TimeType	iStartTime = 0
	)

Definition at line 32 of file C4Network2Stats.cpp.

        : iBackLogLength(iBackLogLength), iInitialStartTime(iStartTime), iTime(iStartTime), iAveragedTime(iStartTime)
{
    // create value buffer
    assert(iBackLogLength);
    pValues = pAveragedValues = new ValueType[iBackLogLength];
    *pValues = 0;
}

~C4TableGraph()

C4TableGraph::~C4TableGraph ( )

override

Definition at line 41 of file C4Network2Stats.cpp.

{
    // flush stuff
    Reset(-1);
    // free value buffer(s)
    if (pValues != pAveragedValues) delete [] pAveragedValues;
    delete [] pValues;
}

References Reset().

Here is the call graph for this function:

Member Function Documentation

DumpToFile()

bool C4TableGraph::DumpToFile ( const StdStrBuf &  rszFilename, bool  fAppend  ) const

virtual

Definition at line 156 of file C4Network2Stats.cpp.

{
    assert(!!rszFilename);
    // nothing to write?
    if (!fWrapped && !iBackLogPos) return false;
    // try append if desired; create if unsuccessful
    CStdFile out;
    if (fAppend) if (!out.Append(rszFilename.getData())) fAppend = false;
    if (!fAppend)
    {
        if (!out.Create(rszFilename.getData())) return false;
        // print header
        out.WriteString("t\tv\n\r");
    }
    // write out current timeframe
    int iEndTime = GetEndTime();
    StdStrBuf buf;
    for (int iWriteTime = GetStartTime(); iWriteTime < iEndTime; ++iWriteTime)
    {
        buf.Format("%d\t%d\n\r", (int) iWriteTime, (int) GetValue(iWriteTime));
        out.WriteString(buf.getData());
    }
    return true;
}

References CStdFile::Append(), CStdFile::Create(), StdStrBuf::Format(), StdStrBuf::getData(), GetEndTime(), GetStartTime(), GetValue(), and CStdFile::WriteString().

Referenced by RecordValue(), and Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAtValue()

C4Graph::ValueType C4TableGraph::GetAtValue

(

TimeType

iAtTime

)

const

Definition at line 85 of file C4Network2Stats.cpp.

{
    // must be inside buffer
    assert(Inside(iAtTime, GetStartTime(), GetEndTime()-1));
    // query it - can't be negative if inside start/end-time
    return pValues[(iAtTime - iInitialStartTime) % iBackLogLength];
}

References GetEndTime(), GetStartTime(), and Inside().

Referenced by Update().

Here is the call graph for this function:

Here is the caller graph for this function:

GetColorDw()

DWORD C4Graph::GetColorDw ( ) const

inlineinherited

Definition at line 55 of file C4Network2Stats.h.

{ return dwColor; }

Referenced by C4Chart::DrawElement().

Here is the caller graph for this function:

GetEndTime()

C4Graph::TimeType C4TableGraph::GetEndTime ( ) const

overridevirtual

Implements C4Graph.

Definition at line 71 of file C4Network2Stats.cpp.

{
    // end time is current
    return iTime;
}

Referenced by DumpToFile(), GetAtValue(), GetValue(), and SetAvgValue().

Here is the caller graph for this function:

GetMaxValue()

C4Graph::ValueType C4TableGraph::GetMaxValue ( ) const

overridevirtual

Implements C4Graph.

Definition at line 126 of file C4Network2Stats.cpp.

{
    int iPos0 = iBackLogPos ? iBackLogPos-1 : iBackLogPos;
    ValueType iMaxVal = pAveragedValues[iPos0];
    int i = iPos0; ValueType *p = pAveragedValues;
    while (i--) iMaxVal = std::max(iMaxVal, *p++);
    if (fWrapped)
    {
        i = iBackLogLength - iPos0;
        while (--i) iMaxVal = std::max(iMaxVal, *++p);
    }
    return iMaxVal * fMultiplier;
}

GetMedianValue()

C4Graph::ValueType C4TableGraph::GetMedianValue ( TimeType  iStartTime, TimeType  iEndTime  ) const

overridevirtual

Implements C4Graph.

Definition at line 101 of file C4Network2Stats.cpp.

{
    assert(iStartTime < iEndTime);
    // safety: Never build median if no values are recorded
    if (!iBackLogPos && !fWrapped) return 0;
    // sum up and divide in the end - let's hope this will never be called for really large values that could overflow ValueType
    ValueType iSum = GetValue(iStartTime), iNum=1;
    for (; ++iStartTime < iEndTime; ++iNum) iSum += GetValue(iStartTime);
    return iSum / iNum;
}

References GetValue().

Here is the call graph for this function:

GetMinValue()

C4Graph::ValueType C4TableGraph::GetMinValue ( ) const

overridevirtual

Implements C4Graph.

Definition at line 112 of file C4Network2Stats.cpp.

{
    int iPos0 = iBackLogPos ? iBackLogPos-1 : iBackLogPos;
    ValueType iMinVal = pAveragedValues[iPos0];
    int i = iPos0; ValueType *p = pAveragedValues;
    while (i--) iMinVal = std::min(iMinVal, *p++);
    if (fWrapped)
    {
        i = iBackLogLength - iPos0;
        while (--i) iMinVal = std::min(iMinVal, *++p);
    }
    return iMinVal * fMultiplier;
}

GetSeries()

const C4Graph* C4TableGraph::GetSeries ( int  iIndex ) const

inlineoverridevirtual

Implements C4Graph.

Definition at line 116 of file C4Network2Stats.h.

{ return iIndex ? nullptr : this; }

GetSeriesCount()

int C4TableGraph::GetSeriesCount ( ) const

inlineoverridevirtual

Implements C4Graph.

Definition at line 115 of file C4Network2Stats.h.

{ return 1; }

GetStartTime()

C4Graph::TimeType C4TableGraph::GetStartTime ( ) const

overridevirtual

Implements C4Graph.

Definition at line 63 of file C4Network2Stats.cpp.

{
    // wrap? -> whole buffer used
    if (fWrapped) return iTime - iBackLogLength;
    // otherwise, just buffer to the start used
    return iTime - iBackLogPos;
}

Referenced by DumpToFile(), GetAtValue(), GetValue(), SetAvgValue(), and Update().

Here is the caller graph for this function:

GetTitle()

const char* C4Graph::GetTitle ( ) const

inlineinherited

Definition at line 56 of file C4Network2Stats.h.

{ return szTitle.getData(); }

References StdStrBuf::getData().

Referenced by C4Chart::DrawElement().

Here is the call graph for this function:

Here is the caller graph for this function:

GetValue()

C4Graph::ValueType C4TableGraph::GetValue ( TimeType  iAtTime ) const

overridevirtual

Implements C4Graph.

Definition at line 77 of file C4Network2Stats.cpp.

{
    // must be inside buffer
    assert(Inside(iAtTime, GetStartTime(), GetEndTime()-1));
    // query it - can't be negative if inside start/end-time
    return pAveragedValues[(iAtTime - iInitialStartTime) % iBackLogLength] * fMultiplier;
}

References GetEndTime(), GetStartTime(), and Inside().

Referenced by DumpToFile(), and GetMedianValue().

Here is the call graph for this function:

Here is the caller graph for this function:

RecordValue()

void C4TableGraph::RecordValue

(

ValueType

iValue

)

Definition at line 140 of file C4Network2Stats.cpp.

{
    // rec value
    pValues[iBackLogPos] = iValue;
    // calc time
    ++iTime;
    if (++iBackLogPos >= iBackLogLength)
    {
        // create dump before overwriting last buffer
        if (!!szDumpFile) DumpToFile(szDumpFile, fWrapped);
        // restart buffer
        fWrapped = true;
        iBackLogPos = 0;
    }
}

References DumpToFile().

Referenced by C4Network2Stats::ExecuteFrame(), and C4Network2Stats::ExecuteSecond().

Here is the call graph for this function:

Here is the caller graph for this function:

Reset()

void C4TableGraph::Reset

(

TimeType

iToTime

)

Definition at line 50 of file C4Network2Stats.cpp.

{
    // flush buffer
    if (!!szDumpFile) DumpToFile(szDumpFile, fWrapped);
    // reset stuff
    iInitialStartTime = iTime = iToTime;
    fWrapped = false;
    iBackLogPos = 0;
    *pValues = 0;
}

References DumpToFile().

Referenced by ~C4TableGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

SetAverageTime()

void C4TableGraph::SetAverageTime ( int  iToTime )

overridevirtual

Implements C4Graph.

Definition at line 181 of file C4Network2Stats.cpp.

{
    // set new time; resetting valid, averaged range
    if (iAveragedTime == iToTime) return;
    assert(iToTime > 0);
    iAvgRange = iToTime;
    iAveragedTime = iInitialStartTime;
}

SetAvgValue()

void C4TableGraph::SetAvgValue	(	TimeType	iAtTime,
		ValueType	iValue
	)		const

Definition at line 93 of file C4Network2Stats.cpp.

{
    // must be inside buffer
    assert(Inside(iAtTime, GetStartTime(), GetEndTime()-1));
    // set it - can't be negative if inside start/end-time
    pAveragedValues[(iAtTime - iInitialStartTime) % iBackLogLength] = iValue;
}

References GetEndTime(), GetStartTime(), and Inside().

Referenced by Update().

Here is the call graph for this function:

Here is the caller graph for this function:

SetColorDw()

void C4Graph::SetColorDw ( DWORD  dwClr )

inlineinherited

Definition at line 39 of file C4Network2Stats.h.

{ dwColor = dwClr; }

Referenced by C4Network2Stats::C4Network2Stats(), C4Network2Client::CreateGraphs(), and C4Player::CreateGraphs().

Here is the caller graph for this function:

SetDumpFile()

void C4TableGraph::SetDumpFile ( StdStrBuf &  szFile )

inline

Definition at line 94 of file C4Network2Stats.h.

{ szDumpFile = szFile; }

SetMultiplier()

void C4TableGraph::SetMultiplier ( ValueType  fToVal )

inlineoverridevirtual

Implements C4Graph.

Definition at line 121 of file C4Network2Stats.h.

{ fMultiplier = fToVal; }

SetTitle()

void C4Graph::SetTitle ( const char *  szNewTitle )

inlineinherited

Definition at line 38 of file C4Network2Stats.h.

{ szTitle.Copy(szNewTitle); }

References StdStrBuf::Copy().

Referenced by C4Network2Stats::C4Network2Stats(), C4Network2Client::CreateGraphs(), and C4Player::CreateGraphs().

Here is the call graph for this function:

Here is the caller graph for this function:

Update()

void C4TableGraph::Update ( ) const

overridevirtual

Reimplemented from C4Graph.

Definition at line 193 of file C4Network2Stats.cpp.

{
    // no averaging necessary?
    if (pAveragedValues == pValues)
    {
        if (iAvgRange == 1) return;
        // averaging necessary, but buffer not yet created: Create it!
        pAveragedValues = new ValueType[iBackLogLength];
    }
    // up-to-date?
    if (iAveragedTime == iTime) return;
    assert(iAveragedTime < iTime); // must not have gone back!
    // update it
    int iStartTime = GetStartTime();
#ifdef FORWARD_AVERAGE
    int iAvgFwRange = iAvgRange/FORWARD_AVERAGE_FACTOR;
#else
    int iAvgFwRange = 0;
#endif
    for (int iUpdateTime = std::max(iAveragedTime-iAvgFwRange-1, iStartTime); iUpdateTime < iTime; ++iUpdateTime)
    {
        ValueType iSum=0, iSumWeight=0, iWeight;
        for (int iSumTime = std::max(iUpdateTime - iAvgRange, iStartTime); iSumTime < std::min(iUpdateTime + iAvgFwRange+1, iTime); ++iSumTime)
        {
            iWeight = (ValueType) iAvgRange - Abs(iUpdateTime - iSumTime) + 1;
            iSum += GetAtValue(iSumTime) * iWeight;
            iSumWeight += iWeight;
        }
        SetAvgValue(iUpdateTime, iSum / iSumWeight);
    }
    // now it's all up-to-date
    iAveragedTime = iTime;
}

References Abs(), FORWARD_AVERAGE_FACTOR, GetAtValue(), GetStartTime(), and SetAvgValue().

Here is the call graph for this function:

---

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

• C4Network2Stats.h
• C4Network2Stats.cpp