Package org.dcm4che.typeddicom.dataelements

Class RangeModulatorDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RangeModulatorDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class RangeModulatorDescription
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Range Modulator Description
Keyword: RangeModulatorDescription
Tag: (300A,034A)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Range Modulator Sequence > Range Modulator Description
  as follows:
  Attribute Name: Range Modulator Description
  Type: 3
  Attribute Description:

  User-defined description of Range Modulator.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RangeModulatorDescription()	Creates a new Range Modulator Description object which wraps a new and empty Attributes object.
RangeModulatorDescription(org.dcm4che3.data.Attributes attributes)	Creates a new Range Modulator Description object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RangeModulatorDescription	copy()	Returns a new Range Modulator Description which wraps a copy of the Attributes wrapped in this Range Modulator Description.
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.DataElementWrapper

exists, getValue

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

getValueRepresentation

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

RangeModulatorDescription

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

Creates a new Range Modulator Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RangeModulatorDescription

public RangeModulatorDescription()

Creates a new Range Modulator Description object which wraps a new and empty Attributes object.

Method Details

copy

public RangeModulatorDescription copy()

Returns a new Range Modulator Description which wraps a copy of the Attributes wrapped in this Range Modulator Description. (see Attributes(Attributes)

Returns:

a new Range Modulator Description which wraps a copy of the Attributes wrapped in this Range Modulator Description.

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.