Package org.dcm4che.typeddicom.dataelements

Class TreatmentTerminationStatus

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TreatmentTerminationStatus

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class TreatmentTerminationStatus
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Treatment Termination Status
Keyword: TreatmentTerminationStatus
Tag: (3008,002A)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Treatment Termination Status
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Treatment Termination Status
  as follows:
  Attribute Name: Treatment Termination Status
  Type: 1
  Attribute Description:

  Conditions under which treatment was terminated.

  Enumerated Values:

  NORMAL

  treatment terminated normally

  OPERATOR

  operator terminated treatment

  MACHINE

  machine terminated treatment

  UNKNOWN

  status at termination unknown

  
  
• Described in the contexts:
  • RT Treatment Summary Record Module > Fraction Group Summary Sequence > Fraction Status Summary Sequence > Treatment Termination Status
  as follows:
  Attribute Name: Treatment Termination Status
  Type: 2
  Attribute Description:

  Conditions under which treatment was terminated.

  Enumerated Values:

  NORMAL

  treatment terminated normally

  OPERATOR

  operator terminated treatment

  MACHINE

  machine terminated treatment for other than NORMAL condition

  UNKNOWN

  status at termination unknown

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Treatment Termination Status
  as follows:
  Attribute Name: Treatment Termination Status
  Type: 1
  Attribute Description:

  Conditions under which treatment was terminated.

  Enumerated Values:

  NORMAL

  treatment terminated normally

  OPERATOR

  operator terminated treatment

  MACHINE

  machine terminated treatment for other than NORMAL condition

  UNKNOWN

  status at termination unknown

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, getValue

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

Constructor Details

TreatmentTerminationStatus

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

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

Parameters:

attributes - The Attributes object to be wrapped.

TreatmentTerminationStatus

public TreatmentTerminationStatus()

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

Method Details

copy

public TreatmentTerminationStatus copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.