Package org.dcm4che.typeddicom.dataelements

Class ApplicatorOpening

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ApplicatorOpening

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class ApplicatorOpening
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Applicator Opening
Keyword: ApplicatorOpening
Tag: (300A,0433)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Image Module > Exposure Sequence > Applicator Sequence > Applicator Geometry Sequence > Applicator Opening
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Applicator Sequence > Applicator Geometry Sequence > Applicator Opening
  • RT Beams Module > Beam Sequence > Applicator Sequence > Applicator Geometry Sequence > Applicator Opening
  as follows:
  Attribute Name: Applicator Opening
  Type: 1C
  Attribute Description:

  Opening (in mm) of the applicator's aperture in IEC BEAM LIMITING DEVICE coordinate system. In case of square-shaped applicator contains the length of the sides of the square. In case of circular-shaped applicators, contains the diameter of the circular aperture.

  Required if Applicator Aperture Shape (300A,0432) is SYM_SQUARE or SYM_CIRCULAR.

  
  

Nested Class Summary

Nested Classes

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

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

FloatingPointSingleWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends FloatingPointSingleWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ApplicatorOpening()	Creates a new Applicator Opening object which wraps a new and empty Attributes object.
ApplicatorOpening(org.dcm4che3.data.Attributes attributes)	Creates a new Applicator Opening object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ApplicatorOpening	copy()	Returns a new Applicator Opening which wraps a copy of the Attributes wrapped in this Applicator Opening.
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, getPrivateCreator, getValue

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

getDouble, setDouble

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

getFloat, setFloat

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ApplicatorOpening

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

Creates a new Applicator Opening object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ApplicatorOpening

public ApplicatorOpening()

Creates a new Applicator Opening object which wraps a new and empty Attributes object.

Method Details

copy

public ApplicatorOpening copy()

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

Returns:

a new Applicator Opening which wraps a copy of the Attributes wrapped in this Applicator Opening.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.