Package org.dcm4che.typeddicom.dataelements

Class ScanSpotPrescribedIndices

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScanSpotPrescribedIndices

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, IntegerStringMultiWrapper, StringDataElementMultiWrapper

public class ScanSpotPrescribedIndices
extends AbstractDataElementWrapper
implements IntegerStringMultiWrapper

Name: Scan Spot Prescribed Indices
Keyword: ScanSpotPrescribedIndices
Tag: (300A,0391)
Value Representation: IS
Value Multiplicity: 1-n

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Scan Spot Prescribed Indices
  as follows:
  Attribute Name: Scan Spot Prescribed Indices
  Type: 1C
  Attribute Description:

  The indices of the prescribed spots corresponding to each delivered spot. These indices are the ordinal positions of the spots in the Scan Spot Meterset Weights (300A,0396) in the Ion Control Point Sequence (300A,03A8) of the referenced RT Ion Plan. The numbering of indices of the prescribed spots shall start at one (a value of one refers the first ordinal position).

  Required, if Scan Spot Reordered (300A,0393) equals YES.

  Contains N values where N is the Number of Scan Spot Positions (300A,0392).

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScanSpotPrescribedIndices.Builder<SELF extends ScanSpotPrescribedIndices.Builder<SELF,T>,T extends ScanSpotPrescribedIndices.Holder>
static interface	ScanSpotPrescribedIndices.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Scan Spot Prescribed Indices" (see ScanSpotPrescribedIndices)
static class	ScanSpotPrescribedIndices.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ScanSpotPrescribedIndices()	Creates a new Scan Spot Prescribed Indices object which wraps a new and empty Attributes object.
ScanSpotPrescribedIndices(org.dcm4che3.data.Attributes attributes)	Creates a new Scan Spot Prescribed Indices object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ScanSpotPrescribedIndices	copy()	Returns a new Scan Spot Prescribed Indices which wraps a copy of the Attributes wrapped in this Scan Spot Prescribed Indices.
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.IntDataElementMultiWrapper

getInt, getInts, setInts

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

getValueRepresentation

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

getString, getString, getStrings, setStrings

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ScanSpotPrescribedIndices

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

Creates a new Scan Spot Prescribed Indices object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ScanSpotPrescribedIndices

public ScanSpotPrescribedIndices()

Creates a new Scan Spot Prescribed Indices object which wraps a new and empty Attributes object.

Method Details

copy

public ScanSpotPrescribedIndices copy()

Returns a new Scan Spot Prescribed Indices which wraps a copy of the Attributes wrapped in this Scan Spot Prescribed Indices. (see Attributes(Attributes)

Returns:

a new Scan Spot Prescribed Indices which wraps a copy of the Attributes wrapped in this Scan Spot Prescribed Indices.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.