LDicomNet::SendNReportRequest

#include "ltdic.h"

L_INT LDicomNet::SendNReportRequest(nPresentationID, nMessageID, pszClass, pszInstance, nEvent, pDS)

L_UCHAR nPresentationID;	/* presentation ID */
L_UINT16 nMessageID;	/* message ID */
L_TCHAR * pszClass;	/* class type */
L_TCHAR * pszInstance;	/* instance */
L_UINT16 nEvent;	/* event */
LDicomDS *pDS;	/* data set */

Sends an N-EVENT-REPORT-REQ message to a peer member of a connection. This function is available in the PACS Imaging Toolkit.

Parameter	Description
nPresentationID	Presentation ID. The presentation ID provides information about both the class type of the data and the transfer syntax to use when transferring the data.
nMessageID	Message ID. Each message sent by a member of a connection should have a unique ID. Since a member of a connection may send several messages, this ID allows that member to identify when a specific request has been completed.
pszClass	Class affected by the request. This will be an SOP Class or an SOP MetaClass.
pszInstance	The instance of the class. A server may, for example, have three instances of the Nuclear Medicine Class. This value identifies the data with a specific instance.
nEvent	An application specific event for which a report is to be generated.
pDS	Application specific data set which contains information related to the operation.

Returns

0	SUCCESS
>0	An error occurred. Refer to Return Codes.

Comments

Calling this function generates a call to LDicomNet::OnReceiveNReportRequest on the SCP. The SCP should respond by calling LDicomNet::SendNReportResponse which will generate a call to LDicomNet::OnReceiveNReportResponse.

A report is generated to let all peers attached to a server know of some event that has occurred. This event may be the addition of a new patient, the deletion of a patient, the addition of a new study, etc. The nEvent value, which designates the event that occurred is determined by the server. To find out the values used, you must contact the organization that created the server. When creating a server, the values and their corresponding meanings are determined by those creating the server.

Required DLLs and Libraries

LTDIC

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

See Also

Functions:	LDicomNet::SendNReportResponse, LDicomNet::OnReceiveNReportRequest, LDicomNet::OnReceiveNReportResponse
Topics:	Working with DICOM Network Connections

Example

