Package org.dcm4che.typeddicom.dataelements

Class ReferencedDefinedDeviceIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedDefinedDeviceIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ReferencedDefinedDeviceIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Referenced Defined Device Index
Keyword: ReferencedDefinedDeviceIndex
Tag: (300A,0602)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • General Accessories Definition Macro > General Accessory Definition Sequence > Referenced Defined Device Index
  as follows:
  Attribute Name: Referenced Defined Device Index
  Type: 1C
  Attribute Description:

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the General Accessory Definition Sequence (300A,0671) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

  
  
• Described in the contexts:
  • Boluses Definition Macro > Bolus Definition Sequence > Referenced Defined Device Index
  as follows:
  Attribute Name: Referenced Defined Device Index
  Type: 1C
  Attribute Description:

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the Bolus Definition Sequence (300A,0673) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

  
  
• Described in the contexts:
  • Compensators Definition Macro > Compensator Definition Sequence > Referenced Defined Device Index
  as follows:
  Attribute Name: Referenced Defined Device Index
  Type: 1C
  Attribute Description:

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the Compensator Definition Sequence (300A,0662) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

  
  
• Described in the contexts:
  • RT Accessory Holders Definition Macro > RT Accessory Holder Definition Sequence > Referenced Defined Device Index
  as follows:
  Attribute Name: Referenced Defined Device Index
  Type: 1C
  Attribute Description:

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the RT Accessory Holder Definition Sequence (300A,0614) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

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

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the RT Beam Limiting Device Definition Sequence (300A,064D) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

  
  
• Described in the contexts:
  • Wedges Definition Macro > Wedge Definition Sequence > Referenced Defined Device Index
  as follows:
  Attribute Name: Referenced Defined Device Index
  Type: 1C
  Attribute Description:

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the Wedges Definition Sequence (300A,0651) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

  
  
• Described in the contexts:
  • Blocks Definition Macro > Block Definition Sequence > Referenced Defined Device Index
  as follows:
  Attribute Name: Referenced Defined Device Index
  Type: 1C
  Attribute Description:

  Device Index value that links the device defined by this Sequence Item to the corresponding device in an RT Radiation Instance. The device identification of the two devices may or may not be the same.

  The value is the index of a device in the Block Definition Sequence (300A,066A) within the single SOP Instance referenced by Referenced RT Instance Sequence (300A,0631).

  Required if the Instance referenced in Referenced RT Instance Sequence (300A,0631) contains the device that corresponds to the device defined by this Sequence Item.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.5.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ReferencedDefinedDeviceIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedDefinedDeviceIndex

public ReferencedDefinedDeviceIndex()

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

Method Details

copy

public ReferencedDefinedDeviceIndex copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.