Package org.dcm4che.typeddicom.dataelements

Class RTControlPointIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTControlPointIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class RTControlPointIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: RT Control Point Index
Keyword: RTControlPointIndex
Tag: (300A,0600)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Control Point General Macro > RT Control Point Index
  as follows:
  Attribute Name: RT Control Point Index
  Type: 1
  Attribute Description:

  The index of the RT Control Point within the Sequence where this Macro is included.

  RT Control Points shall be executed in the order of the RT Control Point Index.

  The value shall start at 1 and increase monotonically by 1 within the Sequence where this Macro is included.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

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

RTControlPointIndex

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

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

Parameters:

attributes - The Attributes object to be wrapped.

RTControlPointIndex

public RTControlPointIndex()

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

Method Details

copy

public RTControlPointIndex copy()

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

Returns:

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