Package org.dcm4che.typeddicom.dataelements

Class RTTreatmentPhaseIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTTreatmentPhaseIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class RTTreatmentPhaseIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: RT Treatment Phase Index
Keyword: RTTreatmentPhaseIndex
Tag: (3010,003A)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Treatment Phase Macro > RT Treatment Phase Index
  as follows:
  Attribute Name: RT Treatment Phase Index
  Type: 1
  Attribute Description:

  Index of the RT Treatment Phase in the Sequence.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RTTreatmentPhaseIndex	copy()	Returns a new RT Treatment Phase Index which wraps a copy of the Attributes wrapped in this RT Treatment Phase 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

RTTreatmentPhaseIndex

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

Creates a new RT Treatment Phase Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTTreatmentPhaseIndex

public RTTreatmentPhaseIndex()

Creates a new RT Treatment Phase Index object which wraps a new and empty Attributes object.

Method Details

copy

public RTTreatmentPhaseIndex copy()

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

Returns:

a new RT Treatment Phase Index which wraps a copy of the Attributes wrapped in this RT Treatment Phase Index.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.