OpenDDS::DCPS::DataCollector< DatumType > Class Template Reference

Collect data in a buffer. More...

#include <DataCollector_T.h>

List of all members.

Public Types
	KeepOldest
	KeepNewest
	Unbounded
enum	OnFull { KeepOldest, KeepNewest, Unbounded }
	Selectors for behavior when buffer fills. More...
Public Member Functions
	DataCollector (unsigned int bound=0, OnFull onFull=KeepOldest)
virtual	~DataCollector ()
	Allow the class to be extended.
void	collect (const DatumType &datum)
	Implement data collection.
unsigned int	size () const
	Amount of data actually stored.
DataCollector< DatumType > &	operator<< (DatumType datum)
std::ostream &	insert (std::ostream &str) const
	Implement insertion of collected data onto an ostream.
Private Member Functions
	OPENDDS_VECTOR (DatumType) buffer_
	The collected data goes here.
Private Attributes
unsigned int	writeAt_
	Where to write the next datum collected.
unsigned int	bound_
	Total or initial capacity of buffer.
bool	full_
OnFull	onFull_
	Selector for behavior when buffer fills.

---

Detailed Description

template<typename DatumType>
class OpenDDS::DCPS::DataCollector< DatumType >

Collect data in a buffer.

This class implements a rudimentary data collection mechanism. It is extendable to allow data to be collected as a feature of a more complex class.

Definition at line 36 of file DataCollector_T.h.

---

Member Enumeration Documentation

template<typename DatumType>

enum OpenDDS::DCPS::DataCollector::OnFull

Selectors for behavior when buffer fills.

Enumerator:

KeepOldest
KeepNewest
Unbounded

Definition at line 39 of file DataCollector_T.h.

{ KeepOldest, KeepNewest, Unbounded};

---

Constructor & Destructor Documentation

template<typename DatumType>

ACE_INLINE OpenDDS::DCPS::DataCollector< DatumType >::DataCollector	(	unsigned int	bound = 0,
		OnFull	onFull = KeepOldest
	)

Construct with optional buffer size and full behavior.

Parameters:

	bound	- amount of data to store or reserve as buffer.
	onFull	- behavior of collector when bound is reached.

OnFull == KeepOldest: The buffer is limited to the amount of data specified by the bouund parameter and only the data collected first is retained. OnFull == KeepNewest: The buffer is limited to the amount of data specified by the bouund parameter and only the most recently collected data is retained. OnFull == Unbounded: The buffer contains all collected data and the bound parameter is used as an initial reservation amount.

Collection is either bounded or unbounded. In the case of a bounded collection, either the first data collected or the most recent data collected is retained. When an unbounded collection is specified, then the bound parameter is used as a capacity hint and that amount of data is reserved initially.

Definition at line 25 of file DataCollector_T.inl.

References OpenDDS::DCPS::DataCollector< DatumType >::Unbounded.

  : buffer_(bound),
    writeAt_(0),
    bound_(bound),
    full_(false),
    onFull_(onFull)
{
  if (this->onFull_ == Unbounded) {
    this->buffer_.clear();
  }
}

template<typename DatumType>

OpenDDS::DCPS::DataCollector< DatumType >::~DataCollector

(

)

[virtual]

Allow the class to be extended.

Definition at line 20 of file DataCollector_T.cpp.

{
}

---

Member Function Documentation

template<typename DatumType>

void OpenDDS::DCPS::DataCollector< DatumType >::collect

(

const DatumType &

datum

)

Implement data collection.

Definition at line 26 of file DataCollector_T.cpp.

References OpenDDS::DCPS::DataCollector< DatumType >::full_, OpenDDS::DCPS::DataCollector< DatumType >::KeepNewest, OpenDDS::DCPS::DataCollector< DatumType >::Unbounded, and OpenDDS::DCPS::DataCollector< DatumType >::writeAt_.

Referenced by OpenDDS::DCPS::DataCollector< DatumType >::operator<<().

