DVPSGraphicLayer_PList Class Reference

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

List of all members.

Public Member Functions

 DVPSGraphicLayer_PList ()
 default constructor
 DVPSGraphicLayer_PList (const DVPSGraphicLayer_PList &copy)
 copy constructor
DVPSGraphicLayer_PList * clone ()
 clone method.
virtual ~DVPSGraphicLayer_PList ()
 destructor
OFCondition read (DcmItem &dset)
 reads the Graphic Layer Sequence from a DICOM dataset.
OFCondition write (DcmItem &dset)
 writes the Graphic Layer Sequence managed by this object to a DICOM dataset.
void clear ()
 reset the object to initial state.
OFCondition addGraphicLayer (const char *gLayer, const Sint32 gLayerOrder, const char *gLayerDescription=NULL)
 adds a new graphic layer to the list.
OFCondition addGraphicLayer (const char *gLayer, const char *gLayerDescription=NULL)
 creates a new graphic layer with the given name and optional description.
size_t size () const
 get number of graphic layer objects in this list.
void sortGraphicLayers (Sint32 lowestLayer=1)
 sorts the graphic layers according to the graphic layer order.
const char * getGraphicLayerName (size_t idx)
 gets the unique name of the graphic layer with the given index.
size_t getGraphicLayerIndex (const char *name)
 gets the index of the graphic layer with the given unique name.
const char * getGraphicLayerDescription (size_t idx)
 gets a description string for the graphic layer with the given index.
OFBool haveGraphicLayerRecommendedDisplayValue (size_t idx)
 checks whether a recommended display value (grayscale, color or both) for the given graphic layer exists.
OFCondition getGraphicLayerRecommendedDisplayValueGray (size_t idx, Uint16 &gray)
 gets the recommended grayscale display value for the given graphic layer.
OFCondition getGraphicLayerRecommendedDisplayValueRGB (size_t idx, Uint16 &r, Uint16 &g, Uint16 &b)
 gets the recommended RGB display value for the given graphic layer.
OFCondition setGraphicLayerRecommendedDisplayValueGray (size_t idx, Uint16 gray)
 set graphic layer recommended grayscale display value for the given graphic layer.
OFCondition setGraphicLayerRecommendedDisplayValueRGB (size_t idx, Uint16 r, Uint16 g, Uint16 b)
 set graphic layer recommended RGB display value for the given graphic layer.
void removeGraphicLayerRecommendedDisplayValue (size_t idx, OFBool rgb, OFBool monochrome)
 removes recommended display values for the given graphic layer.
OFCondition setGraphicLayerName (size_t idx, const char *name)
 assigns a new unique name to the given graphic layer.
OFCondition setGraphicLayerDescription (size_t idx, const char *descr)
 sets a new description to the given graphic layer.
OFCondition toFrontGraphicLayer (size_t idx)
 makes a graphic layer the highest layer for display.
OFCondition toBackGraphicLayer (size_t idx)
 makes a graphic layer the lowest layer for display.
OFCondition exchangeGraphicLayers (size_t idx1, size_t idx2)
 exchanges the layer order of the two graphic layers with the given indices.
OFCondition removeGraphicLayer (size_t idx)
 removes and deletes a graphic layer.
void cleanupLayers (DVPSOverlayCurveActivationLayer_PList &activations, DVPSGraphicAnnotation_PList &annotations)
 removes and deletes all graphic layers for which no matching text, graphic, curve or overlay object exists.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream

Private Member Functions

DVPSGraphicLayer_PList & operator= (const DVPSGraphicLayer_PList &)
 private undefined assignment operator
DVPSGraphicLayer * getGraphicLayer (size_t idx)
 gets the the graphic layer with the given index.

Private Attributes

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

This class manages the data structures comprising the complete Graphic Layer Sequence in a Presentation State object.

Definition at line 50 of file dvpsgll.h.

Member Function Documentation

OFCondition DVPSGraphicLayer_PList::addGraphicLayer (  const char *  gLayer,
const char *  gLayerDescription = NULL
) 
 

creates a new graphic layer with the given name and optional description.

The new name must be unique, otherwise an error code is returned. The toFrontGraphicLayer() method is implicitly called for the new layer.

Parameters:
gLayer the name of the graphic layer. Must be a valid DICOM Code String.
gLayerDescription the optional description of the graphic layer. Must be a valid DICOM Long String.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::addGraphicLayer (  const char *  gLayer,
const Sint32  gLayerOrder,
const char *  gLayerDescription = NULL
) 
 

adds a new graphic layer to the list.

The recommended display value of the new graphic layer remains undefined and can be set later.

Parameters:
gLayer name of the graphic layer. Must be unique within the sequence, i.e. no other graphic layer with the same name may exist, otherwise an error code is returned.
gLayerOrder graphic layer order of the new layer.
gLayerDescription (optional) description of the new layer. Default: description absent.
Returns:
EC_Normal if successful, an error code otherwise.

void DVPSGraphicLayer_PList::cleanupLayers (  DVPSOverlayCurveActivationLayer_PList &  activations,
DVPSGraphicAnnotation_PList &  annotations
) 
 

removes and deletes all graphic layers for which no matching text, graphic, curve or overlay object exists.

Called before writing a presentation state.

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

DVPSGraphicLayer_PList* DVPSGraphicLayer_PList::clone (   )  [inline]
 

clone method.

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

Definition at line 63 of file dvpsgll.h.

References DVPSGraphicLayer_PList().

OFCondition DVPSGraphicLayer_PList::exchangeGraphicLayers (  size_t  idx1,
size_t  idx2
) 
 

exchanges the layer order of the two graphic layers with the given indices.

This method does not sort or renumber the graphic layers.

Parameters:
idx1 index of the first graphic layer, must be < getNumberOfGraphicLayers()
idx2 index of the second graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

DVPSGraphicLayer* DVPSGraphicLayer_PList::getGraphicLayer (  size_t  idx  )  [private]
 

gets the the graphic layer with the given index.

If no layer for the given index exists, NULL is returned.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
pointer to the graphic layer

const char* DVPSGraphicLayer_PList::getGraphicLayerDescription (  size_t  idx  ) 
 

gets a description string for the graphic layer with the given index.

If no layer for the given index exists, or if the description is empty, NULL is returned.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
description of the graphic layer

size_t DVPSGraphicLayer_PList::getGraphicLayerIndex (  const char *  name  ) 
 

gets the index of the graphic layer with the given unique name.

If no matching layer is found, DVPS_IDX_NONE is returned.

Parameters:
name name of the graphic layer
Returns:
index of the graphic layer

const char* DVPSGraphicLayer_PList::getGraphicLayerName (  size_t  idx  ) 
 

gets the unique name of the graphic layer with the given index.

If no layer for the given index exists, NULL is returned.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
name of the graphic layer

OFCondition DVPSGraphicLayer_PList::getGraphicLayerRecommendedDisplayValueGray (  size_t  idx,
Uint16 &  gray
) 
 

gets the recommended grayscale display value for the given graphic layer.

If the graphic layer contains an RGB display value but no grayscale display value, the RGB value is implicitly converted to grayscale.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
gray the recommended display value as an unsigned 16-bit P-value is returned in this parameter.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::getGraphicLayerRecommendedDisplayValueRGB (  size_t  idx,
Uint16 &  r,
Uint16 &  g,
Uint16 &  b
) 
 

gets the recommended RGB display value for the given graphic layer.

If the graphic layer contains a grayscale display value but no RGB display value, the grayscale value is implicitly converted to RGB.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
r returns the R component of the recommended display value as unsigned 16-bit P-value
g returns the G component of the recommended display value as unsigned 16-bit P-value
b returns the B component of the recommended display value as unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise

