#include <statisticregistrarproxy.h>

Inheritance diagram for EMANE::StatisticRegistrarProxy:

Public Member Functions
	StatisticRegistrarProxy (StatisticService &service, BuildId buildId)

template<typename T >
StatisticNumeric< T > *	registerNumeric (const std::string &sName, const StatisticProperties &properties=StatisticProperties::NONE, const std::string &sDescription="")

template<typename T >
EMANE::StatisticNumeric< T > *	registerNumeric (const std::string &sName, const StatisticProperties &properties, const std::string &sDescription)

template<typename T >
StatisticNonNumeric< T > *	registerNonNumeric (const std::string &sName, const StatisticProperties &properties=StatisticProperties::NONE, const std::string &sDescription="")

template<typename T >
EMANE::StatisticNonNumeric< T > *	registerNonNumeric (const std::string &sName, const StatisticProperties &properties, const std::string &sDescription)

template<typename Key , typename Compare = std::less<EMANE::Any>, std::size_t scolumn = 0>
StatisticTable< Key, Compare, scolumn > *	registerTable (const std::string &sName, const StatisticTableLabels &labels, const StatisticProperties &properties=StatisticProperties::NONE, const std::string &sDescription="")

template<typename Key , typename Function , typename Compare = std::less<EMANE::Any>, std::size_t scolumn = 0>
StatisticTable< Key, Compare, scolumn > *	registerTable (const std::string &sName, const StatisticTableLabels &labels, Function clearFunc, const std::string &sDescription="")

template<typename Key , typename Compare , std::size_t scolumn>
EMANE::StatisticTable< Key, Compare, scolumn > *	registerTable (const std::string &sName, const StatisticTableLabels &labels, const StatisticProperties &properties, const std::string &sDescription)

template<typename Key , typename Function , typename Compare , std::size_t scolumn>
EMANE::StatisticTable< Key, Compare, scolumn > *	registerTable (const std::string &sName, const StatisticTableLabels &labels, Function clearFunc, const std::string &sDescription)

Protected Member Functions
virtual void	registerTablePublisher (const std::string &sName, const StatisticProperties &properties, const std::string &sDescription, StatisticTablePublisher pStatiticTablePublisher, std::function< void(StatisticTablePublisher p)> clearFunc)=0

Detailed Description

Definition at line 41 of file statisticregistrarproxy.h.

Constructor & Destructor Documentation

◆ StatisticRegistrarProxy()

EMANE::StatisticRegistrarProxy::StatisticRegistrarProxy	(	StatisticService &	service,
		BuildId	buildId
	)

Definition at line 35 of file statisticregistrarproxy.cc.

Member Function Documentation

◆ registerNonNumeric() [1/2]

template<typename T >

EMANE::StatisticNonNumeric<T>* EMANE::StatisticRegistrar::registerNonNumeric	(	const std::string &	sName,
		const StatisticProperties &	properties,
		const std::string &	sDescription
	)

inherited

Definition at line 58 of file statisticregistrar.inl.

◆ registerNonNumeric() [2/2]

template<typename T >

StatisticNonNumeric<T>* EMANE::StatisticRegistrar::registerNonNumeric	(	const std::string &	sName,
		const StatisticProperties &	properties = `StatisticProperties::NONE`,
		const std::string &	sDescription = `""`
	)

inherited

Register a non-numeric statistic. The registered statistic is owned by the StatisticRegistrar.

Parameters

sName	Name of the statistic
properties	Statistic properties
sDescription	Statistic description

Returns: A borrowed reference to the statistic that may be used during the lifetime of the registered component.

Exceptions

RegistrarException when a error occurs during registration.

◆ registerNumeric() [1/2]

template<typename T >

EMANE::StatisticNumeric<T>* EMANE::StatisticRegistrar::registerNumeric	(	const std::string &	sName,
		const StatisticProperties &	properties,
		const std::string &	sDescription
	)

inherited

Definition at line 37 of file statisticregistrar.inl.

◆ registerNumeric() [2/2]

template<typename T >

StatisticNumeric<T>* EMANE::StatisticRegistrar::registerNumeric	(	const std::string &	sName,
		const StatisticProperties &	properties = `StatisticProperties::NONE`,
		const std::string &	sDescription = `""`
	)

