<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>Orthanc Client: OrthancClient::Study Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="OrthancLogoDocumentation.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">Orthanc Client </div> <div id="projectbrief">Documentation of the client library of Orthanc</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Groups</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>OrthancClient</b></li><li class="navelem"><a class="el" href="classOrthancClient_1_1Study.html">Study</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classOrthancClient_1_1Study-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">OrthancClient::Study Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Connection to a study stored in Orthanc. <a href="classOrthancClient_1_1Study.html#details">More...</a></p> <p><code>#include <<a class="el" href="OrthancCppClient_8h_source.html">OrthancCppClient.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ab2ecd3b4cc7bb220fac97eac11b050cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#ab2ecd3b4cc7bb220fac97eac11b050cc">Study</a> (const <a class="el" href="classOrthancClient_1_1Study.html">Study</a> &other)</td></tr> <tr class="memdesc:ab2ecd3b4cc7bb220fac97eac11b050cc"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new reference to this object. <a href="#ab2ecd3b4cc7bb220fac97eac11b050cc">More...</a><br/></td></tr> <tr class="separator:ab2ecd3b4cc7bb220fac97eac11b050cc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af2958a2a64589d39b349b144e773aefc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#af2958a2a64589d39b349b144e773aefc">Study</a> (::<a class="el" href="classOrthancClient_1_1OrthancConnection.html">OrthancClient::OrthancConnection</a> &connection, const ::std::string &id)</td></tr> <tr class="memdesc:af2958a2a64589d39b349b144e773aefc"><td class="mdescLeft"> </td><td class="mdescRight">Create a connection to some study. <a href="#af2958a2a64589d39b349b144e773aefc">More...</a><br/></td></tr> <tr class="separator:af2958a2a64589d39b349b144e773aefc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adbcb321b5b2f685dedcbf8d586e0291c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#adbcb321b5b2f685dedcbf8d586e0291c">~Study</a> ()</td></tr> <tr class="separator:adbcb321b5b2f685dedcbf8d586e0291c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a91700ea0d449aab41df9c488a926f149"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#a91700ea0d449aab41df9c488a926f149">Reload</a> ()</td></tr> <tr class="memdesc:a91700ea0d449aab41df9c488a926f149"><td class="mdescLeft"> </td><td class="mdescRight">Reload the series of this study. <a href="#a91700ea0d449aab41df9c488a926f149">More...</a><br/></td></tr> <tr class="separator:a91700ea0d449aab41df9c488a926f149"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a53d332727502f6eef060498baf123946"><td class="memItemLeft" align="right" valign="top">LAAW_UINT32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#a53d332727502f6eef060498baf123946">GetSeriesCount</a> ()</td></tr> <tr class="memdesc:a53d332727502f6eef060498baf123946"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of series for this study. <a href="#a53d332727502f6eef060498baf123946">More...</a><br/></td></tr> <tr class="separator:a53d332727502f6eef060498baf123946"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a96989f978a07e48f101222eb4bf1daf0"><td class="memItemLeft" align="right" valign="top">inline::OrthancClient::Series </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#a96989f978a07e48f101222eb4bf1daf0">GetSeries</a> (LAAW_UINT32 index)</td></tr> <tr class="memdesc:a96989f978a07e48f101222eb4bf1daf0"><td class="mdescLeft"> </td><td class="mdescRight">Get some series of this study. <a href="#a96989f978a07e48f101222eb4bf1daf0">More...</a><br/></td></tr> <tr class="separator:a96989f978a07e48f101222eb4bf1daf0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2d0e2089dc305ea54c362fd88a4b911e"><td class="memItemLeft" align="right" valign="top">inline::std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#a2d0e2089dc305ea54c362fd88a4b911e">GetId</a> () const </td></tr> <tr class="memdesc:a2d0e2089dc305ea54c362fd88a4b911e"><td class="mdescLeft"> </td><td class="mdescRight">Get the Orthanc identifier of this study. <a href="#a2d0e2089dc305ea54c362fd88a4b911e">More...</a><br/></td></tr> <tr class="separator:a2d0e2089dc305ea54c362fd88a4b911e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6306b233f2b724b9ce39bacad8b3f87f"><td class="memItemLeft" align="right" valign="top">inline::std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Study.html#a6306b233f2b724b9ce39bacad8b3f87f">GetMainDicomTag</a> (const ::std::string &tag, const ::std::string &defaultValue) const </td></tr> <tr class="memdesc:a6306b233f2b724b9ce39bacad8b3f87f"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of one of the main DICOM tags for this study. <a href="#a6306b233f2b724b9ce39bacad8b3f87f">More...</a><br/></td></tr> <tr class="separator:a6306b233f2b724b9ce39bacad8b3f87f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This class encapsulates a connection to a study from a remote instance of Orthanc. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="ab2ecd3b4cc7bb220fac97eac11b050cc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OrthancClient::Study::Study </td> <td>(</td> <td class="paramtype">const <a class="el" href="classOrthancClient_1_1Study.html">Study</a> & </td> <td class="paramname"><em>other</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">other</td><td>The original object. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af2958a2a64589d39b349b144e773aefc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OrthancClient::Study::Study </td> <td>(</td> <td class="paramtype">::<a class="el" href="classOrthancClient_1_1OrthancConnection.html">OrthancClient::OrthancConnection</a> & </td> <td class="paramname"><em>connection</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const ::std::string & </td> <td class="paramname"><em>id</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Create a connection to some study.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">connection</td><td>The remote instance of Orthanc. </td></tr> <tr><td class="paramname">id</td><td>The Orthanc identifier of the study. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="adbcb321b5b2f685dedcbf8d586e0291c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OrthancClient::Study::~Study </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destructs the object. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a2d0e2089dc305ea54c362fd88a4b911e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string OrthancClient::Study::GetId </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the Orthanc identifier of this study.</p> <dl class="section return"><dt>Returns</dt><dd>The identifier. </dd></dl> </div> </div> <a class="anchor" id="a6306b233f2b724b9ce39bacad8b3f87f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string OrthancClient::Study::GetMainDicomTag </td> <td>(</td> <td class="paramtype">const ::std::string & </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const ::std::string & </td> <td class="paramname"><em>defaultValue</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the value of one of the main DICOM tags for this study.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">tag</td><td>The name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime"). </td></tr> <tr><td class="paramname">defaultValue</td><td>The default value to be returned if this tag does not exist. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The value of the tag. </dd></dl> </div> </div> <a class="anchor" id="a96989f978a07e48f101222eb4bf1daf0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classOrthancClient_1_1Series.html">OrthancClient::Series</a> OrthancClient::Study::GetSeries </td> <td>(</td> <td class="paramtype">LAAW_UINT32 </td> <td class="paramname"><em>index</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This method will return an object that contains information about some series. The series are indexed by a number between 0 (inclusive) and the result of <a class="el" href="classOrthancClient_1_1Study.html#a53d332727502f6eef060498baf123946" title="Return the number of series for this study.">GetSeriesCount()</a> (exclusive).</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">index</td><td>The index of the series of interest. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The series. </dd></dl> </div> </div> <a class="anchor" id="a53d332727502f6eef060498baf123946"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">LAAW_UINT32 OrthancClient::Study::GetSeriesCount </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the number of series for this study.</p> <dl class="section return"><dt>Returns</dt><dd>The number of series. </dd></dl> </div> </div> <a class="anchor" id="a91700ea0d449aab41df9c488a926f149"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OrthancClient::Study::Reload </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This method will reload the list of the series of this study. Pay attention to the fact that the series that have been previously returned by <a class="el" href="classOrthancClient_1_1Study.html#a96989f978a07e48f101222eb4bf1daf0" title="Get some series of this study.">GetSeries()</a> will be invalidated. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="OrthancCppClient_8h_source.html">OrthancCppClient.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Nov 8 2013 16:49:51 for Orthanc Client by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>