XnStack Class Reference

#include <XnStack.h>

List of all members.

Public Member Functions
XnBool	IsEmpty () const
XnStatus	Pop (XnValue &value)
XnStatus	Push (XnValue const &value)
XnUInt32	Size () const
XnValue const &	Top () const
XnValue &	Top ()
	XnStack ()
	~XnStack ()
Private Attributes
XnList	m_List

---

Detailed Description

The stack

Definition at line 40 of file XnStack.h.

---

Constructor & Destructor Documentation

XnStack::XnStack

(

)

[inline]

Constructor. Initialize internal representations

Definition at line 46 of file XnStack.h.

XnStack::~XnStack

(

)

[inline]

Destructor. Destroy internal representations

Definition at line 50 of file XnStack.h.

---

Member Function Documentation

XnBool XnStack::IsEmpty

(

)

const [inline]

Check if stack is empty

Definition at line 105 of file XnStack.h.

XnStatus XnStack::Pop

(

XnValue &

value

)

[inline]

Pop the value at the top of the stack

Parameters:

value

[out] The value that was at the top of the stack

Returns:

XN_STATUS_IS_EMPTY The stack is empty

Definition at line 71 of file XnStack.h.

XnStatus XnStack::Push

(

XnValue const &

value

)

[inline]

Push a new value to the stack

Parameters:

value

[in] The value to add to the stack

Returns:

XN_STATUS_ALLOC_FAILED Failed to add to the stack because no nodes are available.

Definition at line 59 of file XnStack.h.

XnUInt32 XnStack::Size

(

)

const [inline]

Get current size of the stack

Definition at line 113 of file XnStack.h.

XnValue const& XnStack::Top

(

)

const [inline]

Get the value at the top of the queue (it is user responsibility to check queue is not empty)

Returns:

a reference to the object at head of the queue.

Definition at line 87 of file XnStack.h.

XnValue& XnStack::Top

(

)

[inline]

Get the value at the top of the queue (it is user responsibility to check queue is not empty)

Returns:

a reference to the object at head of the queue.

Definition at line 97 of file XnStack.h.

---

Member Data Documentation

XnList XnStack::m_List [private]

The internal XnList with which the stack is implemented.

Definition at line 120 of file XnStack.h.

---

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

• XnStack.h