Package org.dcm4che.typeddicom.dataelements

Class TreatmentMachineName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TreatmentMachineName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class TreatmentMachineName
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Treatment Machine Name
Keyword: TreatmentMachineName
Tag: (300A,00B2)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Application Setups Module > Treatment Machine Sequence > Treatment Machine Name
  as follows:
  Attribute Name: Treatment Machine Name
  Type: 2
  Attribute Description:

  User-defined name identifying treatment machine to be used for treatment delivery.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Treatment Machine Name
  as follows:
  Attribute Name: Treatment Machine Name
  Type: 2
  Attribute Description:

  User-defined name identifying treatment machine to be used for beam delivery. See Note 2.

  
  
• Described in the contexts:
  • RT General Machine Verification Module > General Machine Verification Sequence > Treatment Machine Name
  as follows:
  Attribute Name: Treatment Machine Name
  Type:
  Attribute Description:

  User-defined name identifying treatment machine to be used for beam delivery. See DICOM Standard Part 3 - Section C.8.8.25.2.

  
  
• Described in the contexts:
  • RT Treatment Machine Record Module > Treatment Machine Sequence > Treatment Machine Name
  as follows:
  Attribute Name: Treatment Machine Name
  Type: 2
  Attribute Description:

  User-defined name identifying treatment machine used for treatment delivery.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Treatment Machine Name
  as follows:
  Attribute Name: Treatment Machine Name
  Type: 2
  Attribute Description:

  User-defined name identifying treatment machine to be used for beam delivery. See DICOM Standard Part 3 - Section C.8.8.25.2.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TreatmentMachineName.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Machine Name" (see TreatmentMachineName)

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
TreatmentMachineName()	Creates a new Treatment Machine Name object which wraps a new and empty Attributes object.
TreatmentMachineName(org.dcm4che3.data.Attributes attributes)	Creates a new Treatment Machine Name object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TreatmentMachineName	copy()	Returns a new Treatment Machine Name which wraps a copy of the Attributes wrapped in this Treatment Machine Name.
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

TreatmentMachineName

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

Creates a new Treatment Machine Name object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TreatmentMachineName

public TreatmentMachineName()

Creates a new Treatment Machine Name object which wraps a new and empty Attributes object.

Method Details

copy

public TreatmentMachineName copy()

Returns a new Treatment Machine Name which wraps a copy of the Attributes wrapped in this Treatment Machine Name. (see Attributes(Attributes)

Returns:

a new Treatment Machine Name which wraps a copy of the Attributes wrapped in this Treatment Machine Name.

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.