DIMSE classes

The DIMSE classes (DICOM Service) take care of transmitting and receiving DICOM commands through a DICOM association (a ImebraAssociationBase derived class).

The main DIMSE class is ImebraDimseService, through which all the DICOM commands and responses are sent and received.

ImebraDimseService

class ImebraDimseService : public NSObject

Sends and receives DICOM commands and responses through an ImebraAssociationSCU or an ImebraAssociationSCP.

ImebraDimseService supplies getNextCommandID (ImebraDimseService) in order to obtain the ID for the commands sent through the ImebraDimseService object.

Public Functions

id ImebraDimseService::initWithAssociation:(ImebraAssociationBase * pAssociation)

Initializer.

Parameters
  • pAssociation: the AssociationBase derived class through which the DICOM commands and responses are sent and received

NSString* ImebraDimseService::getTransferSyntax:error:(NSString * abstractSyntax, NSError ** pError)

Returns the negotiated transfer syntax for a specific abstract syntax.

This method is multithread safe.

Return
the negotiated transfer syntax for the specified abstract syntax
Parameters
  • abstractSyntax: the abstract syntax for which the transfer syntax is needed

unsigned short getNextCommandID()

Retrieves an ID that can be used on the next command sent through this DimseService object.

This method is multithread safe.

Return
an ID that can be used as command ID on a command sent through this DimseService object

ImebraDimseCommand* ImebraDimseService::getCommand:(NSError ** pError)

Retrieves the next incoming DICOM command.

The method blocks until the command is available or until the association is closed, either by the connected peer or by other means (e.g because of the DIMSE timeout), in which case the exception ImebraStreamEOFError is set in pError.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

This method can be called by several threads at once: each thread will receive a DIMSE command and can reply to the command via sendCommandOrResponse().

The underlying AssociationBase object will take care of limiting the number of incoming command according to the maximum number of performed operation negotiated for the association.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the next incoming DICOM command
Parameters
  • pError: set to a NSError derived class in case of error

void ImebraDimseService::sendCommandOrResponse:error:(ImebraDimseCommandBase * pCommand, (swift_error(nonnull_error)) __attribute__)

Sends a DICOM command or response through the association.

This method is multithread safe.

Parameters
  • pCommand: the command or response to send
  • pError: set to a NSError derived class in case of error

ImebraCStoreResponse* ImebraDimseService::getCStoreResponse:error:(ImebraCStoreCommand * pCommand, NSError ** pError)

Wait for the response for the specified C-STORE command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent C-CSTORE command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraCGetResponse* ImebraDimseService::getCGetResponse:error:(ImebraCGetCommand * pCommand, NSError ** pError)

Wait for the response for the specified C-GET command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent C-GET command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraCFindResponse* ImebraDimseService::getCFindResponse:error:(ImebraCFindCommand * pCommand, NSError ** pError)

Wait for the response for the specified C-FIND command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent C-FIND command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraCMoveResponse* ImebraDimseService::getCMoveResponse:error:(ImebraCMoveCommand * pCommand, NSError ** pError)

Wait for the response for the specified C-MOVE command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent C-MOVE command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraCEchoResponse* ImebraDimseService::getCEchoResponse:error:(ImebraCEchoCommand * pCommand, NSError ** pError)

Wait for the response for the specified C-ECHO command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent C-ECHO command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraNEventReportResponse* ImebraDimseService::getNEventReportResponse:error:(ImebraNEventReportCommand * pCommand, NSError ** pError)

Wait for the response for the specified N-EVENT-REPORT command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent N-EVENT-REPORT command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraNGetResponse* ImebraDimseService::getNGetResponse:error:(ImebraNGetCommand * pCommand, NSError ** pError)

Wait for the response for the specified N-GET command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent N-GET command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraNSetResponse* ImebraDimseService::getNSetResponse:error:(ImebraNSetCommand * pCommand, NSError ** pError)

Wait for the response for the specified N-SET command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent N-SET command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraNActionResponse* ImebraDimseService::getNActionResponse:error:(ImebraNActionCommand * pCommand, NSError ** pError)

