---

ACE_Fixed_Stack Class Template Reference

Implement a generic LIFO abstract data type. More...

#include <Containers_T.h>

Collaboration diagram for ACE_Fixed_Stack:

[legend]List of all members.

Public Methods
	ACE_Fixed_Stack (void)
	Initialize a new stack so that it is empty. More...
	ACE_Fixed_Stack (const ACE_Fixed_Stack< T, ACE_SIZE > &s)
	The copy constructor (performs initialization). More...
void	operator= (const ACE_Fixed_Stack< T, ACE_SIZE > &s)
	Assignment operator (performs assignment). More...
	~ACE_Fixed_Stack (void)
	Perform actions needed when stack goes out of scope. More...
int	push (const T &new_item)
	Constant time placement of element on top of stack. More...
int	pop (T &item)
	Constant time removal of top of stack. More...
int	top (T &item) const
	Constant time examination of top of stack. More...
int	is_empty (void) const
	Returns 1 if the container is empty, otherwise returns 0. More...
int	is_full (void) const
	Returns 1 if the container is full, otherwise returns 0. More...
size_t	size (void) const
	The number of items in the stack. More...
void	dump (void) const
	Dump the state of an object. More...
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...
Private Attributes
size_t	size_
	Size of the allocated data. More...
size_t	top_
	Keeps track of the current top of stack. More...
T	stack_ [ACE_SIZE]
	Holds the stack's contents. More...

---

Detailed Description

template<class T, size_t ACE_SIZE>
class ACE_Fixed_Stack< T, ACE_SIZE >

Implement a generic LIFO abstract data type.

This implementation of a Stack uses a fixed array with the size fixed at instantiation time.

Requirements and Performance Characteristics

• Internal Structure Fixed array
• Duplicates allowed? Yes
• Random access allowed? No
• Search speed N/A
• Insert/replace speed N/A
• Iterator still valid after change to container? N/A
• Frees memory for removed elements? No
• Items inserted by Value
• Requirements for contained type
  1. Default constructor
  2. Copy constructor
  3. operator=

Definition at line 207 of file Containers_T.h.

---

Constructor & Destructor Documentation

template<class T, size_t ACE_SIZE> ACE_Fixed_Stack< T, ACE_SIZE >::ACE_Fixed_Stack (  void    )

