OverlayDataAsOB.Holder (dcm4che-typeddicom-lib-std 0.5.4 API)

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OverlayPlaneModule

All Known Implementing Classes:

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

Enclosing class:

OverlayDataAsOB
```
public static interface OverlayDataAsOB.Holder
extends org.dcm4che.typeddicom.AttributesWrapper
```
A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Data" (see OverlayDataAsOB)

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class OverlayDataAsOB.Holder.Builder

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static OverlayDataAsOB.Holder.Builder`	`builder()`
`static OverlayDataAsOB.Holder.Builder`	`builder(org.dcm4che3.data.Attributes attributes)`
`default boolean`	`containsOverlayDataAsOB()`
`default OverlayDataAsOB`	`getOverlayDataAsOB()`
`default void`	`removeOverlayDataAsOB()`	Removes the Overlay Data (see `OverlayDataAsOB`
`static OverlayDataAsOB.Holder`	`wrap(org.dcm4che3.data.Attributes attributes)`

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper
copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

- Method Detail
  - wrap
```
static OverlayDataAsOB.Holder wrap(org.dcm4che3.data.Attributes attributes)
```
    Parameters:
    
    attributes - an attributes object containing the Overlay Data (see OverlayDataAsOB)
    
    Returns:
    
    a wrapper object implementing the OverlayDataAsOB.Holder interface.
  - builder
```
static OverlayDataAsOB.Holder.Builder builder()
```
    Returns:
    
    a OverlayDataAsOB.Holder.Builder to create Overlay Data Items with a fluent API.
  - builder
```
static OverlayDataAsOB.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)
```
    Parameters:
    
    attributes - the Attributes to be wrapped by the OverlayDataAsOB.Holder.Builder.
    
    Returns:
    
    a OverlayDataAsOB.Holder.Builder to create Overlay Data Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.
  - getOverlayDataAsOB
```
default OverlayDataAsOB getOverlayDataAsOB()
```
    Returns:
    
    the Overlay Data (see OverlayDataAsOB)
  - containsOverlayDataAsOB
```
default boolean containsOverlayDataAsOB()
```
    Returns:
    
    whether it contains the Overlay Data (see OverlayDataAsOB)
  - removeOverlayDataAsOB
```
default void removeOverlayDataAsOB()
```
    Removes the Overlay Data (see OverlayDataAsOB