Wait for the response for the specified N-ACTION command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent N-ACTION command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraNCreateResponse* ImebraDimseService::getNCreateResponse:error:(ImebraNCreateCommand * pCommand, NSError ** pError)

Wait for the response for the specified N-CREATE command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent N-CREATE command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraNDeleteResponse* ImebraDimseService::getNDeleteResponse:error:(ImebraNDeleteCommand * pCommand, NSError ** pError)

Wait for the response for the specified N-DELETE command and returns it.

Other threads can wait for other commands or responses from the same DIMSE service. All the commands and responses are received by a secondary thread and distributed to all the listener waiting for a command or a response.

Set pError to StreamEOFError if the association is closed while the method is waiting for an incoming command or response.

Return
the response for the specified command
Parameters
  • pCommand: the sent N-DELETE command for which to wait for a response
  • pError: set to a NSError derived class in case of error

ImebraDimseCommandBase

class ImebraDimseCommandBase : public NSObject

Base class for the DICOM commands and responses.

Subclassed by ImebraDimseCommand, ImebraDimseResponse

Public Functions

ImebraDataSet* ImebraDimseCommandBase::getCommandDataSet:(NSError ** pError)

Returns the ImebraDataSet containing the command data.

Return
the ImebraDataSet containing the command data
Parameters
  • pError: set to a NSError derived class in case of error

ImebraDataSet* ImebraDimseCommandBase::getPayloadDataSet:(NSError ** pError)

Returns the ImebraDataSet containing the payload data.

Return
the ImebraDataSet containing the payload data
Parameters
  • pError: set to a NSError derived class in case of error

NSString *getAbstractSyntax()

Returns the message abstract syntax.

Return
the message abstract syntax

NSString* ImebraDimseCommandBase::getAffectedSopInstanceUid:(NSError ** pError)

Returns the affected SOP instance UID.

Return
the affected SOP instance UID
Parameters
  • pError: set to a NSError derived class in case of error

NSString* ImebraDimseCommandBase::getAffectedSopClassUid:(NSError ** pError)

Returns the affected SOP Class UID.

Return
the affected SOP Class UID
Parameters
  • pError: set to a NSError derived class in case of error

NSString* ImebraDimseCommandBase::getRequestedSopInstanceUid:(NSError ** pError)

Returns the requested SOP instance UID.

Return
requested SOP instance UID
Parameters
  • pError: set to a NSError derived class in case of error

NSString* ImebraDimseCommandBase::getRequestedSopClassUid:(NSError ** pError)

Returns the requested SOP class UID.

Return
requested SOP class UID
Parameters
  • pError: set to a NSError derived class in case of error

ImebraDimseCommand

class ImebraDimseCommand : public ImebraDimseCommandBase

Base class for the DICOM commands.

Subclassed by ImebraCCancelCommand, ImebraCEchoCommand, ImebraCFindCommand, ImebraCGetCommand, ImebraCMoveCommand, ImebraCStoreCommand, ImebraNActionCommand, ImebraNCreateCommand, ImebraNDeleteCommand, ImebraNEventReportCommand, ImebraNGetCommand, ImebraNSetCommand

Property

property ImebraDimseCommand::ID

Returns the command ID.

property ImebraDimseCommand::commandType

Returns the command type.

ImebraDimseResponse

class ImebraDimseResponse : public ImebraDimseCommandBase

Base class for the DICOM responses.

Subclassed by ImebraCEchoResponse, ImebraCFindResponse, ImebraCPartialResponse, ImebraCStoreResponse, ImebraNActionResponse, ImebraNCreateResponse, ImebraNDeleteResponse, ImebraNEventReportResponse, ImebraNGetResponse, ImebraNSetResponse

Property

property ImebraDimseResponse::status

Returns the response status.

property ImebraDimseResponse::statusCode

Returns the response status code.

ImebraCPartialResponse

class ImebraCPartialResponse : public ImebraDimseResponse

Base class for all the partial responses (responses to C-GET, C-MOVE and C-FIND).

Subclassed by ImebraCGetResponse, ImebraCMoveResponse

Public Functions

unsigned int ImebraCPartialResponse::getRemainingSubOperations:((swift_error(nonnull_error)) __attribute__)

Returns the number of remaining C-STORE sub operations.

