Package org.dcm4che.typeddicom.dataelements

Class ReferencedStopControlPointIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedStopControlPointIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ReferencedStopControlPointIndex
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Referenced Stop Control Point Index
Keyword: ReferencedStopControlPointIndex
Tag: (300C,00F6)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Dose Module > Referenced RT Plan Sequence > Referenced Fraction Group Sequence > Referenced Beam Sequence > Referenced Control Point Sequence > Referenced Stop Control Point Index
  as follows:
  Attribute Name: Referenced Stop Control Point Index
  Type: 1
  Attribute Description:

  Identifies Control Point specified by Control Point Index (300A,0112) within Beam referenced by Referenced Beam Number (300C,0006). This is the second of the two Control Points from which the Dose contribution to the Control Point can be calculated.

  The Control Point Index (300A,0112) referenced by Referenced

  Stop Control Point Index (300C,00F6) shall be the Control Point Index (300A,0112) immediately following the Control Point Index (300A,0112) referenced by Referenced Start Control Point Index (300C,00F4) within the Referenced Beam Number (300C,0006).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedStopControlPointIndex()	Creates a new Referenced Stop Control Point Index object which wraps a new and empty Attributes object.
ReferencedStopControlPointIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Stop Control Point Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedStopControlPointIndex	copy()	Returns a new Referenced Stop Control Point Index which wraps a copy of the Attributes wrapped in this Referenced Stop Control Point Index.
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.IntDataElementWrapper

getInt, setInt

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper

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

ReferencedStopControlPointIndex

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

Creates a new Referenced Stop Control Point Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedStopControlPointIndex

public ReferencedStopControlPointIndex()

Creates a new Referenced Stop Control Point Index object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedStopControlPointIndex copy()

Returns a new Referenced Stop Control Point Index which wraps a copy of the Attributes wrapped in this Referenced Stop Control Point Index. (see Attributes(Attributes)

Returns:

a new Referenced Stop Control Point Index which wraps a copy of the Attributes wrapped in this Referenced Stop Control Point Index.

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.