cdac.medinfo.sdk.dcm30_04.baselibs

Class TransferSyntax

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.TransferSyntax

All Implemented Interfaces:

ITransferSyntax, java.io.Serializable

public class TransferSyntax
extends java.lang.Object
implements ITransferSyntax

It implements the set of encoding rules that allow Application Entities to unambiguously negotiate the encoding techniques (e.g., Data Element structure, byte ordering, compression) they are able to support, thereby allowing these Application Entities to communicate.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TransferSyntax() Constructs TransferSyntax with default TransferSyntax UID
TransferSyntax(int iVRTS, int endianNess) This constructor sets the TS with specified endianness and VRType
TransferSyntax(java.lang.String strTransferSyntaxUID) This constructor constructs a TransferSyntax object based on the UID passed to it.

Method Summary

Methods

Modifier and Type	Method and Description
int	changeToDefault() This method changes any transfersyntax to its corresponding DICOM DefaultTransferSyntax.
boolean	equals(java.lang.Object objObject) This method checks the equality of Module's TransferSyntax and DataSet's TransferSyntax.
int	getEndianNess() This method returns the EndianNess specified by DICOM Standard
ISingleCollection<java.lang.String>	getLosslessCompressedTSUIDs() This method returns the collection of UID of Lossless Compressed TransferSyntax.
ISingleCollection<java.lang.String>	getLossyCompressedTSUIDs() This method returns the collection of UID of Lossy Compressed TransferSyntax.
java.lang.String	getTransferSyntaxUID() This method returns the TransferSyntax UID string specified by DICOM Standard
ISingleCollection<java.lang.String>	getUncompressedTSUIDs() This method returns the collection of UID of Uncompressed TransferSyntax.
int	getVRTransferSyntax() This method returns the VRTransferSyntax specified by DICOM Standard
boolean	isDefaultTransferSyntax() This function checks whether the transfer syntax is DICOM Default TransferSyntax
void	setEndianNess(int iEndianNess) This method sets the EndianNess specified by DICOM Standard.
void	setTranferSyntax(int iVRTransferSyntax, int iEndianNess) This method sets the TransferSyntax.
int	setTransferSyntax(java.lang.String strTransferSyntaxUID) Sets the TransferSyntax according to unique ID.
void	setVRTransferSyntax(int iVRTransferSyntax) This method sets the VRTransferSyntax specified by DICOM Standard.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransferSyntax

public TransferSyntax()

Constructs TransferSyntax with default TransferSyntax UID

TransferSyntax

public TransferSyntax(java.lang.String strTransferSyntaxUID)

This constructor constructs a TransferSyntax object based on the UID passed to it. It sets the endianness and VR Type into the TransferSyntax according to the UID

Parameters:

strTransferSyntaxUID - The String UID specified by NEMA for uniquely identifying TransferSyntax

TransferSyntax

public TransferSyntax(int iVRTS,
              int endianNess)

This constructor sets the TS with specified endianness and VRType

Parameters:

endianNess - endianNess of TransferSyntax

iVRTS - type of TS(implicit or explicit)

Method Detail

setTranferSyntax

public void setTranferSyntax(int iVRTransferSyntax,
                    int iEndianNess)

This method sets the TransferSyntax.

Specified by:

setTranferSyntax in interface ITransferSyntax

Parameters:

iVRTransferSyntax - integer value of TransferSyntax.

iEndianNess - integer value shows endianness.

getTransferSyntaxUID

public java.lang.String getTransferSyntaxUID()

This method returns the TransferSyntax UID string specified by DICOM Standard

Specified by:

getTransferSyntaxUID in interface ITransferSyntax

Returns:

String - representing TransferSyntax UID specified by DICOM Standard

getVRTransferSyntax

public int getVRTransferSyntax()

This method returns the VRTransferSyntax specified by DICOM Standard

Specified by:

getVRTransferSyntax in interface ITransferSyntax

Returns:

int - int representing VRTransferSyntax specified by DICOM Standard

setVRTransferSyntax

public void setVRTransferSyntax(int iVRTransferSyntax)

This method sets the VRTransferSyntax specified by DICOM Standard.

Specified by:

setVRTransferSyntax in interface ITransferSyntax

Parameters:

iVRTransferSyntax - integer value of VRTransferSyntax.

getEndianNess

public int getEndianNess()

This method returns the EndianNess specified by DICOM Standard

Specified by:

getEndianNess in interface ITransferSyntax

Returns:

int - int representing EndianNess specified by DICOM Standard

setEndianNess

public void setEndianNess(int iEndianNess)

This method sets the EndianNess specified by DICOM Standard.

Specified by:

setEndianNess in interface ITransferSyntax

Parameters:

iEndianNess - integer value of EndianNess.

isDefaultTransferSyntax

public boolean isDefaultTransferSyntax()

This function checks whether the transfer syntax is DICOM Default TransferSyntax

Specified by:

isDefaultTransferSyntax in interface ITransferSyntax

Returns:

boolean - returns true if the object contains default transfer syntax, otherwise false

setTransferSyntax

public int setTransferSyntax(java.lang.String strTransferSyntaxUID)

Description copied from interface: ITransferSyntax

Sets the TransferSyntax according to unique ID.

Specified by:

setTransferSyntax in interface ITransferSyntax

Parameters:

strTransferSyntaxUID - specifies UID designated by Dicom standard for the TransferSyntaxes.

Returns:

functin status [success/failure]

changeToDefault

public int changeToDefault()

This method changes any transfersyntax to its corresponding DICOM DefaultTransferSyntax. e.g. For Native Format TS, it converts to DICOM Default TransferSyntax For Encapsulated Format TS, it converts to corresponding image type respective DICOM Default TransferSyntax

Specified by:

changeToDefault in interface ITransferSyntax

Returns:

- returns status of the function

equals

public boolean equals(java.lang.Object objObject)

This method checks the equality of Module's TransferSyntax and DataSet's TransferSyntax.

Specified by:

equals in interface ITransferSyntax

Overrides:

equals in class java.lang.Object

Parameters:

objObject - object of Object class.

Returns:

boolean - shows success or failure of the comparison.

getLossyCompressedTSUIDs

public ISingleCollection<java.lang.String> getLossyCompressedTSUIDs()

This method returns the collection of UID of Lossy Compressed TransferSyntax.

Specified by:

getLossyCompressedTSUIDs in interface ITransferSyntax

Returns:

ISingleCollection - returns collection of string.

getLosslessCompressedTSUIDs

public ISingleCollection<java.lang.String> getLosslessCompressedTSUIDs()

This method returns the collection of UID of Lossless Compressed TransferSyntax.

Specified by:

getLosslessCompressedTSUIDs in interface ITransferSyntax

Returns:

ISingleCollection - returns collection of string.

getUncompressedTSUIDs

public ISingleCollection<java.lang.String> getUncompressedTSUIDs()

This method returns the collection of UID of Uncompressed TransferSyntax.

Specified by:

getUncompressedTSUIDs in interface ITransferSyntax

Returns:

ISingleCollection - returns collection of string.