Package org.dcm4che.typeddicom.dataelements

Class OverlayActivationLayer

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverlayActivationLayer

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class OverlayActivationLayer
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Overlay Activation Layer
Keyword: OverlayActivationLayer
Tag: (60xx,1001)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Overlay Activation Module > Overlay Activation Layer
  as follows:
  Attribute Name: Overlay Activation Layer
  Type: 2C
  Attribute Description:

  The layer (defined in Graphic Layer (0070,0002) of the DICOM Standard Part 3 - Section C.10.7 in which the Overlay described in group 60xx shall be displayed. If no layer is specified (zero length) then the overlay shall not be displayed.

  Required if Group 60xx is present in the referenced image(s) or the Presentation State Instance containing this Module.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

OverlayActivationLayer

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

Creates a new Overlay Activation Layer object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OverlayActivationLayer

public OverlayActivationLayer()

Creates a new Overlay Activation Layer object which wraps a new and empty Attributes object.

Method Details

copy

public OverlayActivationLayer copy()

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

Returns:

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

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.