Package org.dcm4che.typeddicom.dataelements

Class ReferencedControlPointIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedControlPointIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ReferencedControlPointIndex
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Referenced Control Point Index
Keyword: ReferencedControlPointIndex
Tag: (300C,00F0)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Brachy Control Point Delivered Sequence > Referenced Control Point Index
  as follows:
  Attribute Name: Referenced Control Point Index
  Type: 3
  Attribute Description:

  Index of current Control Point, starting at 0 for first Control Point.

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

  Uniquely identifies Control Point specified by Control Point Index (300A,0112) within Beam referenced by Referenced Beam Number (300C,0006).

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Pulse Specific Brachy Control Point Delivered Sequence > Brachy Pulse Control Point Delivered Sequence > Referenced Control Point Index
  as follows:
  Attribute Name: Referenced Control Point Index
  Type: 3
  Attribute Description:

  Index of current Control Point, starting at 0 for first Control Point in this Sequence.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Referenced Dose Reference Sequence > Beam Dose Verification Control Point Sequence > Referenced Control Point Index
  as follows:
  Attribute Name: Referenced Control Point Index
  Type: 1C
  Attribute Description:

  Uniquely identifies the Control Point specified by Control Point Index (300A,0112) within Beam referenced by Referenced Beam Number (300C,0006).

  See DICOM Standard Part 3 - Section C.8.8.14.16.

  Required, if the Referenced Cumulative Meterset corresponds to a Control Point in the Control Point Sequence (300A,0111).

  
  
• Described in the contexts:
  • RT Conventional Machine Verification Module > Conventional Machine Verification Sequence > Conventional Control Point Verification Sequence > Referenced Control Point Index
  as follows:
  Attribute Name: Referenced Control Point Index
  Type:
  Attribute Description:

  Uniquely identifies Control Point specified by Control Point Index (300A,0112) within the Beam referenced by Referenced Beam Number (300C,0006).

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

  Uniquely identifies Control Point specified by Control Point Index (300A,0112) within the Beam referenced by Referenced Beam Number (300C,0006).

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Ion Control Point Verification Sequence > Referenced Control Point Index
  as follows:
  Attribute Name: Referenced Control Point Index
  Type:
  Attribute Description:

  Uniquely identifies Control Point specified by Control Point Index (300A,0112 within the Beam referenced by Referenced Beam Number (300C,0006).

  
  

Nested Class Summary

Nested Classes

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

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 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
ReferencedControlPointIndex()	Creates a new Referenced Control Point Index object which wraps a new and empty Attributes object.
ReferencedControlPointIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Control Point Index object which wraps the provided attributes.

Method Summary

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

getInt, setInt

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

ReferencedControlPointIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedControlPointIndex

public ReferencedControlPointIndex()

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

Method Details

copy

public ReferencedControlPointIndex copy()

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

Returns:

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

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.