Package org.dcm4che.typeddicom.dataelements

Class RepresentativeFrameNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RepresentativeFrameNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class RepresentativeFrameNumber
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Representative Frame Number
Keyword: RepresentativeFrameNumber
Tag: (0028,6010)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Multi-frame Functional Groups Module > Representative Frame Number
  as follows:
  Attribute Name: Representative Frame Number
  Type: 3
  Attribute Description:

  The frame number selected for use as a pictorial representation (e.g., icon) of the multi-frame Image.

  
  
• Described in the contexts:
  • Frame Pointers Module > Representative Frame Number
  as follows:
  Attribute Name: Representative Frame Number
  Type: 3
  Attribute Description:

  The frame number selected for use as a pictorial representation (e.g., icon) of the Multi-frame Image

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RepresentativeFrameNumber.Builder<SELF extends RepresentativeFrameNumber.Builder<SELF,T>,T extends RepresentativeFrameNumber.Holder>
static interface	RepresentativeFrameNumber.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Representative Frame Number" (see RepresentativeFrameNumber)
static class	RepresentativeFrameNumber.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
RepresentativeFrameNumber()	Creates a new Representative Frame Number object which wraps a new and empty Attributes object.
RepresentativeFrameNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Representative Frame Number object which wraps the provided attributes.

Method Summary

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

RepresentativeFrameNumber

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

Creates a new Representative Frame Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RepresentativeFrameNumber

public RepresentativeFrameNumber()

Creates a new Representative Frame Number object which wraps a new and empty Attributes object.

Method Details

copy

public RepresentativeFrameNumber copy()

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

Returns:

a new Representative Frame Number which wraps a copy of the Attributes wrapped in this Representative Frame Number.

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.