Package org.dcm4che.typeddicom.dataelements

Class DoseComment

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseComment

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class DoseComment
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Dose Comment
Keyword: DoseComment
Tag: (3004,0006)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • RT Dose Module > Dose Comment
  as follows:
  Attribute Name: Dose Comment
  Type: 3
  Attribute Description:

  User-defined comments for dose data.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DoseComment	copy()	Returns a new Dose Comment which wraps a copy of the Attributes wrapped in this Dose 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.LongStringWrapper

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

DoseComment

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

Creates a new Dose Comment object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseComment

public DoseComment()

Creates a new Dose Comment object which wraps a new and empty Attributes object.

Method Details

copy

public DoseComment copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.