Package org.dcm4che.typeddicom.dataelements

Class AlternateBeamDoseType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.AlternateBeamDoseType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class AlternateBeamDoseType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Alternate Beam Dose Type
Keyword: AlternateBeamDoseType
Tag: (300A,0092)
Value Representation: CS
Value Multiplicity: 1

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

  Type of Dose of the Alternate Beam Dose (300A,0091).

  Enumerated Values:

  PHYSICAL

  EFFECTIVE

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

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

  
  

Nested Class Summary

Nested Classes

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

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 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
AlternateBeamDoseType()	Creates a new Alternate Beam Dose Type object which wraps a new and empty Attributes object.
AlternateBeamDoseType(org.dcm4che3.data.Attributes attributes)	Creates a new Alternate Beam Dose Type object which wraps the provided attributes.

Method Summary

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

AlternateBeamDoseType

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

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

Parameters:

attributes - The Attributes object to be wrapped.

AlternateBeamDoseType

public AlternateBeamDoseType()

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

Method Details

copy

public AlternateBeamDoseType copy()

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

Returns:

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