Package org.dcm4che.typeddicom.dataelements

Class ClinicalFractionNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ClinicalFractionNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ClinicalFractionNumber
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Clinical Fraction Number
Keyword: ClinicalFractionNumber
Tag: (300A,0705)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Radiation Set Delivery Instruction Module > Clinical Fraction Number
  as follows:
  Attribute Name: Clinical Fraction Number
  Type: 1C
  Attribute Description:

  A number that indicates the RT Treatment Fraction to be delivered.

  Required if RT Radiation Set Delivery Usage (300A,079E) is TREATMENT. May be present otherwise.

  See DICOM Standard Part 3 - Section C.36.20.1.2.

  
  
• Described in the contexts:
  • RT Radiation Record Set Module > Clinical Fraction Number
  as follows:
  Attribute Name: Clinical Fraction Number
  Type: 1C
  Attribute Description:

  Count of the RT Treatment Fractions that have been delivered, irrespective of the RT Radiation Set(s) used.

  Required if Referenced RT Radiation Set Sequence (300A,0702) is present and RT Radiation Set Usage (300A,0707) is TREATMENT. May be present otherwise.

  See DICOM Standard Part 3 - Section C.36.20.1.2.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClinicalFractionNumber.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Clinical Fraction Number" (see ClinicalFractionNumber)

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

Method Summary

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

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

ClinicalFractionNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ClinicalFractionNumber

public ClinicalFractionNumber()

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

Method Details

copy

public ClinicalFractionNumber copy()

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

Returns:

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