Package org.dcm4che.typeddicom.dataelements

Class BeamOrderIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamOrderIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedLongWrapper

public class BeamOrderIndex
extends AbstractDataElementWrapper
implements UnsignedLongWrapper

Name: Beam Order Index
Keyword: BeamOrderIndex
Tag: (0074,1324)
Value Representation: UL
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Delivery Instruction Module > Beam Task Sequence > Beam Order Index
  as follows:
  Attribute Name: Beam Order Index
  Type: 3
  Attribute Description:

  Identifies required ordering of beam delivery, monotonically increasing by 1, starting from 1. See DICOM Standard Part 3 - Section C.8.8.29.5.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
BeamOrderIndex()	Creates a new Beam Order Index object which wraps a new and empty Attributes object.
BeamOrderIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Beam Order Index object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

BeamOrderIndex

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

Creates a new Beam Order Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamOrderIndex

public BeamOrderIndex()

Creates a new Beam Order Index object which wraps a new and empty Attributes object.

Method Details

copy

public BeamOrderIndex copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.