JPtrQueue< T, S > Class Template Reference

#include <JPtrQueue.h>

Inheritance diagram for JPtrQueue< T, S >:

Public Member Functions
	JPtrQueue (const JPtrArrayT::CleanUpAction action)
	~JPtrQueue () override
void	AppendCopy (const T &newElement)
void	FlushDelete ()
void	FlushDeleteAsArrays ()
void	DiscardDelete (const JSize numToDiscard)
void	DiscardDeleteAsArrays (const JSize numToDiscard)
JPtrArrayT::CleanUpAction	GetCleanUpAction () const
void	SetCleanUpAction (const JPtrArrayT::CleanUpAction action)
Public Member Functions inherited from JQueue< T *, S >
	JQueue ()
	JQueue (const JQueue< T *, S > &source)
	~JQueue () override
JQueue< T *, S > &	operator= (const JQueue< T *, S > &source)
void	Append (const T * &newElement)
T *	GetNext ()
bool	GetNext (T * *element)
const T *	PeekNext () const
bool	PeekNext (T * *element) const
const T *	PeekNext (const JIndex index) const
bool	PeekNext (const JIndex index, T * *element) const
void	Flush ()
void	Discard (const JSize numToDiscard)
JListIterator< T * > *	NewIterator ()
JListIterator< T * > *	NewIterator () const
Public Member Functions inherited from JContainer
	JContainer ()
	JContainer (const JContainer &source)
JContainer &	operator= (const JContainer &source)
Public Member Functions inherited from JCollection
	JCollection ()
	JCollection (const JCollection &source)
	~JCollection () override
JCollection &	operator= (const JCollection &source)
JSize	GetItemCount () const
bool	IsEmpty () const
bool	IndexValid (const JIndex index) const
JIndex	GetIndexFromEnd (const JIndex index) const
JString	ToString () const override
Public Member Functions inherited from JBroadcaster
	JBroadcaster ()
virtual	~JBroadcaster ()
JBroadcaster &	operator= (const JBroadcaster &source)
bool	HasSenders () const
JSize	GetSenderCount () const
bool	HasRecipients () const
JSize	GetRecipientCount () const
template<class T >
void	ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)

Additional Inherited Members
Protected Member Functions inherited from JQueue< T *, S >
S *	GetElements ()
Protected Member Functions inherited from JContainer
void	InstallCollection (JCollection *list)
const JCollection *	GetList () const
void	Receive (JBroadcaster *sender, const Message &message) override
Protected Member Functions inherited from JCollection
void	ItemAdded ()
void	ItemRemoved ()
void	SetItemCount (const JSize newItemCount)
Protected Member Functions inherited from JBroadcaster
	JBroadcaster (const JBroadcaster &source)
void	ListenTo (const JBroadcaster *sender)
void	StopListening (const JBroadcaster *sender)
void	ClearWhenGoingAway (const JBroadcaster *sender, void *pointerToMember)
void	StopListening (const JBroadcaster *sender, const std::type_info &messageType)
template<class T >
void	Send (JBroadcaster *recipient, const T &message)
template<class T >
void	Broadcast (const T &message)
void	SendWithFeedback (JBroadcaster *recipient, Message *message)
void	BroadcastWithFeedback (Message *message)
virtual void	ReceiveWithFeedback (JBroadcaster *sender, Message *message)
virtual void	ReceiveGoingAway (JBroadcaster *sender)

Detailed Description

template<class T, class S>
class JPtrQueue< T, S >

Interface for JPtrQueue class

Constructor & Destructor Documentation

JPtrQueue()

template<class T , class S >

JPtrQueue< T, S >::JPtrQueue

(

const JPtrArrayT::CleanUpAction

action

)

This class provides extra functions that are useful when storing a queue of pointers.

~JPtrQueue()

template<class T , class S >

JPtrQueue< T, S >::~JPtrQueue ( )

override

Member Function Documentation

AppendCopy()

template<class T , class S >

void JPtrQueue< T, S >::AppendCopy

(

const T &

data

)

Not called Append() to avoid shadowing function in base class.

DiscardDelete()

template<class T , class S >

void JPtrQueue< T, S >::DiscardDelete

(

const JSize

numToDiscard

)

Delete the first few elements and remove them from the queue.

DiscardDeleteAsArrays()

template<class T , class S >

void JPtrQueue< T, S >::DiscardDeleteAsArrays

(

const JSize

numToDiscard

)

Delete the first few elements and remove them from the queue.

FlushDelete()

template<class T , class S >

void JPtrQueue< T, S >::FlushDelete

(

)

Delete all the elements and remove them from the queue.

FlushDeleteAsArrays()

template<class T , class S >

void JPtrQueue< T, S >::FlushDeleteAsArrays

(

)

Delete all the elements and remove them from the queue.

GetCleanUpAction()

template<class T , class S >

JPtrArrayT::CleanUpAction JPtrQueue< T, S >::GetCleanUpAction ( ) const

inline

What to do when the destructor is called. This is especially useful for objects allocated on the stack, because one can set the appropriate action and then never have to worry about short-circuit returns.

SetCleanUpAction()

template<class T , class S >

void JPtrQueue< T, S >::SetCleanUpAction ( const JPtrArrayT::CleanUpAction  action )

inline

---

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

• libjcore/code/JPtrQueue.h
• libjcore/code/JPtrQueue.tmpl