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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, ShortStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class RTPlanLabel
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ShortStringWrapper

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

• Described in the contexts:
  • RT Dose Module > Plan Overview Sequence > RT Plan Label
  as follows:
  Attribute Name: RT Plan Label
  Type: 2
  Attribute Description:

  User-defined label of treatment plan.

  
  
• 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)

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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.ShortStringWrapper

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper