Package org.dcm4che.typeddicom.dataelements

Class CurrentTreatmentStatus

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CurrentTreatmentStatus

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class CurrentTreatmentStatus
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Current Treatment Status
Keyword: CurrentTreatmentStatus
Tag: (3008,0200)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Treatment Summary Record Module > Current Treatment Status
  as follows:
  Attribute Name: Current Treatment Status
  Type: 1
  Attribute Description:

  Status of the Treatment at the time the Treatment Summary was created.

  Enumerated Values:

  NOT_STARTED

  ON_TREATMENT

  ON_BREAK

  SUSPENDED

  STOPPED

  COMPLETED

  See DICOM Standard Part 3 - Section C.8.8.23.1.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CurrentTreatmentStatus.Builder<SELF extends CurrentTreatmentStatus.Builder<SELF,T>,T extends CurrentTreatmentStatus.Holder>
static interface	CurrentTreatmentStatus.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Current Treatment Status" (see CurrentTreatmentStatus)
static class	CurrentTreatmentStatus.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 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.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

CurrentTreatmentStatus

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CurrentTreatmentStatus

public CurrentTreatmentStatus()

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

Method Details

copy

public CurrentTreatmentStatus copy()

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

Returns:

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

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.