Package org.dcm4che.typeddicom.dataelements

Class ReferencedPlanOverviewIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedPlanOverviewIndex

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper

public class ReferencedPlanOverviewIndex
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Referenced Plan Overview Index
Keyword: ReferencedPlanOverviewIndex
Tag: (300C,0118)
Value Representation: UnsignedShort
Value Multiplicity: 1

• Described in the contexts:
  • RT Dose Module > Referenced RT Plan Sequence > Referenced Plan Overview Index
  as follows:
  Attribute Name: Referenced Plan Overview Index
  Type: 1C
  Attribute Description:

  The value of Plan Overview Index (300C,0117) from the Plan Overview Sequence (300C,0116) to which this RT Plan corresponds. Shall be unique, i.e., not be duplicated within another Item of this Referenced RT Plan Sequence (300C,0002).

  Required if Plan Overview Sequence (300C,0116) is present.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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
ReferencedPlanOverviewIndex()	Creates a new Referenced Plan Overview Index object which wraps a new and empty Attributes object.
ReferencedPlanOverviewIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Plan Overview Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedPlanOverviewIndex	copy()	Returns a new Referenced Plan Overview Index which wraps a copy of the Attributes wrapped in this Referenced Plan Overview Index.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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 Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

ReferencedPlanOverviewIndex

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

Creates a new Referenced Plan Overview Index object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

ReferencedPlanOverviewIndex

public ReferencedPlanOverviewIndex()

Creates a new Referenced Plan Overview Index object which wraps a new and empty Attributes object.

Method Detail

copy

public ReferencedPlanOverviewIndex copy()

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

Returns:

a new Referenced Plan Overview Index which wraps a copy of the Attributes wrapped in this Referenced Plan Overview Index.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper