Package org.dcm4che.typeddicom.dataelements

Class FrameReferenceDateTime

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameReferenceDateTime

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DateDataElementWrapper, DateTimeWrapper, StringDataElementWrapper

public class FrameReferenceDateTime
extends AbstractDataElementWrapper
implements DateTimeWrapper

Name: Frame Reference DateTime
Keyword: FrameReferenceDateTime
Tag: (0018,9151)
Value Representation: DT
Value Multiplicity: 1

• Described in the contexts:
  • Frame Content Macro > Frame Content Sequence > Frame Reference DateTime
  as follows:
  Attribute Name: Frame Reference DateTime
  Type: 1C
  Attribute Description:

  The point in time that is most representative of when data was acquired for this frame. See DICOM Standard Part 3 - Section C.7.6.16.2.2.1 and DICOM Standard Part 3 - Section C.7.6.16.2.2.2 for further explanation.

  Note

  The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time synchronized (0018,1800).

  Required if Frame Type (0008,9007) Value 1 of this frame is ORIGINAL and the SOP Class UID is not "1.2.840.10008.5.1.4.1.1.2.2" or "1.2.840.10008.5.1.4.1.1.4.4" or "1.2.840.10008.5.1.4.1.1.128.1" (Legacy Converted) or 1.2.840.10008.5.1.4.1.1.77.1.6 (VL Whole Slide Microscopy Image Storage). May be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
FrameReferenceDateTime()	Creates a new Frame Reference DateTime object which wraps a new and empty Attributes object.
FrameReferenceDateTime(org.dcm4che3.data.Attributes attributes)	Creates a new Frame Reference DateTime object which wraps the provided attributes.

Method Summary

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

getDate, getDate, getDate, setDate, setDate

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

getValueRepresentation

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

getString, setString

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

FrameReferenceDateTime

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

Creates a new Frame Reference DateTime object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FrameReferenceDateTime

public FrameReferenceDateTime()

Creates a new Frame Reference DateTime object which wraps a new and empty Attributes object.

Method Details

copy

public FrameReferenceDateTime copy()

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

Returns:

a new Frame Reference DateTime which wraps a copy of the Attributes wrapped in this Frame Reference DateTime.

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.