Package org.dcm4che.typeddicom.dataelements

Class BlockTrayID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BlockTrayID

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, ShortStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class BlockTrayID
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ShortStringWrapper

Name: Block Tray ID
Keyword: BlockTrayID
Tag: (300A,00F5)
Value Representation: ShortString
Value Multiplicity: 1

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

  User-supplied identifier for block tray.

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

  User-supplied identifier for block tray or Electron Insert.

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

  User-supplied identifier for block tray or Electron Insert.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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
BlockTrayID()	Creates a new Block Tray ID object which wraps a new and empty Attributes object.
BlockTrayID(org.dcm4che3.data.Attributes attributes)	Creates a new Block Tray ID object which wraps the provided attributes.

Method Summary

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

PRIVATE_CREATOR

public static final java.lang.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 Detail

BlockTrayID

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

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

Parameters:

attributes - the Attributes object to be wrapped.

BlockTrayID

public BlockTrayID()

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

Method Detail

copy

public BlockTrayID copy()

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

Returns:

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

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper