Package org.dcm4che.typeddicom.dataelements

Class MaterialID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.MaterialID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class MaterialID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Material ID
Keyword: MaterialID
Tag: (300A,00E1)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Range Compensator Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 2
  Attribute Description:

  User-supplied identifier for material used to manufacture Compensator.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Block Sequence > Material ID
  • RT Image Module > Exposure Sequence > Block Sequence > Material ID
  • RT Beams Module > Beam Sequence > Block Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 2
  Attribute Description:

  User-supplied identifier for material used to manufacture Block.

  
  
• Described in the contexts:
  • RT Brachy Application Setups Module > Source Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 3
  Attribute Description:

  User-supplied identifier for encapsulation material of active Source.

  
  
• Described in the contexts:
  • Blocks Definition Macro > Block Definition Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 2
  Attribute Description:

  User-defined identifier for material used to manufacture the Block.

  
  
• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 3
  Attribute Description:

  User-supplied identifier for material of Source Applicator wall. See Note.

  
  
• Described in the contexts:
  • RT ROI Observations Module > RT ROI Observations Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 3
  Attribute Description:

  User-supplied identifier for ROI material.

  
  
• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Brachy Accessory Device Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 3
  Attribute Description:

  User-supplied identifier for material of Brachy Accessory Device. See Note.

  
  
• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Channel Shield Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 3
  Attribute Description:

  User-supplied identifier for material of Channel Shield. See Note.

  
  
• Described in the contexts:
  • Compensators Definition Macro > Compensator Definition Sequence > Compensator Shape Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 2
  Attribute Description:

  User-defined identifier for the material used to manufacture the Compensator.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Compensator Sequence > Material ID
  as follows:
  Attribute Name: Material ID
  Type: 2C
  Attribute Description:

  User-supplied identifier for material used to manufacture Compensator. Required if Number of Compensators (300A,00E0) is non-zero.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

MaterialID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

MaterialID

public MaterialID()

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

Method Details

copy

public MaterialID copy()

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

Returns:

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