OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts > Class Template Reference

#include <SafetyProfileSequence.h>

Inheritance diagram for OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >:

Collaboration diagram for OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >:

Public Types
typedef seq_size_type	size_type
typedef seq_size_type	_size_type
typedef Elts	ElementPolicy
typedef Elts::Element	Element
typedef Elts::ConstElement	ConstElement
typedef Elts::ConstRawElement	ConstRawElement
typedef ConstElement	const_subscript_type
typedef Element	subscript_type
typedef T	value_type
typedef T &	reference
typedef const T &	const_reference
typedef T *	iterator
typedef const T *	const_iterator
typedef std::ptrdiff_t	difference_type

Public Member Functions
void	length (size_type len)
size_type	length () const
ConstElement	operator[] (size_type idx) const
Element	operator[] (size_type idx)
seq_flag_type	release () const
T *	get_buffer (seq_flag_type orphan=false)
const ConstRawElement *	get_buffer () const
const T *	begin () const
T *	begin ()
const T *	end () const
T *	end ()
bool	operator== (const Sequence &rhs) const
bool	operator!= (const Sequence &rhs) const
size_type	size () const
bool	empty () const

Static Public Member Functions
static void	freebuf (T *data)

Protected Member Functions
	Sequence (size_type maximum=0, size_type length=0, T *data=0, seq_flag_type release=false)
	Sequence (const Sequence &seq)
	~Sequence ()
Sequence &	operator= (const Sequence &seq)
void	swap (Sequence &rhs) throw ()

Private Member Functions
void	replace_i (size_type maximum, size_type length, T *data, seq_flag_type release)
void	lazy_alloc () const

Private Attributes
size_type	length_
seq_flag_type	release_
T *	buffer_

Friends
struct	AllocPolicy< T, Sequence, Bounds >

Detailed Description

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>
class OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >

Generic base class for all IDL-defined sequences accepted by opendds_idl. Derived classes (generated by opendds_idl) need to provide the following methods to be compliant with the IDL-to-C++ specification: If bounded:

• Constructors: default, copy, 3-arg If unbounded:
• Constructors: default, copy, 1-arg (maximum), 4-arg Both bounded and unbounded:
• Copy assignment
• non-member swap(), while not in spec this is useful for copy assignment

  Template Parameters

  T	element type of the sequence
  Bounds	either Bounded<N> or Unbounded
  Elts	element handling policy

Definition at line 246 of file SafetyProfileSequence.h.

Member Typedef Documentation

_size_type

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef seq_size_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::_size_type

Definition at line 251 of file SafetyProfileSequence.h.

const_iterator

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef const T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::const_iterator

Definition at line 298 of file SafetyProfileSequence.h.

const_reference

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef const T& OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::const_reference

Definition at line 296 of file SafetyProfileSequence.h.

const_subscript_type

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef ConstElement OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::const_subscript_type

Definition at line 271 of file SafetyProfileSequence.h.

ConstElement

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef Elts::ConstElement OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::ConstElement

Definition at line 268 of file SafetyProfileSequence.h.

ConstRawElement

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef Elts::ConstRawElement OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::ConstRawElement

Definition at line 269 of file SafetyProfileSequence.h.

difference_type

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef std::ptrdiff_t OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::difference_type

Definition at line 299 of file SafetyProfileSequence.h.

Element

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef Elts::Element OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::Element

Definition at line 267 of file SafetyProfileSequence.h.

ElementPolicy

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef Elts OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::ElementPolicy

Definition at line 252 of file SafetyProfileSequence.h.

iterator

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::iterator

Definition at line 297 of file SafetyProfileSequence.h.

reference

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef T& OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::reference

Definition at line 295 of file SafetyProfileSequence.h.

size_type

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef seq_size_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::size_type

Definition at line 250 of file SafetyProfileSequence.h.

subscript_type

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef Element OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::subscript_type

Definition at line 272 of file SafetyProfileSequence.h.

value_type

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

typedef T OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::value_type

Definition at line 294 of file SafetyProfileSequence.h.

Constructor & Destructor Documentation

Sequence() [1/2]

template<typename T , typename Bounds , typename Elts >

OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::Sequence ( size_type  maximum = 0, size_type  length = 0, T *  data = 0, seq_flag_type  release = false  )

inlineexplicitprotected

Definition at line 527 of file SafetyProfileSequence.h.

    : AllocPolicy<T, Sequence, Bounds>(maximum)
    , length_(length)
    , release_(release)
    , buffer_(data)
  {
  }

Sequence() [2/2]

template<typename T , typename Bounds , typename Elts >

OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::Sequence ( const Sequence< T, Bounds, Elts > &  seq )

inlineprotected

Definition at line 538 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length_.

    : AllocPolicy<T, Sequence, Bounds>(seq.maximum())
    , length_(seq.length_)
    , release_(true)
    , buffer_((seq.maximum() && seq.buffer_) ? allocate() : 0)
  {
    if (buffer_) {
      Elts::copy_n(seq.buffer_, length_, buffer_);
    }
  }

~Sequence()

template<typename T , typename Bounds , typename Elts >

OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::~Sequence ( )

inlineprotected

Definition at line 550 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::freebuf(), and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_.

  {
    if (release_) {
      freebuf(buffer_);
    }
  }

Member Function Documentation

begin() [1/2]

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

const T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::begin ( void  ) const

inline

Definition at line 301 of file SafetyProfileSequence.h.

{ return buffer_; }

begin() [2/2]

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::begin ( void  )

inline

Definition at line 302 of file SafetyProfileSequence.h.

{ return buffer_; }

empty()

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

bool OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::empty ( void  ) const

inline

Definition at line 312 of file SafetyProfileSequence.h.

{ return !length_; }

end() [1/2]

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

const T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::end ( void  ) const

inline

Definition at line 304 of file SafetyProfileSequence.h.

{ return buffer_ + length_; }

end() [2/2]

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::end ( void  )

inline

Definition at line 305 of file SafetyProfileSequence.h.

References OpenDDS::DCPS::operator!=(), and OpenDDS::DCPS::operator==().

{ return buffer_ + length_; }

freebuf()

template<typename T , typename Bounds , typename Elts >

void OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::freebuf ( T *  data )

inlinestatic

Definition at line 654 of file SafetyProfileSequence.h.

References ACE_Allocator::free(), and ACE_Allocator::instance().

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::~Sequence().

  {
    if (!data) return;
    T* const allocated = Elts::destroy(data, Bounds::Bounds);
    ACE_Allocator::instance()->free(allocated);
  }

get_buffer() [1/2]

template<typename T , typename Bounds , typename Elts >

T * OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::get_buffer ( seq_flag_type  orphan = false )

inline

