Package org.dcm4che.typeddicom.dataelements

Class SOPInstanceStatus

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SOPInstanceStatus

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class SOPInstanceStatus
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: SOP Instance Status
Keyword: SOPInstanceStatus
Tag: (0100,0410)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • SOP Common Module > SOP Instance Status
  as follows:
  Attribute Name: SOP Instance Status
  Type: 3
  Attribute Description:

  A flag that indicates the storage status of the SOP Instance.

  Enumerated Values:

  NS

  Not Specified; implies that this SOP Instance has no special storage status, and hence no special actions need be taken

  OR

  Original; implies that this is the primary SOP Instance for the purpose of storage, but that it has not yet been authorized for diagnostic use

  AO

  Authorized Original; implies that this is the primary SOP Instance for the purpose of storage, which has been authorized for diagnostic use

  AC

  Authorized Copy; implies that this is a copy of an Authorized Original SOP Instance; any copies of an Authorized Original should be given the status of Authorized Copy

  Note

  Proper use of these flags is specified in Security Profiles. Implementations that do not conform to such Security Profiles may not necessarily handle these flags properly.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
SOPInstanceStatus	copy()	Returns a new SOP Instance Status which wraps a copy of the Attributes wrapped in this SOP Instance Status.
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

SOPInstanceStatus

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

Creates a new SOP Instance Status object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SOPInstanceStatus

public SOPInstanceStatus()

Creates a new SOP Instance Status object which wraps a new and empty Attributes object.

Method Details

copy

public SOPInstanceStatus copy()

Returns a new SOP Instance Status which wraps a copy of the Attributes wrapped in this SOP Instance Status. (see Attributes(Attributes)

Returns:

a new SOP Instance Status which wraps a copy of the Attributes wrapped in this SOP Instance Status.

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.