Package org.dcm4che.typeddicom.dataelements

Class ApplicatorID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ApplicatorID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class ApplicatorID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Applicator ID
Keyword: ApplicatorID
Tag: (300A,0108)
Value Representation: SH
Value Multiplicity: 1

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

  User or machine supplied identifier for Applicator.

  
  
• Described in the contexts:
  • RT General Machine Verification Module > General Machine Verification Sequence > Applicator Sequence > Applicator ID
  as follows:
  Attribute Name: Applicator ID
  Type:
  Attribute Description:

  User or machine supplied identifier for Applicator.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

ApplicatorID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ApplicatorID

public ApplicatorID()

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

Method Details

copy

public ApplicatorID copy()

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

Returns:

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

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.