Package org.dcm4che.typeddicom.dataelements

Class ModulatedScanModeType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ModulatedScanModeType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ModulatedScanModeType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Modulated Scan Mode Type
Keyword: ModulatedScanModeType
Tag: (300A,0309)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Modulated Scan Mode Type
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Modulated Scan Mode Type
  as follows:
  Attribute Name: Modulated Scan Mode Type
  Type: 1C
  Attribute Description:

  Defines the specialization of a modulated scan mode.

  Defined Terms:

  STATIONARY

  The Meterset is delivered while the beam spot is at the specified position. The beam is always turned off when the position changes.

  LEAPING

  The Meterset is mainly delivered at the specified spot position, while some of the Meterset is delivered while the spot is moved from the prior spot position. This mode also supports turning off the beam between spot positions.

  LINEAR

  The Meterset is delivered uniformly while the beam spot position changes. This mode also supports turning off the beam between line segments.

  Note

  The Defined Term MIXED was previously defined. It is now retired.

  Required if Scan Mode (300A,0308) is MODULATED_SPEC.

  See DICOM Standard Part 3 - Section C.8.8.25.8.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ModulatedScanModeType	copy()	Returns a new Modulated Scan Mode Type which wraps a copy of the Attributes wrapped in this Modulated Scan Mode Type.
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

ModulatedScanModeType

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

Creates a new Modulated Scan Mode Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ModulatedScanModeType

public ModulatedScanModeType()

Creates a new Modulated Scan Mode Type object which wraps a new and empty Attributes object.

Method Details

copy

public ModulatedScanModeType copy()

Returns a new Modulated Scan Mode Type which wraps a copy of the Attributes wrapped in this Modulated Scan Mode Type. (see Attributes(Attributes)

Returns:

a new Modulated Scan Mode Type which wraps a copy of the Attributes wrapped in this Modulated Scan Mode Type.

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.