Logging::loggingStatistics

NAME
SYNOPSIS
Constructor & Destructor Documentation
Member Function Documentation
Member Data Documentation
Author

NAME

Logging::loggingStatistics −

SYNOPSIS

#include <loggingStatistics.h>

Public Member Functions

bool getDisableStatistics ()

std::string getStatisticsIdentification ()

uint32_t getAccumulatedNumberOfMessages ()

uint32_t getAccumulatedNumberOfLogErrors ()

uint32_t getStatisticsGranularity ()

uint32_t getLastPeriodNumberOfMessages ()

uint32_t getLastPeriodNumberOfLogErrors ()

uint64_t getLastStatisticsRepportTime ()

uint32_t getStatisticsCalculationPeriod ()

void setAccumulatedNumberOfMessages (uint32_t value)

void setAccumulatedNumberOfLogErrors (uint32_t value)

void setLastStatisticsRepportTime (uint64_t value)

void setStatisticsCalculationPeriod (uint32_t value)

void setStatisticsGranularity (uint32_t value)

void setLastPeriodNumberOfMessages (uint32_t value)

void setLastPeriodNumberOfLogErrors (uint32_t value)

loggingStatistics ()

virtual ~loggingStatistics ()

virtual void calculateLoggingStatistics ()

virtual void retrieveStatisticsLogs (std::list< std::string > &statisticsLogList, const std::string loggerId)

virtual void incrementNumberOfMessages ()

virtual void incrementNumberOfLogErrors ()

virtual void resetStatistics ()

virtual void configureStatistics (const std::string elementName, const bool state, const uint32_t period, const uint32_t granularity)

Static Public Attributes

static const uint32_t INITIAL_NUMBER_MESSAGES

static const uint32_t INITIAL_NUMBER_ERRORS

static const uint32_t DEFAULT_STATISTICS_PERIOD

static const uint32_t DEFAULT_STATISTICS_GRANULARITY

static const bool DEFAULT_STATISTICS_STATE

Private Attributes

bool disableStatistics

std::string statisticsIdentification

uint32_t accumulatedNumberOfMessages

uint32_t accumulatedNumberOfLogErrors

uint64_t lastStatisticsRepportTime

uint32_t statisticsCalculationPeriod

uint32_t statisticsGranularity

uint32_t lastPeriodNumberOfMessages

uint32_t lastPeriodNumberOfLogErrors

float messageStatistics

float errorStatistics

float messageIncrement

float errorIncrement

float actualStatisticsPeriod

Constructor & Destructor Documentation

Logging::loggingStatistics::loggingStatistics ()

virtual Logging::loggingStatistics::~loggingStatistics () [inline, virtual]

Member Function Documentation

virtual void Logging::loggingStatistics::calculateLoggingStatistics () [virtual] This method calculates the logging statistics

Returns:

void

virtual void Logging::loggingStatistics::configureStatistics (const std::string elementName, const bool state, const uint32_t period, const uint32_t granularity) [virtual] This method allows the statistic module to be configured

Parameters:

elementName String defining the name of the module the statistics belong to
state
Configuaration of disableStatistics attribute (to enable / diable statistics module)
period
Configuration of statisticsCalculationPeriod
granularity
Configuration of statisticsGranularity

Returns:

void

uint32_t Logging::loggingStatistics::getAccumulatedNumberOfLogErrors ()

uint32_t Logging::loggingStatistics::getAccumulatedNumberOfMessages ()

bool Logging::loggingStatistics::getDisableStatistics ()

uint32_t Logging::loggingStatistics::getLastPeriodNumberOfLogErrors ()

uint32_t Logging::loggingStatistics::getLastPeriodNumberOfMessages ()

uint64_t Logging::loggingStatistics::getLastStatisticsRepportTime ()

uint32_t Logging::loggingStatistics::getStatisticsCalculationPeriod ()

uint32_t Logging::loggingStatistics::getStatisticsGranularity ()

std::string Logging::loggingStatistics::getStatisticsIdentification ()

virtual void Logging::loggingStatistics::incrementNumberOfLogErrors () [virtual] This method increments the stored number of logging errors detected

Returns:

void

virtual void Logging::loggingStatistics::incrementNumberOfMessages () [virtual] This method increments the stored number of correctly transferred logs

Returns:

void

virtual void Logging::loggingStatistics::resetStatistics () [virtual] This method makes a backup and resets the current statisctics values

Returns:

void

virtual void Logging::loggingStatistics::retrieveStatisticsLogs (std::list< std::string > & statisticsLogList, const std::string loggerId) [virtual] This method retrieves the logging statistics

Parameters:

statisticsLogList List of logs (strings)
loggerId
String to indintify the logger (normaly will consist on logger name + container name

Returns:

void

void Logging::loggingStatistics::setAccumulatedNumberOfLogErrors (uint32_t value)

void Logging::loggingStatistics::setAccumulatedNumberOfMessages (uint32_t value)

void Logging::loggingStatistics::setLastPeriodNumberOfLogErrors (uint32_t value)

void Logging::loggingStatistics::setLastPeriodNumberOfMessages (uint32_t value)

void Logging::loggingStatistics::setLastStatisticsRepportTime (uint64_t value)

void Logging::loggingStatistics::setStatisticsCalculationPeriod (uint32_t value)

void Logging::loggingStatistics::setStatisticsGranularity (uint32_t value)

Member Data Documentation

uint32_t Logging::loggingStatistics::accumulatedNumberOfLogErrors [private]

uint32_t Logging::loggingStatistics::accumulatedNumberOfMessages [private]

float Logging::loggingStatistics::actualStatisticsPeriod [private]

const uint32_t Logging::loggingStatistics::DEFAULT_STATISTICS_GRANULARITY [static]

const uint32_t Logging::loggingStatistics::DEFAULT_STATISTICS_PERIOD [static]

const bool Logging::loggingStatistics::DEFAULT_STATISTICS_STATE [static]

bool Logging::loggingStatistics::disableStatistics [private]

float Logging::loggingStatistics::errorIncrement [private]

float Logging::loggingStatistics::errorStatistics [private]

const uint32_t Logging::loggingStatistics::INITIAL_NUMBER_ERRORS [static]

const uint32_t Logging::loggingStatistics::INITIAL_NUMBER_MESSAGES [static] These constant members represent the default values of the statistics parametres.

uint32_t Logging::loggingStatistics::lastPeriodNumberOfLogErrors [private]

uint32_t Logging::loggingStatistics::lastPeriodNumberOfMessages [private]

uint64_t Logging::loggingStatistics::lastStatisticsRepportTime [private]

float Logging::loggingStatistics::messageIncrement [private]

float Logging::loggingStatistics::messageStatistics [private]

uint32_t Logging::loggingStatistics::statisticsCalculationPeriod [private]

uint32_t Logging::loggingStatistics::statisticsGranularity [private]

std::string Logging::loggingStatistics::statisticsIdentification [private]

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.