Package org.dcm4che.typeddicom.dataelements

Class ApplicatorApertureShape

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ApplicatorApertureShape

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ApplicatorApertureShape
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Applicator Aperture Shape
Keyword: ApplicatorApertureShape
Tag: (300A,0432)
Value Representation: CS
Value Multiplicity: 1

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

  Aperture shape of the applicator.

  Defined Terms:

  SYM_SQUARE

  A square-shaped aperture symmetrical to the central axis.

  SYM_RECTANGLE

  A rectangular-shaped aperture symmetrical to the central axis.

  SYM_CIRCULAR

  A circular-shaped aperture symmetrical to the central axis.

  
  

Nested Class Summary

Nested Classes

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

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
ApplicatorApertureShape()	Creates a new Applicator Aperture Shape object which wraps a new and empty Attributes object.
ApplicatorApertureShape(org.dcm4che3.data.Attributes attributes)	Creates a new Applicator Aperture Shape object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ApplicatorApertureShape	copy()	Returns a new Applicator Aperture Shape which wraps a copy of the Attributes wrapped in this Applicator Aperture Shape.
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

ApplicatorApertureShape

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

Creates a new Applicator Aperture Shape object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ApplicatorApertureShape

public ApplicatorApertureShape()

Creates a new Applicator Aperture Shape object which wraps a new and empty Attributes object.

Method Details

copy

public ApplicatorApertureShape copy()

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

Returns:

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

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.