DVPSVOIWindow_PList Class Reference

the list of VOI Windows contained in an image attached to a presentation state. More...

List of all members.

Public Member Functions

 DVPSVOIWindow_PList ()
 default constructor
 DVPSVOIWindow_PList (const DVPSVOIWindow_PList &copy)
 copy constructor
DVPSVOIWindow_PList * clone ()
 clone method.
virtual ~DVPSVOIWindow_PList ()
 destructor
OFCondition read (DcmItem &dset)
 reads a list of VOI Windows from a DICOM dataset.
void clear ()
 reset the object to initial state.
size_t size () const
 get number of VOI Windows in this list.
DVPSVOIWindow * getVOIWindow (size_t idx)
 returns a pointer to the VOI Window with the given index or NULL if it does not exist.

Private Member Functions

DVPSVOIWindow_PList & operator= (const DVPSVOIWindow_PList &)
 private undefined assignment operator

Private Attributes

OFList< DVPSVOIWindow * > list_
 the list maintained by this object

Detailed Description

the list of VOI Windows contained in an image attached to a presentation state.

This class manages the data structures comprising the VOI Windows of one image attached to a presentation state.

Definition at line 44 of file dvpsvwl.h.

Member Function Documentation

DVPSVOIWindow_PList* DVPSVOIWindow_PList::clone (  )  [inline]

clone method.

Returns:
a pointer to a new DVPSVOIWindow_PList object containing a deep copy of this object.

Definition at line 57 of file dvpsvwl.h.

References DVPSVOIWindow_PList().

OFCondition DVPSVOIWindow_PList::read ( DcmItem &  dset  ) 

reads a list of VOI Windows from a DICOM dataset.

The DICOM elements of the VOI Window are copied from the dataset to this object. If this method returns an error code, the object is in undefined state afterwards.

Parameters:
dset the dataset from which the VOI Windows are to be read
Returns:
EC_Normal if successful, an error code otherwise.

void DVPSVOIWindow_PList::clear (  ) 

reset the object to initial state.

After this call, the object is in the same state as after creation with the default constructor.

size_t DVPSVOIWindow_PList::size (  )  const [inline]

get number of VOI Windows in this list.

Returns:
the number of VOI Windows.

Definition at line 80 of file dvpsvwl.h.

References list_, and OFList< T >::size().

DVPSVOIWindow* DVPSVOIWindow_PList::getVOIWindow ( size_t  idx  ) 

returns a pointer to the VOI Window with the given index or NULL if it does not exist.

Parameters:
idx index, must be < size()
Returns:
pointer to VOI Window or NULL

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

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1