cdac.medinfo.sdk.dcm30_04.commoninterface

Interface IDicomStream

All Known Implementing Classes:

DicomBufferStream, DicomFileStream, DicomStream

public interface IDicomStream

This interface needs to be implemented by all classes which implements the necessary functionality for the Dicom Stream.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns the number of bytes available on the stream
int	close() Closes the stream.
boolean	endSend() Shows the end of sending process.
int	getEndianNess() Retrieves the endianNess of the stream.
int	getReadBytes() Keeps track of how much bytes are read from the stream
int	getStream() Retrieves the stream.
int	mark(int iReadAheadLimit) Marks the stream for further resetting with specified limit.
int	readBuffer(byte[] arrbyte) Reads reads buffer byte per byte from stream
byte	readByte() Reads a single byte from the stream
byte[]	readChars(int iLength) Reads specified number of characters from the stream
double	readDouble() Reads a double from the stream
float	readFloat() Reads a float from the stream
int	readInt() Reads an integer from the stream
long	readLong() Reads a long from stream.
short	readShort() Reads a short from the stream
java.lang.String	readString(int intVar) Reads a string from the stream with specified length
byte[]	readWord() Reads a word from stream
int	reset() Resets the stream to a specific marked position.
int	setEndianNess(int iEndianNess) Sets the endianess of the steam [BIG_ENDIAN/LITTLE_ENDIAN] Endianness defines the byte ordering used to store values as bytes in computer memory.
int	skip(int iNumBytes) Skips the specified number of bytes.
boolean	startReceive() Shows the beginning of receiving process.
boolean	writeBuffer(byte[] arrbyte, int iOffset, int iLength) Writes the data to the buffer.
int	writeByte(byte bVar) Writes a byte to the stream
int	writeChars(byte[] arrChar) Writes array of charactors to the stream
int	writeDouble(double dVar) Writes a double value to the stream
int	writeFloat(float fVar) Writes a float value to the stream
int	writeInt(int nVar) Writes an int value to the stream
int	writeLong(int iVar) Writes an Long value to the stream
int	writeShort(short shtVar) Writes a short value on to the stream
int	writeString(java.lang.String s) Writes an String value to the stream
int	writeWord(byte[] byteVal) Writes a word to the stream

Method Detail

getStream

int getStream()

Retrieves the stream.

Returns:

int - integer value of stream type.

writeBuffer

boolean writeBuffer(byte[] arrbyte,
                  int iOffset,
                  int iLength)
                    throws java.io.IOException

Writes the data to the buffer.

Parameters:

arrbyte - Byte array containing data.

iOffset - integer value shows offset.

iLength - integer value shows length.

Returns:

boolean - shows status as success or failure.

Throws:

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

writeByte

int writeByte(byte bVar)
              throws java.io.IOException

Writes a byte to the stream

Parameters:

bVar - Byte value.

Returns:

int - shows status as success or failure.

Throws:

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

writeShort

int writeShort(short shtVar)
               throws java.io.IOException

Writes a short value on to the stream

Parameters:

shtVar - short value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeDouble

int writeDouble(double dVar)
                throws java.io.IOException

Writes a double value to the stream

Parameters:

dVar - Shows double value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeFloat

int writeFloat(float fVar)
               throws java.io.IOException

Writes a float value to the stream

Parameters:

fVar - Shows float value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeInt

int writeInt(int nVar)
             throws java.io.IOException

Writes an int value to the stream

Parameters:

nVar - integer value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeLong

int writeLong(int iVar)
              throws java.io.IOException

Writes an Long value to the stream

Parameters:

iVar - integer value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeString

int writeString(java.lang.String s)
                throws java.io.IOException

Writes an String value to the stream

Parameters:

s - String value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeChars

int writeChars(byte[] arrChar)
               throws java.io.IOException

Writes array of charactors to the stream

Parameters:

arrChar - Array of charactors value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

writeWord

int writeWord(byte[] byteVal)
              throws java.io.IOException

Writes a word to the stream

Parameters:

byteVal - Array of Byte value to write.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - If IO operation fails.

readLong

long readLong()
              throws java.io.IOException