inherited

Register a numeric statistic. The registered statistic is owned by the StatisticRegistrar.

Parameters

sName	Name of the statistic
properties	Statistic properties
sDescription	Statistic description

Returns: A borrowed reference to the statistic that may be used during the lifetime of the registered component.

Exceptions

RegistrarException when a error occurs during registration.

◆ registerTable() [1/4]

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

EMANE::StatisticTable<Key,Compare,scolumn>* EMANE::StatisticRegistrar::registerTable	(	const std::string &	sName,
		const StatisticTableLabels &	labels,
		const StatisticProperties &	properties,
		const std::string &	sDescription
	)

inherited

Definition at line 77 of file statisticregistrar.inl.

◆ registerTable() [2/4]

template<typename Key , typename Function , typename Compare , std::size_t scolumn>

EMANE::StatisticTable<Key,Compare,scolumn>* EMANE::StatisticRegistrar::registerTable	(	const std::string &	sName,
		const StatisticTableLabels &	labels,
		Function	clearFunc,
		const std::string &	sDescription
	)

inherited

Definition at line 100 of file statisticregistrar.inl.

◆ registerTable() [3/4]

template<typename Key , typename Compare = std::less<EMANE::Any>, std::size_t scolumn = 0>

StatisticTable<Key,Compare,scolumn>* EMANE::StatisticRegistrar::registerTable	(	const std::string &	sName,
		const StatisticTableLabels &	labels,
		const StatisticProperties &	properties = `StatisticProperties::NONE`,
		const std::string &	sDescription = `""`
	)

inherited

Register a statistic table. The registered statistic table is owned by the StatisticRegistrar.

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

Parameters

sName	Name of the statistic table
labels	Table column labels
properties	Table properties
sDescription	Statistic table description

Returns: A borrowed reference to the statistic table that may be used during the lifetime of the registered component.

Exceptions

RegistrarException when a error occurs during registration.

◆ registerTable() [4/4]

template<typename Key , typename Function , typename Compare = std::less<EMANE::Any>, std::size_t scolumn = 0>

StatisticTable<Key,Compare,scolumn>* EMANE::StatisticRegistrar::registerTable	(	const std::string &	sName,
		const StatisticTableLabels &	labels,
		Function	clearFunc,
		const std::string &	sDescription = `""`
	)

inherited

Register a statistic table. The registered statistic table is owned by the StatisticRegistrar.

Template Parameters

Key	Type of the keys. Each row in the table is uniquely identified by its key value
Function	A function that takes a pointer to the statistic table and that is called when the table is cleared
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

Parameters

sName	Name of the statistic table
labels	Table column labels
clearFunc	Function called when table clear is requested
sDescription	Statistic table description

Returns: A borrowed reference to the statistic table that may be used during the lifetime of the registered component.

Exceptions

RegistrarException when a error occurs during registration.

Note: The specified clear function is called on an internal emulator framework thread a synchronization object will most likely me needed to avoid race conditions. The function is responsible for clearing the statistic table.

◆ registerTablePublisher()

virtual void EMANE::StatisticRegistrar::registerTablePublisher	(	const std::string &	sName,
		const StatisticProperties &	properties,
		const std::string &	sDescription,
		StatisticTablePublisher *	pStatiticTablePublisher,
		std::function< void(StatisticTablePublisher *p)>	clearFunc
	)

protectedpure virtualinherited

Register a statistic table publisher and take ownership

Parameters

sName	Name of the statistic table
properties	Table properties
sDescription	Statistic table description
pStatiticTablePublisher	Pointer to the statistic table publisher
clearFunc	Function called when table clear is requested

Exceptions

RegistrarException when a error occurs during registration.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ StatisticRegistrarProxy()

Member Function Documentation

◆ registerNonNumeric() [1/2]

◆ registerNonNumeric() [2/2]

◆ registerNumeric() [1/2]

◆ registerNumeric() [2/2]

◆ registerTable() [1/4]

◆ registerTable() [2/4]

◆ registerTable() [3/4]

◆ registerTable() [4/4]

◆ registerTablePublisher()