Package org.dcm4che.typeddicom.dataelements

Class ReferencedPatientSetupProcedureIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedPatientSetupProcedureIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ReferencedPatientSetupProcedureIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Referenced Patient Setup Procedure Index
Keyword: ReferencedPatientSetupProcedureIndex
Tag: (300A,0796)
Value Representation: US
Value Multiplicity: 1

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

  The value of Patient Treatment Preparation Procedure Index (300A,0795) from Patient Treatment Preparation Procedure Sequence (300A,0790) corresponding to the Patient Treatment Preparation Procedure to which this Sequence Item refers.

  Required if this Patient Setup Photo is associated with a Patient Treatment Preparation Procedure.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ReferencedPatientSetupProcedureIndex

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

Creates a new Referenced Patient Setup Procedure Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedPatientSetupProcedureIndex

public ReferencedPatientSetupProcedureIndex()

Creates a new Referenced Patient Setup Procedure Index object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedPatientSetupProcedureIndex copy()

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

Returns:

a new Referenced Patient Setup Procedure Index which wraps a copy of the Attributes wrapped in this Referenced Patient Setup 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.