Reads a long from stream. In Java, long is of 8 bytes, but in Dicom Standard long data type length is expected as 4 bytes. So here it reads only 4 bytes from stream.

Returns:

long - Next read long value.

Throws:

java.io.IOException - If IO operation fails.

readInt

int readInt()
            throws java.io.IOException

Reads an integer from the stream

Returns:

int - Next read integer value.

Throws:

java.io.IOException - If IO operation fails.

readFloat

float readFloat()
                throws java.io.IOException

Reads a float from the stream

Returns:

float - Next read float value.

Throws:

java.io.IOException - If IO operation fails.

readDouble

double readDouble()
                  throws java.io.IOException

Reads a double from the stream

Returns:

double - Next read double value.

Throws:

java.io.IOException - If IO operation fails.

readByte

byte readByte()
              throws java.io.IOException

Reads a single byte from the stream

Returns:

byte - Next read byte value.

Throws:

java.io.IOException - If IO operation fails.

readShort

short readShort()
                throws java.io.IOException

Reads a short from the stream

Returns:

short - Next read short value.

Throws:

java.io.IOException - If IO operation fails.

readString

java.lang.String readString(int intVar)
                            throws java.io.IOException

Reads a string from the stream with specified length

Parameters:

intVar - Integer value shows length of string to read.

Returns:

String - Read string value of specified length.

Throws:

java.io.IOException - If IO operation fails.

readChars

byte[] readChars(int iLength)
                 throws java.io.IOException

Reads specified number of characters from the stream

Parameters:

iLength - integer value shows no. of characters to read.

Returns:

byte[] - Byte array of next read characters.

Throws:

java.io.IOException - If IO operation fails.

readBuffer

int readBuffer(byte[] arrbyte)
               throws java.io.IOException

Reads reads buffer byte per byte from stream

Parameters:

arrbyte - Byte array populated by stream.

Returns:

int -Returns the integer number of bytes actually read from input stream . If no byte is available because the stream is at end of file, the value -1 is returned.

Throws:

java.io.IOException - If IO operation fails.

readWord

byte[] readWord()
                throws java.io.IOException

Reads a word from stream

Returns:

byte[] - Returns the byte array which contains the word read from stream.

Throws:

java.io.IOException - If IO operation fails.

startReceive

boolean startReceive()

Shows the beginning of receiving process.

Returns:

boolean - shows status.

endSend

boolean endSend()
                throws java.io.IOException

Shows the end of sending process.

Returns:

boolean - shows status as success or failure.

Throws:

java.io.IOException - Exception if IO operation fails.

setEndianNess

int setEndianNess(int iEndianNess)

Sets the endianess of the steam [BIG_ENDIAN/LITTLE_ENDIAN] Endianness defines the byte ordering used to store values as bytes in computer memory.

Parameters:

iEndianNess - Integer value shows endianNess.

Returns:

int - Integer value shows success.

getEndianNess

int getEndianNess()

Retrieves the endianNess of the stream. Endianness defines the byte ordering used to store values as bytes in computer memory.

Returns:

int - Integer value shows the endianNess.

getReadBytes

int getReadBytes()

Keeps track of how much bytes are read from the stream

Returns:

int - Integer value of number of bytes read.

skip

int skip(int iNumBytes)
         throws java.io.IOException

Skips the specified number of bytes.

Parameters:

iNumBytes - Integer value shows no. of bytes to skip.

Returns:

int - Integer value shows success.

Throws:

java.io.IOException - Exception if IO operation fails.

mark

int mark(int iReadAheadLimit)

Marks the stream for further resetting with specified limit.

Parameters:

iReadAheadLimit - integer number of bytes to mark.

Returns:

int - Integer value shows success.

reset

int reset()
          throws java.io.IOException

Resets the stream to a specific marked position.

Returns:

int - Integer value shows success.

Throws:

java.io.IOException - Exception if IO operation fails.

available

int available()
              throws java.io.IOException

Returns the number of bytes available on the stream

Returns:

int - Integer value of available bytes.

Throws:

java.io.IOException - Exception if IO operation fails.

close

int close()
          throws java.io.IOException

Closes the stream.

Returns:

int - integer value shows success.

Throws:

java.io.IOException - Exception if IO operation fails.