L_INT LDicomNet__SendNReportRequestExample(LMyDicomNet *m_pDicomNet)
{
   //This example sends an N-Event Report message to all clients
   //Let them know a new patient was created
   //In this example:
   //
   //1. LMyDicomNet is a class derived from LDicomNet
   //2. LMyDicomNet has the following member variables:
   //       m_nClientOrServer:  can be (STATUS_NONE, STATUS_SERVER, STATUS_CLIENT)
   //                           identifieds the LMyDicomNet object as a server or a client
   //       m_nDataCommand:     can be (COMMAND_C_MOVE,COMMAND_C_GET) 
   //                           set so the server knows how a C-Store Response was generated
   //
   //3. m_pDicomNet points to a valid LMyDicomNet object
   //      LMyDicomNet *m_pDicomNet
   // 
   //4. A connection exists between client and server
   //5. An association exists between the client and server
   L_INT nRet;
   CString strMsg = TEXT("N-Event Report\n");
   //Choose a class
   CString strClassUID = UID_US_IMAGE_STORAGE;
   
   //Choose an instance
   CString strInstance = TEXT("1.1.1.1.1.1.1.1.1.1.1.1.1.1.1.1");
   
   //create the data set
   LDicomDS DicomDS;
   DicomDS.InitDS(CLASS_UNKNOWN, 0);
   
   //add the required elements
   
   //TAG_SPECIFIC_CHARACTER_SET
   pDICOMTAG pDicomTag = LDicomTag::Find(TAG_SPECIFIC_CHARACTER_SET);
   pDICOMELEMENT pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_SPECIFIC_CHARACTER_SET,  //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0           
                  //L_UINT32 nIndex
      );
   
   //TAG_INSTANCE_CREATION_DATE
   pDicomTag = LDicomTag::Find(TAG_INSTANCE_CREATION_DATE);
   pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_INSTANCE_CREATION_DATE,  //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   
   VALUEDATE valueDate;
   valueDate.nYear = 1999;
   valueDate.nMonth = 12;
   valueDate.nDay = 31;
   DicomDS.SetDateValue(pElement, &valueDate, 1);
   
 
   //TAG_INSTANCE_CREATION_TIME
   pDicomTag = LDicomTag::Find(TAG_INSTANCE_CREATION_TIME);
   pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_INSTANCE_CREATION_TIME,  //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   
   VALUETIME valueTime;
   valueTime.nFractions =  0;
   valueTime.nHours     = 12;
   valueTime.nMinutes   = 30;
   valueTime.nSeconds   = 10;
   DicomDS.SetTimeValue(pElement, &valueTime, 1);
   
   //TAG_INSTANCE_CREATOR_UID
   
 pDicomTag = LDicomTag::Find(TAG_INSTANCE_CREATOR_UID);
   pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_INSTANCE_CREATOR_UID,    //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   DicomDS.SetStringValue(pElement, TEXT("9.9.9999.9"),
                           1, DICOM_CHARACTER_SET_DEFAULT);
   
   //TAG_PATIENT_NAME
   pDicomTag = LDicomTag::Find(TAG_PATIENT_NAME);
   pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_PATIENT_NAME,            //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   DicomDS.SetStringValue(pElement, TEXT("dummy_patient_name"),
                           1, DICOM_CHARACTER_SET_DEFAULT);
   
   //add the optional fields that we want returned
   
   
   //TAG_PATIENT_ID
   pDicomTag = LDicomTag::Find(TAG_PATIENT_ID);
   pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_PATIENT_ID,              //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   DicomDS.SetStringValue(pElement, TEXT("dummy_patient_id"),
                           1, DICOM_CHARACTER_SET_DEFAULT);
   
   //TAG_PATIENT_BIRTH_DATE
   pDicomTag = LDicomTag::Find(TAG_PATIENT_BIRTH_DATE);
   pElement = DicomDS.InsertElement( 
      NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_PATIENT_BIRTH_DATE,      //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   DicomDS.SetDateValue(pElement, &valueDate, 1);
   
   
   //TAG_PATIENT_SEX
   pDicomTag = LDicomTag::Find(TAG_PATIENT_SEX);
   pElement = DicomDS.InsertElement( 
      
    NULL,                        //pDICOMELEMENT pNeighbor
      FALSE,                       //L_BOOL bChild
      TAG_PATIENT_SEX,             //L_UINT32 nTag
      pDicomTag->nVR,              //L_UINT16 nVR
      FALSE,                       //L_BOOL bSequence,
      0                            //L_UINT32 nIndex
      );
   DicomDS.SetConvertValue(pElement, TEXT("M"), 1);
   
   //iterate through all clients
   for (L_UINT32 i=0; i<m_pDicomNet->GetClientCount(); i++)
   {
      LDicomNet *pDicomNetClient = m_pDicomNet->GetClient(i);
      
      //Get the associate object of client[i]
      LDicomAssociate *pDicomAssociate = pDicomNetClient->GetAssociate();
 
         
      //Is class supported in the assocation?
      L_UCHAR nPresentationID = pDicomAssociate->FindAbstract((L_TCHAR *)(LPCTSTR)strClassUID);
      
      //nPresentationID must be odd--0 indicates failure
      if (nPresentationID==0)
      {
         CString strTmp;
         strTmp.Format(TEXT("Abstract Syntax[%s] Not Included in the Association"), strClassUID);
         strMsg = strMsg + strTmp;
      }
      else 
      {
         //Send N-Report Request  message
         L_UINT16 uUniqueID = 99;
         L_UINT16 nEvent = 1;
         
         nRet =pDicomNetClient->SendNReportRequest( 
                                             nPresentationID, 
                                             uUniqueID, 
                                             (L_TCHAR *)(LPCTSTR)strClassUID, 
                                             (L_TCHAR *)(LPCTSTR)strInstance,
                                               nEvent, 
                                             &DicomDS);
         if(nRet > 0)
            return nRet;
      }
   }
   AfxMessageBox(strMsg);
   return DICOM_SUCCESS;
}