Definition at line 627 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::lazy_alloc(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_, and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap().

  {
    if (orphan && !release_) {
      return 0;
    }

    lazy_alloc();

    if (orphan) {
      Sequence tmp;
      swap(tmp);
      tmp.release_ = false;
      return tmp.buffer_;
    }

    return buffer_;
  }

get_buffer() [2/2]

template<typename T , typename Bounds , typename Elts >

const Sequence< T, Bounds, Elts >::ConstRawElement * OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::get_buffer ( ) const

inline

Definition at line 647 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::lazy_alloc().

  {
    lazy_alloc();
    return buffer_;
  }

lazy_alloc()

template<typename T , typename Bounds , typename Elts >

void OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::lazy_alloc ( ) const

inlineprivate

Definition at line 585 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_.

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::get_buffer(), and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length().

  {
    if (!buffer_) {
      buffer_ = allocate();
      release_ = true;
    }
  }

length() [1/2]

template<typename T , typename Bounds , typename Elts >

void OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length ( size_type  len )

inline

Definition at line 594 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::lazy_alloc(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length_, OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_, and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap().

  {
    if (len <= maximum()) {
      if (len && !buffer_) {
        lazy_alloc();
      }
      else if (release_ && len < length_) {
        Elts::reset_n(buffer_ + len, length_ - len);
      }
      length_ = len;
      return;
    }

    Sequence tmp(len, len, allocate(len), true);
    Elts::move_n(buffer_, length_, tmp.buffer_);
    swap(tmp);
  }

length() [2/2]

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

size_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length ( void  ) const

inline

Definition at line 265 of file SafetyProfileSequence.h.

{ return length_; }

operator!=()

template<typename T , typename Bounds , typename Elts >

bool OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator!= ( const Sequence< T, Bounds, Elts > &  rhs ) const

inline

Definition at line 677 of file SafetyProfileSequence.h.

  {
    return !(*this == rhs);
  }

operator=()

template<typename T , typename Bounds , typename Elts >

Sequence< T, Bounds, Elts > & OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator= ( const Sequence< T, Bounds, Elts > &  seq )

inlineprotected

Definition at line 559 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap().

  {
    Sequence cpy(seq);
    swap(cpy);
    return *this;
  }

operator==()

template<typename T , typename Bounds , typename Elts >

bool OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator== ( const Sequence< T, Bounds, Elts > &  rhs ) const

inline

Definition at line 662 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::size().

  {
    const size_type sz = size();
    if (sz != rhs.size()) {
      return false;
    }
    for (size_type i = 0; i < sz; ++i) {
      if (!((*this)[i] == rhs[i])) {
        return false;
      }
    }
    return true;
  }

operator[]() [1/2]

template<typename T , typename Bounds , typename Elts >

Sequence< T, Bounds, Elts >::ConstElement OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator[] ( size_type  idx ) const

inline

Definition at line 614 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_.

  {
    return buffer_[idx];
  }

operator[]() [2/2]

template<typename T , typename Bounds , typename Elts >

Sequence< T, Bounds, Elts >::Element OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator[] ( size_type  idx )

inline

Definition at line 621 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_.

  {
    return Elts::make_element(buffer_[idx], release_);
  }

release()

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

seq_flag_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release ( void  ) const

inline

Definition at line 277 of file SafetyProfileSequence.h.

{ return release_; }

replace_i()

template<typename T , typename Bounds , typename Elts >

void OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::replace_i ( size_type  maximum, size_type  length, T *  data, seq_flag_type  release  )

inlineprivate

Definition at line 576 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap().

Referenced by OpenDDS::SafetyProfile::AllocPolicy< T, Sequence, Bounded< N > >::replace(), and OpenDDS::SafetyProfile::AllocPolicy< T, Sequence, Unbounded >::replace().

  {
    Sequence tmp(maximum, length, data, release);
    swap(tmp);
  }

size()

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

size_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::size ( void  ) const

inline

Definition at line 310 of file SafetyProfileSequence.h.

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator==().

{ return length_; }

swap()

template<typename T , typename Bounds , typename Elts >

void OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap ( Sequence< T, Bounds, Elts > &  rhs ) throw ( )

inlineprotected

Definition at line 567 of file SafetyProfileSequence.h.

References OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_, OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length_, OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_, and OpenDDS::DCPS::swap().

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::get_buffer(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator=(), and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::replace_i().

  {
    AllocPolicy<T, Sequence, Bounds>::swap(rhs);
    std::swap(length_, rhs.length_);
    std::swap(release_, rhs.release_);
    std::swap(buffer_, rhs.buffer_);
  }

Friends And Related Function Documentation

AllocPolicy< T, Sequence, Bounds >

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

friend struct AllocPolicy< T, Sequence, Bounds >

friend

Definition at line 315 of file SafetyProfileSequence.h.

Member Data Documentation

buffer_

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

T* OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::buffer_

mutableprivate

Definition at line 325 of file SafetyProfileSequence.h.

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::get_buffer(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::lazy_alloc(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator[](), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::Sequence(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap(), and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::~Sequence().

length_

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

size_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length_

private

Definition at line 323 of file SafetyProfileSequence.h.

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::Sequence(), and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap().

release_

template<typename T, typename Bounds, typename Elts = DefaultEltPolicy<T>>

seq_flag_type OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::release_

mutableprivate

Definition at line 324 of file SafetyProfileSequence.h.

Referenced by OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::get_buffer(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::lazy_alloc(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::length(), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::operator[](), OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::swap(), and OpenDDS::SafetyProfile::Sequence< T, Bounds, Elts >::~Sequence().

---

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

• SafetyProfileSequence.h