Package org.dcm4che.typeddicom.dataelements

Interface OverlayDescription.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

OverlayPlaneModule

All Known Implementing Classes:

ColorSoftcopyPresentationStateIOD, CRImageIOD, CTImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, GrayscaleSoftcopyPresentationStateIOD, MRImageIOD, NMImageIOD, OverlayDescription.SimpleHolder, PETImageIOD, PseudoColorSoftcopyPresentationStateIOD, RTDoseIOD, SecondaryCaptureImageIOD, USImageIOD, USMultiFrameImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

OverlayDescription

public static interface OverlayDescription.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Description" (see OverlayDescription)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OverlayDescription.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static OverlayDescription.Holder.Builder	builder()
static OverlayDescription.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsOverlayDescription()
default OverlayDescription	getOverlayDescription()
default void	removeOverlayDescription()	Removes the Overlay Description (see OverlayDescription
static OverlayDescription.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

static OverlayDescription.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - An attributes object containing the Overlay Description (see OverlayDescription)

Returns:

A wrapper object implementing the OverlayDescription.Holder interface.

builder

static OverlayDescription.Holder.Builder builder()

Returns:

a OverlayDescription.Holder.Builder to create Overlay Description Items with a fluent API.

builder

static OverlayDescription.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - The Attributes to be wrapped by the OverlayDescription.Holder.Builder.

Returns:

a OverlayDescription.Holder.Builder to create Overlay Description Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getOverlayDescription

default OverlayDescription getOverlayDescription()

Returns:

the Overlay Description (see OverlayDescription)

containsOverlayDescription

default boolean containsOverlayDescription()

Returns:

Whether it contains the Overlay Description (see OverlayDescription)

removeOverlayDescription

default void removeOverlayDescription()

Removes the Overlay Description (see OverlayDescription