Package org.dcm4che.typeddicom.dataelements

Class ReferencedBeamNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedBeamNumber

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, IntegerStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class ReferencedBeamNumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Referenced Beam Number
Keyword: ReferencedBeamNumber
Tag: (300C,0006)
Value Representation: IntegerString
Value Multiplicity: 1

• Described in the contexts:
  • RT General Machine Verification Module > General Machine Verification Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type:
  Attribute Description:

  References Beam specified by Beam Number (300A,00C0) in Beam Sequence (300A,00B0) in DICOM Standard Part 3 - Section C.8.8.14 of referenced RT Plan or in Ion Beam Sequence (300A,03A2) in DICOM Standard Part 3 - Section C.8.8.25 within the referenced RT Ion Plan.

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

  References Beam specified by Beam Number (300A,00C0) in Ion Beam Sequence (300A,03A2) in DICOM Standard Part 3 - Section C.8.8.25 within the referenced RT Ion Plan.

  
  
• Described in the contexts:
  • RT Patient Position Acquisition Instruction Module > Acquisition Task Sequence > Acquisition Subtask Sequence > Referenced Baseline Parameters RT Radiation Instance Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 1C
  Attribute Description:

  Uniquely identifies the Beam specified by Beam Number (300A,00C0) in the referenced SOP Instance.

  Required, if the referenced SOP Instance has the SOP Class UID RT Plan ("1.2.840.10008.5.1.4.1.1.481.5") or RT Ion Plan ("1.2.840.10008.5.1.4.1.1.481.8").

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 3
  Attribute Description:

  References Beam specified by Beam Number (300A,00C0) in Beam Sequence (300A,00B0) in DICOM Standard Part 3 - Section C.8.8.14 within referenced RT Plan.

  
  
• Described in the contexts:
  • RT Image Module > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 3
  Attribute Description:

  Uniquely identifies the corresponding N-segment treatment beam specified by Beam Number (300A,00C0) within Beam Sequence (300A,00B0) in DICOM Standard Part 3 - Section C.8.8.14 within the RT Plan referenced in Referenced RT Plan Sequence (300C,0002) or the Ion Beam Sequence (300A,03A2) in the DICOM Standard Part 3 - Section C.8.8.25 within the RT Ion Plan referenced in Referenced RT Plan Sequence (300C,0002).

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

  Uniquely identifies the Beam that is specified by Beam Number (300A,00C0) within Beam Sequence (300A,00B0) in DICOM Standard Part 3 - Section C.8.8.14 of referenced RT Plan or within Ion Beam Sequence (300A,03A2) in DICOM Standard Part 3 - Section C.8.8.25 of the referenced RT Ion Plan.

  
  
• Described in the contexts:
  • RT Patient Position Scope With Legacy Support Macro > Referenced RT Plan Sequence > Beam Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 1
  Attribute Description:

  Beam Number identifying the referenced RT Beam or RT Ion Beam.

  
  
• Described in the contexts:
  • RT Dose Module > Referenced RT Plan Sequence > Referenced Fraction Group Sequence > Referenced Beam Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 1
  Attribute Description:

  Uniquely identifies Beam specified by Beam Number (300A,00C0) in Beam Sequence (300A,00B0) of DICOM Standard Part 3 - Section C.8.8.14 within RT Plan referenced in Referenced RT Plan Sequence (300C,0002) or in Ion Beam Sequence (300A,03A2) of DICOM Standard Part 3 - Section C.8.8.25 within RT Ion Plan referenced in Referenced RT Plan Sequence (300C,0002).

  
  
• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Beam Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 1
  Attribute Description:

  Uniquely identifies Beam specified by Beam Number (300A,00C0) within Beam Sequence (300A,00B0) in DICOM Standard Part 3 - Section C.8.8.14 or within Ion Beam Sequence (300A,03A2) in DICOM Standard Part 3 - Section C.8.8.25.

  
  
• Described in the contexts:
  • RT Dose Module > Referenced Treatment Record Sequence > Referenced Beam Sequence > Referenced Beam Number
  as follows:
  Attribute Name: Referenced Beam Number
  Type: 1
  Attribute Description:

  Uniquely identifies Beam specified by Referenced Beam Number (300C,0006) in Treatment Session Beam Sequence (3008,0020) of DICOM Standard Part 3 - Section C.8.8.21 within RT Beams Treatment Record referenced in the Referenced Treatment Record Sequence (3008,0030) or in Treatment Session Ion Beam Sequence (3008,0021) of DICOM Standard Part 3 - Section C.8.8.26 within RT Ion Beams Treatment Record referenced in the Referenced Treatment Record Sequence (3008,0030).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedBeamNumber()	Creates a new Referenced Beam Number object which wraps a new and empty Attributes object.
ReferencedBeamNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Beam Number object which wraps the provided attributes.

Method Summary

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

ReferencedBeamNumber

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

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

Parameters:

attributes - the Attributes object to be wrapped.

ReferencedBeamNumber

public ReferencedBeamNumber()

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

Method Detail

copy

public ReferencedBeamNumber copy()

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

Returns:

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

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