org.dcm4che2.net
Class TransferCapability

java.lang.Object
  org.dcm4che2.net.TransferCapability

Direct Known Subclasses:

ExtQueryTransferCapability, ExtRetrieveTransferCapability, ExtStorageTransferCapability

public class TransferCapability
extends java.lang.Object

DICOM Standard, Part 15, Annex H: Transfer Capability � The description of the SOP classes and syntaxes supported by a Network AE.

An instance of the TransferCapability class describes the DICOM transfer capabilities of an SCU or SCP in terms of a single presentation syntax. This includes the role selection (SCU or SCP), the acceptable transfer syntaxes for a given SOP Class, and any extra information.

Since:

Oct 7, 2005

Version:

$Reversion$ $Date: 2009-06-08 07:47:01 +0200 (Mon, 08 Jun 2009) $

Author:

gunter zeilinger(gunterze@gmail.com)

Field Summary

protected java.lang.String	commonName
protected byte[]	extInfo
protected boolean	scp
static java.lang.String	SCP String representation of the DICOM SCP role.
static java.lang.String	SCU String representation of the DICOM SCU role.
protected java.lang.String	sopClass
protected java.lang.String[]	transferSyntax

Constructor Summary

TransferCapability()
Default constructor.

TransferCapability(java.lang.String sopClass, java.lang.String[] transferSyntax, java.lang.String role)
Creates the TransferCapability instance with the specified presentation context..

Method Summary

java.lang.String	getCommonName() Set the name of the Transfer Capability object.
byte[]	getExtInfo()
boolean	getExtInfoBoolean(int field)
int	getExtInfoInt(int field)
java.lang.String	getRole() Get the role selection for this TransferCapabilityinstance.
java.lang.String	getSopClass() Get the SOP Class of this Transfer Capability object.
java.lang.String[]	getTransferSyntax() Get the transfer syntax(es) that may be requested as an SCU or that are offered as an SCP.
boolean	isSCP() Determine if this Transfer Capability object is capable of acting as an SCP.
boolean	isSCU() Determine if this Transfer Capability object is capable of acting as an SCU.
protected ExtendedNegotiation	negotiate(ExtendedNegotiation offered) Negotiate any extended negotiation items for the association.
void	setCommonName(java.lang.String commonName) Get the name of the Transfer Capability object.
void	setExtInfo(byte[] info)
void	setExtInfoBoolean(int field, boolean b)
void	setExtInfoInt(int field, int value)
void	setRole(java.lang.String role) Set the role selection for this TransferCapabilityinstance.
void	setSopClass(java.lang.String sopClass) Set the SOP Class of this Transfer Capability object.
void	setTransferSyntax(java.lang.String[] transferSyntax) Set the transfer syntax(es) that may be requested as an SCU or that are offered as an SCP.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCU

public static final java.lang.String SCU

String representation of the DICOM SCU role.

See Also:

Constant Field Values

SCP

public static final java.lang.String SCP

String representation of the DICOM SCP role.

See Also:

Constant Field Values

commonName

protected java.lang.String commonName

sopClass

protected java.lang.String sopClass

scp

protected boolean scp

transferSyntax

protected java.lang.String[] transferSyntax

extInfo

protected byte[] extInfo

Constructor Detail

TransferCapability

public TransferCapability()

Default constructor.

TransferCapability

public TransferCapability(java.lang.String sopClass,
                          java.lang.String[] transferSyntax,
                          java.lang.String role)

Creates the TransferCapability instance with the specified presentation context..

Parameters:

sopClass - A String containing the SOP Class UID.

transferSyntax - A String array containing the acceptable transfer syntaxes for sopClass.

role - A String defining the role selection (SCU or SCP) for this TransferCapabilityinstance

Method Detail

getCommonName

public java.lang.String getCommonName()

Set the name of the Transfer Capability object. Can be a meaningful name or any unique sequence of characters.

Returns:

A String containing the common name.

setCommonName

public void setCommonName(java.lang.String commonName)

Get the name of the Transfer Capability object. Can be a meaningful name or any unique sequence of characters.

Parameters:

commonName - A String containing the common name.

getRole

public java.lang.String getRole()

Get the role selection for this TransferCapabilityinstance.

Returns:

A String defining the role selection (SCU or SCP) for this TransferCapabilityinstance

setRole

public void setRole(java.lang.String role)

Set the role selection for this TransferCapabilityinstance.

Parameters:

role - A String defining the role selection (SCU or SCP) for this TransferCapabilityinstance

Throws:

java.lang.IllegalArgumentException - If the role is not equal to SCU or SCP.

isSCP

public boolean isSCP()

Determine if this Transfer Capability object is capable of acting as an SCP.

Returns:

true if SCP is the selected role of this object.

isSCU

public boolean isSCU()

Determine if this Transfer Capability object is capable of acting as an SCU.

Returns:

true if SCU is the selected role of this object.

getSopClass

public java.lang.String getSopClass()

Get the SOP Class of this Transfer Capability object.

Returns:

A String containing the SOP Class UID.

setSopClass

public void setSopClass(java.lang.String sopClass)

Set the SOP Class of this Transfer Capability object.

Parameters:

sopClass - A String containing the SOP Class UID.

getTransferSyntax

public java.lang.String[] getTransferSyntax()

Get the transfer syntax(es) that may be requested as an SCU or that are offered as an SCP.

Returns:

String array containing the transfer syntaxes.

setTransferSyntax

public void setTransferSyntax(java.lang.String[] transferSyntax)

Set the transfer syntax(es) that may be requested as an SCU or that are offered as an SCP.

Parameters:

transferSyntax - String array containing the transfer syntaxes.

getExtInfo

public byte[] getExtInfo()

setExtInfo

public void setExtInfo(byte[] info)

getExtInfoBoolean

public boolean getExtInfoBoolean(int field)

Parameters:

field -

Returns:

getExtInfoInt

public int getExtInfoInt(int field)

Parameters:

field -

Returns:

setExtInfoBoolean

public void setExtInfoBoolean(int field,
                              boolean b)

Parameters:

field -

b -

setExtInfoInt

public void setExtInfoInt(int field,
                          int value)

Parameters:

field -

value -

negotiate

protected ExtendedNegotiation negotiate(ExtendedNegotiation offered)

Negotiate any extended negotiation items for the association.

Parameters:

offered - The ExtendedNegotiation that was offered.

Returns:

ExtendedNegotiation that was negotiated.