ACE_Sample_History Class Reference

Save multiple samples in an array. More...

#include <Sample_History.h>

Public Types
typedef ACE_UINT64	scale_factor_type

Public Member Functions
	ACE_Sample_History (size_t max_samples)
	Constructor.
	~ACE_Sample_History ()
	Destructor.
int	sample (ACE_UINT64 value)
	Record one sample.
size_t	max_samples () const
	Returns the maximum number of samples.
size_t	sample_count () const
	Returns the current number of samples.
void	dump_samples (const ACE_TCHAR *msg, scale_factor_type scale_factor) const
	Dump all the samples.
void	collect_basic_stats (ACE_Basic_Stats &) const
	Collect the summary for all the samples.
ACE_UINT64	get_sample (size_t i) const
	Get a sample.

Private Attributes
size_t	max_samples_
	The maximum number of samples.
size_t	sample_count_
	The current number of samples.
ACE_UINT64 *	samples_
	The samples.

Detailed Description

Save multiple samples in an array.

Save multiple samples (usually latency numbers), into an array, and later print them in several formats.

Member Typedef Documentation

scale_factor_type

typedef ACE_UINT64 ACE_Sample_History::scale_factor_type

Constructor & Destructor Documentation

ACE_Sample_History()

ACE_Sample_History::ACE_Sample_History

(

size_t

max_samples

)

Constructor.

The number of samples is pre-allocated, and cannot changes once the class is initialized.

~ACE_Sample_History()

ACE_Sample_History::~ACE_Sample_History

(

)

Destructor.

Member Function Documentation

collect_basic_stats()

void ACE_Sample_History::collect_basic_stats

(

ACE_Basic_Stats &

stats

)

const

Collect the summary for all the samples.

dump_samples()

void ACE_Sample_History::dump_samples	(	const ACE_TCHAR *	msg,
		ACE_Sample_History::scale_factor_type	scale_factor ) const

Dump all the samples.

Prints out all the samples, using msg as a prefix for each message.

get_sample()

ACE_UINT64 ACE_Sample_History::get_sample ( size_t i ) const

inline

Get a sample.

max_samples()

size_t ACE_Sample_History::max_samples ( ) const

inline

Returns the maximum number of samples.

sample()

int ACE_Sample_History::sample ( ACE_UINT64 value )

inline

Record one sample.

Return 0 on success, -1 if the sample could not be stored

sample_count()

size_t ACE_Sample_History::sample_count ( ) const

inline

Returns the current number of samples.

Member Data Documentation

max_samples_

size_t ACE_Sample_History::max_samples_

private

The maximum number of samples.

sample_count_

size_t ACE_Sample_History::sample_count_

private

The current number of samples.

samples_

ACE_UINT64* ACE_Sample_History::samples_

private

The samples.

---

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

• Sample_History.h
• Sample_History.cpp
• Sample_History.inl