Package org.dcm4che.typeddicom.dataelements

Class BeamStopperPosition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamStopperPosition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class BeamStopperPosition
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Beam Stopper Position
Keyword: BeamStopperPosition
Tag: (3008,0230)
Value Representation: CS
Value Multiplicity: 1

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

  Position of Beam Stopper during beam administration.

  Enumerated Values:

  EXTENDED

  Beam Stopper extended

  RETRACTED

  Beam Stopper retracted

  UNKNOWN

  Position unknown

  
  

Nested Class Summary

Nested Classes

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

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

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

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

Method Summary

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

BeamStopperPosition

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

Creates a new Beam Stopper Position object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamStopperPosition

public BeamStopperPosition()

Creates a new Beam Stopper Position object which wraps a new and empty Attributes object.

Method Details

copy

public BeamStopperPosition copy()

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

Returns:

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

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.