Package org.dcm4che.typeddicom.dataelements

Class RTPlanLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTPlanLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class RTPlanLabel
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: RT Plan Label
Keyword: RTPlanLabel
Tag: (300A,0002)
Value Representation: SH
Value Multiplicity: 1

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

  User-defined label for treatment plan.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

RTPlanLabel

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

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

Parameters:

attributes - The Attributes object to be wrapped.

RTPlanLabel

public RTPlanLabel()

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

Method Details

copy

public RTPlanLabel copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.