Pyrogenesis  trunk
Public Member Functions | List of all members
AbstractProfileTable Class Referenceabstract

Class AbstractProfileTable: Profile table data model. More...

#include <ProfileViewer.h>

Inheritance diagram for AbstractProfileTable:
Inheritance graph
[legend]

Public Member Functions

virtual ~AbstractProfileTable ()
 
virtual CStr GetName ()=0
 GetName: Short descriptive name of this table (should be static). More...
 
virtual CStr GetTitle ()=0
 GetTitle: Longer, explanatory text (can be dynamic). More...
 
virtual size_t GetNumberRows ()=0
 GetNumberRows. More...
 
virtual const std::vector< ProfileColumn > & GetColumns ()=0
 GetColumnDescriptions. More...
 
virtual CStr GetCellText (size_t row, size_t col)=0
 GetCellText. More...
 
virtual AbstractProfileTableGetChild (size_t row)=0
 GetChild: Return a row's child table if the child is expandable. More...
 
virtual bool IsHighlightRow (size_t row)
 IsHighlightRow. More...
 

Detailed Description

Class AbstractProfileTable: Profile table data model.

Clients that wish to display debug information in the profile viewer have to implement this class and hook it into CProfileViewer.

Note that the profiling system is robust against deletion of object instances in the sense that it will automatically remove an AbstractProfileTable instance from its internal records when you delete it. Conversely, deleting an AbstractProfileTable instance is the responsibility of its creator.

Constructor & Destructor Documentation

AbstractProfileTable::~AbstractProfileTable ( )
virtual

Member Function Documentation

virtual CStr AbstractProfileTable::GetCellText ( size_t  row,
size_t  col 
)
pure virtual

GetCellText.

Parameters
rowRow index (the first row has index 0).
colColumn index (the first column has index 0).
Returns
Text to be displayed in the given cell.

Implemented in CRendererStatsTable, CProfileNodeTable, CNetStatsTable, and CScriptStatsTable.

virtual AbstractProfileTable* AbstractProfileTable::GetChild ( size_t  row)
pure virtual

GetChild: Return a row's child table if the child is expandable.

Parameters
rowRow index (the first row has index 0).
Returns
Pointer to the child table if the given row has one. Otherwise, return 0.

Implemented in CRendererStatsTable, CProfileNodeTable, CNetStatsTable, and CScriptStatsTable.

virtual const std::vector<ProfileColumn>& AbstractProfileTable::GetColumns ( )
pure virtual

GetColumnDescriptions.

Returns
A vector describing all columns of the table.

Implemented in CRendererStatsTable, CProfileNodeTable, CNetStatsTable, and CScriptStatsTable.

virtual CStr AbstractProfileTable::GetName ( )
pure virtual

GetName: Short descriptive name of this table (should be static).

Returns
Descriptive name of this table.

Implemented in CRendererStatsTable, CProfileNodeTable, CNetStatsTable, and CScriptStatsTable.

virtual size_t AbstractProfileTable::GetNumberRows ( )
pure virtual

GetNumberRows.

Returns
Number of rows in this table.

Implemented in CRendererStatsTable, CProfileNodeTable, CNetStatsTable, and CScriptStatsTable.

virtual CStr AbstractProfileTable::GetTitle ( )
pure virtual

GetTitle: Longer, explanatory text (can be dynamic).

Returns
Title for the table.

Implemented in CRendererStatsTable, CProfileNodeTable, CNetStatsTable, and CScriptStatsTable.

virtual bool AbstractProfileTable::IsHighlightRow ( size_t  row)
inlinevirtual

IsHighlightRow.

Parameters
rowRow index (the first row has index 0).
Returns
true if the row should be highlighted in a special color.

Reimplemented in CProfileNodeTable.


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