cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons

Interface ICommandElement

All Known Implementing Classes:

CommandElement

public interface ICommandElement

This interface needs to be implemented by all classes which implements functioning of CommandElement.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objTempObject) The implementation of this method Check for the equality of two objects.
int	getCommandElementLength() The implementation of this method retrieves the length of CommandElement.
IDicomValue	getDicomValue() The implementation of this method retrieves the value part of the Command Element.
int	getLength() The implementation of this method retrieves the length part of the Command Element.
ITag	getTag() The implementation of this method retrieves the Tag part of the Command Element.
ITransferSyntax	getTransferSyntax() The implementation of this method retrieves the TransferSyntax set in the CommandElement object.
int	getValueLength() The implementation of this method retrieves the length of value for a CommandElement.
int	getValueMultiplicity() The implementation of this method retrieves the value multiplicity of the value in CommandElement.
int	parse(IDicomStream objIDicomStream) The implementation of this method parses the Command Element from the given Stream.
int	serialize(IDicomStream objIDicomStream) The implementation of this method serializes the Command Element from the given Stream.
void	setCommandElementLength() The implementation of this method sets the length of CommandElement.
void	setDicomValue(IDicomValue objIDicomValue) The implementation of this method sets the DicomValue as a value in the CommandElement.
void	setLength(int iLength) The implementation of this method sets length of the CommandElement.
void	setTag(int iGroupNumber, int iElementNumber) The implementation of this method sets the GroupNumber and ElementNumber of the Command Element.
void	setValueMultiplicity(int iVM) The implementation of this method sets the value multiplicity of the value of CommandElement.

Method Detail

serialize

int serialize(IDicomStream objIDicomStream)
              throws InvalidDataTypeException,
                     java.io.IOException

The implementation of this method serializes the Command Element from the given Stream.

Parameters:

objIDicomStream - Stream on which the DICOM data is available

Returns:

int - shows status as success or failure.

Throws:

InvalidDataTypeException - If DataType validation fails.

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

parse

int parse(IDicomStream objIDicomStream)
          throws InvalidCommandElementException,
                 java.io.IOException

The implementation of this method parses the Command Element from the given Stream.

Parameters:

objIDicomStream - Stream on which the DICOM data is available

Returns:

int - shows status as success or failure.

Throws:

InvalidDataElementException - If Data Element fails to satisfy Validation Criteria.

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

InvalidCommandElementException - the invalid command element exception

setLength

void setLength(int iLength)

The implementation of this method sets length of the CommandElement.

Parameters:

iLength - 4 bytes Length of Value in the Command Element.

getValueLength

int getValueLength()

The implementation of this method retrieves the length of value for a CommandElement.

Returns:

int - Integer value of length.

getCommandElementLength

int getCommandElementLength()

The implementation of this method retrieves the length of CommandElement.

Returns:

int - Integer value of length.

getLength

int getLength()

The implementation of this method retrieves the length part of the Command Element.

Returns:

int - Integer value of length.

getValueMultiplicity

int getValueMultiplicity()

The implementation of this method retrieves the value multiplicity of the value in CommandElement.

Returns:

integer - returns the actual value multiplicity of value in the CommandElement

setValueMultiplicity

void setValueMultiplicity(int iVM)

The implementation of this method sets the value multiplicity of the value of CommandElement.

Parameters:

iVM - value multiplicity of the value

setTag

void setTag(int iGroupNumber,
          int iElementNumber)

The implementation of this method sets the GroupNumber and ElementNumber of the Command Element.

Parameters:

iGroupNumber - specifies the Group Number.

iElementNumber - specifies the Element Number.

setCommandElementLength

void setCommandElementLength()

The implementation of this method sets the length of CommandElement.

getTag

ITag getTag()

The implementation of this method retrieves the Tag part of the Command Element.

Returns:

ITag - Tag containing Group Number and Element Number.

getDicomValue

IDicomValue getDicomValue()

The implementation of this method retrieves the value part of the Command Element.

Returns:

IDicomValue - instance containing the value of the Command Element.

setDicomValue

void setDicomValue(IDicomValue objIDicomValue)

The implementation of this method sets the DicomValue as a value in the CommandElement.

Parameters:

objIDicomValue - object of DicomValue representing the value of CommandElement

getTransferSyntax

ITransferSyntax getTransferSyntax()

The implementation of this method retrieves the TransferSyntax set in the CommandElement object.

Returns:

ITransferSyntax object of TransferSyntax set in the CommandElement object.

equals

boolean equals(java.lang.Object objTempObject)

The implementation of this method Check for the equality of two objects.

Overrides:

equals in class java.lang.Object

Parameters:

objTempObject - the object to compare with.

Returns:

boolean - true if the objects are the same; false otherwise.