OverlayOrigin.Holder (dcm4che-typeddicom-lib-std 0.5.5 API)

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

OverlayPlaneModule

All Known Implementing Classes:

ColorSoftcopyPresentationStateIOD, ComputedRadiographyImageIOD, CTImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, GrayscaleSoftcopyPresentationStateIOD, MRImageIOD, NuclearMedicineImageIOD, OverlayPlaneModule.SimpleWrapper, PositronEmissionTomographyImageIOD, PseudoColorSoftcopyPresentationStateIOD, SecondaryCaptureImageIOD, UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

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

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class OverlayOrigin.Holder.Builder

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static OverlayOrigin.Holder.Builder`	`builder()`
`static OverlayOrigin.Holder.Builder`	`builder(org.dcm4che3.data.Attributes attributes)`
`default boolean`	`containsOverlayOrigin()`
`default OverlayOrigin`	`getOverlayOrigin()`
`default void`	`removeOverlayOrigin()`	Removes the Overlay Origin (see `OverlayOrigin`
`static OverlayOrigin.Holder`	`wrap(org.dcm4che3.data.Attributes attributes)`

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

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