{
  if (this->onFull_ == Unbounded) {
    this->buffer_.push_back(datum);

  } else {
    // writeAt == bound only when we either have no buffer (bound == 0) or
    // when we are full with no wrapping (writeAt == bound)
    if (this->writeAt_ != this->bound_) {
      this->buffer_[ this->writeAt_++] = datum;

      // This datum filled the buffer.
      if (this->writeAt_ == this->bound_) {
        this->full_  = true;

        if (this->onFull_ == KeepNewest) {
          this->writeAt_ = 0;
        }
      }
    }
  }
}

template<typename DatumType>

std::ostream & OpenDDS::DCPS::DataCollector< DatumType >::insert

(

std::ostream &

str

)

const

Implement insertion of collected data onto an ostream.

Definition at line 63 of file DataCollector_T.cpp.

References OpenDDS::DCPS::DataCollector< DatumType >::bound_, and OpenDDS::DCPS::DataCollector< DatumType >::writeAt_.

Referenced by OpenDDS::DCPS::operator<<().

{
  std::ofstream initStrState;
  initStrState.copyfmt(str);

  str.precision(5);
  str << std::scientific;

  // Oldest data first.
  if (this->full_) {
    for (unsigned int index = this->writeAt_; index < this->bound_; ++index) {
      str << this->buffer_[ index] << std::endl;
    }
  }

  // Bounded case.
  int end = this->writeAt_;

  if (end == 0) {
    // Unbounded case.
    end = static_cast<int>(this->buffer_.size());
  }

  // Newest data last.
  for (int index = 0; index < end; ++index) {
    str << this->buffer_[ index] << std::endl;
  }

  str.copyfmt(initStrState);
  return str;
}

template<typename DatumType>

OpenDDS::DCPS::DataCollector< DatumType >::OPENDDS_VECTOR

(

DatumType

)

[private]

The collected data goes here.

template<typename DatumType>

ACE_INLINE DataCollector< DatumType > & OpenDDS::DCPS::DataCollector< DatumType >::operator<<

(

DatumType

datum

)

Convenience operator for collecting data by inserting it into the collector.

Definition at line 41 of file DataCollector_T.inl.

References OpenDDS::DCPS::DataCollector< DatumType >::collect().

{
  this->collect(datum);
  return *this;
}

template<typename DatumType>

unsigned int OpenDDS::DCPS::DataCollector< DatumType >::size

(

)

const

Amount of data actually stored.

Definition at line 51 of file DataCollector_T.cpp.

References OpenDDS::DCPS::DataCollector< DatumType >::bound_, OpenDDS::DCPS::DataCollector< DatumType >::Unbounded, and OpenDDS::DCPS::DataCollector< DatumType >::writeAt_.

Referenced by OpenDDS::DCPS::WriterStats::raw_data().

{
  if (this->onFull_ == Unbounded) return static_cast<unsigned int>(this->buffer_.size());

  else if (this->full_)           return this->bound_;

  else                            return this->writeAt_;
}

---

Member Data Documentation

template<typename DatumType>

unsigned int OpenDDS::DCPS::DataCollector< DatumType >::bound_ [private]

Total or initial capacity of buffer.

Definition at line 92 of file DataCollector_T.h.

Referenced by OpenDDS::DCPS::DataCollector< DatumType >::insert(), and OpenDDS::DCPS::DataCollector< DatumType >::size().

template<typename DatumType>

bool OpenDDS::DCPS::DataCollector< DatumType >::full_ [private]

Flag indicating that we have collected as much or more data than we can store.

Definition at line 96 of file DataCollector_T.h.

Referenced by OpenDDS::DCPS::DataCollector< DatumType >::collect().

template<typename DatumType>

OnFull OpenDDS::DCPS::DataCollector< DatumType >::onFull_ [private]

Selector for behavior when buffer fills.

Definition at line 99 of file DataCollector_T.h.

template<typename DatumType>

unsigned int OpenDDS::DCPS::DataCollector< DatumType >::writeAt_ [private]

Where to write the next datum collected.

Definition at line 89 of file DataCollector_T.h.

Referenced by OpenDDS::DCPS::DataCollector< DatumType >::collect(), OpenDDS::DCPS::DataCollector< DatumType >::insert(), and OpenDDS::DCPS::DataCollector< DatumType >::size().

---

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

• DataCollector_T.h
• DataCollector_T.cpp
• DataCollector_T.inl

---