Package org.dcm4che.typeddicom.dataelements

Class ReferenceImageNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferenceImageNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ReferenceImageNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Reference Image Number
Keyword: ReferenceImageNumber
Tag: (300A,00C8)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Referenced Reference Image Sequence > Reference Image Number
  • RT Beams Module > Beam Sequence > Referenced Reference Image Sequence > Reference Image Number
  as follows:
  Attribute Name: Reference Image Number
  Type: 1
  Attribute Description:

  Uniquely identifies Reference Image within Referenced Reference Image Sequence (300C,0042).

  
  

Nested Class Summary

Nested Classes

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

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
ReferenceImageNumber()	Creates a new Reference Image Number object which wraps a new and empty Attributes object.
ReferenceImageNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Reference Image Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferenceImageNumber	copy()	Returns a new Reference Image Number which wraps a copy of the Attributes wrapped in this Reference Image Number.
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

ReferenceImageNumber

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

Creates a new Reference Image Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferenceImageNumber

public ReferenceImageNumber()

Creates a new Reference Image Number object which wraps a new and empty Attributes object.

Method Details

copy

public ReferenceImageNumber copy()

Returns a new Reference Image Number which wraps a copy of the Attributes wrapped in this Reference Image Number. (see Attributes(Attributes)

Returns:

a new Reference Image Number which wraps a copy of the Attributes wrapped in this Reference Image Number.

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.