Mercurial > hg > orthanc

comparison OrthancCppClient/OrthancConnection.h @ 593:9d2592c08919

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation completed
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 04 Oct 2013 15:04:37 +0200
parents 8fb9867d8089
children 2d0a347e8cfc
comparison
equal deleted inserted replaced
592:c5ee586a0a08 593:9d2592c08919
38 38
39 namespace OrthancClient 39 namespace OrthancClient
40 { 40 {
41 /** 41 /**
42 * {summary}{Connection to an instance of %Orthanc.} 42 * {summary}{Connection to an instance of %Orthanc.}
43 * {description}{This class encapsulates a connection to an instance 43 * {description}{This class encapsulates a connection to a remote instance
44 * of %Orthanc through its REST API.} 44 * of %Orthanc through its REST API.}
45 **/ 45 **/
46 class LAAW_API OrthancConnection : 46 class LAAW_API OrthancConnection :
47 public boost::noncopyable, 47 public boost::noncopyable,
48 private Orthanc::ArrayFilledByThreads::IFiller 48 private Orthanc::ArrayFilledByThreads::IFiller
106 { 106 {
107 patients_.SetThreadCount(threadCount); 107 patients_.SetThreadCount(threadCount);
108 } 108 }
109 109
110 /** 110 /**
111 * {summary}{Refresh the list of the patients.} 111 * {summary}{Reload the list of the patients.}
112 * {description}{This method will reload the list of the patients from the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.} 112 * {description}{This method will reload the list of the patients from the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.}
113 **/ 113 **/
114 void Refresh() 114 void Reload()
115 { 115 {
116 ReadPatients(); 116 ReadPatients();
117 patients_.Invalidate(); 117 patients_.Invalidate();
118 } 118 }
119 119
157 * {returns}{The patient.} 157 * {returns}{The patient.}
158 **/ 158 **/
159 void DeletePatient(uint32_t index) 159 void DeletePatient(uint32_t index)
160 { 160 {
161 GetPatient(index).Delete(); 161 GetPatient(index).Delete();
162 Refresh(); 162 Reload();
163 } 163 }
164 164
165 /** 165 /**
166 * {summary}{Send a DICOM file.} 166 * {summary}{Send a DICOM file.}
167 * {description}{This method will store a DICOM file in the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.} 167 * {description}{This method will store a DICOM file in the remote instance of %Orthanc. Pay attention to the fact that the patients that have been previously returned by GetPatient() will be invalidated.}