Package org.dcm4che.typeddicom.dataelements

Class OverlayLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class OverlayLabel
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Overlay Label
Keyword: OverlayLabel
Tag: (60xx,1500)
Value Representation: LO
Value Multiplicity: 1

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

  A user defined text string that may be used to label or name this overlay.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OverlayLabel.Builder<SELF extends OverlayLabel.Builder<SELF,T>,T extends OverlayLabel.Holder>
static interface	OverlayLabel.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Overlay Label" (see OverlayLabel)
static class	OverlayLabel.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
OverlayLabel()	Creates a new Overlay Label object which wraps a new and empty Attributes object.
OverlayLabel(org.dcm4che3.data.Attributes attributes)	Creates a new Overlay Label object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OverlayLabel	copy()	Returns a new Overlay Label which wraps a copy of the Attributes wrapped in this Overlay Label.
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

OverlayLabel

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

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

Parameters:

attributes - The Attributes object to be wrapped.

OverlayLabel

public OverlayLabel()

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

Method Details

copy

public OverlayLabel copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.