Package org.dcm4che.typeddicom.dataelements

Class ReportedValuesOrigin

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReportedValuesOrigin

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ReportedValuesOrigin
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Reported Values Origin
Keyword: ReportedValuesOrigin
Tag: (3002,000A)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Image Module > Reported Values Origin
  as follows:
  Attribute Name: Reported Values Origin
  Type: 2C
  Attribute Description:

  Describes the origin of the parameter values reported in the image. Required if Value 3 of Image Type (0008,0008) is SIMULATOR or PORTAL.

  Enumerated Values:

  OPERATOR

  manually entered by operator

  PLAN

  planned parameter values

  ACTUAL

  electronically recorded

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReportedValuesOrigin()	Creates a new Reported Values Origin object which wraps a new and empty Attributes object.
ReportedValuesOrigin(org.dcm4che3.data.Attributes attributes)	Creates a new Reported Values Origin object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReportedValuesOrigin	copy()	Returns a new Reported Values Origin which wraps a copy of the Attributes wrapped in this Reported Values Origin.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

ReportedValuesOrigin

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

Creates a new Reported Values Origin object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReportedValuesOrigin

public ReportedValuesOrigin()

Creates a new Reported Values Origin object which wraps a new and empty Attributes object.

Method Details

copy

public ReportedValuesOrigin copy()

Returns a new Reported Values Origin which wraps a copy of the Attributes wrapped in this Reported Values Origin. (see Attributes(Attributes)

Returns:

a new Reported Values Origin which wraps a copy of the Attributes wrapped in this Reported Values Origin.

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.