bdlcc::Deque< TYPE >::ConstProctor Class Reference

#include <bdlcc_deque.h>

Detailed Description

template<class TYPE>
class bdlcc::Deque< TYPE >::ConstProctor

This class defines a proctor type that provides direct const access to the underlying bsl::deque contained in a Deque.

Public Member Functions
	ConstProctor (const Deque< TYPE > *container=0)
	~ConstProctor ()
void	load (const Deque< TYPE > *container)
void	release ()
const MonoDeque *	operator-> () const
const MonoDeque &	operator* () const
const TYPE &	operator[] (size_type position) const
bool	isNull () const

Constructor & Destructor Documentation

ConstProctor()

template<class TYPE >

bdlcc::Deque< TYPE >::ConstProctor::ConstProctor ( const Deque< TYPE > *  container = 0 )

inlineexplicit

Create a ConstProctor object to provide const access to the underlying bsl::deque contained in the optionally specified *container, locking containers mutex. If no container is specified, this object will be null.

~ConstProctor()

template<class TYPE >

bdlcc::Deque< TYPE >::ConstProctor::~ConstProctor ( )

inline

Release the lock on the mutex of the Deque that was provided at contstuction and destroy this Proctor object.

Precondition

The behavior is undefined if the Deque has been modified since the construction of this object.

Member Function Documentation

isNull()

template<class TYPE >

bool bdlcc::Deque< TYPE >::ConstProctor::isNull ( ) const

inline

Return true if this object is not associated with a Deque object.

load()

template<class TYPE >

void bdlcc::Deque< TYPE >::ConstProctor::load ( const Deque< TYPE > *  container )

inline

In the case where this Proctor has been released, attach this object to the specified container. If this object is already attached, release the previous object first.

Precondition

The behavior is undefined if 0 == container.

operator*()

template<class TYPE >

const bsl::deque< TYPE > & bdlcc::Deque< TYPE >::ConstProctor::operator* ( ) const

inline

Return a reference to the bsl::deque managed by this Proctor object.

Precondition

The behavior is undefined if this ConstProctor has been released.

operator->()

template<class TYPE >

const bsl::deque< TYPE > * bdlcc::Deque< TYPE >::ConstProctor::operator-> ( ) const

inline

Return a pointer to the bsl::deque contained in the Deque managed by this object.

Precondition

The behavior is undefined if this ConstProctor has been released.

operator[]()

template<class TYPE >

const TYPE & bdlcc::Deque< TYPE >::ConstProctor::operator[] ( size_type  position ) const

inline

Return a reference providing non-modifiable access to the element at the specified position in the bsl::deque held by this proctor.

Precondition

The behavior is undefined unless position < size where size is the number of elements in that deque.

release()

template<class TYPE >

void bdlcc::Deque< TYPE >::ConstProctor::release ( )

inline

Release this proctor without destroying it. Afterward the destructor will have no effect. This may be called multiple times; only the first call has any effect;

---

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

• bdlcc_deque.h