Package org.dcm4che.typeddicom.dataelements

Class TreatmentTerminationCode

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TreatmentTerminationCode

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class TreatmentTerminationCode
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Treatment Termination Code
Keyword: TreatmentTerminationCode
Tag: (3008,002B)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Treatment Termination Code
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Treatment Termination Code
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Treatment Termination Code
  as follows:
  Attribute Name: Treatment Termination Code
  Type: 3
  Attribute Description:

  Treatment machine termination code. This code is dependent upon the particular application and equipment.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TreatmentTerminationCode.Builder<SELF extends TreatmentTerminationCode.Builder<SELF,T>,T extends TreatmentTerminationCode.Holder>
static interface	TreatmentTerminationCode.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Termination Code" (see TreatmentTerminationCode)
static class	TreatmentTerminationCode.SimpleHolder

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

ShortStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends ShortStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.ShortStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
TreatmentTerminationCode()	Creates a new Treatment Termination Code object which wraps a new and empty Attributes object.
TreatmentTerminationCode(org.dcm4che3.data.Attributes attributes)	Creates a new Treatment Termination Code object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TreatmentTerminationCode	copy()	Returns a new Treatment Termination Code which wraps a copy of the Attributes wrapped in this Treatment Termination Code.
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.ShortStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

PRIVATE_CREATOR

public static final 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 Details

TreatmentTerminationCode

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

Creates a new Treatment Termination Code object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TreatmentTerminationCode

public TreatmentTerminationCode()

Creates a new Treatment Termination Code object which wraps a new and empty Attributes object.

Method Details

copy

public TreatmentTerminationCode copy()

Returns a new Treatment Termination Code which wraps a copy of the Attributes wrapped in this Treatment Termination Code. (see Attributes(Attributes)

Returns:

a new Treatment Termination Code which wraps a copy of the Attributes wrapped in this Treatment Termination Code.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.