Package org.dcm4che.typeddicom.dataelements

Class OverlayDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class OverlayDescription
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Overlay Description
Keyword: OverlayDescription
Tag: (60xx,0022)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Overlay Plane Module > Overlay Description
  as follows:
  Attribute Name: Overlay Description
  Type: 3
  Attribute Description:

  User-defined comments about the overlay.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OverlayDescription.Builder<SELF extends OverlayDescription.Builder<SELF,T>,T extends OverlayDescription.Holder>
static interface	OverlayDescription.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Description" (see OverlayDescription)
static class	OverlayDescription.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

LongStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends LongStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
OverlayDescription()	Creates a new Overlay Description object which wraps a new and empty Attributes object.
OverlayDescription(org.dcm4che3.data.Attributes attributes)	Creates a new Overlay Description object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OverlayDescription	copy()	Returns a new Overlay Description which wraps a copy of the Attributes wrapped in this Overlay Description.
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

OverlayDescription

public OverlayDescription(org.dcm4che3.data.Attributes attributes)

Creates a new Overlay Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OverlayDescription

public OverlayDescription()

Creates a new Overlay Description object which wraps a new and empty Attributes object.

Method Details

copy

public OverlayDescription copy()

Returns a new Overlay Description which wraps a copy of the Attributes wrapped in this Overlay Description. (see Attributes(Attributes)

Returns:

a new Overlay Description which wraps a copy of the Attributes wrapped in this Overlay Description.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.