| <!-- HTML header for doxygen 1.9.8--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>ResilientDB SDK: TransactionLink 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="doxygen_html_style.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 id="projectrow"> |
| <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function(){initNavTree('classresdb__driver_1_1transaction_1_1TransactionLink.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="classresdb__driver_1_1transaction_1_1TransactionLink-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">TransactionLink Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An object for unidirectional linking to a Transaction's Output. |
| <a href="classresdb__driver_1_1transaction_1_1TransactionLink.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for TransactionLink:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classresdb__driver_1_1transaction_1_1TransactionLink.png" alt=""/> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ac7f6934e18e54994ba4798401864c086" id="r_ac7f6934e18e54994ba4798401864c086"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#ac7f6934e18e54994ba4798401864c086">__bool__</a> (self)</td></tr> |
| <tr class="separator:ac7f6934e18e54994ba4798401864c086"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a909a2bc6a3c96fc53d3ae93305e81486" id="r_a909a2bc6a3c96fc53d3ae93305e81486"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#a909a2bc6a3c96fc53d3ae93305e81486">__eq__</a> (self, other)</td></tr> |
| <tr class="separator:a909a2bc6a3c96fc53d3ae93305e81486"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a171e6903c0464958dd8a214b15a038cb" id="r_a171e6903c0464958dd8a214b15a038cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#a171e6903c0464958dd8a214b15a038cb">__hash__</a> (self)</td></tr> |
| <tr class="separator:a171e6903c0464958dd8a214b15a038cb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a083ab7366379d8ab60d0621365ba0c60" id="r_a083ab7366379d8ab60d0621365ba0c60"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#a083ab7366379d8ab60d0621365ba0c60">__init__</a> (self, <a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#acf5cc20af1153123b499214f36494a2c">txid</a>=None, <a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#ad288825273ed7192429ab0474fb2d4a0">output</a>=None)</td></tr> |
| <tr class="memdesc:a083ab7366379d8ab60d0621365ba0c60"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of a :class:<code>~.TransactionLink</code>. <br /></td></tr> |
| <tr class="separator:a083ab7366379d8ab60d0621365ba0c60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afc0cb56213abca3c24ed8e7eb909394f" id="r_afc0cb56213abca3c24ed8e7eb909394f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#afc0cb56213abca3c24ed8e7eb909394f">from_dict</a> (cls, link)</td></tr> |
| <tr class="memdesc:afc0cb56213abca3c24ed8e7eb909394f"><td class="mdescLeft"> </td><td class="mdescRight">Transforms a Python dictionary to a TransactionLink object. <br /></td></tr> |
| <tr class="separator:afc0cb56213abca3c24ed8e7eb909394f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34ea8af38721a6873df4a2baf3e8cb93" id="r_a34ea8af38721a6873df4a2baf3e8cb93"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#a34ea8af38721a6873df4a2baf3e8cb93">to_dict</a> (self)</td></tr> |
| <tr class="memdesc:a34ea8af38721a6873df4a2baf3e8cb93"><td class="mdescLeft"> </td><td class="mdescRight">Transforms the object to a Python dictionary. <br /></td></tr> |
| <tr class="separator:a34ea8af38721a6873df4a2baf3e8cb93"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aac911afc3594342d51ee6eac6e30dbe3" id="r_aac911afc3594342d51ee6eac6e30dbe3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#aac911afc3594342d51ee6eac6e30dbe3">to_uri</a> (self, path="")</td></tr> |
| <tr class="separator:aac911afc3594342d51ee6eac6e30dbe3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:ad288825273ed7192429ab0474fb2d4a0" id="r_ad288825273ed7192429ab0474fb2d4a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#ad288825273ed7192429ab0474fb2d4a0">output</a></td></tr> |
| <tr class="separator:ad288825273ed7192429ab0474fb2d4a0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf5cc20af1153123b499214f36494a2c" id="r_acf5cc20af1153123b499214f36494a2c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html#acf5cc20af1153123b499214f36494a2c">txid</a></td></tr> |
| <tr class="separator:acf5cc20af1153123b499214f36494a2c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An object for unidirectional linking to a Transaction's Output. </p> |
| <p>Attributes: txid (str, optional): A Transaction to link to. output (int, optional): An output's index in a Transaction with id <code>txid</code>. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a083ab7366379d8ab60d0621365ba0c60" name="a083ab7366379d8ab60d0621365ba0c60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a083ab7366379d8ab60d0621365ba0c60">◆ </a></span>__init__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__init__ </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>txid</em> = <code>None</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>output</em> = <code>None</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an instance of a :class:<code>~.TransactionLink</code>. </p> |
| <p>Note: In an IPLD implementation, this class is not necessary anymore, as an IPLD link can simply point to an object, as well as an objects properties. So instead of having a (de)serializable class, we can have a simple IPLD link of the form: <code>/<tx_id>/transaction/outputs/<output>/</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">txid</td><td>(str): A Transaction to link to. </td></tr> |
| <tr><td class="paramname">output</td><td>An (int): Outputs's index in a Transaction with id <code>txid</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ac7f6934e18e54994ba4798401864c086" name="ac7f6934e18e54994ba4798401864c086"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac7f6934e18e54994ba4798401864c086">◆ </a></span>__bool__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__bool__ </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a909a2bc6a3c96fc53d3ae93305e81486" name="a909a2bc6a3c96fc53d3ae93305e81486"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a909a2bc6a3c96fc53d3ae93305e81486">◆ </a></span>__eq__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__eq__ </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>other</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a171e6903c0464958dd8a214b15a038cb" name="a171e6903c0464958dd8a214b15a038cb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a171e6903c0464958dd8a214b15a038cb">◆ </a></span>__hash__()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">__hash__ </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="afc0cb56213abca3c24ed8e7eb909394f" name="afc0cb56213abca3c24ed8e7eb909394f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc0cb56213abca3c24ed8e7eb909394f">◆ </a></span>from_dict()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">from_dict </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>cls</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>link</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Transforms a Python dictionary to a TransactionLink object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">link</td><td>(dict): The link to be transformed.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>:class:<code>~resdb.transaction.TransactionLink</code> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a34ea8af38721a6873df4a2baf3e8cb93" name="a34ea8af38721a6873df4a2baf3e8cb93"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a34ea8af38721a6873df4a2baf3e8cb93">◆ </a></span>to_dict()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">to_dict </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Transforms the object to a Python dictionary. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The link as an alternative serialization format. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aac911afc3594342d51ee6eac6e30dbe3" name="aac911afc3594342d51ee6eac6e30dbe3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aac911afc3594342d51ee6eac6e30dbe3">◆ </a></span>to_uri()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">to_uri </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>self</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>path</em> = <code>""</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="ad288825273ed7192429ab0474fb2d4a0" name="ad288825273ed7192429ab0474fb2d4a0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad288825273ed7192429ab0474fb2d4a0">◆ </a></span>output</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">output</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="acf5cc20af1153123b499214f36494a2c" name="acf5cc20af1153123b499214f36494a2c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acf5cc20af1153123b499214f36494a2c">◆ </a></span>txid</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">txid</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/github/workspace/resdb_driver/<a class="el" href="resdb__driver_2transaction_8py.html">transaction.py</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceresdb__driver.html">resdb_driver</a></li><li class="navelem"><a class="el" href="namespaceresdb__driver_1_1transaction.html">transaction</a></li><li class="navelem"><a class="el" href="classresdb__driver_1_1transaction_1_1TransactionLink.html">TransactionLink</a></li> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
