DCMTK  Version 3.6.5
OFFIS DICOM Toolkit
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DcmList Class Reference

double-linked list class that maintains pointers to DcmObject instances. More...

Public Member Functions

 DcmList ()
 constructor
 
 ~DcmList ()
 destructor
 
DcmObjectappend (DcmObject *obj)
 insert object at end of list More...
 
DcmObjectprepend (DcmObject *obj)
 insert object at start of list More...
 
DcmObjectinsert (DcmObject *obj, E_ListPos pos=ELP_next)
 insert object relative to current position and indicator More...
 
DcmObjectremove ()
 remove current entry from list, return element More...
 
DcmObjectget (E_ListPos pos=ELP_atpos)
 get pointer to element in list at given position More...
 
DcmObjectseek (E_ListPos pos=ELP_next)
 seek within element in list to given position (i.e. More...
 
DcmObjectseek_to (unsigned long absolute_position)
 seek within element in list to given element index (i.e. More...
 
void deleteAllElements ()
 Remove and delete all elements from list. More...
 
unsigned long card () const
 return cardinality of list
 
OFBool empty (void) const
 return true if list is empty, false otherwise
 
OFBool valid (void) const
 return true if current node exists, false otherwise
 

Private Member Functions

DcmListoperator= (const DcmList &)
 private undefined copy constructor
 
 DcmList (const DcmList &newList)
 private undefined copy assignment operator
 

Private Attributes

DcmListNodefirstNode
 pointer to first node in list
 
DcmListNodelastNode
 pointer to last node in list
 
DcmListNodecurrentNode
 pointer to current node in list
 
unsigned long cardinality
 number of elements in list
 

Detailed Description

double-linked list class that maintains pointers to DcmObject instances.

The remove operation does not delete the object pointed to, however, the destructor will delete all elements pointed to

Member Function Documentation

◆ append()

DcmObject* DcmList::append ( DcmObject obj)

insert object at end of list

Parameters
objpointer to object
Returns
pointer to object

◆ deleteAllElements()

void DcmList::deleteAllElements ( )

Remove and delete all elements from list.

Thus, the elements' memory is also freed by this operation. The list is empty after calling this function.

◆ get()

DcmObject* DcmList::get ( E_ListPos  pos = ELP_atpos)

get pointer to element in list at given position

Parameters
posposition indicator
Returns
pointer to object

◆ insert()

DcmObject* DcmList::insert ( DcmObject obj,
E_ListPos  pos = ELP_next 
)

insert object relative to current position and indicator

Parameters
objpointer to object
posposition indicator
Returns
pointer to object

◆ prepend()

DcmObject* DcmList::prepend ( DcmObject obj)

insert object at start of list

Parameters
objpointer to object
Returns
pointer to object

◆ remove()

DcmObject* DcmList::remove ( )

remove current entry from list, return element

Returns
pointer to removed element, which is not deleted

◆ seek()

DcmObject* DcmList::seek ( E_ListPos  pos = ELP_next)

seek within element in list to given position (i.e.

set current element to given position)

Parameters
posposition indicator
Returns
pointer to new current object

◆ seek_to()

DcmObject* DcmList::seek_to ( unsigned long  absolute_position)

seek within element in list to given element index (i.e.

set current element to given index)

Parameters
absolute_positionposition index < card()
Returns
pointer to new current object

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


Generated on Mon Oct 28 2019 for DCMTK Version 3.6.5 by Doxygen 1.8.15