cdac.medinfo.sdk.dcm30_04.baselibs

Class GraphicLayerSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.GraphicLayerSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class GraphicLayerSequenceItem
extends Item

A sequence of Items each of which represents a single layer in which overlays,curves, graphics or text may be rendered.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getGraphicLayer() Retrieves the layer in which the graphics or text is to be rendered.
java.lang.String	getGraphicLayerDescription() Retrieves A free text description of the contents of this layer.
java.lang.String	getGraphicLayerOrder() Retrieves An integer indicating the order in which it is recommended that the layer be rendered, if the display is capable of distinguishing.
short[]	getGraphicLayerRecommendedDisplayCIELabValue() Retrieves Graphic Layer Recommended Display CIELab Values in Array of short format.
short	getGraphicLayerRecommendedDisplayGrayscaleValue() Retrieves A default single gray unsigned value in which it is recommended that the layer be rendered on a monochrome display.
short[]	getGraphicLayerRecommendedDisplayRGBValue() Retrieves A triplet of unsigned RGB values in which it is recommended that the layer be rendered on a color display.
void	setGraphicLayer(java.lang.String strGraphicLayer) Sets the layer in which the graphics or text is to be rendered.
void	setGraphicLayerDescription(java.lang.String strGraphicLayerDescription) Sets A free text description of the contents of this layer.
void	setGraphicLayerOrder(java.lang.String strGraphicLayerOrder) Sets An integer indicating the order in which it is recommended that the layer be rendered, if the display is capable of distinguishing.
void	setGraphicLayerRecommendedDisplayCIELabValue(short[] arrGraphicLayerRecommendedDisplayCIELabValue) Sets Graphic Layer Recommended Display CIELab Values
void	setGraphicLayerRecommendedDisplayGrayscaleValue(short shGraphicLayerRecommendedDisplayGrayscaleValue) Sets A default single gray unsigned value in which it is recommended that the layer be rendered on a monochrome display.
void	setGraphicLayerRecommendedDisplayRGBValue(short[] arrshGraphicLayerRecommendedDisplayRGBValue) Sets A triplet of unsigned RGB values in which it is recommended that the layer be rendered on a color display.
boolean	validateForModule() Validates all the attributes in GraphicLayerSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in GraphicLayerSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setGraphicLayer

public void setGraphicLayer(java.lang.String strGraphicLayer)

Sets the layer in which the graphics or text is to be rendered.

Parameters:

strGraphicLayer - String value of Graphic Layer

getGraphicLayer

public java.lang.String getGraphicLayer()

Retrieves the layer in which the graphics or text is to be rendered.

Returns:

String - value of Graphic Layer

setGraphicLayerOrder

public void setGraphicLayerOrder(java.lang.String strGraphicLayerOrder)

Sets An integer indicating the order in which it is recommended that the layer be rendered, if the display is capable of distinguishing. Lower numbered layers are to be rendered first.

Parameters:

strGraphicLayerOrder - String value of Graphic Layer Order

getGraphicLayerOrder

public java.lang.String getGraphicLayerOrder()

Retrieves An integer indicating the order in which it is recommended that the layer be rendered, if the display is capable of distinguishing.

Returns:

String - value of Graphic Layer Order

setGraphicLayerRecommendedDisplayGrayscaleValue

public void setGraphicLayerRecommendedDisplayGrayscaleValue(short shGraphicLayerRecommendedDisplayGrayscaleValue)

Sets A default single gray unsigned value in which it is recommended that the layer be rendered on a monochrome display.

Parameters:

shGraphicLayerRecommendedDisplayGrayscaleValue - short gray unsigned value

getGraphicLayerRecommendedDisplayGrayscaleValue

public short getGraphicLayerRecommendedDisplayGrayscaleValue()

Retrieves A default single gray unsigned value in which it is recommended that the layer be rendered on a monochrome display.

Returns:

short - short gray unsigned value

setGraphicLayerRecommendedDisplayRGBValue

public void setGraphicLayerRecommendedDisplayRGBValue(short[] arrshGraphicLayerRecommendedDisplayRGBValue)

Sets A triplet of unsigned RGB values in which it is recommended that the layer be rendered on a color display.

Parameters:

arrshGraphicLayerRecommendedDisplayRGBValue - short array of triplet of unsigned RGB values

getGraphicLayerRecommendedDisplayRGBValue

public short[] getGraphicLayerRecommendedDisplayRGBValue()

Retrieves A triplet of unsigned RGB values in which it is recommended that the layer be rendered on a color display.

Returns:

short[] - short array of triplet of unsigned RGB values

setGraphicLayerRecommendedDisplayCIELabValue

public void setGraphicLayerRecommendedDisplayCIELabValue(short[] arrGraphicLayerRecommendedDisplayCIELabValue)

Sets Graphic Layer Recommended Display CIELab Values

Parameters:

arrGraphicLayerRecommendedDisplayCIELabValue -

getGraphicLayerRecommendedDisplayCIELabValue

public short[] getGraphicLayerRecommendedDisplayCIELabValue()

Retrieves Graphic Layer Recommended Display CIELab Values in Array of short format.

Returns:

short Array - Graphic Layer Recommended Display CIELab Values.

setGraphicLayerDescription

public void setGraphicLayerDescription(java.lang.String strGraphicLayerDescription)

Sets A free text description of the contents of this layer.

Parameters:

strGraphicLayerDescription - String value of text

getGraphicLayerDescription

public java.lang.String getGraphicLayerDescription()

Retrieves A free text description of the contents of this layer.

Returns:

String - value of text