Package org.dcm4che.typeddicom.dataelements

Class ScanSpotTuneID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScanSpotTuneID

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, ShortStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class ScanSpotTuneID
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ShortStringWrapper

Name: Scan Spot Tune ID
Keyword: ScanSpotTuneID
Tag: (300A,0390)
Value Representation: ShortString
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Scan Spot Tune ID
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Scan Spot Tune ID
  as follows:
  Attribute Name: Scan Spot Tune ID
  Type: 1C
  Attribute Description:

  User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine specific value. Required if Scan Mode (300A,0308) is MODULATED or MODULATED_SPEC.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScanSpotTuneID.Builder<SELF extends ScanSpotTuneID.Builder<SELF,T>,T extends ScanSpotTuneID.Holder>
static interface	ScanSpotTuneID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Scan Spot Tune ID" (see ScanSpotTuneID)

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

ShortStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends ShortStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.ShortStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ScanSpotTuneID()	Creates a new Scan Spot Tune ID object which wraps a new and empty Attributes object.
ScanSpotTuneID(org.dcm4che3.data.Attributes attributes)	Creates a new Scan Spot Tune ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ScanSpotTuneID	copy()	Returns a new Scan Spot Tune ID which wraps a copy of the Attributes wrapped in this Scan Spot Tune ID.
java.lang.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.ShortStringWrapper

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

ScanSpotTuneID

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

Creates a new Scan Spot Tune ID object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

ScanSpotTuneID

public ScanSpotTuneID()

Creates a new Scan Spot Tune ID object which wraps a new and empty Attributes object.

Method Detail

copy

public ScanSpotTuneID copy()

Returns a new Scan Spot Tune ID which wraps a copy of the Attributes wrapped in this Scan Spot Tune ID. (see Attributes(Attributes)

Returns:

a new Scan Spot Tune ID which wraps a copy of the Attributes wrapped in this Scan Spot Tune ID.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper