Package org.dcm4che.typeddicom.dataelements

Class PlanIntent

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PlanIntent

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class PlanIntent
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Plan Intent
Keyword: PlanIntent
Tag: (300A,000A)
Value Representation: CS
Value Multiplicity: 1

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

  Intent of this plan.

  Defined Terms:

  CURATIVE

  Curative therapy on patient

  PALLIATIVE

  Palliative therapy on patient

  PROPHYLACTIC

  Preventative therapy on patient

  VERIFICATION

  Verification of patient plan using phantom

  MACHINE_QA

  Quality assurance of the delivery machine (independently of a specific patient)

  RESEARCH

  Research project

  SERVICE

  Machine repair or maintenance operation

  
  

Nested Class Summary

Nested Classes

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

PlanIntent

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

Creates a new Plan Intent object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PlanIntent

public PlanIntent()

Creates a new Plan Intent object which wraps a new and empty Attributes object.

Method Details

copy

public PlanIntent copy()

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

Returns:

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

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.