Package org.dcm4che.typeddicom.dataelements

Class ReferencedTreatmentPositionIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedTreatmentPositionIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ReferencedTreatmentPositionIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Referenced Treatment Position Index
Keyword: ReferencedTreatmentPositionIndex
Tag: (300A,060B)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Control Point General Macro > Referenced Treatment Position Index
  as follows:
  Attribute Name: Referenced Treatment Position Index
  Type: 1C
  Attribute Description:

  The value of Treatment Position Index (300A,0606) from the Treatment Position Sequence (300A,063F) within this IOD that this RT Control Point refers to.

  Required if Treatment Position Sequence (300A,063F) is present and the conditions in DICOM Standard Part 3 - Section C.36.2.2.5.1.1 are satisfied.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedShortWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedTreatmentPositionIndex()	Creates a new Referenced Treatment Position Index object which wraps a new and empty Attributes object.
ReferencedTreatmentPositionIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Treatment Position Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedTreatmentPositionIndex	copy()	Returns a new Referenced Treatment Position Index which wraps a copy of the Attributes wrapped in this Referenced Treatment Position Index.
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, getPrivateCreator, getValue

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ReferencedTreatmentPositionIndex

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

Creates a new Referenced Treatment Position Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedTreatmentPositionIndex

public ReferencedTreatmentPositionIndex()

Creates a new Referenced Treatment Position Index object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedTreatmentPositionIndex copy()

Returns a new Referenced Treatment Position Index which wraps a copy of the Attributes wrapped in this Referenced Treatment Position Index. (see Attributes(Attributes)

Returns:

a new Referenced Treatment Position Index which wraps a copy of the Attributes wrapped in this Referenced Treatment Position Index.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.