Package org.dcm4che.typeddicom.dataelements

Class InstructionIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.InstructionIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class InstructionIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Instruction Index
Keyword: InstructionIndex
Tag: (0018,9915)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Patient Positioning Module > Patient Positioning Instruction Sequence > Instruction Index
  as follows:
  Attribute Name: Instruction Index
  Type: 1
  Attribute Description:

  Identifies the order in which instruction Sequence Items are presented/performed.

  The value shall be an integer, increasing monotonically by 1, starting from 1.

  
  
• Described in the contexts:
  • Instructions Module > Instruction Sequence > Instruction Index
  as follows:
  Attribute Name: Instruction Index
  Type: 1
  Attribute Description:

  Identifies the order in which instruction Sequence Items are performed.

  The value shall be an integer, increasing monotonically by 1, starting from 1.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

InstructionIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

InstructionIndex

public InstructionIndex()

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

Method Details

copy

public InstructionIndex copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.