Return
number of remaining C-STORE sub operations
Parameters
  • pError: set to ImebraMissingDataElementError if the data is missing

unsigned int ImebraCPartialResponse::getCompletedSubOperations:((swift_error(nonnull_error)) __attribute__)

Returns the number of completed C-STORE sub operations.

Return
number of completed C-STORE sub operations
Parameters
  • pError: set to ImebraMissingDataElementError if the data is missing

unsigned int ImebraCPartialResponse::getFailedSubOperations:((swift_error(nonnull_error)) __attribute__)

Returns the number of failed C-STORE sub operations.

Return
number of failed C-STORE sub operations
Parameters
  • pError: set to ImebraMissingDataElementError if the data is missing

unsigned int ImebraCPartialResponse::getWarningSubOperations:((swift_error(nonnull_error)) __attribute__)

Returns the number of C-STORE sub operations completed with warnings.

Return
number of C-STORE sub operations completed with warnings
Parameters
  • pError: set to ImebraMissingDataElementError if the data is missing

ImebraCStoreCommand

class ImebraCStoreCommand : public ImebraDimseCommand

Represents a C-STORE request.

Public Functions

id ImebraCStoreCommand::initWithAbstractSyntax:messageID:priority:affectedSopClassUid:affectedSopInstanceUid:originatorAET:originatorMessageID:payload:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, NSString * affectedSopClassUid, NSString * affectedSopInstanceUid, NSString * originatorAET, unsigned short originatorMessageID, ImebraDataSet * pPayload)

Initializer.

Parameters
  • abstractSyntax: the message’s abstract syntax (previously negotiated via the ImebraPresentationContexts parameter of the ImebraAssociationSCP or ImebraAssociationSCU initializers)
  • messageID: message ID (can be retrieved with getNextCommandID (ImebraDimseService)
  • priority: message priority
  • affectedSopClassUid: affected SOP instance UID
  • affectedSopInstanceUid: affected SOP instance UID
  • originatorAET: originator AET (issuer of the C-MOVE or C-GET command)
  • originatorMessageID: message ID of the C-MOVE or C-GET that triggered the C-STORE
  • pPayload: C-STORE payload

Property

property ImebraCStoreCommand::originatorAET

Returns the AET of the entity that triggered this C-STORE request either via a C-MOVE or a C-GET request.

property ImebraCStoreCommand::originatorMessageID

Returns the message ID of the C-MOVE or C-GET request that triggered this C-STORE request.

ImebraCStoreResponse

class ImebraCStoreResponse : public ImebraDimseResponse

Represents a C-STORE response.

Public Functions

id ImebraCStoreResponse::initWithcommand:responseCode:(ImebraCStoreCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: the C-STORE command for which this response is being constructed
  • responseCode: the response code.

ImebraCGetCommand

class ImebraCGetCommand : public ImebraDimseCommand

Represents a C-GET command.

C-GET triggers a C-STORE command that is issued through the same association used for the C-GET, therefore the SCU must have negotiated the SCP role for the abstract syntax (see ImebraPresentationContexts and ImebraAssociationSCU).

Public Functions

id ImebraCGetCommand::initWithAbstractSyntax:messageID:priority:affectedSopClassUid:identifier:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, NSString * affectedSopClassUid, ImebraDataSet * pIdentifier)

Initializer.

Parameters

ImebraCGetResponse

class ImebraCGetResponse : public ImebraCPartialResponse

Represents a C-GET response.

Public Functions

id ImebraCGetResponse::initWithCommand:responseCode:remainingSubOperations:completedSubOperations:failedSubOperations:warningSubOperations:identifier:(ImebraCGetCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode, unsigned int remainingSubOperations, unsigned int completedSubOperations, unsigned int failedSubOperations, unsigned int warningSubOperations, ImebraDataSet * pIdentifier)

Initializer to use when failed C-STORE operations are present.

This constructor should be used when the response code identifies a canceled operation, a failure, a refused operation or a warning.

Parameters
  • pReceivedCommand: the C-GET command for which this response is being constructed
  • responseCode: the response code.
  • remainingSubOperations: number of remaining C-STORE operations
  • completedSubOperations: number of completed C-STORE operations
  • failedSubOperations: number of failed C-STORE operations
  • warningSubOperations: number of C-STORE operations completed with warnings
  • pIdentifier: DataSet with the list of failed instance UIDs in the tag FailedSOPInstanceUIDList (0008,0058)

id ImebraCGetResponse::initWithcommand:responseCode:remainingSubOperations:completedSubOperations:failedSubOperations:warningSubOperations:(ImebraCGetCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode, unsigned int remainingSubOperations, unsigned int completedSubOperations, unsigned int failedSubOperations, unsigned int warningSubOperations)

Initializer.

Parameters
  • pReceivedCommand: the C-GET command for which this response is being constructed
  • responseCode: the response code.
  • remainingSubOperations: number of remaining C-STORE operations
  • completedSubOperations: number of completed C-STORE operations
  • failedSubOperations: number of failed C-STORE operations
  • warningSubOperations: number of C-STORE operations completed with warnings

ImebraCFindCommand

class ImebraCFindCommand : public ImebraDimseCommand

Represents a C-FIND command.

Public Functions

id ImebraCFindCommand::initWithAbstractSyntax:messageID:priority:affectedSopClassUid:identifier:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, NSString * affectedSopClassUid, ImebraDataSet * pIdentifier)

