Package org.dcm4che.typeddicom.dataelements

Class CurrentFractionNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CurrentFractionNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class CurrentFractionNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Current Fraction Number
Keyword: CurrentFractionNumber
Tag: (3008,0022)
Value Representation: IS
Value Multiplicity: 1

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

  The index of the fraction that is to be delivered or completed in this session. See DICOM Standard Part 3 - Section C.8.8.29.1.

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

  The index of the fraction that is to be delivered or completed in this treatment session.

  See DICOM Standard Part 3 - Section C.8.8.30.3.

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Current Fraction Number
  as follows:
  Attribute Name: Current Fraction Number
  Type: 2
  Attribute Description:

  Fraction number for this application setup.

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

  Fraction number for this beam administration.

  
  

Nested Class Summary

Nested Classes

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

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 int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
CurrentFractionNumber()	Creates a new Current Fraction Number object which wraps a new and empty Attributes object.
CurrentFractionNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Current Fraction Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CurrentFractionNumber	copy()	Returns a new Current Fraction Number which wraps a copy of the Attributes wrapped in this Current Fraction Number.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

CurrentFractionNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CurrentFractionNumber

public CurrentFractionNumber()

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

Method Details

copy

public CurrentFractionNumber copy()

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

Returns:

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

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.