Package org.dcm4che.typeddicom.dataelements

Class SetupDeviceLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SetupDeviceLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class SetupDeviceLabel
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Setup Device Label
Keyword: SetupDeviceLabel
Tag: (300A,01B8)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Patient Setup Module > Patient Setup Sequence > Setup Device Sequence > Setup Device Label
  as follows:
  Attribute Name: Setup Device Label
  Type: 2
  Attribute Description:

  User-defined label for Setup Device used for patient alignment.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SetupDeviceLabel()	Creates a new Setup Device Label object which wraps a new and empty Attributes object.
SetupDeviceLabel(org.dcm4che3.data.Attributes attributes)	Creates a new Setup Device Label object which wraps the provided attributes.

Method Summary

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

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

SetupDeviceLabel

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

Creates a new Setup Device Label object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SetupDeviceLabel

public SetupDeviceLabel()

Creates a new Setup Device Label object which wraps a new and empty Attributes object.

Method Details

copy

public SetupDeviceLabel copy()

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

Returns:

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

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.