Package org.dcm4che.typeddicom.dataelements

Class SimpleFrameList

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SimpleFrameList

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, UnsignedLongMultiWrapper

public class SimpleFrameList
extends AbstractDataElementWrapper
implements UnsignedLongMultiWrapper

Name: Simple Frame List
Keyword: SimpleFrameList
Tag: (0008,1161)
Value Representation: UL
Value Multiplicity: 1-n

• Described in the contexts:
  • Frame Extraction Module > Frame Extraction Sequence > Simple Frame List
  as follows:
  Attribute Name: Simple Frame List
  Type: 1C
  Attribute Description:

  A list of Frames that were extracted in the form of a simple list.

  Required if object extraction is based on a Frame Level Retrieve using the Simple Frame List (0008,1161) Attribute.

  See PS3.4 PS3.4 "Instance and Frame Level Retrieve SOP Classes"

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimpleFrameList.Builder<SELF extends SimpleFrameList.Builder<SELF,T>,T extends SimpleFrameList.Holder>
static interface	SimpleFrameList.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Simple Frame List" (see SimpleFrameList)
static class	SimpleFrameList.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SimpleFrameList()	Creates a new Simple Frame List object which wraps a new and empty Attributes object.
SimpleFrameList(org.dcm4che3.data.Attributes attributes)	Creates a new Simple Frame List object which wraps the provided attributes.

Method Summary

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

getInt, getInts, setInts

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedLongMultiWrapper

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

SimpleFrameList

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

Creates a new Simple Frame List object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SimpleFrameList

public SimpleFrameList()

Creates a new Simple Frame List object which wraps a new and empty Attributes object.

Method Details

copy

public SimpleFrameList copy()

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

Returns:

a new Simple Frame List which wraps a copy of the Attributes wrapped in this Simple Frame List.

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.