Mantid::Kernel::FeatureUsage Class Reference

UsageReporter : The Usage reporter is responsible for collating, and sending all usage data. More...

#include <UsageService.h>

Public Member Functions
::Json::Value	asJson () const
	FeatureUsage (const FeatureType &type, std::string name, const bool internal, std::string application)
	Constructor. More...
bool	operator< (const FeatureUsage &r) const

Public Attributes
std::string	application
bool	internal
std::string	name
FeatureType	type

Protected Member Functions
std::string	featureTypeToString () const
	Convert the stored feature type enum to a string. More...

Detailed Description

UsageReporter : The Usage reporter is responsible for collating, and sending all usage data.

This centralizes all the logic covering Usage Reporting including:

• Detecting if reporting is enabled
• Registering the startup of Mantid
• Sending Startup usage reports, immediately, and every 24 hours thereafter
• Registering feature usage, and storing in a feature usage buffer
• Sending Feature usage reports on application exit, and when the feature usage buffer is above a size threshold.

Definition at line 41 of file UsageService.h.

Constructor & Destructor Documentation

FeatureUsage()

Mantid::Kernel::FeatureUsage::FeatureUsage	(	const FeatureType &	type,
		std::string	name,
		const bool	internal,
		std::string	application
	)

Constructor.

FeatureUsage.

Definition at line 36 of file UsageService.cpp.

Member Function Documentation

asJson()

Json::Value Mantid::Kernel::FeatureUsage::asJson

(

)

const

Definition at line 75 of file UsageService.cpp.

References application, featureTypeToString(), internal, and name.

featureTypeToString()

std::string Mantid::Kernel::FeatureUsage::featureTypeToString ( ) const

protected

Convert the stored feature type enum to a string.

Definition at line 60 of file UsageService.cpp.

References Mantid::Kernel::Algorithm, Mantid::Kernel::Feature, Mantid::Kernel::Function, Mantid::Kernel::Interface, and type.

Referenced by asJson().

operator<()

bool Mantid::Kernel::FeatureUsage::operator<

(

const FeatureUsage &

r

)

const

Definition at line 40 of file UsageService.cpp.

References internal, name, and type.

Member Data Documentation

application

std::string Mantid::Kernel::FeatureUsage::application

Definition at line 52 of file UsageService.h.

Referenced by asJson().

internal

bool Mantid::Kernel::FeatureUsage::internal

Definition at line 51 of file UsageService.h.

Referenced by asJson(), and operator<().

name

std::string Mantid::Kernel::FeatureUsage::name

Definition at line 50 of file UsageService.h.

Referenced by asJson(), and operator<().

type

FeatureType Mantid::Kernel::FeatureUsage::type

Definition at line 49 of file UsageService.h.

Referenced by featureTypeToString(), and operator<().

---

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

• Framework/Kernel/inc/MantidKernel/UsageService.h
• Framework/Kernel/src/UsageService.cpp