DVPSGraphicObject_PList Class Reference

the list of graphic objects contained in a presentation state (internal use only). More...

List of all members.

Public Member Functions

 DVPSGraphicObject_PList ()
 default constructor
 DVPSGraphicObject_PList (const DVPSGraphicObject_PList &copy)
 copy constructor
DVPSGraphicObject_PList * clone ()
 clone method.
virtual ~DVPSGraphicObject_PList ()
 destructor
OFCondition read (DcmItem &dset)
 reads a list of graphic objects from a DICOM dataset.
OFCondition write (DcmItem &dset)
 writes the list of graphic objects managed by this object to a DICOM dataset.
void clear ()
 reset the object to initial state.
size_t size () const
 get number of graphic objects in this list.
DVPSGraphicObject * getGraphicObject (size_t idx)
 returns a pointer to the graphic object with the given index or NULL if it does not exist.
void addGraphicObject (DVPSGraphicObject *graphic)
 adds the given graphic object to the list of graphic objects managed by this object.
DVPSGraphicObject * removeGraphicObject (size_t idx)
 returns a pointer to the graphic object with the given index (or NULL if it does not exist) and removes it from the list.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream

Private Member Functions

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

Private Attributes

OFList< DVPSGraphicObject * > 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 graphic objects contained in a presentation state (internal use only).

This class manages the data structures comprising one complete Graphic Object Sequence which is contained in one item of the Graphic Annotation Sequence in a Presentation State object.

Definition at line 49 of file dvpsgrl.h.

Member Function Documentation

void DVPSGraphicObject_PList::addGraphicObject (  DVPSGraphicObject *  graphic  ) 
 

adds the given graphic object to the list of graphic objects managed by this object.

Parameters:
text graphic object to be inserted.

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

DVPSGraphicObject_PList* DVPSGraphicObject_PList::clone (   )  [inline]
 

clone method.

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

Definition at line 62 of file dvpsgrl.h.

References DVPSGraphicObject_PList().

DVPSGraphicObject* DVPSGraphicObject_PList::getGraphicObject (  size_t  idx  ) 
 

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

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

OFCondition DVPSGraphicObject_PList::read (  DcmItem &  dset  ) 
 

reads a list of graphic objects from a DICOM dataset.

The DICOM elements of the Graphic Object 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 GraphicObjectSequence is to be read
Returns:
EC_Normal if successful, an error code otherwise.

DVPSGraphicObject* DVPSGraphicObject_PList::removeGraphicObject (  size_t  idx  ) 
 

returns a pointer to the graphic object with the given index (or NULL if it does not exist) and removes it from the list.

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

void DVPSGraphicObject_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 DVPSGraphicObject_PList::size (   )  const [inline]
 

get number of graphic objects in this list.

Returns:
the number of graphic objects.

Definition at line 95 of file dvpsgrl.h.

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

OFCondition DVPSGraphicObject_PList::write (  DcmItem &  dset  ) 
 

writes the list of graphic objects managed by this object to a DICOM dataset.

Copies of the DICOM elements managed by this object are inserted into the DICOM dataset.

Parameters:
dset the dataset to which the GraphicObjectSequence is written
Returns:
EC_Normal if successful, an error code otherwise.

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