Package org.dcm4che.typeddicom.dataelements

Class ChannelShieldID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ChannelShieldID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class ChannelShieldID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Channel Shield ID
Keyword: ChannelShieldID
Tag: (300A,02B3)
Value Representation: SH
Value Multiplicity: 1

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

  User or machine supplied identifier for Channel Shield.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ChannelShieldID

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

Creates a new Channel Shield ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ChannelShieldID

public ChannelShieldID()

Creates a new Channel Shield ID object which wraps a new and empty Attributes object.

Method Details

copy

public ChannelShieldID copy()

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

Returns:

a new Channel Shield ID which wraps a copy of the Attributes wrapped in this Channel Shield 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.