CProfileNodeTable Class Reference

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

Inheritance diagram for CProfileNodeTable:

Collaboration diagram for CProfileNodeTable:

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

Private Attributes
CProfileNode *	node
	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::CProfileNodeTable

(

CProfileNode *

n

)

Member Function Documentation

GetCellText()

CStr CProfileNodeTable::GetCellText ( size_t  row, size_t  col  )

overridevirtual

GetCellText.

Parameters

row	Row index (the first row has index 0).
col	Column index (the first column has index 0).

Returns

Text to be displayed in the given cell.

Implements AbstractProfileTable.

GetChild()

AbstractProfileTable * CProfileNodeTable::GetChild ( size_t  row )

overridevirtual

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

Parameters

row	Row index (the first row has index 0).

Returns

Pointer to the child table if the given row has one. Otherwise, return 0.

Implements AbstractProfileTable.

GetColumns()

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

overridevirtual

GetColumnDescriptions.

Returns

A vector describing all columns of the table.

Implements AbstractProfileTable.

GetName()

CStr CProfileNodeTable::GetName ( )

overridevirtual

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

Returns

Descriptive name of this table.

Implements AbstractProfileTable.

GetNumberRows()

size_t CProfileNodeTable::GetNumberRows ( )

overridevirtual

GetNumberRows.

Returns

Number of rows in this table.

Implements AbstractProfileTable.

GetTitle()

CStr CProfileNodeTable::GetTitle ( )

overridevirtual

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

Returns

Title for the table.

Implements AbstractProfileTable.

IsHighlightRow()

bool CProfileNodeTable::IsHighlightRow ( size_t  row )

overridevirtual

IsHighlightRow.

Parameters

row	Row 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

columnDescription

CProfileNodeTable::ColumnDescription CProfileNodeTable::columnDescription

staticprivate

Columns description (shared by all instances)

node

CProfileNode* CProfileNodeTable::node

private

The node represented by this table.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/ps/Profile.cpp