Package org.dcm4che.typeddicom.dataelements

Class ReferencedFractionGroupNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedFractionGroupNumber

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

Name: Referenced Fraction Group Number
Keyword: ReferencedFractionGroupNumber
Tag: (300C,0022)
Value Representation: IntegerString
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Session Record Module > Referenced Fraction Group Number
  as follows:
  Attribute Name: Referenced Fraction Group Number
  Type: 3
  Attribute Description:

  Identifier of fraction group within referenced RT Ion Plan.

  
  
• Described in the contexts:
  • RT Brachy Application Setup Delivery Instruction Module > Referenced Fraction Group Number
  as follows:
  Attribute Name: Referenced Fraction Group Number
  Type: 1
  Attribute Description:

  Indicates which fraction group of the referenced RT Plan in the Referenced RT Plan Sequence (300C,0002) is to be treated in the treatment session.

  
  
• Described in the contexts:
  • RT Treatment Summary Record Module > Fraction Group Summary Sequence > Referenced Fraction Group Number
  as follows:
  Attribute Name: Referenced Fraction Group Number
  Type: 3
  Attribute Description:

  References Fraction Group Number (300A,0071) in Fraction Group Sequence (300A,0070) in the referenced RT Plan.

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

  Indicates which fraction group of the referenced plan is to be treated in the treatment session. Only one Fraction Group shall be specified per Delivery Instruction SOP Instance.

  Required if the referenced plan has more than one Fraction Group Sequence (300A,0070) Item.

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

  Identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Referenced Fraction Group Number
  • RT Beams Session Record Module > Referenced Fraction Group Number
  as follows:
  Attribute Name: Referenced Fraction Group Number
  Type: 3
  Attribute Description:

  Identifier of Fraction Group within referenced RT Plan.

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

  Identifier of Fraction Group within referenced RT Plan.

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

  Uniquely identifies Fraction Group specified by Fraction Group Number (300A,0071) in Fraction Group Sequence of DICOM Standard Part 3 - Section C.8.8.13 within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

ReferencedFractionGroupNumber

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

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

Parameters:

attributes - the Attributes object to be wrapped.

ReferencedFractionGroupNumber

public ReferencedFractionGroupNumber()

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

Method Detail

copy

public ReferencedFractionGroupNumber copy()

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

Returns:

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