NetBurner 3.1
TestStateData Class Reference

This is the main object that will keep track of overall test progress and results. More...

#include <TestStateData.h>

Public Member Functions

void ResetTestData ()
 Reset to the start of a new test. More...
 
void ResetAvgData ()
 Reset to the data that tracks the average values of tests. More...
 
void UpdateBufPtr (BufferObj &bufferObj)
 Updates the current buffer pointer to the location where we are reading/writing the data. More...
 
bool ValidateDataBuffer ()
 Validates if the data buffer used to receive and send data from matches our base data buffer. More...
 
void ReportCurTestData ()
 Prints out data associated with the current test. More...
 
bool UpdateCurTestComplete ()
 Updates the data and averages associated with the overall set of tests that have been run. More...
 
void ReportTotalTestData ()
 Prints out the cumulative data for a specific test type. More...
 

Detailed Description

This is the main object that will keep track of overall test progress and results.

Member Function Documentation

◆ ReportCurTestData()

void TestStateData::ReportCurTestData ( )

Prints out data associated with the current test.

Returns
Nothing

◆ ReportTotalTestData()

void TestStateData::ReportTotalTestData ( )

Prints out the cumulative data for a specific test type.

Parameters
stateThe state that the data should be printed for
Returns
Nothing

◆ ResetAvgData()

void TestStateData::ResetAvgData ( )

Reset to the data that tracks the average values of tests.

Returns
Nothing

◆ ResetTestData()

void TestStateData::ResetTestData ( )

Reset to the start of a new test.

Parameters
fillBufferWhether to fill the buffer with random data or zero it out
testInitiatorWhether the device running is the one that initiated the tests
Returns
Nothing

◆ UpdateBufPtr()

void TestStateData::UpdateBufPtr ( BufferObj &  bufferObj)

Updates the current buffer pointer to the location where we are reading/writing the data.

Returns
Nothing

◆ UpdateCurTestComplete()

bool TestStateData::UpdateCurTestComplete ( )

Updates the data and averages associated with the overall set of tests that have been run.

Returns
True if the data buffer and the validation buffer match, and false if they do not.

◆ ValidateDataBuffer()

bool TestStateData::ValidateDataBuffer ( )

Validates if the data buffer used to receive and send data from matches our base data buffer.

Returns
True if the buffers match, and false if they do not.

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