Package org.dcm4che.typeddicom.dataelements

Class DoseReferenceStructureType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseReferenceStructureType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DoseReferenceStructureType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dose Reference Structure Type
Keyword: DoseReferenceStructureType
Tag: (300A,0014)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Prescription Module > Dose Reference Sequence > Dose Reference Structure Type
  as follows:
  Attribute Name: Dose Reference Structure Type
  Type: 1
  Attribute Description:

  Structure type of Dose Reference.

  Defined Terms:

  POINT

  dose reference point specified as ROI

  VOLUME

  dose reference volume specified as ROI

  COORDINATES

  point specified by Dose Reference Point Coordinates (300A,0018)

  SITE

  dose reference clinical site

  
  

Nested Class Summary

Nested Classes

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

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

Constructor Summary

Constructors

Constructor	Description
DoseReferenceStructureType()	Creates a new Dose Reference Structure Type object which wraps a new and empty Attributes object.
DoseReferenceStructureType(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Reference Structure Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DoseReferenceStructureType	copy()	Returns a new Dose Reference Structure Type which wraps a copy of the Attributes wrapped in this Dose Reference Structure Type.
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

DoseReferenceStructureType

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

Creates a new Dose Reference Structure Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseReferenceStructureType

public DoseReferenceStructureType()

Creates a new Dose Reference Structure Type object which wraps a new and empty Attributes object.

Method Details

copy

public DoseReferenceStructureType copy()

Returns a new Dose Reference Structure Type which wraps a copy of the Attributes wrapped in this Dose Reference Structure Type. (see Attributes(Attributes)

Returns:

a new Dose Reference Structure Type which wraps a copy of the Attributes wrapped in this Dose Reference Structure Type.

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.