LEADTOOLS Medical (Leadtools.Medical.Workstation.Client assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
RetrieveClient Class
See Also  Members  
Leadtools.Medical.Workstation.Client Namespace : RetrieveClient Class



An abstract layer for implementing DICOM Retrieve operations.

Object Model

RetrieveClient Class

Syntax

Visual Basic (Declaration) 
Public MustInherit Class RetrieveClient 
Visual Basic (Usage)Copy Code
Dim instance As RetrieveClient
C# 
public abstract class RetrieveClient 
C++/CLI 
public ref class RetrieveClient abstract 

Example

Visual BasicCopy Code
Public Sub RetrieveLocalDatabase()
         Leadtools.Examples.Support.Unlock()

         Dim clientInfo As AeInfo = New AeInfo()


         clientInfo.Address = Dns.GetHostName() 'local machine
         clientInfo.AETitle = "TEST_CLIENT"
         clientInfo.Port = 1000
         Dim dataAccess As Medical.Storage.DataAccessLayer.IStorageDataAccessAgent

         Dim fromConfiguration As Boolean

         fromConfiguration = False
         If (fromConfiguration) Then

            'Make sure that the Sotrage Data Access is configured before creating an instance.
            dataAccess = DataAccessFactory.GetInstance(New StorageDataAccessConfigurationView()).CreateDataAccessAgent(Of IStorageDataAccessAgent)()
         Else

            Dim connectionString As String = "Data Source=local;Initial Catalog=DicomStorage;Integrated Security=True;User ID=;Password=;Pooling=True"
            'or you can directly create the data access object which works with your database
            dataAccess = New StorageSqlDbDataAccessAgent(connectionString)
         End If
         'Make sure that the MoveAddIn is configured properly before using this class.
         Dim client As DbRetrieveClient = New DbRetrieveClient(clientInfo, dataAccess)

         client.LoadDataSetOnRetrieve = False 'Enable this if you need to read information from the DICOM dataset.

         AddHandler client.InstanceMoved, AddressOf client_InstanceMoved
         client.EnableLog = True
         client.LogFileName = Path.Combine(LEAD_VARS.ImagesDir, "DicomLog.txt")

         PerformClientRetrieve(client)
      End Sub

      Sub client_InstanceMoved(ByVal sender As Object, ByVal e As InstanceMovedEventArgs)
         Console.WriteLine("Number of moved images: {0}", e.Completed)
      End Sub

      Public Sub PerformClientRetrieve(ByVal client As RetrieveClient)


         Dim images As IEnumerable(Of KeyValuePair(Of String, RetrievedDataSet))

         images = client.RetrieveImages("", "") 'perform a wild card search


         For Each imageInformation As KeyValuePair(Of String, RetrievedDataSet) In images
            Console.WriteLine("SOPInstanceUID: {0}", imageInformation.Key)
            Console.WriteLine(imageInformation.Value.DataSetFilePath)
            Console.WriteLine("---------------------------------------------")
         Next imageInformation

      End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void RetrieveLocalDatabase()
      {
         Leadtools.Examples.Support.Unlock();

         AeInfo clientInfo = new AeInfo ( );


         clientInfo.Address = Dns.GetHostName(); //local machine
         clientInfo.AETitle = "TEST_CLIENT" ;
         clientInfo.Port    = 1000 ;

         IStorageDataAccessAgent dataAccess = null ;
         bool fromConfiguration = false ;

         if ( fromConfiguration )
         {
            //Make sure that the Sotrage Data Access is configured before creating an instance.
            dataAccess = DataAccessFactory.GetInstance ( new StorageDataAccessConfigurationView  ( ) ).CreateDataAccessAgent <IStorageDataAccessAgent> ( ) ;
         }
         else
         {
            string connectionString = @"Data Source=local;Initial Catalog=DicomStorage;Integrated Security=True;User ID=;Password=;Pooling=True";
            //or you can directly create the data access object which works with your database
            dataAccess = new StorageSqlDbDataAccessAgent ( connectionString ) ;
         }


         DbRetrieveClient client = new DbRetrieveClient(clientInfo, dataAccess);

         client.InstanceMoved += new EventHandler<InstanceMovedEventArgs>(client_InstanceMoved);
         client.EnableLog = true;
         client.LogFileName = Path.Combine(LEAD_VARS.ImagesDir, "DicomLog.txt");
         client.LoadDataSetOnRetrieve = false ;//Enable this if you need to read information from the DICOM dataset.
         PerformClientRetrieve(client); 
      }

      void client_InstanceMoved(object sender, InstanceMovedEventArgs e)
      {
         Console.WriteLine ( "Number of moved images: {0}", e.Completed ) ;
      }

      public void PerformClientRetrieve(RetrieveClient client) 
      {
         IEnumerable <KeyValuePair <string, RetrievedDataSet>> images = client.RetrieveImages ( "", "" ) ; //perform a wild card search


         foreach ( KeyValuePair <string, RetrievedDataSet> imageInformation in images ) 
         {
            Console.WriteLine ( "SOPInstanceUID: {0}", imageInformation.Key ) ;
            Console.WriteLine ( imageInformation.Value.DataSetFilePath ) ;
            Console.WriteLine("---------------------------------------------" );
         }
      }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Remarks

Inheritors can use this class to provide an abstraction layer for their applications without the need to worry how the retrieve operation is performed.

Derived classes might perform DICOM Communication or any custom method to retrieve the images.

Inheritance Hierarchy

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Medical.Workstation.Client requires a Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features