Package org.dcm4che.typeddicom.dataelements

Class DeviceIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DeviceIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class DeviceIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Device Index
Keyword: DeviceIndex
Tag: (3010,0039)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Segment Annotation Module > RT Segment Annotation Sequence > Segmented RT Accessory Device Sequence > Device Index
  as follows:
  Attribute Name: Device Index
  Type: 1
  Attribute Description:

  Index of the Device.

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

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

  Index of this Item in this Sequence.

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

  
  
• Described in the contexts:
  • Blocks Definition Macro > Block Definition Sequence > Device Index
  • RT Beam Limiting Devices Definition Macro > RT Beam Limiting Device Definition Sequence > Device Index
  • Boluses Definition Macro > Bolus Definition Sequence > Device Index
  • RT Patient Support Devices Macro > Patient Support Devices Sequence > Device Index
  • Compensators Definition Macro > Compensator Definition Sequence > Device Index
  • RT Accessory Holders Definition Macro > RT Accessory Holder Definition Sequence > Device Index
  • General Accessories Definition Macro > General Accessory Definition Sequence > Device Index
  as follows:
  Attribute Name: Device Index
  Type: 1
  Attribute Description:

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

Method Summary

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

DeviceIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DeviceIndex

public DeviceIndex()

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

Method Details

copy

public DeviceIndex copy()

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

Returns:

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