Package org.dcm4che.typeddicom.dataelements

Class SourceApplicatorID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SourceApplicatorID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class SourceApplicatorID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Source Applicator ID
Keyword: SourceApplicatorID
Tag: (300A,0291)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Source Applicator ID
  as follows:
  Attribute Name: Source Applicator ID
  Type: 2C
  Attribute Description:

  User or machine supplied identifier for Source Applicator. Required if Source Applicator Number (300A,0290) is present.

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Recorded Source Applicator Sequence > Source Applicator ID
  as follows:
  Attribute Name: Source Applicator ID
  Type: 2
  Attribute Description:

  User or machine supplied identifier for Source Applicator.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SourceApplicatorID.Builder<SELF extends SourceApplicatorID.Builder<SELF,T>,T extends SourceApplicatorID.Holder>
static interface	SourceApplicatorID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Source Applicator ID" (see SourceApplicatorID)
static class	SourceApplicatorID.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 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
SourceApplicatorID()	Creates a new Source Applicator ID object which wraps a new and empty Attributes object.
SourceApplicatorID(org.dcm4che3.data.Attributes attributes)	Creates a new Source Applicator ID object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

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

Constructor Details

SourceApplicatorID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SourceApplicatorID

public SourceApplicatorID()

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

Method Details

copy

public SourceApplicatorID copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.