Package org.dcm4che.typeddicom.dataelements

Class BeamDoseType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDoseType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class BeamDoseType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Beam Dose Type
Keyword: BeamDoseType
Tag: (300A,0090)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Beam Sequence > Beam Dose Type
  as follows:
  Attribute Name: Beam Dose Type
  Type: 1C
  Attribute Description:

  Type of Dose of the Beam Dose (300A,0084).

  Enumerated Values:

  PHYSICAL

  EFFECTIVE

  Shall not have the same value as Alternate Beam Dose Type (300A,0092).

  Required if Alternate Beam Dose (300A,0091) is present. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BeamDoseType.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Beam Dose Type" (see BeamDoseType)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
BeamDoseType()	Creates a new Beam Dose Type object which wraps a new and empty Attributes object.
BeamDoseType(org.dcm4che3.data.Attributes attributes)	Creates a new Beam Dose Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BeamDoseType	copy()	Returns a new Beam Dose Type which wraps a copy of the Attributes wrapped in this Beam Dose Type.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

BeamDoseType

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

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

Parameters:

attributes - The Attributes object to be wrapped.

BeamDoseType

public BeamDoseType()

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

Method Details

copy

public BeamDoseType copy()

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

Returns:

a new Beam Dose Type which wraps a copy of the Attributes wrapped in this Beam Dose Type.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.