OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DVPSGraphicLayer Class Reference

an item of the graphic layer sequence in a presentation state (internal use only). More...

Collaboration diagram for DVPSGraphicLayer:
[legend]

Public Member Functions

 DVPSGraphicLayer ()
 default constructor
 
 DVPSGraphicLayer (const DVPSGraphicLayer &copy)
 copy constructor
 
DVPSGraphicLayerclone ()
 clone method. More...
 
virtual ~DVPSGraphicLayer ()
 destructor
 
OFCondition read (DcmItem &dset)
 reads a graphic layer from a DICOM dataset. More...
 
OFCondition write (DcmItem &dset)
 writes the graphic layer managed by this object to a DICOM dataset. More...
 
const char * getGL ()
 get graphic layer name of this layer. More...
 
const char * getGLDescription ()
 get graphic layer description of this layer. More...
 
Sint32 getGLOrder ()
 gets the graphic layer order of this layer. More...
 
OFBool haveGLRecommendedDisplayValue ()
 checks whether a recommended display value (grayscale, color or both) exists. More...
 
OFCondition getGLRecommendedDisplayValueGray (Uint16 &gray)
 gets the recommended grayscale display value. More...
 
OFCondition getGLRecommendedDisplayValueRGB (Uint16 &r, Uint16 &g, Uint16 &b)
 gets the recommended RGB display value. More...
 
void removeRecommendedDisplayValue (OFBool rgb, OFBool monochrome)
 removes recommended display values. More...
 
void setGL (const char *gl)
 set graphic layer name of this layer. More...
 
void setGLOrder (Sint32 glOrder)
 set graphic layer order of this layer. More...
 
void setGLRecommendedDisplayValueGray (Uint16 gray)
 set graphic layer recommended grayscale display value of this layer. More...
 
void setGLRecommendedDisplayValueRGB (Uint16 r, Uint16 g, Uint16 b)
 set graphic layer recommended RGB display value of this layer. More...
 
void setGLDescription (const char *glDescription)
 set graphic layer description of this layer. More...
 

Private Member Functions

DVPSGraphicLayeroperator= (const DVPSGraphicLayer &)
 private undefined assignment operator
 

Private Attributes

DcmCodeString graphicLayer
 VR=CS, VM=1, Type 1.
 
DcmIntegerString graphicLayerOrder
 VR=IS, VM=1, Type 1.
 
DcmUnsignedShort graphicLayerRecommendedDisplayGrayscaleValue
 VR=US, VM=1, Type 3.
 
DcmUnsignedShort graphicLayerRecommendedDisplayRGBValue
 VR=US, VM=3, Type 3.
 
DcmLongString graphicLayerDescription
 VR=LO, VM=1, Type 3.
 

Detailed Description

an item of the graphic layer sequence in a presentation state (internal use only).

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

Definition at line 42 of file dvpsgl.h.

Member Function Documentation

DVPSGraphicLayer* DVPSGraphicLayer::clone ( )
inline
const char* DVPSGraphicLayer::getGL ( )

get graphic layer name of this layer.

Returns
a pointer to the graphic layer name

Referenced by clone().

const char* DVPSGraphicLayer::getGLDescription ( )

get graphic layer description of this layer.

Returns
a pointer to the graphic layer description

Referenced by clone().

Sint32 DVPSGraphicLayer::getGLOrder ( )

gets the graphic layer order of this layer.

Returns
the graphic layer order

Referenced by clone().

OFCondition DVPSGraphicLayer::getGLRecommendedDisplayValueGray ( Uint16 &  gray)

gets the recommended grayscale display value.

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

Parameters
graythe recommended display value as an unsigned 16-bit P-value is returned in this parameter.
Returns
EC_Normal upon success, an error code otherwise

Referenced by clone().

OFCondition DVPSGraphicLayer::getGLRecommendedDisplayValueRGB ( Uint16 &  r,
Uint16 &  g,
Uint16 &  b 
)

gets the recommended RGB display value.

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

Parameters
rreturns the R component of the recommended display value as unsigned 16-bit P-value
greturns the G component of the recommended display value as unsigned 16-bit P-value
breturns the B component of the recommended display value as unsigned 16-bit P-value
Returns
EC_Normal upon success, an error code otherwise

Referenced by clone().

OFBool DVPSGraphicLayer::haveGLRecommendedDisplayValue ( )

checks whether a recommended display value (grayscale, color or both) exists.

Returns
OFTrue if a recommended display value exists

Referenced by clone().

OFCondition DVPSGraphicLayer::read ( DcmItem dset)

reads a graphic layer from a DICOM dataset.

The DICOM elements of the Graphic Layer item 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
dsetthe item of the GraphicLayerSequence from which the data is to be read
Returns
EC_Normal if successful, an error code otherwise.

Referenced by clone().

void DVPSGraphicLayer::removeRecommendedDisplayValue ( OFBool  rgb,
OFBool  monochrome 
)

removes recommended display values.

Parameters
rgbif true, the RGB recommended display value is removed
monochromeif true the monochrome recommended display value is removed

Referenced by clone().

void DVPSGraphicLayer::setGL ( const char *  gl)

set graphic layer name of this layer.

Parameters
gla pointer to the graphic layer name, which is copied into this object.

Referenced by clone().

void DVPSGraphicLayer::setGLDescription ( const char *  glDescription)

set graphic layer description of this layer.

Parameters
glDescriptiona pointer to the graphic layer description, which is copied into this object.

Referenced by clone().

void DVPSGraphicLayer::setGLOrder ( Sint32  glOrder)

set graphic layer order of this layer.

Parameters
glOrderthe graphic layer order.

Referenced by clone().

void DVPSGraphicLayer::setGLRecommendedDisplayValueGray ( Uint16  gray)

set graphic layer recommended grayscale display value of this layer.

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

Parameters
graythe recommended display value in P-values 0..0xffff.

Referenced by clone().

void DVPSGraphicLayer::setGLRecommendedDisplayValueRGB ( Uint16  r,
Uint16  g,
Uint16  b 
)

set graphic layer recommended RGB display value of this layer.

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

Parameters
rthe red component of the recommended display value in P-values 0..0xffff.
gthe green component of the recommended display value in P-values 0..0xffff.
bthe blue component of the recommended display value in P-values 0..0xffff.

Referenced by clone().

OFCondition DVPSGraphicLayer::write ( DcmItem dset)

writes the graphic layer managed by this object to a DICOM dataset.

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

Parameters
dsetthe the item of the GraphicLayerSequence to which the data is written
Returns
EC_Normal if successful, an error code otherwise.

Referenced by clone().


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


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11