Pyrogenesis  trunk
Classes | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
CProfileNodeTable Class Reference

Class CProfileNodeTable: Implement ProfileViewer's AbstractProfileTable interface in order to display profiling data in-game. More...

Inheritance diagram for CProfileNodeTable:
Inheritance graph
[legend]
Collaboration diagram for CProfileNodeTable:
Collaboration graph
[legend]

Classes

struct  ColumnDescription
 struct ColumnDescription: The only purpose of this helper structure is to provide the global constructor that sets up the column description. More...
 

Public Member Functions

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

Private Attributes

CProfileNodenode
 The node represented by this table. More...
 

Static Private Attributes

static ColumnDescription columnDescription
 Columns description (shared by all instances) More...
 

Detailed Description

Class CProfileNodeTable: Implement ProfileViewer's AbstractProfileTable interface in order to display profiling data in-game.

Constructor & Destructor Documentation

CProfileNodeTable::CProfileNodeTable ( CProfileNode n)
CProfileNodeTable::~CProfileNodeTable ( )
virtual

Member Function Documentation

CStr CProfileNodeTable::GetCellText ( size_t  row,
size_t  col 
)
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.

Implements AbstractProfileTable.

AbstractProfileTable * CProfileNodeTable::GetChild ( size_t  row)
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.

Implements AbstractProfileTable.

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

GetColumnDescriptions.

Returns
A vector describing all columns of the table.

Implements AbstractProfileTable.

CStr CProfileNodeTable::GetName ( )
virtual

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

Returns
Descriptive name of this table.

Implements AbstractProfileTable.

size_t CProfileNodeTable::GetNumberRows ( )
virtual

GetNumberRows.

Returns
Number of rows in this table.

Implements AbstractProfileTable.

CStr CProfileNodeTable::GetTitle ( )
virtual

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

Returns
Title for the table.

Implements AbstractProfileTable.

bool CProfileNodeTable::IsHighlightRow ( size_t  row)
virtual

IsHighlightRow.

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

Reimplemented from AbstractProfileTable.

Member Data Documentation

CProfileNodeTable::ColumnDescription CProfileNodeTable::columnDescription
staticprivate

Columns description (shared by all instances)

CProfileNode* CProfileNodeTable::node
private

The node represented by this table.


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