Package org.dcm4che.typeddicom.dataelements

Class BeamNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class BeamNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Beam Number
Keyword: BeamNumber
Tag: (300A,00C0)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Beam Number
  as follows:
  Attribute Name: Beam Number
  Type: 1
  Attribute Description:

  Identification number of the Beam. The value of Beam Number (300A,00C0) shall be unique within the RT Ion Plan in which it is created. See DICOM Standard Part 3 - Section C.8.8.25.1.

  
  
• Described in the contexts:
  • Performed XA Acquisition Module > Acquisition Protocol Element Sequence > XA Plane Details Sequence > Beam Number
  as follows:
  Attribute Name: Beam Number
  Type: 1
  Attribute Description:

  Identification number of the beam.

  The value shall be 1 if Plane Identification (0018,9457) equals MONOPLANE or PLANE A, and shall be 2 if Plane Identification (0018,9457) equals PLANE B.

  
  
• Described in the contexts:
  • Performed CT Acquisition Module > Acquisition Protocol Element Sequence > CT X-Ray Details Sequence > Beam Number
  as follows:
  Attribute Name: Beam Number
  Type: 1
  Attribute Description:

  Identification number of the beam.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Beam Number
  as follows:
  Attribute Name: Beam Number
  Type: 1
  Attribute Description:

  Identification number of the Beam. The value of Beam Number (300A,00C0) shall be unique within the RT Plan in which it is created. See Note 1.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

BeamNumber

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

Creates a new Beam Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamNumber

public BeamNumber()

Creates a new Beam Number object which wraps a new and empty Attributes object.

Method Details

copy

public BeamNumber copy()

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

Returns:

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

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.