Cpl::Container::Stack< ITEM > Class Template Reference

This template class implements a Stack that has a fixed depth and stores copies of the data items. More...

Detailed Description

template<class ITEM>
class Cpl::Container::Stack< ITEM >

This template class implements a Stack that has a fixed depth and stores copies of the data items.

Template Args: ITEM:= Type of the data stored in the Stack

#include <Stack.h>

Inheritance diagram for Cpl::Container::Stack< ITEM >:

Public Member Functions
	Stack (unsigned maxElements, ITEM memoryForElements[]) noexcept
	Constructor.
bool	push (const ITEM src) noexcept
	Adds an item to the top of the stack.
bool	pop (ITEM &dst) noexcept
	Removes the top item of the stack.
bool	pop () noexcept
	Removes AND discards the top item of the stack.
bool	peekTop (ITEM &dst) const noexcept
	Returns the item on the top of the Stack.
ITEM *	peekTop () noexcept
	Returns a POINTER to the top item of the Stack.
bool	isEmpty (void) const noexcept
	This method returns true if the Stack is empty.
bool	isFull (void) const noexcept
	This method returns true if the Stack is full.
unsigned	getNumItems (void) const noexcept
	This method returns the current number of items in the Stack.
unsigned	getMaxItems (void) const noexcept
	This method returns the maximum number of items that can be stored in the Stack.
void	clearTheStack () noexcept
	Empties the Stack.

Constructor & Destructor Documentation

Stack()

template<class ITEM >

Cpl::Container::Stack< ITEM >::Stack ( unsigned  maxElements, ITEM  memoryForElements[]  )

noexcept

Constructor.

The application is responsible for providing the memory for the Stack. The argument ''maxElements' is the number of items that will fit in the memory allocated by 'memoryForElements' - it is NOT the number of bytes of 'memoryForElements'.

Member Function Documentation

clearTheStack()

template<class ITEM >

void Cpl::Container::Stack< ITEM >::clearTheStack ( )

inlinenoexcept

Empties the Stack.

All references to the item(s) in the stack are lost.

getMaxItems()

template<class ITEM >

unsigned Cpl::Container::Stack< ITEM >::getMaxItems ( void  ) const

inlinenoexcept

This method returns the maximum number of items that can be stored in the Stack.

getNumItems()

template<class ITEM >

unsigned Cpl::Container::Stack< ITEM >::getNumItems ( void  ) const

inlinenoexcept

This method returns the current number of items in the Stack.

isEmpty()

template<class ITEM >

bool Cpl::Container::Stack< ITEM >::isEmpty ( void  ) const

inlinenoexcept

This method returns true if the Stack is empty.

isFull()

template<class ITEM >

bool Cpl::Container::Stack< ITEM >::isFull ( void  ) const

inlinenoexcept

This method returns true if the Stack is full.

peekTop() [1/2]

template<class ITEM >

ITEM * Cpl::Container::Stack< ITEM >::peekTop ( )

inlinenoexcept

Returns a POINTER to the top item of the Stack.

If the stack is empty, the method returns a null pointer. The pointer is valid until the next push or pop operation.

NOTE: The application CAN modify the item in place on the Stack. Use this power wisely!

peekTop() [2/2]

template<class ITEM >

bool Cpl::Container::Stack< ITEM >::peekTop ( ITEM &  dst ) const

inlinenoexcept

Returns the item on the top of the Stack.

If the stack is empty, the method returns false and no value is returned.

pop() [1/2]

template<class ITEM >

bool Cpl::Container::Stack< ITEM >::pop ( )

inlinenoexcept

Removes AND discards the top item of the stack.

If the stack is empty, the method returns false and no value is returned.

pop() [2/2]

template<class ITEM >

bool Cpl::Container::Stack< ITEM >::pop ( ITEM &  dst )

inlinenoexcept

Removes the top item of the stack.

If the stack is empty, the method returns false and no value is returned.

push()

template<class ITEM >

bool Cpl::Container::Stack< ITEM >::push ( const ITEM  src )

inlinenoexcept

Adds an item to the top of the stack.

Returns true if successful; else false is returned (e.g. on stack overflow).

---

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

• Cpl/Container/Stack.h