org.dicom4j.data.elements
Class UnsignedLong

java.lang.Object
  org.dicom4j.data.elements.support.DataElement
      org.dicom4j.data.elements.UnsignedLong

public class UnsignedLong
extends DataElement

Unsigned Long (UL) DataElement

Since:

0.0.0

Author:

Laurent Lecomte

Constructor Summary

UnsignedLong(DicomTag aDataElementTag)
Creates an (empty) DataElement

UnsignedLong(DicomTag t, long aValue)

Method Summary

void	addValue(long aValue) Add a(nother) long value after any existing values of this attribute.
void	clear() Clear Data contains in this Element
long	getPaddedVL() Get the value length of this attribute, accounting for the need for even-length padding.
String[]	getStringValues(NumberFormat format) Get the values of this attribute as strings.
long	getValue(int aIndex)
int	getValueMultiplicity() Get the value multiplicity of this element
ValueRepresentation	getValueRepresentation() Return the value representation of this data element
long[]	getValues()
byte[]	getVR() Deprecated.
void	read(DicomInputStream aStream, long aLength, SpecificCharacterSet aCharacterSet)
void	setValue(long aValue)
String	toString() Dump the contents of the attribute as a human-readable string.
void	write(DicomOutputStream o) Write the entire attribute (including values) to the output stream.

Methods inherited from class org.dicom4j.data.elements.support.DataElement

addValue, addValue, addValue, addValue, addValue, addValue, getByteValues, getDelimitedStringValues, getDelimitedStringValues, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDoubleValues, getDoubleValues, getFloatValues, getIntegerValues, getIntegerValues, getLongValues, getLongValues, getName, getOriginalStringValues, getShortValues, getSingleDoubleValueOrDefault, getSingleDoubleValueOrDefault, getSingleIntegerValue, getSingleIntegerValue, getSingleIntegerValue, getSingleIntegerValueOrDefault, getSingleLongValueOrDefault, getSingleLongValueOrDefault, getSingleStringValue, getSingleStringValue, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getStringValues, getStringValues, getStringValues, getTag, getValueLength, isAvailableAsString, isGroupLength, isValid, read, removeValues, setValues, setValues, setValues

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UnsignedLong

public UnsignedLong(DicomTag aDataElementTag)

Creates an (empty) DataElement

Parameters:

aDataElementTag - the tag of the DataElement

UnsignedLong

public UnsignedLong(DicomTag t,
                    long aValue)
             throws DicomException

Throws:

DicomException

Method Detail

addValue

public void addValue(long aValue)
              throws DicomException

Description copied from class: DataElement

Add a(nother) long value after any existing values of this attribute.

Overrides:

addValue in class DataElement

Parameters:

aValue - the value

Throws:

DicomException

clear

public void clear()

Description copied from class: DataElement

Clear Data contains in this Element

Overrides:

clear in class DataElement

getPaddedVL

public long getPaddedVL()

Description copied from class: DataElement

Get the value length of this attribute, accounting for the need for even-length padding.

Overrides:

getPaddedVL in class DataElement

Returns:

the value length (padded to an even length)

getStringValues

public String[] getStringValues(NumberFormat format)
                         throws DicomException

Description copied from class: DataElement

Get the values of this attribute as strings.

The strings may have been cleaned up into a canonical form, such as to remove padding as well as numbers formatted.

Overrides:

getStringValues in class DataElement

Parameters:

format - the format to use for each numerical or decimal value

Returns:

the values as an array of String

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getValue

public long getValue(int aIndex)

getValueMultiplicity

public int getValueMultiplicity()

Description copied from class: DataElement

Get the value multiplicity of this element

Overrides:

getValueMultiplicity in class DataElement

Returns:

the value multiplicity

getValueRepresentation

public ValueRepresentation getValueRepresentation()

Return the value representation of this data element

Specified by:

getValueRepresentation in class DataElement

Returns:

the value representation (UL)

getValues

public long[] getValues()

getVR

@Deprecated
public byte[] getVR()

Deprecated.

Get the value representation of this attribute (UL).

Returns:

'U','L' in ASCII as a two byte array; see

read

public void read(DicomInputStream aStream,
                 long aLength,
                 SpecificCharacterSet aCharacterSet)
          throws IOException,
                 DicomException

Specified by:

read in class DataElement

Parameters:

vl -

i -

Throws:

IOException

DicomException

setValue

public void setValue(long aValue)
              throws DicomException

Throws:

DicomException

toString

public String toString()

Description copied from class: DataElement

Dump the contents of the attribute as a human-readable string.

No new line is appended.

The result is of the form:

 (0xgggg,0xeeee) VR=<XX> VL=<0xnnnn> <...>
 

For example:

 (0x0018,0x0020) VR=<CS> VL=<0x2> <GR>
 

Overrides:

toString in class DataElement

Returns:

a single String value

write

public void write(DicomOutputStream o)
           throws DicomException,
                  IOException

Description copied from class: DataElement

Write the entire attribute (including values) to the output stream.

Specified by:

write in class DataElement

Parameters:

o -

Throws:

IOException

DicomException