Package org.dcm4che.typeddicom.dataelements

Class BasisRTTreatmentPhaseIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BasisRTTreatmentPhaseIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class BasisRTTreatmentPhaseIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Basis RT Treatment Phase Index
Keyword: BasisRTTreatmentPhaseIndex
Tag: (3010,003E)
Value Representation: US
Value Multiplicity: 1

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

  The RT Treatment Phase which provides the basis for this interval.

  This index corresponds to an Item in the Intended RT Treatment Phase Sequence (3010,004B).

  See DICOM Standard Part 3 - Section C.36.2.1.3.1.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

BasisRTTreatmentPhaseIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

BasisRTTreatmentPhaseIndex

public BasisRTTreatmentPhaseIndex()

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

Method Details

copy

public BasisRTTreatmentPhaseIndex copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.