Package org.dcm4che.typeddicom.dataelements

Class RTPlanRelationship

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTPlanRelationship

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RTPlanRelationship
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: RT Plan Relationship
Keyword: RTPlanRelationship
Tag: (300A,0055)
Value Representation: CS
Value Multiplicity: 1

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

  Relationship of referenced plan with respect to current plan.

  Defined Terms:

  PRIOR

  plan delivered prior to current treatment

  ALTERNATIVE

  alternative plan prepared for current treatment

  PREDECESSOR

  plan used in derivation of current plan

  VERIFIED_PLAN

  plan that is verified using the current plan. This value shall only be used if Plan Intent (300A,000A) is present and has a value of VERIFICATION

  CONCURRENT

  plan that forms part of a set of two or more RT Plan Instances representing a single conceptual 'plan', applied in parallel in one treatment phase

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, 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

Constructor Details

RTPlanRelationship

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

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

Parameters:

attributes - The Attributes object to be wrapped.

RTPlanRelationship

public RTPlanRelationship()

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

Method Details

copy

public RTPlanRelationship copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.