Package org.dcm4che.typeddicom.dataelements

Class BeamType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class BeamType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Beam Type
Keyword: BeamType
Tag: (300A,00C4)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Beam Type
  as follows:
  Attribute Name: Beam Type
  Type: 1
  Attribute Description:

  Motion characteristic of Beam. See Note 5.

  Enumerated Values:

  STATIC

  All Control Point Sequence (300A,0111) Attributes remain unchanged between consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).

  DYNAMIC

  One or more Control Point Sequence (300A,0111) Attributes change between one or more consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).

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

  Motion characteristic of Beam.

  Enumerated Values:

  STATIC

  All Ion Control Point Sequence (300A,03A8) Attributes remain unchanged between consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).

  DYNAMIC

  One or more Ion Control Point Sequence (300A,03A8) Attributes change between one or more consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).

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

  Motion characteristic of delivered Beam.

  Enumerated Values:

  STATIC

  All Control Point Sequence (300A,0111) Attributes remain unchanged between consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).

  DYNAMIC

  One or more Control Point Sequence (300A,0111) Attributes change between one or more consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
BeamType	copy()	Returns a new Beam Type which wraps a copy of the Attributes wrapped in this Beam 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

BeamType

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

Creates a new Beam Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamType

public BeamType()

Creates a new Beam Type object which wraps a new and empty Attributes object.

Method Details

copy

public BeamType copy()

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

Returns:

a new Beam Type which wraps a copy of the Attributes wrapped in this Beam 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.