EMANE::StatisticTable< Key, Compare, sortIndex > Class Template Reference

A two dimentional statistic table that holds Any values. More...

#include <statistictable.h>

Inheritance diagram for EMANE::StatisticTable< Key, Compare, sortIndex >:

Public Member Functions
	~StatisticTable ()
void	setCell (const Key &key, std::size_t columnIndex, const Any &any)
void	setRow (const Key &key, const std::vector< Any > &anys)
void	addRow (const Key &key, const std::vector< Any > &anys={})
void	deleteRow (const Key &key)
StatisticTableLabels	getLabels () const override
StatisticTableValues	getValues () const override
void	clear () override

Detailed Description

template<typename Key, typename Compare = std::less<EMANE::Any>, std::size_t sortIndex = 0>
class EMANE::StatisticTable< Key, Compare, sortIndex >

A two dimentional statistic table that holds Any values.

Template Parameters

Key	Type of the keys. Each row in the table is uniquely identified by its key value
Compare	A binary predicate that takes two element keys as arguments and returns a bool
scolumn	The column used when sorting the table using Compare

Definition at line 62 of file statistictable.h.

Constructor & Destructor Documentation

~StatisticTable()

template<typename Key , typename Compare , std::size_t sortIndex>

EMANE::StatisticTable< Key, Compare, sortIndex >::~StatisticTable

(

)

Destroys an instance

Definition at line 41 of file statistictable.inl.

Member Function Documentation

addRow()

template<typename Key, typename Compare , std::size_t sortIndex>

void EMANE::StatisticTable< Key, Compare, sortIndex >::addRow	(	const Key &	key,
		const std::vector< Any > &	anys = {}
	)

Adds a row to the table

Parameters

key	Table row key
anys	Vector of any values

Exceptions

StatisticTableException

when either the row key is already in use or the number of columns in the row values does not match the table

Definition at line 98 of file statistictable.inl.

clear()

template<typename Key , typename Compare , std::size_t sortIndex>

void EMANE::StatisticTable< Key, Compare, sortIndex >::clear ( )

overridevirtual

Clears the table

Implements EMANE::StatisticTablePublisher.

Definition at line 172 of file statistictable.inl.

deleteRow()

template<typename Key, typename Compare , std::size_t sortIndex>

void EMANE::StatisticTable< Key, Compare, sortIndex >::deleteRow

(

const Key &

key

)

Deletes a row from the table

Parameters

key	Table row key

Definition at line 127 of file statistictable.inl.

getLabels()

template<typename Key , typename Compare , std::size_t sortIndex>

EMANE::StatisticTableLabels EMANE::StatisticTable< Key, Compare, sortIndex >::getLabels ( ) const

overridevirtual

Gets the table column labels

Returns

labels

Implements EMANE::StatisticTablePublisher.

Definition at line 164 of file statistictable.inl.

getValues()

template<typename Key , typename Compare , std::size_t sortIndex>

EMANE::StatisticTableValues EMANE::StatisticTable< Key, Compare, sortIndex >::getValues ( ) const

overridevirtual

Gets the table values

Returns

values

Implements EMANE::StatisticTablePublisher.

Definition at line 136 of file statistictable.inl.

setCell()

template<typename Key, typename Compare , std::size_t sortIndex>

void EMANE::StatisticTable< Key, Compare, sortIndex >::setCell	(	const Key &	key,
		std::size_t	columnIndex,
		const Any &	any
	)

Sets a specified table cell

Parameters

key	Table row key
columnIndex	Row column index (indexed from 0)
any	Value to set

Exceptions

StatisticTableException

when either the row key of column index are invalid

Definition at line 45 of file statistictable.inl.

setRow()

template<typename Key, typename Compare , std::size_t sortIndex>

void EMANE::StatisticTable< Key, Compare, sortIndex >::setRow	(	const Key &	key,
		const std::vector< Any > &	anys
	)

Sets a column of a specified row

Parameters

key	Table row key
anys	Vector of any values

Exceptions

StatisticTableException

when either the row key is invalid or the number of columns in the row values does not match the table

Definition at line 72 of file statistictable.inl.

---

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

• statistictable.h
• statistictable.inl