OFBool DVPSGraphicLayer_PList::haveGraphicLayerRecommendedDisplayValue (  size_t  idx  ) 
 

checks whether a recommended display value (grayscale, color or both) for the given graphic layer exists.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
OFTrue if a recommended display value exists

OFCondition DVPSGraphicLayer_PList::read (  DcmItem &  dset  ) 
 

reads the Graphic Layer Sequence from a DICOM dataset.

The completeness of the sequence items (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 overlays are read
Returns:
EC_Normal if successful, an error code otherwise.

OFCondition DVPSGraphicLayer_PList::removeGraphicLayer (  size_t  idx  ) 
 

removes and deletes a graphic layer.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

void DVPSGraphicLayer_PList::removeGraphicLayerRecommendedDisplayValue (  size_t  idx,
OFBool  rgb,
OFBool  monochrome
) 
 

removes recommended display values for the given graphic layer.

Parameters:
rgb if true, the RGB recommended display value is removed
monochrome if true the monochrome recommended display value is removed

OFCondition DVPSGraphicLayer_PList::setGraphicLayerDescription (  size_t  idx,
const char *  descr
) 
 

sets a new description to the given graphic layer.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
descr description of the graphic layer. Must be a valid DICOM Long String.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::setGraphicLayerName (  size_t  idx,
const char *  name
) 
 

assigns a new unique name to the given graphic layer.

The new name must be unique, otherwise an error code is returned.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
name the new name of the graphic layer. Must be a valid DICOM Code String.
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::setGraphicLayerRecommendedDisplayValueGray (  size_t  idx,
Uint16  gray
) 
 

set graphic layer recommended grayscale display value for the given graphic layer.

This method does not affect (set or modify) the recommended RGB display value which should be set separately.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
gray the recommended display value as an unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::setGraphicLayerRecommendedDisplayValueRGB (  size_t  idx,
Uint16  r,
Uint16  g,
Uint16  b
) 
 

set graphic layer recommended RGB display value for the given graphic layer.

This method does not affect (set or modify) the recommended grayscale display value which should be set separately.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
r the R component of the recommended display value as unsigned 16-bit P-value
g the G component of the recommended display value as unsigned 16-bit P-value
b the B component of the recommended display value as unsigned 16-bit P-value
Returns:
EC_Normal upon success, an error code otherwise

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

get number of graphic layer objects in this list.

Returns:
the number of objects.

Definition at line 120 of file dvpsgll.h.

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

void DVPSGraphicLayer_PList::sortGraphicLayers (  Sint32  lowestLayer = 1  ) 
 

sorts the graphic layers according to the graphic layer order.

Layers with lower order have lower indices after sorting which means that the layers can be drawn to the screen in ascending index order. Calling this routine may result in a re-numbering of the graphic layer orders in a way that does not affect their sequence.

Parameters:
lowestLayer is the lowest number assigned to a layer during the renumbering.

OFCondition DVPSGraphicLayer_PList::toBackGraphicLayer (  size_t  idx  ) 
 

makes a graphic layer the lowest layer for display.

This method assigns a graphic layer order lower than all existing graphic layer orders to the given graphic layer, sorts and renumbers the list of graphic layers. Upon success, the given graphic layer is guaranteed to have the new index 0.

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::toFrontGraphicLayer (  size_t  idx  ) 
 

makes a graphic layer the highest layer for display.

This method assigns a graphic layer order higher than all existing graphic layer orders to the given graphic layer, sorts and renumbers the list of graphic layers. Upon success, the given graphic layer is guaranteed to have the new index (getNumberOfGraphicLayers()-1).

Parameters:
idx index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
EC_Normal upon success, an error code otherwise

OFCondition DVPSGraphicLayer_PList::write (  DcmItem &  dset  ) 
 

writes the Graphic Layer Sequence 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 DICOM dataset to which the sequence 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