cdac.medinfo.sdk.dcm30_04.baselibs

Class US

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

cdac.medinfo.sdk.dcm30_04.baselibs.US

All Implemented Interfaces:

IDicomValue, java.io.Serializable

public class US
extends DicomValue

US is signifies Unsigned binary integer 16 bits long.Represents integer n in the range:0 <= n < 216.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the value of Attribute in redable form.
long	getMaxLength() Retrieves the max length for US DataType
int	getValueLength() Retrieves the actual value length of US
boolean	read(IDicomStream objIDicomStream, int iLength) Reads the US DataType structure from underlying stream
void	setValue(java.lang.Object objValue) Sets the value in the DicomValue after performing validation on the value After setting the value setValue returns the errorcode indicating whether the validation of value was successful or failing
java.lang.String	toString() This function returns the String value of US Data Type.
boolean	validate() Validates US DataType
boolean	validate(java.lang.Object objToValidate) Validates US DataType
int	write(IDicomStream objIDicomStream) This fucntion writes the Data Value to the Stream

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

clone, getIVRType, getValue, getValueMultiplicity, setIVRType

Methods inherited from class java.lang.Object

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

Method Detail

getMaxLength

public long getMaxLength()

Retrieves the max length for US DataType

Returns:

long - max length for FD DataType

validate

public boolean validate(java.lang.Object objToValidate)

Validates US DataType

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Parameters:

objToValidate - value of US to be validated

Returns:

boolean - status indicating success/failure

validate

public boolean validate()

Validates US DataType

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Returns:

boolean - status indicating success/failure

read

public boolean read(IDicomStream objIDicomStream,
           int iLength)
             throws InvalidDataTypeException,
                    java.io.IOException

Reads the US DataType structure from underlying stream

Specified by:

read in interface IDicomValue

Specified by:

read in class DicomValue

Parameters:

objIDicomStream - stream from which the DataType is to be written

iLength - length of the DicomValue to be read from the stream

Returns:

integer - returns status success/failure

Throws:

InvalidDataTypeException - If data type validation fails.

java.io.IOException - If Input/Output operation fails.

write

public int write(IDicomStream objIDicomStream)
          throws java.io.IOException

This fucntion writes the Data Value to the Stream

Specified by:

write in interface IDicomValue

Specified by:

write in class DicomValue

Parameters:

objIDicomStream - stream onto which the FD DataType is to serialized

Returns:

ineteger - status indicating success/failure of write method

Throws:

java.io.IOException - If Input/Output operation fails.

getValueLength

public int getValueLength()

Retrieves the actual value length of US

Specified by:

getValueLength in interface IDicomValue

Specified by:

getValueLength in class DicomValue

Returns:

integer - actual value length of US

setValue

public void setValue(java.lang.Object objValue)
              throws InvalidDataTypeException

Sets the value in the DicomValue after performing validation on the value After setting the value setValue returns the errorcode indicating whether the validation of value was successful or failing

Specified by:

setValue in interface IDicomValue

Overrides:

setValue in class DicomValue

Parameters:

objValue - value that is to be set into the DicomValue

Throws:

InvalidDataTypeException - Signals Data Type is not valid.

toString

public java.lang.String toString()

This function returns the String value of US Data Type.

Overrides:

toString in class java.lang.Object

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the value of Attribute in redable form.

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.