DVPSVOILUT_PList Class Reference

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

List of all members.

Public Member Functions

 DVPSVOILUT_PList ()
 default constructor
 DVPSVOILUT_PList (const DVPSVOILUT_PList &copy)
 copy constructor
DVPSVOILUT_PList * clone ()
 clone method.
virtual ~DVPSVOILUT_PList ()
 destructor
OFCondition read (DcmItem &dset)
 reads a list of VOI LUTs from a DICOM dataset.
void clear ()
 reset the object to initial state.
size_t size () const
 get number of VOI LUTs in this list.
DVPSVOILUT * getVOILUT (size_t idx)
 returns a pointer to the VOI LUT with the given index or NULL if it does not exist.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream

Private Member Functions

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

Private Attributes

OFList< DVPSVOILUT * > list_
 the list maintained by this object
OFConsole * logstream
 output stream for error messages, never NULL
OFBool verboseMode
 flag indicating whether we're operating in verbose mode
OFBool debugMode
 flag indicating whether we're operating in debug mode

Detailed Description

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

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

Definition at line 49 of file dvpsvll.h.

Member Function Documentation

void DVPSVOILUT_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.

DVPSVOILUT_PList* DVPSVOILUT_PList::clone (   )  [inline]
 

clone method.

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

Definition at line 62 of file dvpsvll.h.

References DVPSVOILUT_PList().

DVPSVOILUT* DVPSVOILUT_PList::getVOILUT (  size_t  idx  ) 
 

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

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

OFCondition DVPSVOILUT_PList::read (  DcmItem &  dset  ) 
 

reads a list of VOI LUTs from a DICOM dataset.

The DICOM elements of the VOI LUT Sequence are copied from the dataset to this object. The completeness of the item (presence of all required elements, value multiplicity) is checked. If this method returns an error code, the object is in undefined state afterwards.

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

void DVPSVOILUT_PList::setLog (  OFConsole *  stream,
OFBool  verbMode,
OFBool  dbgMode
) 
 

sets a new log stream

Parameters:
stream new log stream, NULL for default logstream
verbMode verbose mode flag
dbgMode debug mode flag

size_t DVPSVOILUT_PList::size (   )  const [inline]
 

get number of VOI LUTs in this list.

Returns:
the number of VOI LUTs.

Definition at line 87 of file dvpsvll.h.

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

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5