Package org.dcm4che.typeddicom.dataelements

Class SetupReferenceDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SetupReferenceDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class SetupReferenceDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Setup Reference Description
Keyword: SetupReferenceDescription
Tag: (300A,01D0)
Value Representation: ST
Value Multiplicity: 1

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

  User-defined description of Setup Reference used for patient alignment.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

SetupReferenceDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SetupReferenceDescription

public SetupReferenceDescription()

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

Method Details

copy

public SetupReferenceDescription copy()

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

Returns:

a new Setup Reference Description which wraps a copy of the Attributes wrapped in this Setup Reference 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.