Initializer.

Parameters

ImebraCFindResponse

class ImebraCFindResponse : public ImebraDimseResponse

Represents a C-FIND response.

Public Functions

id ImebraCFindResponse::initWithCommand:identifier:(ImebraCFindCommand * pReceivedCommand, ImebraDataSet * pIdentifier)

Initializer for responses with pending status.

Responses with pending status carry a ImebraDataSet with a single item from the C-FIND query results.

Parameters
  • receivedCommand: command for which the reponse is being constructed
  • identifier: one item from the C-FIND query results

id ImebraCFindResponse::initWithcommand:responseCode:(ImebraCFindCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer for final C-FIND response (success or failure).

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • responseCode: response code

ImebraCMoveCommand

class ImebraCMoveCommand : public ImebraDimseCommand

Represents a C-MOVE command.

Public Functions

id ImebraCMoveCommand::initWithAbstractSyntax:messageID:priority:affectedSopClassUid:identifier:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, NSString * affectedSopClassUid, ImebraDataSet * pIdentifier)

Initializer.

Parameters

ImebraCMoveResponse

class ImebraCMoveCommand : public ImebraDimseCommand

Represents a C-MOVE command.

Public Functions

id ImebraCMoveCommand::initWithAbstractSyntax:messageID:priority:affectedSopClassUid:identifier:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, NSString * affectedSopClassUid, ImebraDataSet * pIdentifier)

Initializer.

Parameters

ImebraCEchoCommand

class ImebraCEchoCommand : public ImebraDimseCommand

Represents a C-ECHO command.

Public Functions

id ImebraCEchoCommand::initWithAbstractSyntax:messageID:priority:affectedSopClassUid:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, NSString * affectedSopClassUid)

Initializer.

Parameters

ImebraCEchoResponse

class ImebraCEchoResponse : public ImebraDimseResponse

Represents a C-ECHO response.

Public Functions

