balm::PublicationType Struct Reference

#include <balm_publicationtype.h>

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.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
k_LENGTH
BAEM_LENGTH

Value

enum balm::PublicationType::Value

Enumerator
e_UNSPECIFIED	There is no defined publication type for the metric.
e_TOTAL
e_COUNT
e_MIN
e_MAX
e_AVG
e_RATE
e_RATE_COUNT
BAEM_UNSPECIFIED
BAEM_TOTAL
BAEM_COUNT
BAEM_MIN
BAEM_MAX
BAEM_AVG
BAEM_RATE
BAEM_RATE_COUNT

Member Function Documentation

fromInt()

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).

fromString() [1/2]

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

inlinestatic

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).

fromString() [2/2]

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).

print()

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

inlinestatic

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

toString()

static const char * balm::PublicationType::toString ( Value  value )

static

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

---

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

• balm_publicationtype.h