Package org.dcm4che.typeddicom.dataelements

Class CompensatorTrayID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorTrayID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class CompensatorTrayID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Compensator Tray ID
Keyword: CompensatorTrayID
Tag: (300A,00EF)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Compensator Sequence > Compensator Tray ID
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Recorded Compensator Sequence > Compensator Tray ID
  as follows:
  Attribute Name: Compensator Tray ID
  Type: 3
  Attribute Description:

  User-supplied identifier for compensator tray.

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

  User-supplied identifier for compensator tray.

  
  

Nested Class Summary

Nested Classes

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

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.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

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

Method Summary

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

CompensatorTrayID

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

Creates a new Compensator Tray ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorTrayID

public CompensatorTrayID()

Creates a new Compensator Tray ID object which wraps a new and empty Attributes object.

Method Details

copy

public CompensatorTrayID copy()

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

Returns:

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

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.