This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Demo.DICOM.Process.Modality

persistent class Demo.DICOM.Process.Modality extends EnsLib.DICOM.Process

SQL Table Name: Demo_DICOM_Process.Modality

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = OperationDuplexName;
This parameter names the operation used to provide storage

Properties

property CancelThreshold as %Integer [ InitialExpression = 5 ];
This specifies the number of C-FIND-RSP records to be recieved before sending a CANCEL
Property methods: CancelThresholdDisplayToLogical(), CancelThresholdGet(), CancelThresholdGetStored(), CancelThresholdIsValid(), CancelThresholdLogicalToDisplay(), CancelThresholdNormalize(), CancelThresholdSet()
property CurrentState as %String [ InitialExpression = "OperationNotConnected" ];
This keeps track of the current state of the process
Property methods: CurrentStateDisplayToLogical(), CurrentStateGet(), CurrentStateGetStored(), CurrentStateIsValid(), CurrentStateLogicalToDisplay(), CurrentStateLogicalToOdbc(), CurrentStateNormalize(), CurrentStateSet()
property OperationDuplexName;
This is the name of the operation providing connectivity
Property methods: OperationDuplexNameDisplayToLogical(), OperationDuplexNameGet(), OperationDuplexNameGetStored(), OperationDuplexNameIsValid(), OperationDuplexNameLogicalToDisplay(), OperationDuplexNameLogicalToOdbc(), OperationDuplexNameNormalize(), OperationDuplexNameSet()
property Request as EnsLib.DICOM.Document;
Request
Property methods: RequestGet(), RequestGetObject(), RequestGetObjectId(), RequestGetStored(), RequestGetSwizzled(), RequestIsValid(), RequestNewObject(), RequestSet(), RequestSetObject(), RequestSetObjectId(), RequestTypeDisplayToLogical(), RequestTypeGet(), RequestTypeGetStored(), RequestTypeIsValid(), RequestTypeLogicalToDisplay(), RequestTypeLogicalToOdbc(), RequestTypeNormalize(), RequestTypeSet(), RequestUnSwizzle()
property RequestType as %String [ InitialExpression = "FIND" ];
Request Type (this can be "FIND" or "ECHO")
Property methods: RequestTypeDisplayToLogical(), RequestTypeGet(), RequestTypeGetStored(), RequestTypeIsValid(), RequestTypeLogicalToDisplay(), RequestTypeLogicalToOdbc(), RequestTypeNormalize(), RequestTypeSet()
property ResponseCount as %Integer [ InitialExpression = 0 ];
This is the count of incoming responses
Property methods: ResponseCountDisplayToLogical(), ResponseCountGet(), ResponseCountGetStored(), ResponseCountIsValid(), ResponseCountLogicalToDisplay(), ResponseCountNormalize(), ResponseCountSet()

Methods

method CreateCancelRequest(Output pDocOut As EnsLib.DICOM.Document) as %Status
Create a Cancel Request
method CreateEchoRequest(Output pDocOut As EnsLib.DICOM.Document) as %Status
Create an Echo Request
method CreateFindRequest(Output pDocOut As EnsLib.DICOM.Document) as %Status
Create a Find Request
method OnAssociationAborted(pSourceConfigName As %String, pInput As EnsLib.DICOM.Notify.Aborted) as %Status
This callback is called by the framework when an association is aborted
method OnAssociationErrored(pSourceConfigName As %String, pInput As EnsLib.DICOM.Notify.Errored) as %Status
This callback is called by the framework when an assocation encounters an error
method OnAssociationEstablished(pSourceConfigName As %String, pInput As EnsLib.DICOM.Notify.Established) as %Status
This method is called by the framework on successful establishment of an association
method OnAssociationRejected(pSourceConfigName As %String, pInput As EnsLib.DICOM.Notify.Rejected) as %Status
This callback is called by the framework when an Association is rejected
method OnAssociationReleased(pSourceConfigName As %String, pInput As EnsLib.DICOM.Notify.Released) as %Status
Inherited description: This callback is called by the framework when an Association is released
method OnError(request As %Library.Persistent, ByRef response As %Library.Persistent, callrequest As %Library.Persistent, pErrorStatus As %Status, pCompletionKey As %String) as %Status
This method is called when any error occurs. Returning the same error will cause the BusinessProcess to set its status to error and close down
method OnMessage(pSourceConfigName As %String, pInput As %Library.Persistent) as %Status
Messages received here are instances of EnsLib.DICOM.Document sent to this process by the service or operation config items. In this demo, the process is ever in one of two states, the Operation is connected or not.
method TraceMessage(pMessage As %String)
Write a message to the console

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"pending",n)
=
%MasterPendingResponses(n)

Storage Model: CacheStorage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"received",n)
=
%MessagesReceived(n)

Storage Model: CacheStorage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"sent",n)
=
%MessagesSent(n)

Storage Model: CacheStorage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID)
=
%%CLASSNAME
%ConfigQueueName
%IsCompleted
%MasterPendingResponsesOld
%PrimaryRequestHeader
%PrimaryResponseHeader
%RepliedStatus
%responseId
Adapter
%SessionId
%TimeCompleted
%TimeCreated
%ConfigName
%QuitTask
AlertOnError
%responseClassName
%IsTimerInterrupted
%IsTerminated
%StatusCode
%MessagesReceivedOld
%MessagesSentOld
ReplyCodeActions
RetryInterval
AlertRetryGracePeriod
FailureTimeout
Retry
SuspendMessage
QueueCountAlert
QueueWaitAlert
InactivityTimeout
BusinessPartner
AlertGroups
%SuperSession

Storage Model: CacheStorage (EnsLib.PrivateSession.Process)

^Ens.BusinessProcessD(ID,"Process")
=
ServiceDuplexName
%IsInPrivateSession

Storage Model: CacheStorage (Demo.DICOM.Process.Modality)

^Ens.BusinessProcessD(ID,"Modality")
=
CurrentState
OperationDuplexName
ResponseCount
Request
RequestType
CancelCount
CancelThreshold
Feedback