balm::PublicationType Struct Reference

#include <balm_publicationtype.h>

List of all members.

Public Types
enum	Value {   e_UNSPECIFIED = 0, e_TOTAL = 1, e_COUNT = 2, e_MIN = 3,   e_MAX = 4, e_AVG = 5, e_RATE = 6, e_RATE_COUNT = 7,   BAEM_UNSPECIFIED = e_UNSPECIFIED, BAEM_TOTAL = e_TOTAL, BAEM_COUNT = e_COUNT, BAEM_MIN = e_MIN,   BAEM_MAX = e_MAX, BAEM_AVG = e_AVG, BAEM_RATE = e_RATE, BAEM_RATE_COUNT = e_RATE_COUNT }
enum	{ k_LENGTH = 8, BAEM_LENGTH = k_LENGTH }
Static Public Member Functions
static const char *	toString (Value value)
static int	fromString (Value *result, const char *string, int stringLength)
static int	fromString (Value *result, const bsl::string_view &string)
static int	fromInt (Value *result, int number)
static bsl::ostream &	print (bsl::ostream &stream, Value value)

---

Detailed Description

This class defines an enumeration of aggregation type that can be used to describe the published output of a metric. Concrete Publisher implementations may use this these types to configure their output.

See Component balm_publicationtype

---

Member Enumeration Documentation

enum balm::PublicationType::Value

Enumerator:

e_UNSPECIFIED	There is no defined publication type for the metric.
e_TOTAL	The total of the measured metric values over the published interval.
e_COUNT	The count of updates over the published interval.
e_MIN	The minimum measured metric value over the published interval.
e_MAX	The maximum measured metric value over the published interval.
e_AVG	The average measured metric value over published interval (i.e., total / count).
e_RATE	The total measured metric value per second over the published interval (i.e., total / sample interval).
e_RATE_COUNT	The count of measured events per second over the published interval (i.e., count / sample interval).
BAEM_UNSPECIFIED	There is no defined publication type for the metric.
BAEM_TOTAL	The total of the measured metric values over the published interval.
BAEM_COUNT	The count of updates over the published interval.
BAEM_MIN	The minimum measured metric value over the published interval.
BAEM_MAX	The maximum measured metric value over the published interval.
BAEM_AVG	The average measured metric value over published interval (i.e., total / count).
BAEM_RATE	The total measured metric value per second over the published interval (i.e., total / sample interval).
BAEM_RATE_COUNT

anonymous enum

Enumerator:

k_LENGTH
BAEM_LENGTH

---

Member Function Documentation

static const char* balm::PublicationType::toString

(

Value

value

)

[static]

Return the string representation exactly matching the enumerator name corresponding to the specified enumeration value.

static int balm::PublicationType::fromString	(	Value *	result,
		const char *	string,
		int	stringLength
	)			[static]

Load into the specified result the enumerator matching the specified string of the specified stringLength. Return 0 on success, and a non-zero value with no effect on result otherwise (i.e., string does not match any enumerator).

static int balm::PublicationType::fromString	(	Value *	result,
		const bsl::string_view &	string
	)			[static]

Load into the specified result the enumerator matching the specified string. Return 0 on success, and a non-zero value with no effect on result otherwise (i.e., string does not match any enumerator).

static int balm::PublicationType::fromInt	(	Value *	result,
		int	number
	)			[static]

Load into the specified result the enumerator matching the specified number. Return 0 on success, and a non-zero value with no effect on result otherwise (i.e., number does not match any enumerator).

static bsl::ostream& balm::PublicationType::print	(	bsl::ostream &	stream,
		Value	value
	)			[static]

Write to the specified stream the string representation of the specified enumeration value. Return a reference to the modifiable stream.

---

The documentation for this struct was generated from the following file:

• balm_publicationtype.h