Package org.dcm4che.typeddicom.dataelements

Class ImageBoxLargeScrollAmount

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImageBoxLargeScrollAmount

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ImageBoxLargeScrollAmount
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Image Box Large Scroll Amount
Keyword: ImageBoxLargeScrollAmount
Tag: (0072,0318)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Hanging Protocol Display Module > Display Sets Sequence > Image Boxes Sequence > Image Box Large Scroll Amount
  as follows:
  Attribute Name: Image Box Large Scroll Amount
  Type: 1C
  Attribute Description:

  Defines the positive integer number of pages, rows, columns, or images per large increment scroll, based on the values of Image Box Large Scroll Type (0072,0316) and Image Box Scroll Direction (0072,0310). The value applies to both forward and backward scrolling.

  Required if Image Box Large Scroll Type (0072,0316) is present with a value.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ImageBoxLargeScrollAmount	copy()	Returns a new Image Box Large Scroll Amount which wraps a copy of the Attributes wrapped in this Image Box Large Scroll Amount.
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

ImageBoxLargeScrollAmount

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

Creates a new Image Box Large Scroll Amount object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ImageBoxLargeScrollAmount

public ImageBoxLargeScrollAmount()

Creates a new Image Box Large Scroll Amount object which wraps a new and empty Attributes object.

Method Details

copy

public ImageBoxLargeScrollAmount copy()

Returns a new Image Box Large Scroll Amount which wraps a copy of the Attributes wrapped in this Image Box Large Scroll Amount. (see Attributes(Attributes)

Returns:

a new Image Box Large Scroll Amount which wraps a copy of the Attributes wrapped in this Image Box Large Scroll Amount.

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.