Package org.dcm4che.typeddicom.dataelements

Class RTPlanName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTPlanName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class RTPlanName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: RT Plan Name
Keyword: RTPlanName
Tag: (300A,0003)
Value Representation: LO
Value Multiplicity: 1

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

  User-defined name for treatment plan.

  
  

Nested Class Summary

Nested Classes

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

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.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RTPlanName	copy()	Returns a new RT Plan Name which wraps a copy of the Attributes wrapped in this RT Plan Name.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

RTPlanName

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

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

Parameters:

attributes - The Attributes object to be wrapped.

RTPlanName

public RTPlanName()

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

Method Details

copy

public RTPlanName copy()

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

Returns:

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

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.