Package org.dcm4che.typeddicom.dataelements

Class PatientTreatmentPreparationProcedureIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientTreatmentPreparationProcedureIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class PatientTreatmentPreparationProcedureIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Patient Treatment Preparation Procedure Index
Keyword: PatientTreatmentPreparationProcedureIndex
Tag: (300A,0795)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Treatment Preparation Module > Patient Treatment Preparation Procedure Sequence > Patient Treatment Preparation Procedure Index
  as follows:
  Attribute Name: Patient Treatment Preparation Procedure Index
  Type: 1
  Attribute Description:

  Index of the Patient Treatment Preparation Procedure in this Sequence.

  The value shall start at 1 and increase monotonically by 1.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PatientTreatmentPreparationProcedureIndex.Builder<SELF extends PatientTreatmentPreparationProcedureIndex.Builder<SELF,T>,T extends PatientTreatmentPreparationProcedureIndex.Holder>
static interface	PatientTreatmentPreparationProcedureIndex.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Patient Treatment Preparation Procedure Index" (see PatientTreatmentPreparationProcedureIndex)
static class	PatientTreatmentPreparationProcedureIndex.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 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.UnsignedShortWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
PatientTreatmentPreparationProcedureIndex()	Creates a new Patient Treatment Preparation Procedure Index object which wraps a new and empty Attributes object.
PatientTreatmentPreparationProcedureIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Patient Treatment Preparation Procedure Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
PatientTreatmentPreparationProcedureIndex	copy()	Returns a new Patient Treatment Preparation Procedure Index which wraps a copy of the Attributes wrapped in this Patient Treatment Preparation Procedure Index.
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.IntDataElementWrapper

getInt, setInt

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

getValueRepresentation

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

PatientTreatmentPreparationProcedureIndex

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

Creates a new Patient Treatment Preparation Procedure Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientTreatmentPreparationProcedureIndex

public PatientTreatmentPreparationProcedureIndex()

Creates a new Patient Treatment Preparation Procedure Index object which wraps a new and empty Attributes object.

Method Details

copy

public PatientTreatmentPreparationProcedureIndex copy()

Returns a new Patient Treatment Preparation Procedure Index which wraps a copy of the Attributes wrapped in this Patient Treatment Preparation Procedure Index. (see Attributes(Attributes)

Returns:

a new Patient Treatment Preparation Procedure Index which wraps a copy of the Attributes wrapped in this Patient Treatment Preparation Procedure Index.

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.