Package org.dcm4che.typeddicom.dataelements

Class TreatmentStatusComment

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TreatmentStatusComment

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class TreatmentStatusComment
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Treatment Status Comment
Keyword: TreatmentStatusComment
Tag: (3008,0202)
Value Representation: ST
Value Multiplicity: 1

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

  Comment on current treatment status.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TreatmentStatusComment	copy()	Returns a new Treatment Status Comment which wraps a copy of the Attributes wrapped in this Treatment Status Comment.
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, getPrivateCreator, getValue

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

getValueRepresentation

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

TreatmentStatusComment

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

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

Parameters:

attributes - The Attributes object to be wrapped.

TreatmentStatusComment

public TreatmentStatusComment()

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

Method Details

copy

public TreatmentStatusComment copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.