Package org.dcm4che.typeddicom.dataelements

Class BeamDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class BeamDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Beam Description
Keyword: BeamDescription
Tag: (300A,00C3)
Value Representation: ST
Value Multiplicity: 1

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

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

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

  User-defined description for delivered Beam.

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

  User-defined description for Beam. See Note 1.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

BeamDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

BeamDescription

public BeamDescription()

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

Method Details

copy

public BeamDescription copy()

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

Returns:

a new Beam Description which wraps a copy of the Attributes wrapped in this Beam Description.

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.