id ImebraCEchoResponse::initWithcommand:responseCode:(ImebraCEchoCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • responseCode: the response code

ImebraCCancelCommand

class ImebraCCancelCommand : public ImebraDimseCommand

Represents the C-CANCEL command.

Public Functions

id ImebraCCancelCommand::initWithAbstractSyntax:messageID:priority:cancelMessageID:(NSString * abstractSyntax, unsigned short messageID, ImebraDimseCommandPriority_t priority, unsigned short cancelMessageID)

Initializer.

Parameters

Property

property ImebraCCancelCommand::cancelMessageID

Returns the ID of the message to cancel.

ImebraNEventReportCommand

class ImebraNEventReportCommand : public ImebraDimseCommand

Represents a N-EVENT-REPORT command.

Public Functions

id ImebraNEventReportCommand::initWithAbstractSyntax:messageID:affectedSopClassUid:affectedSopInstanceUid:eventID:(NSString * abstractSyntax, unsigned short messageID, NSString * affectedSopClassUid, NSString * affectedSopInstanceUid, unsigned short eventID)

Initializer.

Parameters

id ImebraNEventReportCommand::initWithAbstractSyntax:messageID:affectedSopClassUid:affectedSopInstanceUid:eventID:eventInformation:(NSString * abstractSyntax, unsigned short messageID, NSString * affectedSopClassUid, NSString * affectedSopInstanceUid, unsigned short eventID, ImebraDataSet * pEventInformation)

Initializer.

Parameters
  • abstractSyntax: the message’s abstract syntax (previously negotiated via the ImebraPresentationContexts parameter of the ImebraAssociationSCP or ImebraAssociationSCU initializers)
  • messageID: message ID (can be retrieved with DimseService::getNextCommandID()
  • affectedSopClassUid: the affected SOP class UID
  • affectedSopInstanceUid: the affected SOP instance UID
  • eventID: the event ID
  • pEventInformation: the dataset with event information

Property

property ImebraNEventReportCommand::eventID

Returns the event ID.

ImebraNEventReportResponse

class ImebraNEventReportResponse : public ImebraDimseResponse

N-EVENT-REPORT response.

Public Functions

id ImebraNEventReportResponse::initWithCommand:eventReply:(ImebraNEventReportCommand * pReceivedCommand, ImebraDataSet * pEventReply)

Initializer which includes a payload. This implies a successful operation.

Parameters
  • pReceivedCommand: the N-EVENT request command for which the response is being constructed
  • pEventReply: the response payload

id ImebraNEventReportResponse::initWithcommand:responseCode:(ImebraNEventReportCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: the N-EVENT request command for which the response is being constructed
  • responseCode: the response code

Property

property ImebraNEventReportResponse::eventID

Get the event ID. The response may omit this information.

ImebraNSetCommand

class ImebraNSetCommand : public ImebraDimseCommand

Represents the N-SET command.

Public Functions

id ImebraNSetCommand::initWithAbstractSyntax:messageID:requestedSopClassUid:requestedSopInstanceUid:modificationList:(NSString * abstractSyntax, unsigned short messageID, NSString * requestedSopClassUid, NSString * requestedSopInstanceUid, ImebraDataSet * pModificationList)

Initializer.

Parameters

ImebraNSetResponse

class ImebraNSetResponse : public ImebraDimseResponse

Represents the N-SET response.

Public Functions

id ImebraNSetResponse::initWithCommand:modifiedAttributes:(ImebraNSetCommand * pReceivedCommand, NSArray * pModifiedAttributes)

Initializer of a successful response.

Parameters
  • pReceivedCommand: the command for which this response is being constructed
  • pModifiedAttributes: list of modified attributes. A NSArray of ImebraTagId objects

id ImebraNSetResponse::initWithcommand:responseCode:(ImebraNSetCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: the command for which this response is being constructed
  • responseCode: response code

Property

property ImebraNSetResponse::modifiedAttributes

Returns the list of modified attributes. A NSArray of ImebraTagId objects.

ImebraNGetCommand

class ImebraNGetCommand : public ImebraDimseCommand

Represents a N-GET command.

Public Functions

id ImebraNGetCommand::initWithAbstractSyntax:messageID:requestedSopClassUid:requestedSopInstanceUid:attributeIdentifierList:(NSString * abstractSyntax, unsigned short messageID, NSString * requestedSopClassUid, NSString * requestedSopInstanceUid, NSArray * attributeIdentifierList)

Initializes the N-GET command.

Parameters

Property

property ImebraNGetCommand::attributeList

Return the list of tags to retrieve. an empty list means all the tags.

The returned NSArray object is filled with ImebraTagId objects.

ImebraNGetResponse

class ImebraNGetResponse : public ImebraDimseResponse

Represents a N-GET response.

Public Functions

id ImebraNGetResponse::initWithCommand:responseCode:attributeList:(ImebraNGetCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode, ImebraDataSet * pAttributeList)

Initializer.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • responseCode: response code
  • pAttributeList: dataset containing the list of attribute identifiers

id ImebraNGetResponse::initWithcommand:responseCode:(ImebraNGetCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • responseCode: response code

ImebraNActionCommand

class ImebraNActionCommand : public ImebraDimseCommand

Represents the N-ACTION command.

Public Functions

id ImebraNActionCommand::initWithAbstractSyntax:messageID:requestedSopClassUid:requestedSopInstanceUid:actionID:actionInformation:(NSString * abstractSyntax, unsigned short messageID, NSString * requestedSopClassUid, NSString * requestedSopInstanceUid, unsigned short actionID, ImebraDataSet * pActionInformation)

Initializer.

Parameters

id ImebraNActionCommand::initWithAbstractSyntax:messageID:requestedSopClassUid:requestedSopInstanceUid:actionID:(NSString * abstractSyntax, unsigned short messageID, NSString * requestedSopClassUid, NSString * requestedSopInstanceUid, unsigned short actionID)

Initializer.

Parameters

Property

property ImebraNActionCommand::actionID

Returns the action’s ID.

ImebraNActionResponse

class ImebraNActionResponse : public ImebraDimseResponse

Represents the N-ACTION response.

Public Functions

id ImebraNActionResponse::initWithCommand:actionReply:(ImebraNActionCommand * pReceivedCommand, ImebraDataSet * pActionReply)

Initializer for a successful reply.

Parameters
  • pReceivedCommand: the command for which this response is being constructed
  • pActionReply: dataSet with information about the action reply

id ImebraNActionResponse::initWithcommand:responseCode:(ImebraNActionCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: the command for which this response is being constructed
  • responseCode: the response code

Property

property ImebraNActionResponse::actionID

Returns the action’s ID.

ImebraNCreateCommand

class ImebraNCreateCommand : public ImebraDimseCommand

The N-CREATE command.

Public Functions

id ImebraNCreateCommand::initWithAbstractSyntax:messageID:affectedSopClassUid:affectedSopInstanceUid:attributeList:(NSString * abstractSyntax, unsigned short messageID, NSString * affectedSopClassUid, NSString * affectedSopInstanceUid, ImebraDataSet * pAttributeList)

Initializer.

Parameters

id ImebraNCreateCommand::initWithAbstractSyntax:messageID:affectedSopClassUid:affectedSopInstanceUid:(NSString * abstractSyntax, unsigned short messageID, NSString * affectedSopClassUid, NSString * affectedSopInstanceUid)

Initializer.

Parameters

ImebraNCreateResponse

class ImebraNCreateResponse : public ImebraDimseResponse

Represents the N-CREATE response.

Public Functions

id ImebraNCreateResponse::initWithCommand:attributeList:(ImebraNCreateCommand * pReceivedCommand, ImebraDataSet * pAttributeList)

Initializer.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • pAttributeList: dataset containing the attributes list

id ImebraNCreateResponse::initWithCommand:affectedSopInstanceUid:attributeList:(ImebraNCreateCommand * pReceivedCommand, NSString * affectedSopInstanceUid, ImebraDataSet * pAttributeList)

Initializer.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • affectedSopInstanceUid: affected SOP instance UID
  • pAttributeList: dataset containing the attributes list

id ImebraNCreateResponse::initWithCommand:affectedSopInstanceUid:(ImebraNCreateCommand * pReceivedCommand, NSString * affectedSopInstanceUid)

Constructor.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • affectedSopInstanceUid: created SOP instance UID

id ImebraNCreateResponse::initWithcommand:responseCode:(ImebraNCreateCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Constructor.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • responseCode: the response code

ImebraNDeleteCommand

class ImebraNDeleteCommand : public ImebraDimseCommand

The N-DELETE command.

Public Functions

id ImebraNDeleteCommand::initWithAbstractSyntax:messageID:requestedSopClassUid:requestedSopInstanceUid:(NSString * abstractSyntax, unsigned short messageID, NSString * requestedSopClassUid, NSString * requestedSopInstanceUid)

Initializer.

Parameters

ImebraNDeleteResponse

class ImebraNDeleteResponse : public ImebraDimseResponse

The N-DELETE response.

Public Functions

id ImebraNDeleteResponse::initWithcommand:responseCode:(ImebraNDeleteCommand * pReceivedCommand, ImebraDimseStatusCode_t responseCode)

Initializer.

Parameters
  • pReceivedCommand: command for which the response is being constructed
  • responseCode: response code