Package org.dcm4che.typeddicom.dataelements

Class MechanicalIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.MechanicalIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class MechanicalIndex
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Mechanical Index
Keyword: MechanicalIndex
Tag: (0018,5022)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • US Image Module > Mechanical Index
  as follows:
  Attribute Name: Mechanical Index
  Type: 3
  Attribute Description:

  See DICOM Standard Part 3 - Section C.8.5.6.1.8 for Description.

  
  
• Described in the contexts:
  • Enhanced US Image Module > Mechanical Index
  as follows:
  Attribute Name: Mechanical Index
  Type: 1
  Attribute Description:

  See DICOM Standard Part 3 - Section C.8.5.6.1.8 for Description.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
MechanicalIndex()	Creates a new Mechanical Index object which wraps a new and empty Attributes object.
MechanicalIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Mechanical Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
MechanicalIndex	copy()	Returns a new Mechanical Index which wraps a copy of the Attributes wrapped in this Mechanical Index.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getDouble, setDouble

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

getFloat, setFloat

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

MechanicalIndex

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

Creates a new Mechanical Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

MechanicalIndex

public MechanicalIndex()

Creates a new Mechanical Index object which wraps a new and empty Attributes object.

Method Details

copy

public MechanicalIndex copy()

Returns a new Mechanical Index which wraps a copy of the Attributes wrapped in this Mechanical Index. (see Attributes(Attributes)

Returns:

a new Mechanical Index which wraps a copy of the Attributes wrapped in this Mechanical Index.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.