Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

# ACE_Stats_Value Class Reference

Helper class for ACE_Stats. More...

`#include <Stats.h>`

List of all members.

## Public Member Functions
| ACE_Stats_Value (const u_int precision)
u_int | precision (void) const
| Accessor for precision.
void | whole (const ACE_UINT32)
| Set the whole_ field.
ACE_UINT32 | whole (void) const
| Accessor for the whole_ field.
void | fractional (const ACE_UINT32)
| Set the fractional_ field.
ACE_UINT32 | fractional (void) const
| Accessor for the fractional_ field.
ACE_UINT32 | fractional_field (void) const
void | scaled_value (ACE_UINT64 &) const
void | dump (void) const
| Print to stdout.
## Private Member Functions
| ACE_Stats_Value (void)
## Private Attributes
ACE_UINT32 | whole_
| The integer portion of the value.
ACE_UINT32 | fractional_
| The fractional portion of the value.
u_int | precision_

## Detailed Description

Helper class for ACE_Stats.

Container struct for 64-bit signed quantity and its precision. It would be nicer to use a fixed-point class, but this is sufficient. Users typically don't need to use this class directly; see ACE_Stats below.

## Constructor & Destructor Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE ACE_Stats_Value::ACE_Stats_Value | ( | const u_int | precision | ) |

| Constructor, which requires precision in terms of number of decimal digits. The more variation in the data, and the greater the data values, the smaller the precision must be to avoid overflow in the standard deviation calculation. 3 might be a good value, or maybe 4. 5 will probably be too large for non-trivial data sets.

ACE_Stats_Value::ACE_Stats_Value | ( | void |  | ) | `[inline, private]`

## Member Function Documentation

ACE_INLINE void ACE_Stats_Value::dump | ( | void |  | ) | const

| Print to stdout.

ACE_INLINE ACE_UINT32 ACE_Stats_Value::fractional | ( | void |  | ) | const

| Accessor for the fractional_ field.

ACE_INLINE void ACE_Stats_Value::fractional | ( | const | ACE_UINT32 | ) |

| Set the fractional_ field.

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_UINT32 ACE_Stats_Value::fractional_field | ( | void |  | ) | const

| Calculates the maximum value of the fractional portion, given its precision.

ACE_INLINE u_int ACE_Stats_Value::precision | ( | void |  | ) | const

| Accessor for precision.

ACE_INLINE void ACE_Stats_Value::scaled_value | ( | ACE_UINT64 & |  | ) | const

| Access the value as an _unsigned_ 64 bit quantity. It scales the value up by {precision} decimal digits, so that no precision will be lost. It assumes that {whole_} is >= 0.

ACE_INLINE ACE_UINT32 ACE_Stats_Value::whole | ( | void |  | ) | const

| Accessor for the whole_ field.

ACE_INLINE void ACE_Stats_Value::whole | ( | const | ACE_UINT32 | ) |

| Set the whole_ field.

## Member Data Documentation

ACE_UINT32 ACE_Stats_Value::fractional_`[private]`

| The fractional portion of the value.

u_int ACE_Stats_Value::precision_`[private]`

| The number of decimal digits of precision represented by {fractional_}. Not declared const, so the only way to change it is via the assignment operator.

ACE_UINT32 ACE_Stats_Value::whole_`[private]`

| The integer portion of the value.

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

- Stats.h
- Stats.cpp
- Stats.inl