Package org.dcm4che.typeddicom.dataelements

Class RecordInUseFlag

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RecordInUseFlag

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class RecordInUseFlag
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Record In-use Flag
Keyword: RecordInUseFlag
Tag: (0004,1410)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Directory Information Module > Directory Record Sequence > Record In-use Flag
  as follows:
  Attribute Name: Record In-use Flag
  Type: 1
  Attribute Description:

  Enumerated Values:

  FFFFH

  record is in use.

  The value 0000H shall never be present.

  Note

  Formerly, this Attribute was intended to facilitate the deletion of files, with a value 0000H signally an inactive record. This usage has been retired. See ftp://medical.nema.org/MEDICAL/Dicom/2008/08_03pu.pdfPS3.3-2008.

  Other Values are reserved and shall not be set by File-set Creators, but if present shall be interpreted as FFFFH by File-set Readers or Updaters.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RecordInUseFlag	copy()	Returns a new Record In-use Flag which wraps a copy of the Attributes wrapped in this Record In-use Flag.
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

RecordInUseFlag

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

Creates a new Record In-use Flag object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RecordInUseFlag

public RecordInUseFlag()

Creates a new Record In-use Flag object which wraps a new and empty Attributes object.

Method Details

copy

public RecordInUseFlag copy()

Returns a new Record In-use Flag which wraps a copy of the Attributes wrapped in this Record In-use Flag. (see Attributes(Attributes)

Returns:

a new Record In-use Flag which wraps a copy of the Attributes wrapped in this Record In-use Flag.

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.