Package org.dcm4che.typeddicom.dataelements

Class SetupDeviceDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SetupDeviceDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class SetupDeviceDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Setup Device Description
Keyword: SetupDeviceDescription
Tag: (300A,01BA)
Value Representation: ST
Value Multiplicity: 1

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

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

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

SetupDeviceDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SetupDeviceDescription

public SetupDeviceDescription()

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

Method Details

copy

public SetupDeviceDescription copy()

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

Returns:

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

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.