2022-12-19 21:19:50 +01:00
<!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" >
< 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.9.1" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2022-12-31 14:37:34 +01:00
< title > oc-issuer: Model Class Reference< / title >
2022-12-19 21:19:50 +01:00
< 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/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / 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 = "projectalign" style = "padding-left: 0.5em;" >
2022-12-31 14:37:34 +01:00
< div id = "projectname" > oc-issuer
  < span id = "projectnumber" > 0.0.2< / span >
2022-12-19 21:19:50 +01:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
<!-- 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" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-static-methods" > Static Public Member Functions< / a > |
< a href = "classModel-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Model Class Reference< span class = "mlabels" > < span class = "mlabel" > abstract< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "dynheader" >
Inheritance diagram for Model:< / div >
< div class = "dyncontent" >
< div class = "center" > < img src = "classModel__inherit__graph.png" border = "0" usemap = "#aModel_inherit__map" alt = "Inheritance graph" / > < / div >
< map name = "aModel_inherit__map" id = "aModel_inherit__map" >
< area shape = "rect" title = " " alt = "" coords = "29,5,92,32" / >
< area shape = "rect" href = "classDefaultModel.html" title = " " alt = "" coords = "5,80,116,107" / >
< / map >
< center > < span class = "legend" > [< a href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2023-04-20 22:56:11 +02:00
< tr class = "memitem:af4e5cca587cec5d56c955a797cc4295f" > < td class = "memItemLeft" align = "right" valign = "top" > virtual tl::expected< < a class = "el" href = "structCDDC.html" > CDDC< / a > *, bool >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classModel.html#af4e5cca587cec5d56c955a797cc4295f" > get_cddc< / a > (unsigned int cdd_serial)=0< / td > < / tr >
< tr class = "separator:af4e5cca587cec5d56c955a797cc4295f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a50d7fc134c43bc28045a7993ff2f2ca5" > < td class = "memItemLeft" align = "right" valign = "top" > virtual tl::expected< < a class = "el" href = "structCDDC.html" > CDDC< / a > *, bool >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classModel.html#a50d7fc134c43bc28045a7993ff2f2ca5" > get_current_cddc< / a > ()=0< / td > < / tr >
< tr class = "separator:a50d7fc134c43bc28045a7993ff2f2ca5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a022e8d797bf57d111a1ce5bd229f41ea" > < td class = "memItemLeft" align = "right" valign = "top" > virtual std::vector< < a class = "el" href = "structMintKeyCert.html" > MintKeyCert< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classModel.html#a022e8d797bf57d111a1ce5bd229f41ea" > getMKCs< / a > (const std::vector< unsigned int > & denominations, const std::vector< < a class = "el" href = "structBigInt.html" > BigInt< / a > > & mint_key_ids)=0< / td > < / tr >
< tr class = "separator:a022e8d797bf57d111a1ce5bd229f41ea" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-12-31 14:37:34 +01:00
< tr class = "memitem:a0ece13ffd6258825feaaa884247ca6e2" > < td class = "memItemLeft" align = "right" valign = "top" > virtual std::vector< < a class = "el" href = "structBlindSignature.html" > BlindSignature< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classModel.html#a0ece13ffd6258825feaaa884247ca6e2" > mint< / a > (std::string const & transaction_reference, const std::vector< < a class = "el" href = "structBlind.html" > Blind< / a > > & blinds)=0< / td > < / tr >
2022-12-28 00:44:43 +01:00
< tr class = "separator:a0ece13ffd6258825feaaa884247ca6e2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-12-31 14:37:34 +01:00
< tr class = "memitem:a14ae6086fd6ccc2dc34714c2f976258a" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classModel.html#a14ae6086fd6ccc2dc34714c2f976258a" > redeem< / a > (const std::vector< < a class = "el" href = "structCoin.html" > Coin< / a > > & coins)=0< / td > < / tr >
2022-12-19 21:19:50 +01:00
< tr class = "separator:a14ae6086fd6ccc2dc34714c2f976258a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-static-methods" > < / a >
Static Public Member Functions< / h2 > < / td > < / tr >
2023-04-20 22:56:11 +02:00
< tr class = "memitem:a0f33afb8d901d61f93ed7d6f7560403a" > < td class = "memItemLeft" align = "right" valign = "top" > static std::unique_ptr< < a class = "el" href = "classModel.html" > Model< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classModel.html#a0f33afb8d901d61f93ed7d6f7560403a" > get_model< / a > (const std::string & backend_name)< / td > < / tr >
< tr class = "separator:a0f33afb8d901d61f93ed7d6f7560403a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-12-19 21:19:50 +01:00
< / table >
2022-12-31 14:37:34 +01:00
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2023-04-20 22:56:11 +02:00
< a id = "af4e5cca587cec5d56c955a797cc4295f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af4e5cca587cec5d56c955a797cc4295f" > ◆ < / a > < / span > get_cddc()< / h2 >
2022-12-31 14:37:34 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2023-04-20 22:56:11 +02:00
< td class = "memname" > virtual tl::expected< < a class = "el" href = "structCDDC.html" > CDDC< / a > *, bool> Model::get_cddc < / td >
2022-12-31 14:37:34 +01:00
< td > (< / td >
< td class = "paramtype" > unsigned int  < / td >
< td class = "paramname" > < em > cdd_serial< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > return the CurrencyDocumentDescription certifikate for a specific serial version number of it. < a href = "https://opencoin.org/0.4/schemata.html#cddc" > see spec< / a > < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > returns a pointer to the < a class = "el" href = "structCDDC.html" > CDDC< / a > if successful, false otherwise < / dd > < / dl >
2023-04-20 22:56:11 +02:00
< p > Implemented in < a class = "el" href = "classDefaultModel.html#a5d57be9ead842ec3385144f7caa9524e" > DefaultModel< / a > .< / p >
2022-12-31 14:37:34 +01:00
< / div >
< / div >
2023-04-20 22:56:11 +02:00
< a id = "a50d7fc134c43bc28045a7993ff2f2ca5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a50d7fc134c43bc28045a7993ff2f2ca5" > ◆ < / a > < / span > get_current_cddc()< / h2 >
2022-12-31 14:37:34 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2023-04-20 22:56:11 +02:00
< td class = "memname" > virtual tl::expected< < a class = "el" href = "structCDDC.html" > CDDC< / a > *, bool> Model::get_current_cddc < / td >
2022-12-31 14:37:34 +01:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > return the CurrencyDocumentDescription certifikate < a href = "https://opencoin.org/0.4/schemata.html#cddc" > see spec< / a > < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > returns a pointer to the < a class = "el" href = "structCDDC.html" > CDDC< / a > if successful, false otherwise < / dd > < / dl >
2023-04-20 22:56:11 +02:00
< p > Implemented in < a class = "el" href = "classDefaultModel.html#a24f870ad579abc50dc3140dc68fa89fa" > DefaultModel< / a > .< / p >
2022-12-31 14:37:34 +01:00
< / div >
< / div >
2023-04-20 22:56:11 +02:00
< a id = "a0f33afb8d901d61f93ed7d6f7560403a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0f33afb8d901d61f93ed7d6f7560403a" > ◆ < / a > < / span > get_model()< / h2 >
2022-12-31 14:37:34 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2023-04-20 22:56:11 +02:00
< td class = "memname" > std::unique_ptr< < a class = "el" href = "classModel.html" > Model< / a > > Model::get_model < / td >
2022-12-31 14:37:34 +01:00
< td > (< / td >
2023-04-20 22:56:11 +02:00
< td class = "paramtype" > const std::string &   < / td >
< td class = "paramname" > < em > backend_name< / em > < / td > < td > )< / td >
2022-12-31 14:37:34 +01:00
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2023-04-20 22:56:11 +02:00
< span class = "mlabels" > < span class = "mlabel" > static< / span > < / span > < / td >
2022-12-31 14:37:34 +01:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-04-20 22:56:11 +02:00
< p > factory function returning a concrete backend for Opencoin API handling. based on backend_name a concrete backend will be returned or in case of error null. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2022-12-31 14:37:34 +01:00
< table class = "params" >
2023-04-20 22:56:11 +02:00
< tr > < td class = "paramname" > backend_name< / td > < td > < / td > < / tr >
2022-12-31 14:37:34 +01:00
< / table >
< / dd >
< / dl >
2023-04-20 22:56:11 +02:00
< dl class = "section return" > < dt > Returns< / dt > < dd > pointer to backend instance or null on invalid backend name < / dd > < / dl >
2022-12-31 14:37:34 +01:00
< / div >
< / div >
2023-04-20 22:56:11 +02:00
< a id = "a022e8d797bf57d111a1ce5bd229f41ea" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a022e8d797bf57d111a1ce5bd229f41ea" > ◆ < / a > < / span > getMKCs()< / h2 >
2022-12-31 14:37:34 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2023-04-20 22:56:11 +02:00
< td class = "memname" > virtual std::vector< < a class = "el" href = "structMintKeyCert.html" > MintKeyCert< / a > > Model::getMKCs < / td >
2022-12-31 14:37:34 +01:00
< td > (< / td >
2023-04-20 22:56:11 +02:00
< td class = "paramtype" > const std::vector< unsigned int > &   < / td >
< td class = "paramname" > < em > denominations< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "structBigInt.html" > BigInt< / a > > &   < / td >
< td class = "paramname" > < em > mint_key_ids< / em >   < / td >
< / tr >
< tr >
2022-12-31 14:37:34 +01:00
< td > < / td >
2023-04-20 22:56:11 +02:00
< td > )< / td >
< td > < / td > < td > < / td >
2022-12-31 14:37:34 +01:00
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2023-04-20 22:56:11 +02:00
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
2022-12-31 14:37:34 +01:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-04-20 22:56:11 +02:00
< p > return the < a class = "el" href = "structMintKey.html" > MintKey< / a > certificates for a given list of denominations and mint key ids< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2022-12-31 14:37:34 +01:00
< table class = "params" >
2023-04-20 22:56:11 +02:00
< tr > < td class = "paramname" > denominations< / td > < td > < / td > < / tr >
< tr > < td class = "paramname" > mint_key_ids< / td > < td > < / td > < / tr >
2022-12-31 14:37:34 +01:00
< / table >
< / dd >
< / dl >
2023-04-20 22:56:11 +02:00
< dl class = "section return" > < dt > Returns< / dt > < dd > mint key certificates for given denominations and mint_key_ids < / dd > < / dl >
2022-12-31 14:37:34 +01:00
< / div >
< / div >
< a id = "a0ece13ffd6258825feaaa884247ca6e2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0ece13ffd6258825feaaa884247ca6e2" > ◆ < / a > < / span > mint()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual std::vector< < a class = "el" href = "structBlindSignature.html" > BlindSignature< / a > > Model::mint < / td >
< td > (< / td >
< td class = "paramtype" > std::string const &   < / td >
< td class = "paramname" > < em > transaction_reference< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "structBlind.html" > Blind< / a > > &   < / td >
< td class = "paramname" > < em > blinds< / 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" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > returns the vector of blind signatures for a given vector of blinds< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > transaction_reference< / td > < td > reference to a transaction (send from client) < / td > < / tr >
< tr > < td class = "paramname" > blinds< / td > < td > the vector of blinds to sign< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > < / dd > < / dl >
< / div >
< / div >
< a id = "a14ae6086fd6ccc2dc34714c2f976258a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a14ae6086fd6ccc2dc34714c2f976258a" > ◆ < / a > < / span > redeem()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool Model::redeem < / td >
< td > (< / td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "structCoin.html" > Coin< / a > > &   < / td >
< td class = "paramname" > < em > coins< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > redeem valid coins into real money< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > coins< / td > < td > the coins to redeem< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > true if successful, false on error < / dd > < / dl >
< / div >
< / div >
2022-12-19 21:19:50 +01:00
< hr / > The documentation for this class was generated from the following files:< ul >
< li > src/< a class = "el" href = "model_8hpp_source.html" > model.hpp< / a > < / li >
< li > src/model.cpp< / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
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.1
< / small > < / address >
< / body >
< / html >
