Package org.dcm4che.typeddicom.dataelements

Class ApplicatorDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ApplicatorDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class ApplicatorDescription
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Applicator Description
Keyword: ApplicatorDescription
Tag: (300A,010A)
Value Representation: LO
Value Multiplicity: 1

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

  User-defined description for Applicator.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

exists, getValue

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

getValueRepresentation

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

ApplicatorDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ApplicatorDescription

public ApplicatorDescription()

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

Method Details

copy

public ApplicatorDescription copy()

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

Returns:

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

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.