CScriptStatsTable Class Reference

#include <ScriptStats.h>

Inheritance diagram for CScriptStatsTable:

Collaboration diagram for CScriptStatsTable:

Public Member Functions
	CScriptStatsTable ()
void	Add (const ScriptInterface *scriptInterface, const std::string &title)
void	Remove (const ScriptInterface *scriptInterface)
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...
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 Member Functions
	NONCOPYABLE (CScriptStatsTable)

Private Attributes
std::vector< std::pair< const ScriptInterface *, std::string > >	m_ScriptInterfaces
std::vector< ProfileColumn >	m_ColumnDescriptions

Constructor & Destructor Documentation

CScriptStatsTable()

CScriptStatsTable::CScriptStatsTable

(

)

Member Function Documentation

Add()

void CScriptStatsTable::Add	(	const ScriptInterface *	scriptInterface,
		const std::string &	title
	)

GetCellText()

CStr CScriptStatsTable::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 * CScriptStatsTable::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 > & CScriptStatsTable::GetColumns ( )

overridevirtual

GetColumnDescriptions.

Returns

A vector describing all columns of the table.

Implements AbstractProfileTable.

GetName()

CStr CScriptStatsTable::GetName ( )

overridevirtual

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

Returns

Descriptive name of this table.

Implements AbstractProfileTable.

GetNumberRows()

size_t CScriptStatsTable::GetNumberRows ( )

overridevirtual

GetNumberRows.

Returns

Number of rows in this table.

Implements AbstractProfileTable.

GetTitle()

CStr CScriptStatsTable::GetTitle ( )

overridevirtual

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

Returns

Title for the table.

Implements AbstractProfileTable.

NONCOPYABLE()

CScriptStatsTable::NONCOPYABLE ( CScriptStatsTable  )

private

Remove()

void CScriptStatsTable::Remove

(

const ScriptInterface *

scriptInterface

)

Member Data Documentation

m_ColumnDescriptions

std::vector<ProfileColumn> CScriptStatsTable::m_ColumnDescriptions

private

m_ScriptInterfaces

std::vector<std::pair<const ScriptInterface*, std::string> > CScriptStatsTable::m_ScriptInterfaces

private

---

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

• /home/docker/jenkins/workspace/technical-docs/source/scriptinterface/ScriptStats.h
• /home/docker/jenkins/workspace/technical-docs/source/scriptinterface/ScriptStats.cpp