OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Attributes | List of all members
DcmStack Class Reference

this class manages a stack of pointers to DcmObject instances. More...

Collaboration diagram for DcmStack:
[legend]

Public Member Functions

 DcmStack ()
 default constructor, creates empty stack
 
 DcmStack (const DcmStack &arg)
 copy constructor.
 
 ~DcmStack ()
 destructor, not virtual. Do not derive from this class.
 
DcmStackoperator= (const DcmStack &arg)
 copy assignment operator.
 
OFBool operator== (const DcmStack &arg) const
 comparison operator, needed for MSVC5.
 
OFBool operator< (const DcmStack &arg) const
 dummy comparison operator, needed for MSVC5.
 
DcmObjectpush (DcmObject *obj)
 push new pointer do DcmObject instance on stack
 
DcmObjectpop ()
 removes uppermost entry from stack and returns it.
 
DcmObjecttop () const
 returns uppermost entry of stack without removing it.
 
DcmObjectelem (const unsigned long number) const
 returns n-th element from stack without removing it.
 
OFBool empty () const
 checks if the stack is empty
 
unsigned long card () const
 returns cardinality (number of entries) of the stack
 
void clear ()
 returns the stack to default-constructed state, i.e.
 

Private Attributes

DcmStackNodetopNode_
 pointer to the upmost stack entry, NULL if empty
 
unsigned long cardinality_
 current cardinality of the stack
 

Detailed Description

this class manages a stack of pointers to DcmObject instances.

The objects pointed to are never touched, e.g. deleted.

Definition at line 77 of file dcstack.h.

Constructor & Destructor Documentation

DcmStack::DcmStack ( const DcmStack arg)

copy constructor.

Only pointers to objects are copied, the DcmObject instances are not duplicated.

Parameters
argstack to copy from

Member Function Documentation

unsigned long DcmStack::card ( ) const

returns cardinality (number of entries) of the stack

Returns
cardinality of stack
void DcmStack::clear ( )

returns the stack to default-constructed state, i.e.

empty state.

DcmObject* DcmStack::elem ( const unsigned long  number) const

returns n-th element from stack without removing it.

Returns
n-th element from stack
OFBool DcmStack::empty ( ) const

checks if the stack is empty

Returns
true if stack is empty, false otherwise
OFBool DcmStack::operator< ( const DcmStack arg) const

dummy comparison operator, needed for MSVC5.

Parameters
argstack to compare to
Returns
true if the cardinality of this stack is smaller than the cardinality of arg, or if the cardinality is equal and pointer comparison, from the top to the bottom of the stack results in a smaller pointer for this stack.
DcmStack& DcmStack::operator= ( const DcmStack arg)

copy assignment operator.

Only pointers to objects are copied, the DcmObject instances are not duplicated.

Parameters
argobject to assign from
Returns
reference to this object
OFBool DcmStack::operator== ( const DcmStack arg) const

comparison operator, needed for MSVC5.

Parameters
argstack to compare to
Returns
true if stacks are equal, false otherwise
DcmObject* DcmStack::pop ( )

removes uppermost entry from stack and returns it.

Returns
uppermost stack entry
DcmObject* DcmStack::push ( DcmObject obj)

push new pointer do DcmObject instance on stack

Parameters
objobject pointer to push on stack
Returns
pointer passed as obj
DcmObject* DcmStack::top ( ) const

returns uppermost entry of stack without removing it.

Returns
uppermost stack entry

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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2