Package org.dcm4che.typeddicom.dataelements

Class ParameterItemIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ParameterItemIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ParameterItemIndex
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Parameter Item Index
Keyword: ParameterItemIndex
Tag: (3008,0063)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Override Sequence > Parameter Item Index
  as follows:
  Attribute Name: Parameter Item Index
  Type: 1
  Attribute Description:

  Contains the Sequence Item index (monotonically increasing from 1) of the overriden Attributes within it's parent Sequence. The value is limited in scope to the Treatment Session Ion Beam Sequence (3008,0021) and all nested Sequences therein.

  
  
• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Corrected Parameter Sequence > Parameter Item Index
  as follows:
  Attribute Name: Parameter Item Index
  Type: 1
  Attribute Description:

  Contains the Sequence Item index (monotonically increasing from 1) of the corrected Attribute within its parent Sequence as indicated by Parameter Sequence Pointer (3008,0061).

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Control Point Delivery Sequence > Override Sequence > Parameter Item Index
  as follows:
  Attribute Name: Parameter Item Index
  Type: 3
  Attribute Description:

  Contains the Sequence Item index (monotonically increasing from 1) of the overridden Attributes within its parent Sequence. The value is limited in scope to the Treatment Session Beam Sequence (3008,0020) and all nested Sequences therein.

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Control Point Delivery Sequence > Corrected Parameter Sequence > Parameter Item Index
  as follows:
  Attribute Name: Parameter Item Index
  Type: 1
  Attribute Description:

  Contains the Sequence Item index (starting at 1) of the corrected Attribute within its parent Sequence.

  
  

Nested Class Summary

Nested Classes

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

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

IntegerStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends IntegerStringWrapper>

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.IntegerStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ParameterItemIndex()	Creates a new Parameter Item Index object which wraps a new and empty Attributes object.
ParameterItemIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Parameter Item Index object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

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

getString, setString

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

ParameterItemIndex

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

Creates a new Parameter Item Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ParameterItemIndex

public ParameterItemIndex()

Creates a new Parameter Item Index object which wraps a new and empty Attributes object.

Method Details

copy

public ParameterItemIndex copy()

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

Returns:

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