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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper

public class ClinicalFractionNumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Clinical Fraction Number
Keyword: ClinicalFractionNumber
Tag: (300A,0705)
Value Representation: UnsignedShort
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.Builder<SELF extends ClinicalFractionNumber.Builder<SELF,T>,T extends ClinicalFractionNumber.Holder>
static interface	ClinicalFractionNumber.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Clinical Fraction Number" (see ClinicalFractionNumber)
static class	ClinicalFractionNumber.SimpleHolder

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

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

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

VALUE_REPRESENTATION

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

getValueRepresentation

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

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 Detail

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.

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