Initialize a new stack so that it is empty. Initialize an empty stack. Definition at line 92 of file Containers_T.cpp. References ACE_TRACE. : size_ (ACE_SIZE), top_ (0) { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::ACE_Fixed_Stack"); }

template<class T, size_t ACE_SIZE> ACE_Fixed_Stack< T, ACE_SIZE >::ACE_Fixed_Stack (  const ACE_Fixed_Stack< T, ACE_SIZE > &    s )

The copy constructor (performs initialization). Initialize the stack and copy the provided stack into the current stack. Definition at line 100 of file Containers_T.cpp. References ACE_TRACE, stack_, and top_. : size_ (s.size_), top_ (s.top_) { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::ACE_Fixed_Stack"); for (size_t i = 0; i < this->top_; i++) this->stack_[i] = s.stack_[i]; }

template<class T, size_t ACE_SIZE> ACE_Fixed_Stack< T, ACE_SIZE >::~ACE_Fixed_Stack (  void    )

Perform actions needed when stack goes out of scope. Destroy the stack. Definition at line 124 of file Containers_T.cpp. References ACE_TRACE. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::~ACE_Fixed_Stack"); }

---

Member Function Documentation

template<class T, size_t ACE_SIZE> void ACE_Fixed_Stack< T, ACE_SIZE >::dump (  void    )  const

Dump the state of an object. Definition at line 86 of file Containers_T.cpp. References ACE_TRACE. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::dump"); }

template<class T, size_t ACE_SIZE> ACE_INLINE int ACE_Fixed_Stack< T, ACE_SIZE >::is_empty (  void    )  const

Returns 1 if the container is empty, otherwise returns 0. Performs constant time check to see if stack is empty. Definition at line 68 of file Containers_T.i. References ACE_TRACE, and top_. Referenced by pop, and top. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::is_empty"); return this->top_ == 0; }

template<class T, size_t ACE_SIZE> ACE_INLINE int ACE_Fixed_Stack< T, ACE_SIZE >::is_full (  void    )  const

Returns 1 if the container is full, otherwise returns 0. Performs constant time check to see if stack is full. Definition at line 75 of file Containers_T.i. References ACE_TRACE, size_, and top_. Referenced by push. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::is_full"); return this->top_ >= this->size_; }

template<class T, size_t ACE_SIZE> void ACE_Fixed_Stack< T, ACE_SIZE >::operator= (  const ACE_Fixed_Stack< T, ACE_SIZE > &    s )

Assignment operator (performs assignment). Perform a deep copy of the provided stack. Definition at line 110 of file Containers_T.cpp. References ACE_TRACE, stack_, and top_. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::operator="); if (&s != this) { this->top_ = s.top_; for (size_t i = 0; i < this->top_; i++) this->stack_[i] = s.stack_[i]; } }

template<class T, size_t ACE_SIZE> ACE_INLINE int ACE_Fixed_Stack< T, ACE_SIZE >::pop (  T &    item )

Constant time removal of top of stack. Remove and return the top stack item. Returns -1 if the stack is already empty, 0 if the stack is not already empty, and -1 if failure occurs. Definition at line 95 of file Containers_T.i. References ACE_TRACE, is_empty, stack_, and top_. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::pop"); if (this->is_empty () == 0) { item = this->stack_[--this->top_]; return 0; } else return -1; }

template<class T, size_t ACE_SIZE> ACE_INLINE int ACE_Fixed_Stack< T, ACE_SIZE >::push (  const T &    new_item )

Constant time placement of element on top of stack. Place a new item on top of the stack. Returns -1 if the stack is already full, 0 if the stack is not already full, and -1 if failure occurs. Definition at line 82 of file Containers_T.i. References ACE_TRACE, is_full, stack_, and top_. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::push"); if (this->is_full () == 0) { this->stack_[this->top_++] = new_item; return 0; } else return -1; }

template<class T, size_t ACE_SIZE> ACE_INLINE size_t ACE_Fixed_Stack< T, ACE_SIZE >::size (  void    )  const

The number of items in the stack. Constant time access to the current size of the stack. Definition at line 121 of file Containers_T.i. References size_. { return this->size_; }

template<class T, size_t ACE_SIZE> ACE_INLINE int ACE_Fixed_Stack< T, ACE_SIZE >::top (  T &    item )  const

Constant time examination of top of stack. Return top stack item without removing it. Returns -1 if the stack is already empty, 0 if the stack is not already empty, and -1 if failure occurs. Definition at line 108 of file Containers_T.i. References ACE_TRACE, is_empty, stack_, and top_. { ACE_TRACE ("ACE_Fixed_Stack<T, ACE_SIZE>::top"); if (this->is_empty () == 0) { item = this->stack_[this->top_ - 1]; return 0; } else return -1; }

---

Member Data Documentation

template<class T, size_t ACE_SIZE> ACE_Fixed_Stack::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks. Definition at line 285 of file Containers_T.h.

template<class T, size_t ACE_SIZE> size_t ACE_Fixed_Stack::size_ [private]

Size of the allocated data. Definition at line 289 of file Containers_T.h. Referenced by is_full, and size.

template<class T, size_t ACE_SIZE> T ACE_Fixed_Stack::stack_[ACE_SIZE] [private]

Holds the stack's contents. Definition at line 295 of file Containers_T.h. Referenced by ACE_Fixed_Stack, operator=, pop, push, and top.

template<class T, size_t ACE_SIZE> size_t ACE_Fixed_Stack::top_ [private]

Keeps track of the current top of stack. Definition at line 292 of file Containers_T.h. Referenced by ACE_Fixed_Stack, is_empty, is_full, operator=, pop, push, and top.

---

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

• Containers_T.h
• Containers_T.cpp
• Containers_T.i

---