Package org.dcm4che.typeddicom.dataelements

Class ReferencedDoseReferenceNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedDoseReferenceNumber

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 ReferencedDoseReferenceNumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Referenced Dose Reference Number
Keyword: ReferencedDoseReferenceNumber
Tag: (300C,0051)
Value Representation: IntegerString
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Brachy Control Point Sequence > Brachy Referenced Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 1
  Attribute Description:

  Uniquely identifies Dose Reference described in Dose Reference Sequence. (300A,0010) within DICOM Standard Part 3 - Section C.8.8.10 of current RT Plan.

  
  
• Described in the contexts:
  • Calculated Dose Reference Record Module > Calculated Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 1C
  Attribute Description:

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan. Required only if Calculated Dose Reference Number (3008,0072) is not present. It shall not be present otherwise.

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

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan. Required if Referenced Calculated Dose Reference Number (3008,0092) is not present.

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

  Uniquely references Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Ion Plan. Required if Referenced Measured Dose Reference Number (3008,0082) is not present.

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

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) within Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10.

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Referenced Measured Dose Reference Sequence > Referenced Dose Reference Number
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Referenced Measured Dose Reference Sequence > Referenced Dose Reference Number
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Referenced Measured Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 1C
  Attribute Description:

  Uniquely references Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan. Required if Referenced Measured Dose Reference Number (3008,0082) is not present. It shall not be present otherwise.

  
  
• Described in the contexts:
  • RT Treatment Summary Record Module > Treatment Summary Measured Dose Reference Sequence > Referenced Dose Reference Number
  • RT Treatment Summary Record Module > Treatment Summary Calculated Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 3
  Attribute Description:

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan referenced in Referenced RT Plan Sequence (300C,0002) of DICOM Standard Part 3 - Section C.8.8.17.

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Referenced Calculated Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 1
  Attribute Description:

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan. Required if Referenced Calculated Dose Reference Number (3008,0092) is not present. It shall not be present otherwise.

  
  
• Described in the contexts:
  • Measured Dose Reference Record Module > Measured Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 1C
  Attribute Description:

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan. Required only if Measured Dose Reference Number (3008,0064) is not present. It shall not be present otherwise.

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

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Ion Plan. Required if Referenced Calculated Dose Reference Number (3008,0092) is not present.

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Referenced Calculated Dose Reference Sequence > Referenced Dose Reference Number
  as follows:
  Attribute Name: Referenced Dose Reference Number
  Type: 1C
  Attribute Description:

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10 of referenced RT Plan. Required if Referenced Calculated Dose Reference Number (3008,0092) is not present. It shall not be present otherwise.

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

  Uniquely identifies Dose Reference specified by Dose Reference Number (300A,0012) in Dose Reference Sequence (300A,0010) in DICOM Standard Part 3 - Section C.8.8.10.

  
  

Nested Class Summary

Nested Classes

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

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
ReferencedDoseReferenceNumber()	Creates a new Referenced Dose Reference Number object which wraps a new and empty Attributes object.
ReferencedDoseReferenceNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Dose Reference Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedDoseReferenceNumber	copy()	Returns a new Referenced Dose Reference Number which wraps a copy of the Attributes wrapped in this Referenced Dose Reference 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, 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

ReferencedDoseReferenceNumber

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

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

Parameters:

attributes - the Attributes object to be wrapped.

ReferencedDoseReferenceNumber

public ReferencedDoseReferenceNumber()

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

Method Detail

copy

public ReferencedDoseReferenceNumber copy()

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

Returns:

a new Referenced Dose Reference Number which wraps a copy of the Attributes wrapped in this Referenced Dose Reference 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