Package org.dcm4che.typeddicom.dataelements

Class BeamName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class BeamName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Beam Name
Keyword: BeamName
Tag: (300A,00C2)
Value Representation: LO
Value Multiplicity: 1

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

  User-defined name for Beam.

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

  User-defined name for delivered Beam.

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

  User-defined name for Beam. See Note 1.

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

  User-defined name for Beam. See DICOM Standard Part 3 - Section C.8.8.25.1.

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

BeamName

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

Creates a new Beam Name object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamName

public BeamName()

Creates a new Beam Name object which wraps a new and empty Attributes object.

Method Details

copy

public BeamName copy()

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

Returns:

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