Package org.dcm4che.typeddicom.dataelements

Class RTPlanDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTPlanDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class RTPlanDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: RT Plan Description
Keyword: RTPlanDescription
Tag: (300A,0004)
Value Representation: ST
Value Multiplicity: 1

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

  User-defined description of treatment plan.

  
  

Nested Class Summary

Nested Classes

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RTPlanDescription()	Creates a new RT Plan Description object which wraps a new and empty Attributes object.
RTPlanDescription(org.dcm4che3.data.Attributes attributes)	Creates a new RT Plan Description object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RTPlanDescription	copy()	Returns a new RT Plan Description which wraps a copy of the Attributes wrapped in this RT Plan Description.
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.ShortTextWrapper

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

RTPlanDescription

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

Creates a new RT Plan Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTPlanDescription

public RTPlanDescription()

Creates a new RT Plan Description object which wraps a new and empty Attributes object.

Method Details

copy

public RTPlanDescription copy()

Returns a new RT Plan Description which wraps a copy of the Attributes wrapped in this RT Plan Description. (see Attributes(Attributes)

Returns:

a new RT Plan Description which wraps a copy of the Attributes wrapped in this RT Plan Description.

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.