OpenDDS::DCPS::InstanceDataSampleList Class Reference

#include <InstanceDataSampleList.h>

Collaboration diagram for OpenDDS::DCPS::InstanceDataSampleList:

[legend]List of all members.

Public Member Functions
	InstanceDataSampleList ()
	Default constructor clears the list.
	~InstanceDataSampleList ()
void	reset ()
	Reset to initial state.
ssize_t	size () const
DataSampleElement *	head () const
DataSampleElement *	tail () const
void	enqueue_tail (const DataSampleElement *element)
bool	dequeue_head (DataSampleElement *&stale)
bool	dequeue (const DataSampleElement *stale)
Protected Attributes
DataSampleElement *	head_
	The first element of the list.
DataSampleElement *	tail_
	The last element of the list.
ssize_t	size_
	Number of elements in the list.

---

Detailed Description

A list of DataSampleElement pointers to be queued by the order the samples are written to the instance (within PRESENTAION.access_scope==INSTANCE). It is mainly used on the send side to count the depth of instance data and to allow the removal of elements by instance. Manages DataSampleElement's next_instance_sample pointer

Definition at line 32 of file InstanceDataSampleList.h.

---

Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::InstanceDataSampleList::InstanceDataSampleList

(

)

Default constructor clears the list.

Definition at line 15 of file InstanceDataSampleList.inl.

  : head_(0),
    tail_(0),
    size_(0)
{
}

OpenDDS::DCPS::InstanceDataSampleList::~InstanceDataSampleList

(

)

[inline]

Definition at line 38 of file InstanceDataSampleList.h.

{};

---

Member Function Documentation

bool OpenDDS::DCPS::InstanceDataSampleList::dequeue

(

const DataSampleElement *

stale

)

Definition at line 25 of file InstanceDataSampleList.cpp.

References dequeue_head(), head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, size_, and tail_.

{
  if (head_ == 0) {
    return false;
  }

  // Same as dequeue from head.
  if (stale == head_) {
    DataSampleElement* tmp = head_;
    return dequeue_head(tmp);
  }

  // Search from head_->next_instance_sample_.
  DataSampleElement* previous = head_;
  DataSampleElement* item;
  for (item = head_->next_instance_sample_;
       item != 0;
       item = item->next_instance_sample_) {
    if (item == stale) {
      previous->next_instance_sample_ = item->next_instance_sample_;
      if (previous->next_instance_sample_ == 0) {
        tail_ = previous;
      }
      --size_ ;
      item->next_instance_sample_ = 0;
      break;
    }

    previous = item;
  }

  return item;
}

ACE_INLINE bool OpenDDS::DCPS::InstanceDataSampleList::dequeue_head

(

DataSampleElement *&

stale

)

Definition at line 76 of file InstanceDataSampleList.inl.

References head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, size_, and tail_.

Referenced by dequeue(), OpenDDS::DCPS::WriteDataContainer::remove_oldest_historical_sample(), and OpenDDS::DCPS::WriteDataContainer::remove_oldest_sample().

{
  //
  // Remove the oldest sample from the instance list.
  //
  stale = head_;

  if (head_ == 0) {
    // try to dequeue empty instance list.
    return false;

  } else {
    --size_ ;
    head_ = head_->next_instance_sample_ ;

    if (head_ == 0) {
      tail_ = 0;
    }

    stale->next_instance_sample_ = 0;
    return true;
  }
}

ACE_INLINE void OpenDDS::DCPS::InstanceDataSampleList::enqueue_tail

(

const DataSampleElement *

element

)

Definition at line 52 of file InstanceDataSampleList.inl.

References head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, size_, and tail_.

Referenced by OpenDDS::DCPS::WriteDataContainer::enqueue().

{
  // const_cast here so that higher layers don't need to pass around so many
  // non-const pointers to DataSampleElement.  Ideally the design would be
  // changed to accommodate const-correctness throughout.
  DataSampleElement* mSample = const_cast<DataSampleElement*>(sample);

  mSample->next_instance_sample_ = 0;

  ++ size_ ;

  if (head_ == 0) {
    // First sample on queue.
    head_ = tail_ = mSample ;

  } else {
    // Another sample on an existing queue.
    tail_->next_instance_sample_ = mSample ;
    tail_ = mSample ;
  }
}

ACE_INLINE DataSampleElement * OpenDDS::DCPS::InstanceDataSampleList::head

(

)

const

Definition at line 38 of file InstanceDataSampleList.inl.

References head_.

Referenced by OpenDDS::DCPS::WriteDataContainer::remove_oldest_historical_sample().

{
  return head_;
}

ACE_INLINE void OpenDDS::DCPS::InstanceDataSampleList::reset

(

)

Reset to initial state.

Definition at line 23 of file InstanceDataSampleList.inl.

References head_, size_, and tail_.

{
  head_ = tail_ = 0;
  size_ = 0;
}

ACE_INLINE ssize_t OpenDDS::DCPS::InstanceDataSampleList::size

(

)

const

Definition at line 31 of file InstanceDataSampleList.inl.

References size_.

Referenced by OpenDDS::DCPS::WriteDataContainer::dispose(), and OpenDDS::DCPS::WriteDataContainer::num_samples().

{
  return size_;
}

ACE_INLINE DataSampleElement * OpenDDS::DCPS::InstanceDataSampleList::tail

(

)

const

Definition at line 45 of file InstanceDataSampleList.inl.

References tail_.

{
  return tail_;
}

---

Member Data Documentation

DataSampleElement* OpenDDS::DCPS::InstanceDataSampleList::head_ [protected]

The first element of the list.

Definition at line 56 of file InstanceDataSampleList.h.

Referenced by dequeue(), dequeue_head(), enqueue_tail(), head(), and reset().

ssize_t OpenDDS::DCPS::InstanceDataSampleList::size_ [protected]

Number of elements in the list.

Definition at line 62 of file InstanceDataSampleList.h.

Referenced by dequeue(), dequeue_head(), enqueue_tail(), reset(), and size().

DataSampleElement* OpenDDS::DCPS::InstanceDataSampleList::tail_ [protected]

The last element of the list.

Definition at line 59 of file InstanceDataSampleList.h.

Referenced by dequeue(), dequeue_head(), enqueue_tail(), reset(), and tail().

---

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

• InstanceDataSampleList.h
• InstanceDataSampleList.cpp
• InstanceDataSampleList.inl

---