Package org.dcm4che.typeddicom.dataelements

Class ControlPointIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ControlPointIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ControlPointIndex
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Control Point Index
Keyword: ControlPointIndex
Tag: (300A,0112)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Brachy Control Point Sequence > Control Point Index
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Control Point Index
  • RT Beams Module > Beam Sequence > Control Point Sequence > Control Point Index
  as follows:
  Attribute Name: Control Point Index
  Type: 1
  Attribute Description:

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

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

ControlPointIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ControlPointIndex

public ControlPointIndex()

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

Method Details

copy

public ControlPointIndex copy()

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

Returns:

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