Package org.dcm4che.typeddicom.dataelements

Class ReferencedDeviceIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedDeviceIndex

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper

public class ReferencedDeviceIndex
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Referenced Device Index
Keyword: ReferencedDeviceIndex
Tag: (300A,0607)
Value Representation: UnsignedShort
Value Multiplicity: 1

• Described in the contexts:
  • Wedge Positions Macro > Wedge Position Sequence > Referenced Device Index
  as follows:
  Attribute Name: Referenced Device Index
  Type: 1
  Attribute Description:

  The value of Device Index (3010,0039) in Wedge Definition Sequence (300A,0651) for the Wedge being used.

  
  
• Described in the contexts:
  • RT Patient Position Acquisition Instruction Module > Acquisition Task Sequence > Acquisition Subtask Sequence > Referenced Device Index
  as follows:
  Attribute Name: Referenced Device Index
  Type: 1C
  Attribute Description:

  The value of Device Index (3010,0039) from the Acquisition Device Sequence (3002,0117) corresponding to the device to be used for acquisition.

  Required if Number of Acquisition Devices (3002,0116) is greater than one.

  
  
• Described in the contexts:
  • RT Beam Limiting Device Opening Definition Macro > Referenced Device Index
  as follows:
  Attribute Name: Referenced Device Index
  Type: 1
  Attribute Description:

  The value of Device Index (3010,0039) from the RT Beam Limiting Device Definition Sequence (300A,064D) corresponding to the Beam Limiting Device used in this Item.

  
  
• Described in the contexts:
  • RT Tolerance Set Macro > Patient Support Position Device Tolerance Sequence > Referenced Device Index
  • Patient Support Position Macro > Patient Support Position Device Parameter Sequence > Referenced Device Index
  as follows:
  Attribute Name: Referenced Device Index
  Type: 1C
  Attribute Description:

  The value of Device Index (3010,0039) in Patient Support Devices Sequence (300A,0686) corresponding to the Patient Support Device in use.

  Required if Patient Support Position Specification Method (300A,065C) equals DEVICE_SPECIFIC.

  
  
• Described in the contexts:
  • RT Patient Position Acquisition Instruction Module > Acquisition Task Sequence > Acquisition Subtask Sequence > Additional RT Accessory Device Sequence > Referenced Device Index
  as follows:
  Attribute Name: Referenced Device Index
  Type: 1
  Attribute Description:

  Reference to an Item identified by the Device Index (3010,0039) in the General Accessory Definition Sequence (300A,0671).

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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
ReferencedDeviceIndex()	Creates a new Referenced Device Index object which wraps a new and empty Attributes object.
ReferencedDeviceIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Device Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedDeviceIndex	copy()	Returns a new Referenced Device Index which wraps a copy of the Attributes wrapped in this Referenced Device Index.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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 Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

ReferencedDeviceIndex

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

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

Parameters:

attributes - the Attributes object to be wrapped.

ReferencedDeviceIndex

public ReferencedDeviceIndex()

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

Method Detail

copy

public ReferencedDeviceIndex copy()

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

Returns:

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

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper