Package org.dcm4che.typeddicom.dataelements

Class RTRadiationUsage

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTRadiationUsage

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RTRadiationUsage
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: RT Radiation Usage
Keyword: RTRadiationUsage
Tag: (300A,0701)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Radiation Record Common Module > RT Radiation Usage
  as follows:
  Attribute Name: RT Radiation Usage
  Type: 1
  Attribute Description:

  A general indication of how the referenced RT Radiation was used.

  The Defined Terms are specified in DICOM Standard Part 3 - Section C.36.10.1.1.

  This value may differ from the RT Radiation Set Intent (300A,0637) within the Instance referenced by the Referenced RT Radiation Set Sequence (300A,0702).

  See DICOM Standard Part 3 - Section C.36.20.1.4.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RTRadiationUsage.Builder<SELF extends RTRadiationUsage.Builder<SELF,T>,T extends RTRadiationUsage.Holder>
static interface	RTRadiationUsage.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "RT Radiation Usage" (see RTRadiationUsage)
static class	RTRadiationUsage.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
RTRadiationUsage()	Creates a new RT Radiation Usage object which wraps a new and empty Attributes object.
RTRadiationUsage(org.dcm4che3.data.Attributes attributes)	Creates a new RT Radiation Usage object which wraps the provided attributes.

Method Summary

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

RTRadiationUsage

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

Creates a new RT Radiation Usage object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTRadiationUsage

public RTRadiationUsage()

Creates a new RT Radiation Usage object which wraps a new and empty Attributes object.

Method Details

copy

public RTRadiationUsage copy()

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

Returns:

a new RT Radiation Usage which wraps a copy of the Attributes wrapped in this RT Radiation Usage.

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.