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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedLongWrapper

public class BeamOrderIndex
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedLongWrapper

Name: Beam Order Index
Keyword: BeamOrderIndex
Tag: (0074,1324)
Value Representation: UnsignedLong
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)

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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.
java.lang.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.UnsignedLongWrapper

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper