Package org.dcm4che.typeddicom.dataelements

Class OverlaySubtype

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlaySubtype

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class OverlaySubtype
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Overlay Subtype
Keyword: OverlaySubtype
Tag: (60xx,0045)
Value Representation: LO
Value Multiplicity: 1

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

  Defined Term that identifies the intended purpose of the Overlay Type. See DICOM Standard Part 3 - Section C.9.2.1.3 for further explanation.

  
  
• Described in the contexts:
  • US Image Module > Overlay Subtype
  as follows:
  Attribute Name: Overlay Subtype
  Type: 1C
  Attribute Description:

  Defined Term that identifies the intended purpose of the ROI Overlay Type.

  Required if this Overlay Group is referenced in an Item of the Sequence of Ultrasound Regions (0018,6011). May be present otherwise.

  See DICOM Standard Part 3 - Section C.8.5.6.1.11 for specialization.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
OverlaySubtype	copy()	Returns a new Overlay Subtype which wraps a copy of the Attributes wrapped in this Overlay Subtype.
String	getPrivateCreator()
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, getValue

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

getValueRepresentation

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

OverlaySubtype

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

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

Parameters:

attributes - The Attributes object to be wrapped.

OverlaySubtype

public OverlaySubtype()

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

Method Details

copy

public OverlaySubtype copy()

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

Returns:

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

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.