DVPSCurve_PList Class Reference

the list of curves contained in image which is attached to a presentation state. More...

List of all members.

Public Member Functions

 DVPSCurve_PList ()
 default constructor
 DVPSCurve_PList (const DVPSCurve_PList &copy)
 copy constructor
DVPSCurve_PList * clone ()
 clone method.
virtual ~DVPSCurve_PList ()
 destructor
OFCondition read (DcmItem &dset)
 reads all curve groups which can be displayed in a presentation state from a DICOM dataset.
void clear ()
 reset the object to initial state.
OFBool haveCurveGroup (Uint16 group)
 check presence of curve group
DVPSCurve * getCurveGroup (Uint16 group)
 get curve by group
DVPSCurve * getCurve (size_t idx)
 get curve by index
size_t size () const
 get number of curves in this list.

Private Member Functions

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

Private Attributes

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

Detailed Description

the list of curves contained in image which is attached to a presentation state.

This class manages the data structures comprising the list of curves (all instances of the Curve Module repeating elements) contained in an image object.

Definition at line 44 of file dvpscul.h.

Member Function Documentation

DVPSCurve_PList* DVPSCurve_PList::clone (  )  [inline]

clone method.

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

Definition at line 57 of file dvpscul.h.

References DVPSCurve_PList().

OFCondition DVPSCurve_PList::read ( DcmItem &  dset  ) 

reads all curve groups which can be displayed in a presentation state from a DICOM dataset.

This method checks which curves are contained in the DICOM dataset. All curves complying with the presentation state requirements (i.e. 2-dimensional POLY or ROI curves without curve descriptor) are copied into the "list of curves" structure managed by this object. The completeness of the curves (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 DICOM dataset from which the curves are read
Returns:
EC_Normal if successful, an error code otherwise.

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

OFBool DVPSCurve_PList::haveCurveGroup ( Uint16  group  ) 

check presence of curve group

Parameters:
group curve repeating group to be checked
Returns:
OFTrue if the specified curve group is present in the list of curves managed by this object.

DVPSCurve* DVPSCurve_PList::getCurveGroup ( Uint16  group  ) 

get curve by group

Parameters:
group curve repeating group to be checked
Returns:
a pointer to the matching DVPSCurve object if found, NULL otherwise.

DVPSCurve* DVPSCurve_PList::getCurve ( size_t  idx  ) 

get curve by index

Parameters:
idx index, must be < size()
Returns:
a pointer to the matching DVPSCurve object if it exists, NULL otherwise.

size_t DVPSCurve_PList::size (  )  const [inline]

get number of curves in this list.

Returns:
the number of curves.

Definition at line 106 of file dvpscul.h.

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

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