Package org.dcm4che.typeddicom.dataelements

Class AccessoryCode

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.AccessoryCode

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class AccessoryCode
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Accessory Code
Keyword: AccessoryCode
Tag: (300A,00F9)
Value Representation: LO
Value Multiplicity: 1

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

  An identifier for the Block intended to be read by a device such as a bar-code reader.

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > General Accessory Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > General Accessory Sequence > Accessory Code
  • RT Beams Module > Beam Sequence > General Accessory Sequence > Accessory Code
  • RT Image Module > Exposure Sequence > General Accessory Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > General Accessory Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type: 3
  Attribute Description:

  Machine-readable identifier for this accessory

  
  
• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Applicator Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Snout Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Wedge Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Referenced Bolus Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Compensator Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Applicator Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Referenced Bolus Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Lateral Spreading Device Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Snout Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Ion Range Compensator Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Range Modulator Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Range Shifter Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Ion Wedge Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Block Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Range Shifter Sequence > Accessory Code
  • RT Ion Beams Module > Ion Beam Sequence > Lateral Spreading Device Sequence > Accessory Code
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Range Modulator Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type: 3
  Attribute Description:

  An accessory identifier to be read by a device such as a bar code reader.

  
  
• Described in the contexts:
  • Equipment Specification Module > Model Specification Sequence > General Accessory Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type: 1
  Attribute Description:

  Machine readable identifier for the accessory.

  E.g., this may indicate accessory equipment such as cardiac gating equipment.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Block Sequence > Block Slab Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type: 3
  Attribute Description:

  Machine-readable identifier for this accessory.

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

  An identifier for the Compensator intended to be read by a device such as a bar-code reader.

  
  
• Described in the contexts:
  • RT General Machine Verification Module > General Machine Verification Sequence > Recorded Wedge Sequence > Accessory Code
  • RT General Machine Verification Module > General Machine Verification Sequence > Recorded Compensator Sequence > Accessory Code
  • RT General Machine Verification Module > General Machine Verification Sequence > Applicator Sequence > Accessory Code
  • RT General Machine Verification Module > General Machine Verification Sequence > Recorded Block Sequence > Accessory Code
  • RT General Machine Verification Module > General Machine Verification Sequence > Patient Setup Sequence > Fixation Device Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type:
  Attribute Description:

  An identifier for the accessory intended to be read by a device such as a bar-code reader.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Block Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type: 3
  Attribute Description:

  An accessory identifier to be read by a device such as a bar code reader.

  Shall not be present if Block Slab Sequence (300A,0441) is present within the same Item of Ion Block Sequence (300A,03A6) or when the Block Type (300A,00F8) has a value of APERTURE and Block Slab Sequence (300A,0441) is present in another Item having this value.

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Range Modulator Sequence > Accessory Code
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Lateral Spreading Device Sequence > Accessory Code
  • RT General Machine Verification Module > General Machine Verification Sequence > Referenced Bolus Sequence > Accessory Code
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Snout Sequence > Accessory Code
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Range Shifter Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type:
  Attribute Description:

  An accessory identifier to be read by a device such as a bar code reader.

  
  
• Described in the contexts:
  • RT Patient Setup Module > Patient Setup Sequence > Shielding Device Sequence > Accessory Code
  • RT Beams Module > Beam Sequence > Wedge Sequence > Accessory Code
  • RT Beams Module > Beam Sequence > Referenced Bolus Sequence > Accessory Code
  • RT Patient Setup Module > Patient Setup Sequence > Fixation Device Sequence > Accessory Code
  • RT Beams Module > Beam Sequence > Applicator Sequence > Accessory Code
  • RT Patient Setup Module > Patient Setup Sequence > Setup Device Sequence > Accessory Code
  • RT Image Module > Exposure Sequence > Applicator Sequence > Accessory Code
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Recorded Wedge Sequence > Accessory Code
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Referenced Bolus Sequence > Accessory Code
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Applicator Sequence > Accessory Code
  as follows:
  Attribute Name: Accessory Code
  Type: 3
  Attribute Description:

  An identifier for the accessory intended to be read by a device such as a bar-code reader.

  
  

Nested Class Summary

Nested Classes

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

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

LongStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends LongStringWrapper>

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.LongStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
AccessoryCode()	Creates a new Accessory Code object which wraps a new and empty Attributes object.
AccessoryCode(org.dcm4che3.data.Attributes attributes)	Creates a new Accessory Code object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
AccessoryCode	copy()	Returns a new Accessory Code which wraps a copy of the Attributes wrapped in this Accessory Code.
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.LongStringWrapper

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

AccessoryCode

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

Creates a new Accessory Code object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

AccessoryCode

public AccessoryCode()

Creates a new Accessory Code object which wraps a new and empty Attributes object.

Method Details

copy

public AccessoryCode copy()

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

Returns:

a new Accessory Code which wraps a copy of the Attributes wrapped in this Accessory Code.

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.