org.dcm4che3.net

Class TransferCapability

java.lang.Object

org.dcm4che3.net.TransferCapability

All Implemented Interfaces:

Serializable

public class TransferCapability
extends Object
implements Serializable

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.

Author:

Gunter Zeilinger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferCapability.Role

Field Summary

Fields

Modifier and Type	Field and Description
private ApplicationEntity	ae
private String	commonName
private EnumSet<QueryOption>	queryOptions
private TransferCapability.Role	role
private static long	serialVersionUID
private String	sopClass
private StorageOptions	storageOptions
private String[]	transferSyntaxes

Constructor Summary

Constructors

Constructor and Description
TransferCapability()
TransferCapability(String commonName, String sopClass, TransferCapability.Role role, String... transferSyntaxes)

Method Summary

Modifier and Type	Method and Description
boolean	containsTransferSyntax(String ts)
TransferCapability	deepCopy()
String	getCommonName() get the name of the Transfer Capability object.
EnumSet<QueryOption>	getQueryOptions()
TransferCapability.Role	getRole() Get the role for this TransferCapabilityinstance.
String	getSopClass() Get the SOP Class of this Transfer Capability object.
StorageOptions	getStorageOptions()
String[]	getTransferSyntaxes() Get the transfer syntax(es) that may be requested as an SCU or that are offered as an SCP.
StringBuilder	promptTo(StringBuilder sb, String indent)
void	setApplicationEntity(ApplicationEntity ae)
void	setCommonName(String commonName)
void	setQueryOptions(EnumSet<QueryOption> queryOptions)
void	setRole(TransferCapability.Role role)
void	setSopClass(String sopClass)
void	setStorageOptions(StorageOptions storageOptions)
void	setTransferSyntaxes(String... transferSyntaxes)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ae

private ApplicationEntity ae

commonName

private String commonName

sopClass

private String sopClass

role

private TransferCapability.Role role

transferSyntaxes

private String[] transferSyntaxes

queryOptions

private EnumSet<QueryOption> queryOptions

storageOptions

private StorageOptions storageOptions

Constructor Detail

TransferCapability

public TransferCapability()

TransferCapability

public TransferCapability(String commonName,
                          String sopClass,
                          TransferCapability.Role role,
                          String... transferSyntaxes)

Method Detail

setApplicationEntity

public void setApplicationEntity(ApplicationEntity ae)

getCommonName

public String getCommonName()

get 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(String commonName)

getRole

public TransferCapability.Role getRole()

Get the role for this TransferCapabilityinstance.

Returns:

Role (SCU or SCP) for this TransferCapabilityinstance

setRole

public void setRole(TransferCapability.Role role)

getSopClass

public String getSopClass()

Get the SOP Class of this Transfer Capability object.

Returns:

A String containing the SOP Class UID.

setSopClass

public void setSopClass(String sopClass)

getTransferSyntaxes

public String[] getTransferSyntaxes()

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

Returns:

list of transfer syntaxes.

setTransferSyntaxes

public void setTransferSyntaxes(String... transferSyntaxes)

containsTransferSyntax

public boolean containsTransferSyntax(String ts)

setQueryOptions

public void setQueryOptions(EnumSet<QueryOption> queryOptions)

getQueryOptions

public EnumSet<QueryOption> getQueryOptions()

setStorageOptions

public void setStorageOptions(StorageOptions storageOptions)

getStorageOptions

public StorageOptions getStorageOptions()

toString

public String toString()

Overrides:

toString in class Object

deepCopy

public TransferCapability deepCopy()

promptTo

public StringBuilder promptTo(StringBuilder sb,
                              String indent)