From 8bc07bfbd8284561eacc26f8827375bbf0eedb41 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Wed, 9 Feb 2022 06:22:57 +0000 Subject: [PATCH 01/19] deploy: 42cc45a6587140d9f065c03f4cc109a843b12bc0 --- .nojekyll | 0 bc_s.png | Bin 0 -> 676 bytes bdwn.png | Bin 0 -> 147 bytes closed.png | Bin 0 -> 132 bytes doc.png | Bin 0 -> 746 bytes doxygen.css | 1827 ++++++++++++++++++++++++++++++++++++ doxygen.svg | 26 + dynsections.js | 121 +++ folderclosed.png | Bin 0 -> 616 bytes folderopen.png | Bin 0 -> 597 bytes index.html | 75 ++ jquery.js | 35 + md__c_h_a_n_g_e_l_o_g.html | 86 ++ md__r_e_a_d_m_e.html | 108 +++ md_software_checklist.html | 252 +++++ menu.js | 127 +++ menudata.js | 27 + nav_f.png | Bin 0 -> 153 bytes nav_g.png | Bin 0 -> 95 bytes nav_h.png | Bin 0 -> 98 bytes open.png | Bin 0 -> 123 bytes pages.html | 82 ++ search/all_0.html | 37 + search/all_0.js | 4 + search/all_1.html | 37 + search/all_1.js | 4 + search/all_2.html | 37 + search/all_2.js | 4 + search/close.svg | 31 + search/mag_sel.svg | 74 ++ search/nomatches.html | 13 + search/pages_0.html | 37 + search/pages_0.js | 4 + search/pages_1.html | 37 + search/pages_1.js | 4 + search/pages_2.html | 37 + search/pages_2.js | 4 + search/search.css | 263 ++++++ search/search.js | 794 ++++++++++++++++ search/search_l.png | Bin 0 -> 567 bytes search/search_m.png | Bin 0 -> 158 bytes search/search_r.png | Bin 0 -> 553 bytes search/searchdata.js | 18 + splitbar.png | Bin 0 -> 314 bytes sync_off.png | Bin 0 -> 853 bytes sync_on.png | Bin 0 -> 845 bytes tab_a.png | Bin 0 -> 142 bytes tab_b.png | Bin 0 -> 169 bytes tab_h.png | Bin 0 -> 177 bytes tab_s.png | Bin 0 -> 184 bytes tabs.css | 1 + 51 files changed, 4206 insertions(+) create mode 100644 .nojekyll create mode 100644 bc_s.png create mode 100644 bdwn.png create mode 100644 closed.png create mode 100644 doc.png create mode 100644 doxygen.css create mode 100644 doxygen.svg create mode 100644 dynsections.js create mode 100644 folderclosed.png create mode 100644 folderopen.png create mode 100644 index.html create mode 100644 jquery.js create mode 100644 md__c_h_a_n_g_e_l_o_g.html create mode 100644 md__r_e_a_d_m_e.html create mode 100644 md_software_checklist.html create mode 100644 menu.js create mode 100644 menudata.js create mode 100644 nav_f.png create mode 100644 nav_g.png create mode 100644 nav_h.png create mode 100644 open.png create mode 100644 pages.html create mode 100644 search/all_0.html create mode 100644 search/all_0.js create mode 100644 search/all_1.html create mode 100644 search/all_1.js create mode 100644 search/all_2.html create mode 100644 search/all_2.js create mode 100644 search/close.svg create mode 100644 search/mag_sel.svg create mode 100644 search/nomatches.html create mode 100644 search/pages_0.html create mode 100644 search/pages_0.js create mode 100644 search/pages_1.html create mode 100644 search/pages_1.js create mode 100644 search/pages_2.html create mode 100644 search/pages_2.js create mode 100644 search/search.css create mode 100644 search/search.js create mode 100644 search/search_l.png create mode 100644 search/search_m.png create mode 100644 search/search_r.png create mode 100644 search/searchdata.js create mode 100644 splitbar.png create mode 100644 sync_off.png create mode 100644 sync_on.png create mode 100644 tab_a.png create mode 100644 tab_b.png create mode 100644 tab_h.png create mode 100644 tab_s.png create mode 100644 tabs.css diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/bc_s.png b/bc_s.png new file mode 100644 index 0000000000000000000000000000000000000000..224b29aa9847d5a4b3902efd602b7ddf7d33e6c2 GIT binary patch literal 676 zcmV;V0$crwP)y__>=_9%My z{n931IS})GlGUF8K#6VIbs%684A^L3@%PlP2>_sk`UWPq@f;rU*V%rPy_ekbhXT&s z(GN{DxFv}*vZp`F>S!r||M`I*nOwwKX+BC~3P5N3-)Y{65c;ywYiAh-1*hZcToLHK ztpl1xomJ+Yb}K(cfbJr2=GNOnT!UFA7Vy~fBz8?J>XHsbZoDad^8PxfSa0GDgENZS zuLCEqzb*xWX2CG*b&5IiO#NzrW*;`VC9455M`o1NBh+(k8~`XCEEoC1Ybwf;vr4K3 zg|EB<07?SOqHp9DhLpS&bzgo70I+ghB_#)K7H%AMU3v}xuyQq9&Bm~++VYhF09a+U zl7>n7Jjm$K#b*FONz~fj;I->Bf;ule1prFN9FovcDGBkpg>)O*-}eLnC{6oZHZ$o% zXKW$;0_{8hxHQ>l;_*HATI(`7t#^{$(zLe}h*mqwOc*nRY9=?Sx4OOeVIfI|0V(V2 zBrW#G7Ss9wvzr@>H*`r>zE z+e8bOBgqIgldUJlG(YUDviMB`9+DH8n-s9SXRLyJHO1!=wY^79WYZMTa(wiZ!zP66 zA~!21vmF3H2{ngD;+`6j#~6j;$*f*G_2ZD1E;9(yaw7d-QnSCpK(cR1zU3qU0000< KMNUMnLSTYoA~SLT literal 0 HcmV?d00001 diff --git a/bdwn.png b/bdwn.png new file mode 100644 index 0000000000000000000000000000000000000000..940a0b950443a0bb1b216ac03c45b8a16c955452 GIT binary patch literal 147 zcmeAS@N?(olHy`uVBq!ia0vp^>_E)H!3HEvS)PKZC{Gv1kP61Pb5HX&C2wk~_T1|%O$WD@{V-kvUwAr*{o@8{^CZMh(5KoB^r_<4^zF@3)Cp&&t3hdujKf f*?bjBoY!V+E))@{xMcbjXe@)LtDnm{r-UW|*e5JT literal 0 HcmV?d00001 diff --git a/doc.png b/doc.png new file mode 100644 index 0000000000000000000000000000000000000000..17edabff95f7b8da13c9516a04efe05493c29501 GIT binary patch literal 746 zcmV7=@pnbNXRFEm&G8P!&WHG=d)>K?YZ1bzou)2{$)) zumDct!>4SyxL;zgaG>wy`^Hv*+}0kUfCrz~BCOViSb$_*&;{TGGn2^x9K*!Sf0=lV zpP=7O;GA0*Jm*tTYj$IoXvimpnV4S1Z5f$p*f$Db2iq2zrVGQUz~yq`ahn7ck(|CE z7Gz;%OP~J6)tEZWDzjhL9h2hdfoU2)Nd%T<5Kt;Y0XLt&<@6pQx!nw*5`@bq#?l*?3z{Hlzoc=Pr>oB5(9i6~_&-}A(4{Q$>c>%rV&E|a(r&;?i5cQB=} zYSDU5nXG)NS4HEs0it2AHe2>shCyr7`6@4*6{r@8fXRbTA?=IFVWAQJL&H5H{)DpM#{W(GL+Idzf^)uRV@oB8u$ z8v{MfJbTiiRg4bza<41NAzrl{=3fl_D+$t+^!xlQ8S}{UtY`e z;;&9UhyZqQRN%2pot{*Ei0*4~hSF_3AH2@fKU!$NSflS>{@tZpDT4`M2WRTTVH+D? z)GFlEGGHe?koB}i|1w45!BF}N_q&^HJ&-tyR{(afC6H7|aml|tBBbv}55C5DNP8p3 z)~jLEO4Z&2hZmP^i-e%(@d!(E|KRafiU8Q5u(wU((j8un3OR*Hvj+t literal 0 HcmV?d00001 diff --git a/doxygen.css b/doxygen.css new file mode 100644 index 0000000..8e9cca3 --- /dev/null +++ b/doxygen.css @@ -0,0 +1,1827 @@ +/* The standard CSS for doxygen 1.9.2 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +p.reference, p.definition { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +ul.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; + column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +th p.starttd, th p.intertd, th p.endtd { + font-size: 100%; + font-weight: 700; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +p.interli { +} + +p.interdd { +} + +p.intertd { +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.navtab { + border-right: 1px solid #A3B4D7; + padding-right: 15px; + text-align: right; + line-height: 110%; +} + +div.navtab table { + border-spacing: 0; +} + +td.navtab { + padding-right: 6px; + padding-left: 6px; +} +td.navtabHL { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + padding-right: 6px; + padding-left: 6px; +} + +td.navtabHL a, td.navtabHL a:visited { + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} + +a.navtab { + font-weight: bold; +} + +div.qindex{ + text-align: center; + width: 100%; + line-height: 140%; + font-size: 130%; + color: #A0A0A0; +} + +dt.alphachar{ + font-size: 180%; + font-weight: bold; +} + +.alphachar a{ + color: black; +} + +.alphachar a:hover, .alphachar a:visited{ + text-decoration: none; +} + +.classindex dl { + padding: 25px; + column-count:1 +} + +.classindex dd { + display:inline-block; + margin-left: 50px; + width: 90%; + line-height: 1.15em; +} + +.classindex dl.odd { + background-color: #F8F9FC; +} + +@media(min-width: 1120px) { + .classindex dl { + column-count:2 + } +} + +@media(min-width: 1320px) { + .classindex dl { + column-count:3 + } +} + + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +.contents a.qindexHL:visited { + color: #FFFFFF; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +a.code.hl_class { /* style for links to class names in code snippets */ } +a.code.hl_struct { /* style for links to struct names in code snippets */ } +a.code.hl_union { /* style for links to union names in code snippets */ } +a.code.hl_interface { /* style for links to interface names in code snippets */ } +a.code.hl_protocol { /* style for links to protocol names in code snippets */ } +a.code.hl_category { /* style for links to category names in code snippets */ } +a.code.hl_exception { /* style for links to exception names in code snippets */ } +a.code.hl_service { /* style for links to service names in code snippets */ } +a.code.hl_singleton { /* style for links to singleton names in code snippets */ } +a.code.hl_concept { /* style for links to concept names in code snippets */ } +a.code.hl_namespace { /* style for links to namespace names in code snippets */ } +a.code.hl_package { /* style for links to package names in code snippets */ } +a.code.hl_define { /* style for links to macro names in code snippets */ } +a.code.hl_function { /* style for links to function names in code snippets */ } +a.code.hl_variable { /* style for links to variable names in code snippets */ } +a.code.hl_typedef { /* style for links to typedef names in code snippets */ } +a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ } +a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ } +a.code.hl_signal { /* style for links to Qt signal names in code snippets */ } +a.code.hl_slot { /* style for links to Qt slot names in code snippets */ } +a.code.hl_friend { /* style for links to friend names in code snippets */ } +a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ } +a.code.hl_property { /* style for links to property names in code snippets */ } +a.code.hl_event { /* style for links to event names in code snippets */ } +a.code.hl_sequence { /* style for links to sequence names in code snippets */ } +a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ } + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +ul { + overflow: hidden; /*Fixed: list item bullets overlap floating elements*/ +} + +#side-nav ul { + overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */ +} + +#main-nav ul { + overflow: visible; /* reset ul rule for the navigation bar drop down lists */ +} + +.fragment { + text-align: left; + direction: ltr; + overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-y: hidden; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ + margin: 4px 8px 4px 2px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + margin-right: 9px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +.lineno { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #FFFFFF; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl, img.inline { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +.compoundTemplParams { + color: #4665A2; + font-size: 80%; + line-height: 120%; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +blockquote.DocNodeRTL { + border-left: 0; + border-right: 2px solid #9CAFD4; + margin: 0 4px 0 24px; + padding: 0 16px 0 12px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight, .memTemplItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + padding: 8px; + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-image: url('nav_f.png'); + background-repeat: repeat-x; + background-color: #E2E8F2; + line-height: 1.25; + font-weight: 300; + float:left; +} + +.permalink +{ + font-size: 65%; + display: inline-block; + vertical-align: middle; +} + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: 400; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-color: #DFE5F1; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + +} + +.overload { + font-family: "courier new",courier,monospace; + font-size: 65%; +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype, .tparams .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir, .tparams .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; +} + +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + font-weight: 400; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +.PageDocRTL-title div.headertitle { + text-align: right; + direction: rtl; +} + +dl { + padding: 0 0 0 0; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +dl.section { + margin-left: 0px; + padding-left: 0px; +} + +dl.section.DocNodeRTL { + margin-right: 0px; + padding-right: 0px; +} + +dl.note { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #D0C000; +} + +dl.note.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #FF0000; +} + +dl.warning.DocNodeRTL, dl.attention.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00D000; +} + +dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00D000; +} + +dl.deprecated { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #505050; +} + +dl.deprecated.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #505050; +} + +dl.todo { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00C0E0; +} + +dl.todo.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00C0E0; +} + +dl.test { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #3030E0; +} + +dl.test.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #3030E0; +} + +dl.bug { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #C08050; +} + +dl.bug.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; +} + +#projectname +{ + font: 200% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 90% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.plantumlgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; + text-align:right; + width:52px; +} + +dl.citelist dd { + margin:2px 0 2px 72px; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +.PageDocRTL-title div.toc { + float: left !important; + text-align: right; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +.PageDocRTL-title div.toc li { + background-position-x: right !important; + padding-left: 0 !important; + padding-right: 10px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +span.emoji { + /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html + * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort; + */ +} + +.PageDocRTL-title div.toc li.level1 { + margin-left: 0 !important; + margin-right: 0; +} + +.PageDocRTL-title div.toc li.level2 { + margin-left: 0 !important; + margin-right: 15px; +} + +.PageDocRTL-title div.toc li.level3 { + margin-left: 0 !important; + margin-right: 30px; +} + +.PageDocRTL-title div.toc li.level4 { + margin-left: 0 !important; + margin-right: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + white-space: nowrap; + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + +/* @group Markdown */ + +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.markdownTable tr { +} + +th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +th.markdownTableHeadLeft, td.markdownTableBodyLeft { + text-align: left +} + +th.markdownTableHeadRight, td.markdownTableBodyRight { + text-align: right +} + +th.markdownTableHeadCenter, td.markdownTableBodyCenter { + text-align: center +} + +.DocNodeRTL { + text-align: right; + direction: rtl; +} + +.DocNodeLTR { + text-align: left; + direction: ltr; +} + +table.DocNodeRTL { + width: auto; + margin-right: 0; + margin-left: auto; +} + +table.DocNodeLTR { + width: auto; + margin-right: auto; + margin-left: 0; +} + +tt, code, kbd, samp +{ + display: inline-block; + direction:ltr; +} +/* @end */ + +u { + text-decoration: underline; +} + diff --git a/doxygen.svg b/doxygen.svg new file mode 100644 index 0000000..d42dad5 --- /dev/null +++ b/doxygen.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/dynsections.js b/dynsections.js new file mode 100644 index 0000000..3174bd7 --- /dev/null +++ b/dynsections.js @@ -0,0 +1,121 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (la9#ETzayK)T~Jw&MMH>OIr#&;dC}is*2Mqdf&akCc=O@`qC+4i z5Iu3w#1M@KqXCz8TIZd1wli&kkl2HVcAiZ8PUn5z_kG@-y;?yK06=cA0U%H0PH+kU zl6dp}OR(|r8-RG+YLu`zbI}5TlOU6ToR41{9=uz^?dGTNL;wIMf|V3`d1Wj3y!#6` zBLZ?xpKR~^2x}?~zA(_NUu3IaDB$tKma*XUdOZN~c=dLt_h_k!dbxm_*ibDM zlFX`g{k$X}yIe%$N)cn1LNu=q9_CS)*>A zsX_mM4L@`(cSNQKMFc$RtYbx{79#j-J7hk*>*+ZZhM4Hw?I?rsXCi#mRWJ=-0LGV5a-WR0Qgt<|Nqf)C-@80`5gIz45^_20000IqP)X=#(TiCT&PiIIVc55T}TU}EUh*{q$|`3@{d>{Tc9Bo>e= zfmF3!f>fbI9#GoEHh0f`i5)wkLpva0ztf%HpZneK?w-7AK@b4Itw{y|Zd3k!fH?q2 zlhckHd_V2M_X7+)U&_Xcfvtw60l;--DgZmLSw-Y?S>)zIqMyJ1#FwLU*%bl38ok+! zh78H87n`ZTS;uhzAR$M`zZ`bVhq=+%u9^$5jDplgxd44}9;IRqUH1YHH|@6oFe%z( zo4)_>E$F&^P-f(#)>(TrnbE>Pefs9~@iN=|)Rz|V`sGfHNrJ)0gJb8xx+SBmRf@1l zvuzt=vGfI)<-F9!o&3l?>9~0QbUDT(wFdnQPv%xdD)m*g%!20>Bc9iYmGAp<9YAa( z0QgYgTWqf1qN++Gqp z8@AYPTB3E|6s=WLG?xw0tm|U!o=&zd+H0oRYE;Dbx+Na9s^STqX|Gnq%H8s(nGDGJ j8vwW|`Ts`)fSK|Kx=IK@RG@g200000NkvXXu0mjfauFEA literal 0 HcmV?d00001 diff --git a/index.html b/index.html new file mode 100644 index 0000000..e65cbf1 --- /dev/null +++ b/index.html @@ -0,0 +1,75 @@ + + + + + + + +cppDataPipeline: Main Page + + + + + + + + + +
+
+ + + + + + +
+
cppDataPipeline 0.3.0 +
+
C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
cppDataPipeline Documentation
+
+
+
+ +
+Generated by doxygen 1.9.2 +
+ + diff --git a/jquery.js b/jquery.js new file mode 100644 index 0000000..c9ed3d9 --- /dev/null +++ b/jquery.js @@ -0,0 +1,35 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0a;a++)for(i in o[a])n=o[a][i],o[a].hasOwnProperty(i)&&void 0!==n&&(e[i]=t.isPlainObject(n)?t.isPlainObject(e[i])?t.widget.extend({},e[i],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,i){var n=i.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=s.call(arguments,1),h=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(h=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(h=i&&i.jquery?h.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):h=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new i(o,this))})),h}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.widthi?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t("
"),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidtht.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element +},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/** + * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler + * Licensed under MIT + * @author Ariel Flesler + * @version 2.1.2 + */ +;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017 + * http://www.smartmenus.org/ + * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("").addClass("sub-arrow"),this.opts.subIndicatorsText&&this.$subArrow.html(this.opts.subIndicatorsText)),initMouseDetection()}if(this.$firstSub=this.$root.find("ul").each(function(){e.menuInit($(this))}).eq(0),this.$firstLink=this.$root.find("a").eq(0),this.opts.markCurrentItem){var s=/(index|default)\.[^#\?\/]*/i,o=/#.*/,a=window.location.href.replace(s,""),n=a.replace(o,"");this.$root.find("a").each(function(){var t=this.href.replace(s,""),i=$(this);(t==a||t==n)&&(i.addClass("current"),e.opts.markCurrentTree&&i.parentsUntil("[data-smartmenus-id]","ul").each(function(){$(this).dataSM("parent-a").addClass("current")}))})}this.wasCollapsible=this.isCollapsible()},destroy:function(t){if(!t){var e=".smartmenus";this.$root.removeData("smartmenus").removeAttr("data-smartmenus-id").removeDataSM("level").off(e),e+=this.rootId,$(document).off(e),$(window).off(e),this.opts.subIndicators&&(this.$subArrow=null)}this.menuHideAll();var i=this;this.$root.find("ul").each(function(){var t=$(this);t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.dataSM("shown-before")&&((i.opts.subMenusMinWidth||i.opts.subMenusMaxWidth)&&t.css({width:"",minWidth:"",maxWidth:""}).removeClass("sm-nowrap"),t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.css({zIndex:"",top:"",left:"",marginLeft:"",marginTop:"",display:""})),0==(t.attr("id")||"").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeDataSM("in-mega").removeDataSM("shown-before").removeDataSM("scroll-arrows").removeDataSM("parent-a").removeDataSM("level").removeDataSM("beforefirstshowfired").removeAttr("role").removeAttr("aria-hidden").removeAttr("aria-labelledby").removeAttr("aria-expanded"),this.$root.find("a.has-submenu").each(function(){var t=$(this);0==t.attr("id").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeClass("has-submenu").removeDataSM("sub").removeAttr("aria-haspopup").removeAttr("aria-controls").removeAttr("aria-expanded").closest("li").removeDataSM("sub"),this.opts.subIndicators&&this.$root.find("span.sub-arrow").remove(),this.opts.markCurrentItem&&this.$root.find("a.current").removeClass("current"),t||(this.$root=null,this.$firstLink=null,this.$firstSub=null,this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),menuTrees.splice($.inArray(this,menuTrees),1))},disable:function(t){if(!this.disabled){if(this.menuHideAll(),!t&&!this.opts.isPopup&&this.$root.is(":visible")){var e=this.$root.offset();this.$disableOverlay=$('
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('')[0],$('')[0]]).on({mouseenter:function(){t.dataSM("scroll").up=$(this).hasClass("scroll-up"),x.menuScroll(t)},mouseleave:function(e){x.menuScrollStop(t),x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(t){t.preventDefault()}}).insertAfter(t));var A=".smartmenus_scroll";if(t.dataSM("scroll",{y:this.cssTransforms3d?0:i-m,step:1,itemH:m,subH:h,arrowDownH:this.getHeight(t.dataSM("scroll-arrows").eq(1))}).on(getEventsNS({mouseover:function(e){x.menuScrollOver(t,e)},mouseout:function(e){x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(e){x.menuScrollMousewheel(t,e)}},A)).dataSM("scroll-arrows").css({top:"auto",left:"0",marginLeft:e+(parseInt(t.css("border-left-width"))||0),width:r-(parseInt(t.css("border-left-width"))||0)-(parseInt(t.css("border-right-width"))||0),zIndex:t.css("z-index")}).eq(g&&this.opts.bottomToTopSubMenus?0:1).show(),this.isFixed()){var C={};C[touchEvents?"touchstart touchmove touchend":"pointerdown pointermove pointerup MSPointerDown MSPointerMove MSPointerUp"]=function(e){x.menuScrollTouch(t,e)},t.css({"touch-action":"none","-ms-touch-action":"none"}).on(getEventsNS(C,A))}}}t.css({top:"auto",left:"0",marginLeft:e,marginTop:i-m})},menuScroll:function(t,e,i){var s,o=t.dataSM("scroll"),a=t.dataSM("scroll-arrows"),n=o.up?o.upEnd:o.downEnd;if(!e&&o.momentum){if(o.momentum*=.92,s=o.momentum,.5>s)return this.menuScrollStop(t),void 0}else s=i||(e||!this.opts.scrollAccelerate?this.opts.scrollStep:Math.floor(o.step));var r=t.dataSM("level");if(this.activatedItems[r-1]&&this.activatedItems[r-1].dataSM("sub")&&this.activatedItems[r-1].dataSM("sub").is(":visible")&&this.menuHideSubMenus(r-1),o.y=o.up&&o.y>=n||!o.up&&n>=o.y?o.y:Math.abs(n-o.y)>s?o.y+(o.up?s:-s):n,t.css(this.cssTransforms3d?{"-webkit-transform":"translate3d(0, "+o.y+"px, 0)",transform:"translate3d(0, "+o.y+"px, 0)"}:{marginTop:o.y}),mouse&&(o.up&&o.y>o.downEnd||!o.up&&o.y0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$}); \ No newline at end of file diff --git a/md__c_h_a_n_g_e_l_o_g.html b/md__c_h_a_n_g_e_l_o_g.html new file mode 100644 index 0000000..40c63a8 --- /dev/null +++ b/md__c_h_a_n_g_e_l_o_g.html @@ -0,0 +1,86 @@ + + + + + + + +cppDataPipeline: Unreleased + + + + + + + + + +
+
+ + + + + + +
+
cppDataPipeline 0.3.0 +
+
C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
Unreleased
+
+
+
    +
  • Added functions for reading requested objects in the configuration file.
    • +
  • Reading of configuration YAML file using yaml-cpp.
    • +
  • Reading and writing of TOML files to represent parameters and distributions using toml11.
    • +
  • Reading and writing of arrays to/from a HDF5 file.
    • +
  • Hashing of file names and file content via SHA1.
    • +
  • Semantic versioning via a dedicated version class.
    • +
  • Added ability to talk to the RestAPI via the CURL library.
    • +
  • Use of spdlog as a logging library for plenty of output during debugging.
    • +
+
+
+ +
+Generated by doxygen 1.9.2 +
+ + diff --git a/md__r_e_a_d_m_e.html b/md__r_e_a_d_m_e.html new file mode 100644 index 0000000..ed2d41c --- /dev/null +++ b/md__r_e_a_d_m_e.html @@ -0,0 +1,108 @@ + + + + + + + +cppDataPipeline: FAIR Data Pipeline C++ API + + + + + + + + + +
+
+ + + + + + +
+
cppDataPipeline 0.3.0 +
+
C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
FAIR Data Pipeline C++ API
+
+
+

FDP C++ API License: LGPL v3 software-checklist DOI

+

+Contents

+ +

+Installation

+

You can build and test the library using CMake, this implementation requires C++11.

+

It is recomended that you install CURL prior to installation of this API

+

compile the library and tests by running:

+
$ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
+
$ cmake --build build
+

Important For multi-config compilers such as Visual Studio xcode or ninja the config type needs to be set to Release otherwise the API will not build for example:

$ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
+
$ cmake --build build --config=Release
+

+Outline

+

The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

+

+Unit Tests

+

The unit tests use the local registry, this needs to be running prior to running the tests see: the CLI documentation

+

Tests can be lauched using the following command:

+

+Unix

+
$ ./build/bin/fdpapi-tests
+

+Windows

+
$ build\bin\Release\fdpapi-tests.exe
+
+
+ +
+Generated by doxygen 1.9.2 +
+ + diff --git a/md_software_checklist.html b/md_software_checklist.html new file mode 100644 index 0000000..da6f893 --- /dev/null +++ b/md_software_checklist.html @@ -0,0 +1,252 @@ + + + + + + + +cppDataPipeline: SCRC Software checklist + + + + + + + + + +
+
+ + + + + + +
+
cppDataPipeline 0.3.0 +
+
C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
SCRC Software checklist
+
+
+

This checklist has been developed by the Scottish Covid-19 Response Consortium and has been used to assess the software engineering aspects of "model readiness" for our six epidemiological models. This is intended to be part of a broader scheme to evaluate and describe suitability of model results to be used in decision making so this checklist covers only the software implementation and assumes that other documents cover questions about model validation, quality of science, data provenance and quality and policy readiness.

+

In order to use this checklist for the SCRC FAIR data pipeline components, three questions that apply only to software producing scientific results have been marked "models only" and for other software an N/A response can be given.

+

+Software details

+

+Model / software name

+
+

cppDataPipeline

+
+

+Date

+
+

18/01/22

+
+

+Version identifier

+
+

v0.2.0

+
+

+This assessment

+

+Filled in by

+

Name

+
+

Ryan Field

+
+

Role on project:

+
+

RSE

+
+

Person identifier:

+
+

https://github.com/RyanJField

+
+

+Overall statement

+

Do we have sufficient confidence in the correctness of the software to trust the results?

+

This is your overall judgement on the level of confidence based on all the aspects of the checklist. There is no formulaic way to arrive at this overall assessment based on the individual checklist answers but please explain how the measures in place combine to reach this level of confidence and make clear any caveats (eg applies for certain ways of using the software and not others).

+
+

- [ ] Yes

    +
  • [x] Yes, with caveats
    • +
  • [ ] No
    • +
+

The code is well written and tested through unit tests and continous integration, the documentation is still a work in progress.

+
+

+Checklist

+

Please use a statement from this list: "Sufficiently addressed", "Some work remaining or caveats", or "Needs to be addressed" to begin each response.

+

Additionally, for each question please explain the situation and include any relevant links (eg tool dashboards, documentation). The sub bullet points are to make the scope of the question clear and should be covered if relevant but do not have to be answered individually.

+

+Can a run be repeated and reproduce exactly the same results? (models only)

+
    +
  • How is stochasticity handled?
    • +
  • Is sufficient meta-data logged to enable a run to be reproduced: Is the exact code version recorded (and whether the repository was "clean"), including versions of dependent libraries (e.g. an environment.yml file or similar) along with all command line arguments and the content of any configuration files?
    • +
  • Is there up-to-date documentation which explains precisely how to run the code to reproduce existing results?
    • +
+
+

- [ ] Sufficiently addressed

    +
  • [ ] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
  • [x] N/A
    • +
+
+

+Are there appropriate tests? (And are they automated?)

+
    +
  • Are there unit tests? What is covered?
    • +
  • System and integration tests? Automated model validation tests?
    • +
  • Regression tests? (Which show whether changes to the code lead to changes in the output. Changes to the model will be expected to change the output, but many other changes, such as refactoring and adding new features, should not. Having these tests gives confidence that the code hasn't developed bugs due to unintentional changes.)
    • +
  • Is there CI?
    • +
  • Is everything you need to run the tests (including documentation) in the repository (or the data pipeline where appropriate)?
    • +
+
+

- [ ] Sufficiently addressed

    +
  • [x] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
+

Tests are run via GitHub Actions CI ([![software-checklist][https://img.shields.io/badge/software-checklist-3891A6]][https://github.com/FAIRDataPipeline/cppDataPipeline/blob/main/software-checklist.md]) with good code coverage.

+
+

+Are the scientific results of runs robust to different ways of running the code? (models only)

+
    +
  • Running on a different machine?
    • +
  • With different number of processes?
    • +
  • With different compilers and optimisation levels?
    • +
  • Running in debug mode?
    • +
+

(We don't require bitwise identical results here, but the broad conclusions after looking at the results of the test case should be the same.)

+
+

- [ ] Sufficiently addressed

    +
  • [ ] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
  • [x] N/A
    • +
+
+

+Has any sort of automated code checking been applied?

+
    +
  • For C++, this might just be the compiler output when run with "all warnings". It could also be more extensive static analysis. For other languages, it could be e.g. pylint, StaticLint.jl, etc.
    • +
  • If there are possible issues reported by such a tool, have they all been either fixed or understood to not be important?
    • +
+
+

- [ ] Sufficiently addressed

    +
  • [x] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
+

Minimal warnings are present with some notes.

+
+

+Is the code clean, generally understandable and readable and written according to good software engineering principles?

+
    +
  • Is it modular? Are the internal implementation details of one module hidden from other modules?
    • +
  • Commented where necessary?
    • +
  • Avoiding red flags such as very long functions, global variables, copy and pasted code, etc.?
    • +
+
+

- [ ] Sufficiently addressed

    +
  • [x] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
+

The code is organised and follows best practice but requires some refactoring to remove redundant code.

+
+

+Is there sufficient documentation?

+
    +
  • Is there a readme?
    • +
  • Does the code have user documentation?
    • +
  • Does the code have developer documentation?
    • +
  • Does the code have algorithm documentation? e.g. something that describes how the model is actually simulated, or inference is performed?
    • +
  • Is all the documentation up to date?
    • +
+
+

- [ ] Sufficiently addressed

    +
  • [x] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
+

There is a readme, however the code is in need of proper documentation.

+
+

+Is there suitable collaboration infrastructure?

+
    +
  • Is the code in a version-controlled repository?
    • +
  • Is there a license?
    • +
  • Is an issue tracker used?
    • +
  • Are there contribution guidelines?
    • +
+
+

- [x] Sufficiently addressed

    +
  • [ ] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
+

The code is stored in a GitHub, includes a license and uses github issues, for issue tracking.

+
+

+Are software dependencies listed and of appropriate quality?

+
+

- [x] Sufficiently addressed

    +
  • [ ] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
+

Dependencies are listed in the readme, with most being automatically included.

+
+

+Is input and output data handled carefully? (Models only)

+
    +
  • Does the code use the data pipeline for all inputs and outputs?
    • +
  • Is the code appropriately parameterized (i.e. have hard coded parameters been removed)?
    • +
+
+

- [ ] Sufficiently addressed

    +
  • [ ] Some work remaining or caveats
    • +
  • [ ] Needs to be addressed
    • +
  • [x] N/A
    • +
+
+
+
+ +
+Generated by doxygen 1.9.2 +
+ + diff --git a/menu.js b/menu.js new file mode 100644 index 0000000..54e81cf --- /dev/null +++ b/menu.js @@ -0,0 +1,127 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+=''; + } + return result; + } + var searchBox; + if (searchEnabled) { + if (serverSide) { + searchBox='
'+ + '
'+ + '
'+ + ''+ + '
'+ + '
'+ + '
'+ + '
'; + } else { + searchBox='
'+ + ''+ + ''+ + ''+ + ''+ + ''+ + '' + '' + '
'; + } + } + + $('#main-nav').before('
'+ + ''+ + ''+ + '
'); + $('#main-nav').append(makeTree(menudata,relPath)); + $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); + if (searchBox) { + $('#main-menu').append('
  • '); + } + var $mainMenuState = $('#main-menu-state'); + var prevWidth = 0; + if ($mainMenuState.length) { + function initResizableIfExists() { + if (typeof initResizable==='function') initResizable(); + } + // animate mobile menu + $mainMenuState.change(function(e) { + var $menu = $('#main-menu'); + var options = { duration: 250, step: initResizableIfExists }; + if (this.checked) { + options['complete'] = function() { $menu.css('display', 'block') }; + $menu.hide().slideDown(options); + } else { + options['complete'] = function() { $menu.css('display', 'none') }; + $menu.show().slideUp(options); + } + }); + // set default menu visibility + function resetState() { + var $menu = $('#main-menu'); + var $mainMenuState = $('#main-menu-state'); + var newWidth = $(window).outerWidth(); + if (newWidth!=prevWidth) { + if ($(window).outerWidth()<768) { + $mainMenuState.prop('checked',false); $menu.hide(); + $('#searchBoxPos1').html(searchBox); + $('#searchBoxPos2').hide(); + } else { + $menu.show(); + $('#searchBoxPos1').empty(); + $('#searchBoxPos2').html(searchBox); + $('#searchBoxPos2').show(); + } + prevWidth = newWidth; + } + } + $(window).ready(function() { resetState(); initResizableIfExists(); }); + $(window).resize(resetState); + } + $('#main-menu').smartmenus(); +} +/* @license-end */ diff --git a/menudata.js b/menudata.js new file mode 100644 index 0000000..752f4f4 --- /dev/null +++ b/menudata.js @@ -0,0 +1,27 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file +*/ +var menudata={children:[ +{text:"Main Page",url:"index.html"}, +{text:"Related Pages",url:"pages.html"}]} diff --git a/nav_f.png b/nav_f.png new file mode 100644 index 0000000000000000000000000000000000000000..72a58a529ed3a9ed6aa0c51a79cf207e026deee2 GIT binary patch literal 153 zcmeAS@N?(olHy`uVBq!ia0vp^j6iI`!2~2XGqLUlQVE_ejv*C{Z|{2ZH7M}7UYxc) zn!W8uqtnIQ>_z8U literal 0 HcmV?d00001 diff --git a/nav_g.png b/nav_g.png new file mode 100644 index 0000000000000000000000000000000000000000..2093a237a94f6c83e19ec6e5fd42f7ddabdafa81 GIT binary patch literal 95 zcmeAS@N?(olHy`uVBq!ia0vp^j6lrB!3HFm1ilyoDK$?Q$B+ufw|5PB85lU25BhtE tr?otc=hd~V+ws&_A@j8Fiv!KF$B+ufw|5=67#uj90@pIL wZ=Q8~_Ju`#59=RjDrmm`tMD@M=!-l18IR?&vFVdQ&MBb@0HFXL1|%O$WD@{VPM$7~Ar*{o?;hlAFyLXmaDC0y znK1_#cQqJWPES%4Uujug^TE?jMft$}Eq^WaR~)%f)vSNs&gek&x%A9X9sM + + + + + + +cppDataPipeline: Related Pages + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Related Pages
    +
    +
    +
    Here is a list of all related documentation pages:
    + + + + +
     Unreleased
     FAIR Data Pipeline C++ API
     SCRC Software checklist
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/search/all_0.html b/search/all_0.html new file mode 100644 index 0000000..65f85b5 --- /dev/null +++ b/search/all_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_0.js b/search/all_0.js new file mode 100644 index 0000000..59482d3 --- /dev/null +++ b/search/all_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../md__r_e_a_d_m_e.html',1,'']]] +]; diff --git a/search/all_1.html b/search/all_1.html new file mode 100644 index 0000000..af53dab --- /dev/null +++ b/search/all_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_1.js b/search/all_1.js new file mode 100644 index 0000000..5e2db56 --- /dev/null +++ b/search/all_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['scrc_20software_20checklist_0',['SCRC Software checklist',['../md_software_checklist.html',1,'']]] +]; diff --git a/search/all_2.html b/search/all_2.html new file mode 100644 index 0000000..f8fe8ec --- /dev/null +++ b/search/all_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_2.js b/search/all_2.js new file mode 100644 index 0000000..cd0d928 --- /dev/null +++ b/search/all_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['unreleased_0',['Unreleased',['../md__c_h_a_n_g_e_l_o_g.html',1,'']]] +]; diff --git a/search/close.svg b/search/close.svg new file mode 100644 index 0000000..a933eea --- /dev/null +++ b/search/close.svg @@ -0,0 +1,31 @@ + + + + + + image/svg+xml + + + + + + + + diff --git a/search/mag_sel.svg b/search/mag_sel.svg new file mode 100644 index 0000000..03626f6 --- /dev/null +++ b/search/mag_sel.svg @@ -0,0 +1,74 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/search/nomatches.html b/search/nomatches.html new file mode 100644 index 0000000..2b9360b --- /dev/null +++ b/search/nomatches.html @@ -0,0 +1,13 @@ + + + + + + + + +
    +
    No Matches
    +
    + + diff --git a/search/pages_0.html b/search/pages_0.html new file mode 100644 index 0000000..34ca499 --- /dev/null +++ b/search/pages_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/pages_0.js b/search/pages_0.js new file mode 100644 index 0000000..59482d3 --- /dev/null +++ b/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../md__r_e_a_d_m_e.html',1,'']]] +]; diff --git a/search/pages_1.html b/search/pages_1.html new file mode 100644 index 0000000..37ed0d6 --- /dev/null +++ b/search/pages_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/pages_1.js b/search/pages_1.js new file mode 100644 index 0000000..5e2db56 --- /dev/null +++ b/search/pages_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['scrc_20software_20checklist_0',['SCRC Software checklist',['../md_software_checklist.html',1,'']]] +]; diff --git a/search/pages_2.html b/search/pages_2.html new file mode 100644 index 0000000..878d7ec --- /dev/null +++ b/search/pages_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/pages_2.js b/search/pages_2.js new file mode 100644 index 0000000..cd0d928 --- /dev/null +++ b/search/pages_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['unreleased_0',['Unreleased',['../md__c_h_a_n_g_e_l_o_g.html',1,'']]] +]; diff --git a/search/search.css b/search/search.css new file mode 100644 index 0000000..648a792 --- /dev/null +++ b/search/search.css @@ -0,0 +1,263 @@ +/*---------------- Search Box */ + +#MSearchBox { + white-space : nowrap; + background: white; + border-radius: 0.65em; + box-shadow: inset 0.5px 0.5px 3px 0px #555; + z-index: 102; +} + +#MSearchBox .left { + display: inline-block; + vertical-align: middle; + height: 1.4em; +} + +#MSearchSelect { + display: inline-block; + vertical-align: middle; + height: 19px; + padding: 0 0 0 0.3em; + margin: 0; +} + +#MSearchField { + display: inline-block; + vertical-align: middle; + width: 7.5em; + height: 19px; + margin: 0 0.15em; + padding: 0; + line-height: 1em; + border:none; + color: #909090; + outline: none; + font-family: Arial, Verdana, sans-serif; + -webkit-border-radius: 0px; + border-radius: 0px; + background: none; +} + +@media(hover: none) { + /* to avoid zooming on iOS */ + #MSearchField { + font-size: 16px; + } +} + +#MSearchBox .right { + display: inline-block; + vertical-align: middle; + width: 1.4em; + height: 1.4em; +} + +#MSearchClose { + display: none; + font-size: inherit; + background : none; + border: none; + margin: 0; + padding: 0; + outline: none; + +} + +#MSearchCloseImg { + height: 1.4em; + padding: 0.3em; + margin: 0; +} + +.MSearchBoxActive #MSearchField { + color: #000000; +} + +#main-menu > li:last-child { + /* This
  • object is the parent of the search bar */ + display: flex; + justify-content: center; + align-items: center; + height: 36px; + margin-right: 1em; +} + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #90A5CE; + background-color: #F9FAFC; + z-index: 10001; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt Arial, Verdana, sans-serif; + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: monospace; + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: #000000; + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: #000000; + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: #FFFFFF; + background-color: #3D578C; + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + /*width: 60ex;*/ + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #000; + background-color: #EEF1F7; + z-index:10000; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; + padding-bottom: 15px; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +body.SRPage { + margin: 5px 2px; +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +span.SRScope { + padding-left: 4px; + font-family: Arial, Verdana, sans-serif; +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; + font-family: Arial, Verdana, sans-serif; +} + +.SRResult { + display: none; +} + +div.searchresults { + margin-left: 10px; + margin-right: 10px; +} + +/*---------------- External search page results */ + +.searchresult { + background-color: #F0F3F8; +} + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: url("../tab_a.png"); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/search/search.js b/search/search.js new file mode 100644 index 0000000..ac8055d --- /dev/null +++ b/search/search.js @@ -0,0 +1,794 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function convertToId(search) +{ + var result = ''; + for (i=0;i do a search + { + this.Search(); + } + } + + this.OnSearchSelectKey = function(evt) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==40 && this.searchIndex0) // Up + { + this.searchIndex--; + this.OnSelectItem(this.searchIndex); + } + else if (e.keyCode==13 || e.keyCode==27) + { + this.OnSelectItem(this.searchIndex); + this.CloseSelectionWindow(); + this.DOMSearchField().focus(); + } + return false; + } + + // --------- Actions + + // Closes the results window. + this.CloseResultsWindow = function() + { + this.DOMPopupSearchResultsWindow().style.display = 'none'; + this.DOMSearchClose().style.display = 'none'; + this.Activate(false); + } + + this.CloseSelectionWindow = function() + { + this.DOMSearchSelectWindow().style.display = 'none'; + } + + // Performs a search. + this.Search = function() + { + this.keyTimeout = 0; + + // strip leading whitespace + var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); + + var code = searchValue.toLowerCase().charCodeAt(0); + var idxChar = searchValue.substr(0, 1).toLowerCase(); + if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair + { + idxChar = searchValue.substr(0, 2); + } + + var resultsPage; + var resultsPageWithSearch; + var hasResultsPage; + + var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar); + if (idx!=-1) + { + var hexCode=idx.toString(16); + resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + this.extension; + resultsPageWithSearch = resultsPage+'?'+escape(searchValue); + hasResultsPage = true; + } + else // nothing available for this search term + { + resultsPage = this.resultsPath + '/nomatches' + this.extension; + resultsPageWithSearch = resultsPage; + hasResultsPage = false; + } + + window.frames.MSearchResults.location = resultsPageWithSearch; + var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); + + if (domPopupSearchResultsWindow.style.display!='block') + { + var domSearchBox = this.DOMSearchBox(); + this.DOMSearchClose().style.display = 'inline-block'; + var domPopupSearchResults = this.DOMPopupSearchResults(); + var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; + var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + var maxWidth = document.body.clientWidth; + var width = 400; + if (left<10) left=10; + if (width+left+8>maxWidth) width=maxWidth-left-8; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + domPopupSearchResultsWindow.style.width = width + 'px'; + } + + this.lastSearchValue = searchValue; + this.lastResultsPage = resultsPage; + } + + // -------- Activation Functions + + // Activates or deactivates the search panel, resetting things to + // their default values if necessary. + this.Activate = function(isActive) + { + if (isActive || // open it + this.DOMPopupSearchResultsWindow().style.display == 'block' + ) + { + this.DOMSearchBox().className = 'MSearchBoxActive'; + + var searchField = this.DOMSearchField(); + + if (searchField.value == this.searchLabel) // clear "Search" term upon entry + { + searchField.value = ''; + this.searchActive = true; + } + } + else if (!isActive) // directly remove the panel + { + this.DOMSearchBox().className = 'MSearchBoxInactive'; + this.DOMSearchField().value = this.searchLabel; + this.searchActive = false; + this.lastSearchValue = '' + this.lastResultsPage = ''; + } + } +} + +// ----------------------------------------------------------------------- + +// The class that handles everything on the search results page. +function SearchResults(name) +{ + // The number of matches from the last run of . + this.lastMatchCount = 0; + this.lastKey = 0; + this.repeatOn = false; + + // Toggles the visibility of the passed element ID. + this.FindChildElement = function(id) + { + var parentElement = document.getElementById(id); + var element = parentElement.firstChild; + + while (element && element!=parentElement) + { + if (element.nodeName.toLowerCase() == 'div' && element.className == 'SRChildren') + { + return element; + } + + if (element.nodeName.toLowerCase() == 'div' && element.hasChildNodes()) + { + element = element.firstChild; + } + else if (element.nextSibling) + { + element = element.nextSibling; + } + else + { + do + { + element = element.parentNode; + } + while (element && element!=parentElement && !element.nextSibling); + + if (element && element!=parentElement) + { + element = element.nextSibling; + } + } + } + } + + this.Toggle = function(id) + { + var element = this.FindChildElement(id); + if (element) + { + if (element.style.display == 'block') + { + element.style.display = 'none'; + } + else + { + element.style.display = 'block'; + } + } + } + + // Searches for the passed string. If there is no parameter, + // it takes it from the URL query. + // + // Always returns true, since other documents may try to call it + // and that may or may not be possible. + this.Search = function(search) + { + if (!search) // get search word from URL + { + search = window.location.search; + search = search.substring(1); // Remove the leading '?' + search = unescape(search); + } + + search = search.replace(/^ +/, ""); // strip leading spaces + search = search.replace(/ +$/, ""); // strip trailing spaces + search = search.toLowerCase(); + search = convertToId(search); + + var resultRows = document.getElementsByTagName("div"); + var matches = 0; + + var i = 0; + while (i < resultRows.length) + { + var row = resultRows.item(i); + if (row.className == "SRResult") + { + var rowMatchName = row.id.toLowerCase(); + rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' + + if (search.length<=rowMatchName.length && + rowMatchName.substr(0, search.length)==search) + { + row.style.display = 'block'; + matches++; + } + else + { + row.style.display = 'none'; + } + } + i++; + } + document.getElementById("Searching").style.display='none'; + if (matches == 0) // no results + { + document.getElementById("NoMatches").style.display='block'; + } + else // at least one result + { + document.getElementById("NoMatches").style.display='none'; + } + this.lastMatchCount = matches; + return true; + } + + // return the first item with index index or higher that is visible + this.NavNext = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index++; + } + return focusItem; + } + + this.NavPrev = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index--; + } + return focusItem; + } + + this.ProcessKeys = function(e) + { + if (e.type == "keydown") + { + this.repeatOn = false; + this.lastKey = e.keyCode; + } + else if (e.type == "keypress") + { + if (!this.repeatOn) + { + if (this.lastKey) this.repeatOn = true; + return false; // ignore first keypress after keydown + } + } + else if (e.type == "keyup") + { + this.lastKey = 0; + this.repeatOn = false; + } + return this.lastKey!=0; + } + + this.Nav = function(evt,itemIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + var newIndex = itemIndex-1; + var focusItem = this.NavPrev(newIndex); + if (focusItem) + { + var child = this.FindChildElement(focusItem.parentNode.parentNode.id); + if (child && child.style.display == 'block') // children visible + { + var n=0; + var tmpElem; + while (1) // search for last child + { + tmpElem = document.getElementById('Item'+newIndex+'_c'+n); + if (tmpElem) + { + focusItem = tmpElem; + } + else // found it! + { + break; + } + n++; + } + } + } + if (focusItem) + { + focusItem.focus(); + } + else // return focus to search field + { + parent.document.getElementById("MSearchField").focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = itemIndex+1; + var focusItem; + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem && elem.style.display == 'block') // children visible + { + focusItem = document.getElementById('Item'+itemIndex+'_c0'); + } + if (!focusItem) focusItem = this.NavNext(newIndex); + if (focusItem) focusItem.focus(); + } + else if (this.lastKey==39) // Right + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'block'; + } + else if (this.lastKey==37) // Left + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'none'; + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } + + this.NavChild = function(evt,itemIndex,childIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + if (childIndex>0) + { + var newIndex = childIndex-1; + document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); + } + else // already at first child, jump to parent + { + document.getElementById('Item'+itemIndex).focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = childIndex+1; + var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); + if (!elem) // last child, jump to parent next parent + { + elem = this.NavNext(itemIndex+1); + } + if (elem) + { + elem.focus(); + } + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } +} + +function setKeyActions(elem,action) +{ + elem.setAttribute('onkeydown',action); + elem.setAttribute('onkeypress',action); + elem.setAttribute('onkeyup',action); +} + +function setClassAttr(elem,attr) +{ + elem.setAttribute('class',attr); + elem.setAttribute('className',attr); +} + +function createResults() +{ + var results = document.getElementById("SRResults"); + for (var e=0; e(R!W8j_r#qQ#gnr4kAxdU#F0+OBry$Z+ z_0PMi;P|#{d%mw(dnw=jM%@$onTJa%@6Nm3`;2S#nwtVFJI#`U@2Q@@JCCctagvF- z8H=anvo~dTmJ2YA%wA6IHRv%{vxvUm|R)kgZeo zmX%Zb;mpflGZdXCTAgit`||AFzkI#z&(3d4(htA?U2FOL4WF6wY&TB#n3n*I4+hl| z*NBpo#FA92vEu822WQ%mvv4FO#qs` BFGc_W literal 0 HcmV?d00001 diff --git a/search/search_r.png b/search/search_r.png new file mode 100644 index 0000000000000000000000000000000000000000..1af5d21ee13e070d7600f1c4657fde843b953a69 GIT binary patch literal 553 zcmeAS@N?(olHy`uVBq!ia0vp^LO?9c!2%@BXHTsJQY`6?zK#qG8~eHcB(ehe3dtTp zz6=bxGZ+|(`xqD=STHa&U1eaXVrO7DwS|Gf*oA>XrmV$GYcEhOQT(QLuS{~ooZ2P@v=Xc@RKW@Irliv8_;wroU0*)0O?temdsA~70jrdux+`@W7 z-N(<(C)L?hOO?KV{>8(jC{hpKsws)#Fh zvsO>IB+gb@b+rGWaO&!a9Z{!U+fV*s7TS>fdt&j$L%^U@Epd$~Nl7e8wMs5Z1yT$~ z28I^8hDN#u<{^fLRz?<9hUVG^237_Jy7tbuQ8eV{r(~v8;?@w8^gA7>fx*+&&t;uc GLK6VEQpiUD literal 0 HcmV?d00001 diff --git a/search/searchdata.js b/search/searchdata.js new file mode 100644 index 0000000..2c6df75 --- /dev/null +++ b/search/searchdata.js @@ -0,0 +1,18 @@ +var indexSectionsWithContent = +{ + 0: "fsu", + 1: "fsu" +}; + +var indexSectionNames = +{ + 0: "all", + 1: "pages" +}; + +var indexSectionLabels = +{ + 0: "All", + 1: "Pages" +}; + diff --git a/splitbar.png b/splitbar.png new file mode 100644 index 0000000000000000000000000000000000000000..fe895f2c58179b471a22d8320b39a4bd7312ec8e GIT binary patch literal 314 zcmeAS@N?(olHy`uVBq!ia0vp^Yzz!63>-{AmhX=Jf(#6djGiuzAr*{o?=JLmPLyc> z_*`QK&+BH@jWrYJ7>r6%keRM@)Qyv8R=enp0jiI>aWlGyB58O zFVR20d+y`K7vDw(hJF3;>dD*3-?v=<8M)@x|EEGLnJsniYK!2U1 Y!`|5biEc?d1`HDhPgg&ebxsLQ02F6;9RL6T literal 0 HcmV?d00001 diff --git a/sync_off.png b/sync_off.png new file mode 100644 index 0000000000000000000000000000000000000000..3b443fc62892114406e3d399421b2a881b897acc GIT binary patch literal 853 zcmV-b1FHOqP)oT|#XixUYy%lpuf3i8{fX!o zUyDD0jOrAiT^tq>fLSOOABs-#u{dV^F$b{L9&!2=9&RmV;;8s^x&UqB$PCj4FdKbh zoB1WTskPUPu05XzFbA}=KZ-GP1fPpAfSs>6AHb12UlR%-i&uOlTpFNS7{jm@mkU1V zh`nrXr~+^lsV-s1dkZOaI|kYyVj3WBpPCY{n~yd%u%e+d=f%`N0FItMPtdgBb@py; zq@v6NVArhyTC7)ULw-Jy8y42S1~4n(3LkrW8mW(F-4oXUP3E`e#g**YyqI7h-J2zK zK{m9##m4ri!7N>CqQqCcnI3hqo1I;Yh&QLNY4T`*ptiQGozK>FF$!$+84Z`xwmeMh zJ0WT+OH$WYFALEaGj2_l+#DC3t7_S`vHpSivNeFbP6+r50cO8iu)`7i%Z4BTPh@_m3Tk!nAm^)5Bqnr%Ov|Baunj#&RPtRuK& z4RGz|D5HNrW83-#ydk}tVKJrNmyYt-sTxLGlJY5nc&Re zU4SgHNPx8~Yxwr$bsju?4q&%T1874xxzq+_%?h8_ofw~(bld=o3iC)LUNR*BY%c0y zWd_jX{Y8`l%z+ol1$@Qa?Cy!(0CVIEeYpKZ`(9{z>3$CIe;pJDQk$m3p}$>xBm4lb zKo{4S)`wdU9Ba9jJbVJ0C=SOefZe%d$8=2r={nu<_^a3~>c#t_U6dye5)JrR(_a^E f@}b6j1K9lwFJq@>o)+Ry00000NkvXXu0mjfWa5j* literal 0 HcmV?d00001 diff --git a/sync_on.png b/sync_on.png new file mode 100644 index 0000000000000000000000000000000000000000..e08320fb64e6fa33b573005ed6d8fe294e19db76 GIT binary patch literal 845 zcmV-T1G4;yP)Y;xxyHF2B5Wzm| zOOGupOTn@c(JmBOl)e;XMNnZuiTJP>rM8<|Q`7I_))aP?*T)ow&n59{}X4$3Goat zgjs?*aasfbrokzG5cT4K=uG`E14xZl@z)F={P0Y^?$4t z>v!teRnNZym<6h{7sLyF1V0HsfEl+l6TrZpsfr1}luH~F7L}ktXu|*uVX^RG$L0`K zWs3j|0tIvVe(N%_?2{(iCPFGf#B6Hjy6o&}D$A%W%jfO8_W%ZO#-mh}EM$LMn7joJ z05dHr!5Y92g+31l<%i1(=L1a1pXX+OYnalY>31V4K}BjyRe3)9n#;-cCVRD_IG1fT zOKGeNY8q;TL@K{dj@D^scf&VCs*-Jb>8b>|`b*osv52-!A?BpbYtTQBns5EAU**$m zSnVSm(teh>tQi*S*A>#ySc=n;`BHz`DuG4&g4Kf8lLhca+zvZ7t7RflD6-i-mcK=M z!=^P$*u2)bkY5asG4gsss!Hn%u~>}kIW`vMs%lJLH+u*9<4PaV_c6U`KqWXQH%+Nu zTv41O(^ZVi@qhjQdG!fbZw&y+2o!iYymO^?ud3{P*HdoX83YV*Uu_HB=?U&W9%AU# z80}k1SS-CXTU7dcQlsm<^oYLxVSseqY6NO}dc`Nj?8vrhNuCdm@^{a3AQ_>6myOj+ z`1RsLUXF|dm|3k7s2jD(B{rzE>WI2scH8i1;=O5Cc9xB3^aJk%fQjqsu+kH#0=_5a z0nCE8@dbQa-|YIuUVvG0L_IwHMEhOj$Mj4Uq05 X8=0q~qBNan00000NkvXXu0mjfptF>5 literal 0 HcmV?d00001 diff --git a/tab_a.png b/tab_a.png new file mode 100644 index 0000000000000000000000000000000000000000..3b725c41c5a527a3a3e40097077d0e206a681247 GIT binary patch literal 142 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!2~3aiye;!QlXwMjv*C{Z|8b*H5dputLHD# z=<0|*y7z(Vor?d;H&?EG&cXR}?!j-Lm&u1OOI7AIF5&c)RFE;&p0MYK>*Kl@eiymD r@|NpwKX@^z+;{u_Z~trSBfrMKa%3`zocFjEXaR$#tDnm{r-UW|TZ1%4 literal 0 HcmV?d00001 diff --git a/tab_b.png b/tab_b.png new file mode 100644 index 0000000000000000000000000000000000000000..e2b4a8638cb3496a016eaed9e16ffc12846dea18 GIT binary patch literal 169 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!2~3aiye;!QU#tajv*C{Z}0l@H7kg?K0Lnr z!j&C6_(~HV9oQ0Pa6x{-v0AGV_E?vLn=ZI-;YrdjIl`U`uzuDWSP?o#Dmo{%SgM#oan kX~E1%D-|#H#QbHoIja2U-MgvsK&LQxy85}Sb4q9e0Efg%P5=M^ literal 0 HcmV?d00001 diff --git a/tabs.css b/tabs.css new file mode 100644 index 0000000..00d1c60 --- /dev/null +++ b/tabs.css @@ -0,0 +1 @@ +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:#666;-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file From 5e3a98df4569d6ca2d1496ef3ec50ddb9a971a59 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Wed, 9 Feb 2022 06:40:38 +0000 Subject: [PATCH 02/19] deploy: 09060f79a91fb6fc0a5988c7d666d0eb9b01c68d --- annotated.html | 94 +++ api_8hxx.html | 220 +++++ api_8hxx_source.html | 179 ++++ api__object_8hxx_source.html | 126 +++ class_f_d_p_1_1_a_p_i-members.html | 94 +++ class_f_d_p_1_1_a_p_i.html | 482 +++++++++++ class_f_d_p_1_1_api_object-members.html | 93 +++ class_f_d_p_1_1_api_object.html | 383 +++++++++ class_f_d_p_1_1_config-members.html | 107 +++ class_f_d_p_1_1_config.html | 766 ++++++++++++++++++ class_f_d_p_1_1_data_pipeline-members.html | 91 +++ class_f_d_p_1_1_data_pipeline.html | 241 ++++++ ..._d_p_1_1_data_pipeline_impl__-members.html | 89 ++ class_f_d_p_1_1_data_pipeline_impl__.html | 257 ++++++ class_f_d_p_1_1_i_o_object-members.html | 98 +++ class_f_d_p_1_1_i_o_object.html | 685 ++++++++++++++++ ...d_p_1_1_versioning_1_1version-members.html | 101 +++ class_f_d_p_1_1_versioning_1_1version.html | 268 ++++++ ...d_p_1_1config__parsing__error-members.html | 83 ++ class_f_d_p_1_1config__parsing__error.html | 98 +++ class_f_d_p_1_1config__parsing__error.png | Bin 0 -> 645 bytes ...s_f_d_p_1_1json__parse__error-members.html | 83 ++ class_f_d_p_1_1json__parse__error.html | 98 +++ class_f_d_p_1_1json__parse__error.png | Bin 0 -> 612 bytes ..._d_p_1_1rest__apiquery__error-members.html | 83 ++ class_f_d_p_1_1rest__apiquery__error.html | 98 +++ class_f_d_p_1_1rest__apiquery__error.png | Bin 0 -> 651 bytes class_f_d_p_1_1sync__error-members.html | 83 ++ class_f_d_p_1_1sync__error.html | 98 +++ class_f_d_p_1_1sync__error.png | Bin 0 -> 521 bytes class_f_d_p_1_1validation__error-members.html | 83 ++ class_f_d_p_1_1validation__error.html | 98 +++ class_f_d_p_1_1validation__error.png | Bin 0 -> 571 bytes class_f_d_p_1_1write__error-members.html | 83 ++ class_f_d_p_1_1write__error.html | 98 +++ class_f_d_p_1_1write__error.png | Bin 0 -> 509 bytes classes.html | 105 +++ config_8hxx.html | 105 +++ config_8hxx_source.html | 221 +++++ data__io_8hxx_source.html | 150 ++++ datapipeline_8hxx.html | 110 +++ datapipeline_8hxx_source.html | 144 ++++ ... dir_39f1df2935b9bcc0c6b792c5d1359e85.html | 29 +- ... dir_68267d1309a1af8e8297ef4c3efbcdba.html | 21 +- dir_7b5d38f1875f1b693f62ca6a108a1129.html | 79 ++ dir_a7fa5847c07dc92c5227f8a150238560.html | 79 ++ dir_ac6c6686346e4bb6ee59787dd26cbe81.html | 92 +++ dir_cb3c39cc4ab347a95dfc53ab4ca55b3c.html | 79 ++ dir_d44c64559bbebec7f509842c48db8b23.html | 83 ++ dir_d98af0b859cb0744225e11c767d17cdb.html | 89 ++ dir_f537a5f098b413116eae11cd84c41a43.html | 88 ++ exceptions_8hxx_source.html | 127 +++ fdp_8hxx_source.html | 125 +++ files.html | 96 +++ functions.html | 199 +++++ functions_func.html | 199 +++++ hierarchy.html | 93 +++ index.html | 41 +- io__object_8hxx_source.html | 185 +++++ json_8hxx.html | 133 +++ json_8hxx_source.html | 91 +++ logging_8hxx.html | 149 ++++ logging_8hxx_source.html | 95 +++ md__r_e_a_d_m_e.html | 108 --- md_software_checklist.html | 252 ------ menudata.js | 47 +- metadata_8hxx.html | 341 ++++++++ metadata_8hxx_source.html | 130 +++ namespace_f_d_p_1_1_versioning.html | 144 ++++ namespacemembers.html | 75 ++ namespacemembers_enum.html | 75 ++ namespaces.html | 94 +++ search/all_0.js | 7 +- search/all_1.js | 2 +- search/{pages_1.html => all_10.html} | 2 +- search/all_10.js | 5 + search/{pages_2.html => all_11.html} | 2 +- search/all_11.js | 6 + search/all_2.js | 10 +- search/all_3.html | 37 + search/all_3.js | 6 + search/all_4.html | 37 + search/all_4.js | 4 + search/all_5.html | 37 + search/all_5.js | 7 + search/all_6.html | 37 + search/all_6.js | 37 + search/all_7.html | 37 + search/all_7.js | 7 + search/all_8.html | 37 + search/all_8.js | 6 + search/all_9.html | 37 + search/all_9.js | 7 + search/all_a.html | 37 + search/all_a.js | 7 + search/all_b.html | 37 + search/all_b.js | 6 + search/all_c.html | 37 + search/all_c.js | 5 + search/all_d.html | 37 + search/all_d.js | 12 + search/all_e.html | 37 + search/all_e.js | 7 + search/all_f.html | 37 + search/all_f.js | 5 + search/classes_0.html | 37 + search/classes_0.js | 5 + search/classes_1.html | 37 + search/classes_1.js | 5 + search/classes_2.html | 37 + search/classes_2.js | 5 + search/classes_3.html | 37 + search/classes_3.js | 4 + search/classes_4.html | 37 + search/classes_4.js | 4 + search/classes_5.html | 37 + search/classes_5.js | 4 + search/classes_6.html | 37 + search/classes_6.js | 4 + search/classes_7.html | 37 + search/classes_7.js | 5 + search/classes_8.html | 37 + search/classes_8.js | 4 + search/enums_0.html | 37 + search/enums_0.js | 4 + search/enums_1.html | 37 + search/enums_1.js | 4 + search/enumvalues_0.html | 37 + search/enumvalues_0.js | 4 + search/enumvalues_1.html | 37 + search/enumvalues_1.js | 4 + search/enumvalues_2.html | 37 + search/enumvalues_2.js | 4 + search/enumvalues_3.html | 37 + search/enumvalues_3.js | 6 + search/files_0.html | 37 + search/files_0.js | 4 + search/files_1.html | 37 + search/files_1.js | 4 + search/files_2.html | 37 + search/files_2.js | 4 + search/files_3.html | 37 + search/files_3.js | 4 + search/files_4.html | 37 + search/files_4.js | 4 + search/files_5.html | 37 + search/files_5.js | 4 + search/files_6.html | 37 + search/files_6.js | 4 + search/functions_0.html | 37 + search/functions_0.js | 6 + search/functions_1.html | 37 + search/functions_1.js | 10 + search/functions_10.html | 37 + search/functions_10.js | 6 + search/functions_2.html | 37 + search/functions_2.js | 5 + search/functions_3.html | 37 + search/functions_3.js | 4 + search/functions_4.html | 37 + search/functions_4.js | 5 + search/functions_5.html | 37 + search/functions_5.js | 37 + search/functions_6.html | 37 + search/functions_6.js | 7 + search/functions_7.html | 37 + search/functions_7.js | 6 + search/functions_8.html | 37 + search/functions_8.js | 5 + search/functions_9.html | 37 + search/functions_9.js | 5 + search/functions_a.html | 37 + search/functions_a.js | 4 + search/functions_b.html | 37 + search/functions_b.js | 5 + search/functions_c.html | 37 + search/functions_c.js | 7 + search/functions_d.html | 37 + search/functions_d.js | 5 + search/functions_e.html | 37 + search/functions_e.js | 4 + search/functions_f.html | 37 + search/functions_f.js | 4 + search/namespaces_0.html | 37 + search/namespaces_0.js | 4 + search/pages_0.js | 2 +- search/pages_1.js | 4 - search/pages_2.js | 4 - search/searchdata.js | 29 +- search/variables_0.html | 37 + search/variables_0.js | 4 + semver_8hxx.html | 120 +++ semver_8hxx_source.html | 234 ++++++ 193 files changed, 12092 insertions(+), 409 deletions(-) create mode 100644 annotated.html create mode 100644 api_8hxx.html create mode 100644 api_8hxx_source.html create mode 100644 api__object_8hxx_source.html create mode 100644 class_f_d_p_1_1_a_p_i-members.html create mode 100644 class_f_d_p_1_1_a_p_i.html create mode 100644 class_f_d_p_1_1_api_object-members.html create mode 100644 class_f_d_p_1_1_api_object.html create mode 100644 class_f_d_p_1_1_config-members.html create mode 100644 class_f_d_p_1_1_config.html create mode 100644 class_f_d_p_1_1_data_pipeline-members.html create mode 100644 class_f_d_p_1_1_data_pipeline.html create mode 100644 class_f_d_p_1_1_data_pipeline_impl__-members.html create mode 100644 class_f_d_p_1_1_data_pipeline_impl__.html create mode 100644 class_f_d_p_1_1_i_o_object-members.html create mode 100644 class_f_d_p_1_1_i_o_object.html create mode 100644 class_f_d_p_1_1_versioning_1_1version-members.html create mode 100644 class_f_d_p_1_1_versioning_1_1version.html create mode 100644 class_f_d_p_1_1config__parsing__error-members.html create mode 100644 class_f_d_p_1_1config__parsing__error.html create mode 100644 class_f_d_p_1_1config__parsing__error.png create mode 100644 class_f_d_p_1_1json__parse__error-members.html create mode 100644 class_f_d_p_1_1json__parse__error.html create mode 100644 class_f_d_p_1_1json__parse__error.png create mode 100644 class_f_d_p_1_1rest__apiquery__error-members.html create mode 100644 class_f_d_p_1_1rest__apiquery__error.html create mode 100644 class_f_d_p_1_1rest__apiquery__error.png create mode 100644 class_f_d_p_1_1sync__error-members.html create mode 100644 class_f_d_p_1_1sync__error.html create mode 100644 class_f_d_p_1_1sync__error.png create mode 100644 class_f_d_p_1_1validation__error-members.html create mode 100644 class_f_d_p_1_1validation__error.html create mode 100644 class_f_d_p_1_1validation__error.png create mode 100644 class_f_d_p_1_1write__error-members.html create mode 100644 class_f_d_p_1_1write__error.html create mode 100644 class_f_d_p_1_1write__error.png create mode 100644 classes.html create mode 100644 config_8hxx.html create mode 100644 config_8hxx_source.html create mode 100644 data__io_8hxx_source.html create mode 100644 datapipeline_8hxx.html create mode 100644 datapipeline_8hxx_source.html rename md__c_h_a_n_g_e_l_o_g.html => dir_39f1df2935b9bcc0c6b792c5d1359e85.html (73%) rename pages.html => dir_68267d1309a1af8e8297ef4c3efbcdba.html (72%) create mode 100644 dir_7b5d38f1875f1b693f62ca6a108a1129.html create mode 100644 dir_a7fa5847c07dc92c5227f8a150238560.html create mode 100644 dir_ac6c6686346e4bb6ee59787dd26cbe81.html create mode 100644 dir_cb3c39cc4ab347a95dfc53ab4ca55b3c.html create mode 100644 dir_d44c64559bbebec7f509842c48db8b23.html create mode 100644 dir_d98af0b859cb0744225e11c767d17cdb.html create mode 100644 dir_f537a5f098b413116eae11cd84c41a43.html create mode 100644 exceptions_8hxx_source.html create mode 100644 fdp_8hxx_source.html create mode 100644 files.html create mode 100644 functions.html create mode 100644 functions_func.html create mode 100644 hierarchy.html create mode 100644 io__object_8hxx_source.html create mode 100644 json_8hxx.html create mode 100644 json_8hxx_source.html create mode 100644 logging_8hxx.html create mode 100644 logging_8hxx_source.html delete mode 100644 md__r_e_a_d_m_e.html delete mode 100644 md_software_checklist.html create mode 100644 metadata_8hxx.html create mode 100644 metadata_8hxx_source.html create mode 100644 namespace_f_d_p_1_1_versioning.html create mode 100644 namespacemembers.html create mode 100644 namespacemembers_enum.html create mode 100644 namespaces.html rename search/{pages_1.html => all_10.html} (95%) create mode 100644 search/all_10.js rename search/{pages_2.html => all_11.html} (95%) create mode 100644 search/all_11.js create mode 100644 search/all_3.html create mode 100644 search/all_3.js create mode 100644 search/all_4.html create mode 100644 search/all_4.js create mode 100644 search/all_5.html create mode 100644 search/all_5.js create mode 100644 search/all_6.html create mode 100644 search/all_6.js create mode 100644 search/all_7.html create mode 100644 search/all_7.js create mode 100644 search/all_8.html create mode 100644 search/all_8.js create mode 100644 search/all_9.html create mode 100644 search/all_9.js create mode 100644 search/all_a.html create mode 100644 search/all_a.js create mode 100644 search/all_b.html create mode 100644 search/all_b.js create mode 100644 search/all_c.html create mode 100644 search/all_c.js create mode 100644 search/all_d.html create mode 100644 search/all_d.js create mode 100644 search/all_e.html create mode 100644 search/all_e.js create mode 100644 search/all_f.html create mode 100644 search/all_f.js create mode 100644 search/classes_0.html create mode 100644 search/classes_0.js create mode 100644 search/classes_1.html create mode 100644 search/classes_1.js create mode 100644 search/classes_2.html create mode 100644 search/classes_2.js create mode 100644 search/classes_3.html create mode 100644 search/classes_3.js create mode 100644 search/classes_4.html create mode 100644 search/classes_4.js create mode 100644 search/classes_5.html create mode 100644 search/classes_5.js create mode 100644 search/classes_6.html create mode 100644 search/classes_6.js create mode 100644 search/classes_7.html create mode 100644 search/classes_7.js create mode 100644 search/classes_8.html create mode 100644 search/classes_8.js create mode 100644 search/enums_0.html create mode 100644 search/enums_0.js create mode 100644 search/enums_1.html create mode 100644 search/enums_1.js create mode 100644 search/enumvalues_0.html create mode 100644 search/enumvalues_0.js create mode 100644 search/enumvalues_1.html create mode 100644 search/enumvalues_1.js create mode 100644 search/enumvalues_2.html create mode 100644 search/enumvalues_2.js create mode 100644 search/enumvalues_3.html create mode 100644 search/enumvalues_3.js create mode 100644 search/files_0.html create mode 100644 search/files_0.js create mode 100644 search/files_1.html create mode 100644 search/files_1.js create mode 100644 search/files_2.html create mode 100644 search/files_2.js create mode 100644 search/files_3.html create mode 100644 search/files_3.js create mode 100644 search/files_4.html create mode 100644 search/files_4.js create mode 100644 search/files_5.html create mode 100644 search/files_5.js create mode 100644 search/files_6.html create mode 100644 search/files_6.js create mode 100644 search/functions_0.html create mode 100644 search/functions_0.js create mode 100644 search/functions_1.html create mode 100644 search/functions_1.js create mode 100644 search/functions_10.html create mode 100644 search/functions_10.js create mode 100644 search/functions_2.html create mode 100644 search/functions_2.js create mode 100644 search/functions_3.html create mode 100644 search/functions_3.js create mode 100644 search/functions_4.html create mode 100644 search/functions_4.js create mode 100644 search/functions_5.html create mode 100644 search/functions_5.js create mode 100644 search/functions_6.html create mode 100644 search/functions_6.js create mode 100644 search/functions_7.html create mode 100644 search/functions_7.js create mode 100644 search/functions_8.html create mode 100644 search/functions_8.js create mode 100644 search/functions_9.html create mode 100644 search/functions_9.js create mode 100644 search/functions_a.html create mode 100644 search/functions_a.js create mode 100644 search/functions_b.html create mode 100644 search/functions_b.js create mode 100644 search/functions_c.html create mode 100644 search/functions_c.js create mode 100644 search/functions_d.html create mode 100644 search/functions_d.js create mode 100644 search/functions_e.html create mode 100644 search/functions_e.js create mode 100644 search/functions_f.html create mode 100644 search/functions_f.js create mode 100644 search/namespaces_0.html create mode 100644 search/namespaces_0.js delete mode 100644 search/pages_1.js delete mode 100644 search/pages_2.js create mode 100644 search/variables_0.html create mode 100644 search/variables_0.js create mode 100644 semver_8hxx.html create mode 100644 semver_8hxx_source.html diff --git a/annotated.html b/annotated.html new file mode 100644 index 0000000..5aadcb4 --- /dev/null +++ b/annotated.html @@ -0,0 +1,94 @@ + + + + + + + +cppDataPipeline: Class List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Class List
    +
    +
    +
    Here are the classes, structs, unions and interfaces with brief descriptions:
    +
    [detail level 123]
    + + + + + + + + + + + + + + + +
     ▼NFDP
     ▼NVersioningNamespace containing all semantic versioning types and classes
     CversionClass describing the semantic version of an object
     CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CApiObjectClass for API objects
     CConfigClass for interacting with confifurations
     Cconfig_parsing_error
     CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
     CIOObjectClass for API objects
     Cjson_parse_error
     Crest_apiquery_error
     Csync_error
     Cvalidation_error
     Cwrite_error
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/api_8hxx.html b/api_8hxx.html new file mode 100644 index 0000000..71c9d38 --- /dev/null +++ b/api_8hxx.html @@ -0,0 +1,220 @@ + + + + + + + +cppDataPipeline: include/fdp/registry/api.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Enumerations | +Functions
    +
    api.hxx File Reference
    +
    +
    + +

    File containing classes and methods for connecting to the RestAPI. +More...

    +
    #include <algorithm>
    +#include <curl/curl.h>
    +#include <ghc/filesystem.hpp>
    +#include <iostream>
    +#include <iterator>
    +#include <json/reader.h>
    +#include <map>
    +#include <regex>
    +#include <string>
    +#include <vector>
    +#include "fdp/exceptions.hxx"
    +#include "fdp/objects/api_object.hxx"
    +#include "fdp/utilities/json.hxx"
    +#include "fdp/utilities/logging.hxx"
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    class  FDP::API
     a class which handles the fetching and posting of information to the FDP data pipeline RestAPI More...
     
    + + + + +

    +Enumerations

    enum class  FDP::RESTAPI { REMOTE +, LOCAL + }
     selection of either local or remote pipeline running More...
     
    + + + + + + +

    +Functions

    size_t FDP::write_func_ (void *ptr, size_t size, size_t nmemb, std::string *data)
     function for writing to file from a CURL call More...
     
    +std::string FDP::url_encode (std::string url)
     
    +

    Detailed Description

    +

    File containing classes and methods for connecting to the RestAPI.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Date
    2021-05-05
    +

    The classes and methods within this file are used to access the FDP Data Pipeline RestAPI, they handle sending of requests and retrieval of data as JSON strings

    +

    Enumeration Type Documentation

    + +

    ◆ RESTAPI

    + +
    +
    + + + + + +
    + + + + +
    enum class FDP::RESTAPI
    +     		+strong
    +
    + +

    selection of either local or remote pipeline running

    +
    +
    Author
    K. Zarebski (UKAEA) & R. Field
    + + + +
    Enumerator
    REMOTE 

    Run from remote registry

    +
    LOCAL 

    Run from local registry

    +
    + +
    +
    +

    Function Documentation

    + +

    ◆ write_func_()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    size_t FDP::write_func_ (void * ptr,
    size_t size,
    size_t nmemb,
    std::string * data 
    )
    +
    + +

    function for writing to file from a CURL call

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Parameters
    + + + + + +
    ptr
    size
    nmemb
    data
    +
    +
    +
    Returns
    size_t
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/api_8hxx_source.html b/api_8hxx_source.html new file mode 100644 index 0000000..27b2956 --- /dev/null +++ b/api_8hxx_source.html @@ -0,0 +1,179 @@ + + + + + + + +cppDataPipeline: include/fdp/registry/api.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    api.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    11#ifndef __FDP_API_HXX__
    +
    12#define __FDP_API_HXX__
    +
    13
    +
    14#include <algorithm>
    +
    15#include <curl/curl.h>
    +
    16#include <ghc/filesystem.hpp>
    +
    17#include <iostream>
    +
    18#include <iterator>
    +
    19#include <json/reader.h>
    +
    20#include <map>
    +
    21#include <regex>
    +
    22#include <string>
    +
    23#include <vector>
    +
    24
    +
    25#include "fdp/exceptions.hxx"
    +
    26#include "fdp/objects/api_object.hxx"
    +
    27#include "fdp/utilities/json.hxx"
    +
    28#include "fdp/utilities/logging.hxx"
    +
    29
    +
    30namespace FDP {
    +
    37enum class RESTAPI {
    +
    38 REMOTE,
    +
    39 LOCAL
    +
    40};
    +
    41
    +
    52size_t write_func_(void *ptr, size_t size, size_t nmemb, std::string *data);
    +
    53
    +
    63class API {
    +
    64public:
    +
    71 API(std::string url_root)
    +
    72 : url_root_(API::append_with_forward_slash(url_root)) {}
    +
    73
    +
    83 Json::Value get_request(const std::string &addr_path,
    +
    84 long expected_response = 200, std::string token = "");
    +
    85
    +
    86 Json::Value patch(const std::string addr_path, Json::Value &post_data,
    +
    87 const std::string &token, long expected_response = 200);
    +
    98 Json::Value post(const std::string addr_path, Json::Value &post_data,
    +
    99 const std::string &token, long expected_response = 201);
    +
    100
    +
    101 Json::Value post_storage_root(Json::Value &post_data, const std::string &token);
    +
    102
    +
    103 Json::Value get_by_json_query(const std::string &addr_path,
    +
    104 Json::Value &query_data,
    +
    105 long expected_response = 200,
    +
    106 std::string token = "");
    +
    107
    +
    116 Json::Value get_by_id(const std::string &table, int const &id,
    +
    117 long expected_response = 200, std::string token = "");
    +
    118
    +
    125 std::string get_url_root() const { return url_root_; }
    +
    126
    +
    135 std::string json_to_query_string(Json::Value &json_value);
    +
    136
    +
    145 std::string escape_space(std::string &str);
    +
    146
    +
    154 static std::string append_with_forward_slash(std::string string);
    +
    155
    +
    162 static std::string remove_leading_forward_slash(std::string str);
    +
    163
    +
    164private:
    +
    165 std::string url_root_;
    +
    166 CURL *setup_json_session_(std::string &addr_path, std::string *response,
    +
    167 long &http_code, std::string token = "");
    +
    168 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
    +
    169 FILE *file);
    +
    170
    +
    171 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
    +
    172 const std::string &token, long expected_response, bool PATCH = false);
    +
    173
    +
    174 // Legacy Method
    +
    175 Json::Value get_request(const ghc::filesystem::path &addr_path,
    +
    176 long expected_response = 200, std::string token = "");
    +
    177
    +
    178 void download_file(const ghc::filesystem::path &url,
    +
    179 ghc::filesystem::path out_path);
    +
    180};
    +
    181
    +
    182std::string url_encode(std::string url);
    +
    183
    +
    184}; // namespace FDP
    +
    185
    +
    186#endif
    +
    FDP::write_func_
    size_t write_func_(void *ptr, size_t size, size_t nmemb, std::string *data)
    function for writing to file from a CURL call
    +
    FDP::RESTAPI
    RESTAPI
    selection of either local or remote pipeline running
    Definition: api.hxx:37
    + + +
    FDP::API
    a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
    Definition: api.hxx:63
    +
    FDP::API::post
    Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
    post information from a JSON value object to the RestAPI
    Definition: api.cxx:183
    +
    FDP::API::get_request
    Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
    sends the given 'packet' of information to the RestAPI
    Definition: api.cxx:83
    +
    FDP::API::append_with_forward_slash
    static std::string append_with_forward_slash(std::string string)
    Static function to append a given string with a "/" unless the string is empty or already ends with a...
    Definition: api.cxx:287
    +
    FDP::API::remove_leading_forward_slash
    static std::string remove_leading_forward_slash(std::string str)
    Remove the leading forward slash from a given string.
    Definition: api.cxx:300
    +
    FDP::API::escape_space
    std::string escape_space(std::string &str)
    escapes space " " characters within a string with it's html character code (%20)
    Definition: api.cxx:178
    +
    FDP::API::get_url_root
    std::string get_url_root() const
    returns the root URL for the RestAPI used by the API instance
    Definition: api.hxx:125
    +
    FDP::API::API
    API(std::string url_root)
    construct an API object using the given URL as the root
    Definition: api.hxx:71
    +
    FDP::API::json_to_query_string
    std::string json_to_query_string(Json::Value &json_value)
    Formats a json object into a string representation which can be used as a url endpoint query.
    Definition: api.cxx:142
    +
    FDP::API::get_by_id
    Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
    get an object from the api by it's id
    Definition: api.cxx:135
    +
    json.hxx
    File contains methods relating to handling of JSON based data.
    +
    logging.hxx
    File contains pointers for creating global logger during session.
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/api__object_8hxx_source.html b/api__object_8hxx_source.html new file mode 100644 index 0000000..75b0068 --- /dev/null +++ b/api__object_8hxx_source.html @@ -0,0 +1,126 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/api_object.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    api_object.hxx
    +
    +
    +
    1#ifndef __FDP_APIOBJECT_HXX__
    +
    2#define __FDP_APIOBJECT_HXX__
    +
    3
    +
    4#include <string>
    +
    5#include <cstddef>
    +
    6#include <json/value.h>
    +
    7
    +
    8#include "fdp/utilities/logging.hxx"
    +
    9
    +
    10namespace FDP {
    +
    15 class ApiObject {
    +
    16 private:
    +
    17 Json::Value obj_;
    +
    18 public:
    +
    19 ApiObject() : obj_(Json::Value()){};
    +
    25 ApiObject(Json::Value obj) : obj_(obj){}
    +
    32 int get_id();
    +
    39 static int get_id_from_string(std::string url);
    +
    40
    +
    41 std::string get_type();
    +
    47 std::string get_uri() const;
    +
    48
    +
    55 std::string get_value_as_string(std::string key) const;
    +
    56
    +
    63 int get_value_as_int(std::string key) const;
    +
    64
    +
    70 std::string get_first_component() const;
    +
    71
    +
    77 Json::Value get_object(){return obj_;}
    +
    78
    +
    85 bool is_empty();
    +
    86 };
    +
    87};
    +
    88
    +
    89#endif
    +
    FDP::ApiObject
    Class for API objects.
    Definition: api_object.hxx:15
    +
    FDP::ApiObject::get_value_as_int
    int get_value_as_int(std::string key) const
    Get the value of a given key as int object.
    Definition: api_object.cxx:40
    +
    FDP::ApiObject::is_empty
    bool is_empty()
    Check to see if the object is empty.
    Definition: api_object.cxx:44
    +
    FDP::ApiObject::get_id
    int get_id()
    Get the object id from the uri.
    Definition: api_object.cxx:9
    +
    FDP::ApiObject::get_id_from_string
    static int get_id_from_string(std::string url)
    Get the object type from the uri.
    Definition: api_object.cxx:13
    +
    FDP::ApiObject::get_uri
    std::string get_uri() const
    Get the object uri.
    Definition: api_object.cxx:33
    +
    FDP::ApiObject::get_value_as_string
    std::string get_value_as_string(std::string key) const
    Get the value of a given key as string object.
    Definition: api_object.cxx:37
    +
    FDP::ApiObject::get_first_component
    std::string get_first_component() const
    Get the first component of the object.
    Definition: api_object.cxx:51
    +
    FDP::ApiObject::ApiObject
    ApiObject(Json::Value obj)
    Construct a new Api Object object.
    Definition: api_object.hxx:25
    +
    FDP::ApiObject::get_type
    std::string get_type()
    Returns the object type from the object uri_ (table)
    Definition: api_object.cxx:25
    +
    FDP::ApiObject::get_object
    Json::Value get_object()
    Get the object as a Json::Value.
    Definition: api_object.hxx:77
    +
    logging.hxx
    File contains pointers for creating global logger during session.
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_a_p_i-members.html b/class_f_d_p_1_1_a_p_i-members.html new file mode 100644 index 0000000..9c02dff --- /dev/null +++ b/class_f_d_p_1_1_a_p_i-members.html @@ -0,0 +1,94 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::API Member List
    +
    +
    + +

    This is the complete list of members for FDP::API, including all inherited members.

    + + + + + + + + + + + + + +
    API(std::string url_root)FDP::APIinline
    append_with_forward_slash(std::string string)FDP::APIstatic
    escape_space(std::string &str)FDP::API
    get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")FDP::API
    get_by_json_query(const std::string &addr_path, Json::Value &query_data, long expected_response=200, std::string token="") (defined in FDP::API)FDP::API
    get_request(const std::string &addr_path, long expected_response=200, std::string token="")FDP::API
    get_url_root() constFDP::APIinline
    json_to_query_string(Json::Value &json_value)FDP::API
    patch(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=200) (defined in FDP::API)FDP::API
    post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)FDP::API
    post_storage_root(Json::Value &post_data, const std::string &token) (defined in FDP::API)FDP::API
    remove_leading_forward_slash(std::string str)FDP::APIstatic
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_a_p_i.html b/class_f_d_p_1_1_a_p_i.html new file mode 100644 index 0000000..bcffe11 --- /dev/null +++ b/class_f_d_p_1_1_a_p_i.html @@ -0,0 +1,482 @@ + + + + + + + +cppDataPipeline: FDP::API Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    FDP::API Class Reference
    +
    +
    + +

    a class which handles the fetching and posting of information to the FDP data pipeline RestAPI + More...

    + +

    #include <fdp/registry/api.hxx>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     API (std::string url_root)
     construct an API object using the given URL as the root More...
     
    Json::Value get_request (const std::string &addr_path, long expected_response=200, std::string token="")
     sends the given 'packet' of information to the RestAPI More...
     
    +Json::Value patch (const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=200)
     
    Json::Value post (const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
     post information from a JSON value object to the RestAPI More...
     
    +Json::Value post_storage_root (Json::Value &post_data, const std::string &token)
     
    +Json::Value get_by_json_query (const std::string &addr_path, Json::Value &query_data, long expected_response=200, std::string token="")
     
    Json::Value get_by_id (const std::string &table, int const &id, long expected_response=200, std::string token="")
     get an object from the api by it's id More...
     
    std::string get_url_root () const
     returns the root URL for the RestAPI used by the API instance More...
     
    std::string json_to_query_string (Json::Value &json_value)
     Formats a json object into a string representation which can be used as a url endpoint query. More...
     
    std::string escape_space (std::string &str)
     escapes space " " characters within a string with it's html character code (%20) More...
     
    + + + + + + + +

    +Static Public Member Functions

    static std::string append_with_forward_slash (std::string string)
     Static function to append a given string with a "/" unless the string is empty or already ends with a "/". More...
     
    static std::string remove_leading_forward_slash (std::string str)
     Remove the leading forward slash from a given string. More...
     
    +

    Detailed Description

    +

    a class which handles the fetching and posting of information to the FDP data pipeline RestAPI

    +
    +
    Author
    K. Zarebski (UKAEA) & R. Field
    +

    The API class has know specific knowledge about the RestAPI but rather provides the interface for sending/receiving data as JSON strings

    +

    Constructor & Destructor Documentation

    + +

    ◆ API()

    + +
    +
    + + + + + +
    + + + + + + + + +
    FDP::API::API (std::string url_root)
    +     		+inline
    +
    + +

    construct an API object using the given URL as the root

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Parameters
    + + +
    url_rootthe root of the query address, e.g. localhost:8000/api
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ append_with_forward_slash()

    + +
    +
    + + + + + +
    + + + + + + + + +
    std::string FDP::API::append_with_forward_slash (std::string string)
    +     		+static
    +
    + +

    Static function to append a given string with a "/" unless the string is empty or already ends with a "/".

    +
    Parameters
    + + +
    stringString to be appended with "/"
    +
    +
    +
    Returns
    std::string Appended string
    + +
    +
    + +

    ◆ escape_space()

    + +
    +
    + + + + + + + + +
    std::string FDP::API::escape_space (std::string & str)
    +
    + +

    escapes space " " characters within a string with it's html character code (%20)

    +
    Parameters
    + + +
    strstring containing space characters
    +
    +
    +
    Returns
    std::string string with space characters represented by html character code "%20"
    + +
    +
    + +

    ◆ get_by_id()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Json::Value FDP::API::get_by_id (const std::string & table,
    int const & id,
    long expected_response = 200,
    std::string token = "" 
    )
    +
    + +

    get an object from the api by it's id

    +
    Parameters
    + + + + +
    tableApi endpoint (table)
    idid of the object
    expected_responseexpected responce of the request (default 200)
    +
    +
    +
    Returns
    Json::Value
    + +
    +
    + +

    ◆ get_request()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    Json::Value FDP::API::get_request (const std::string & addr_path,
    long expected_response = 200,
    std::string token = "" 
    )
    +
    + +

    sends the given 'packet' of information to the RestAPI

    +
    Parameters
    + + + + +
    addr_paththe api endpoint a.k.a the table name e.g. "coderun"
    expected_responsethe expected return HTTP code
    token
    +
    +
    +
    Returns
    Json::Value JSON object containing the information returned by the request
    + +
    +
    + +

    ◆ get_url_root()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::API::get_url_root () const
    +     		+inline
    +
    + +

    returns the root URL for the RestAPI used by the API instance

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Returns
    URL of the RestAPI query endpoint
    + +
    +
    + +

    ◆ json_to_query_string()

    + +
    +
    + + + + + + + + +
    std::string FDP::API::json_to_query_string (Json::Value & json_value)
    +
    + +

    Formats a json object into a string representation which can be used as a url endpoint query.

    +
    Parameters
    + + +
    json_valuethe json object to be converted typically returned by the post method
    +
    +
    +
    Returns
    std::string
    + +
    +
    + +

    ◆ post()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Json::Value FDP::API::post (const std::string addr_path,
    Json::Value & post_data,
    const std::string & token,
    long expected_response = 201 
    )
    +
    + +

    post information from a JSON value object to the RestAPI

    +
    +
    Author
    K. Zarebski (UKAEA) & R. Field
    +
    Parameters
    + + + + + +
    addr_paththe api endpoint a.k.a the table name e.g. "coderun"
    post_datathe data to transmit as a Json::Value object
    keyapi token
    expected_responsethe expected HTTP return code, default is 201
    +
    +
    +
    Returns
    the result of the API post as a JSON object
    + +
    +
    + +

    ◆ remove_leading_forward_slash()

    + +
    +
    + + + + + +
    + + + + + + + + +
    std::string FDP::API::remove_leading_forward_slash (std::string str)
    +     		+static
    +
    + +

    Remove the leading forward slash from a given string.

    +
    Parameters
    + + +
    str
    +
    +
    +
    Returns
    std::string
    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • include/fdp/registry/api.hxx
      • +
    • src/registry/api.cxx
      • +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_api_object-members.html b/class_f_d_p_1_1_api_object-members.html new file mode 100644 index 0000000..8ea1563 --- /dev/null +++ b/class_f_d_p_1_1_api_object-members.html @@ -0,0 +1,93 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::ApiObject Member List
    +
    +
    + +

    This is the complete list of members for FDP::ApiObject, including all inherited members.

    + + + + + + + + + + + + +
    ApiObject() (defined in FDP::ApiObject)FDP::ApiObjectinline
    ApiObject(Json::Value obj)FDP::ApiObjectinline
    get_first_component() constFDP::ApiObject
    get_id()FDP::ApiObject
    get_id_from_string(std::string url)FDP::ApiObjectstatic
    get_object()FDP::ApiObjectinline
    get_type()FDP::ApiObject
    get_uri() constFDP::ApiObject
    get_value_as_int(std::string key) constFDP::ApiObject
    get_value_as_string(std::string key) constFDP::ApiObject
    is_empty()FDP::ApiObject
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_api_object.html b/class_f_d_p_1_1_api_object.html new file mode 100644 index 0000000..cfb14cf --- /dev/null +++ b/class_f_d_p_1_1_api_object.html @@ -0,0 +1,383 @@ + + + + + + + +cppDataPipeline: FDP::ApiObject Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    FDP::ApiObject Class Reference
    +
    +
    + +

    Class for API objects. + More...

    + +

    #include <fdp/objects/api_object.hxx>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     ApiObject (Json::Value obj)
     Construct a new Api Object object. More...
     
    int get_id ()
     Get the object id from the uri. More...
     
    std::string get_type ()
     Returns the object type from the object uri_ (table) More...
     
    std::string get_uri () const
     Get the object uri. More...
     
    std::string get_value_as_string (std::string key) const
     Get the value of a given key as string object. More...
     
    int get_value_as_int (std::string key) const
     Get the value of a given key as int object. More...
     
    std::string get_first_component () const
     Get the first component of the object. More...
     
    Json::Value get_object ()
     Get the object as a Json::Value. More...
     
    bool is_empty ()
     Check to see if the object is empty. More...
     
    + + + + +

    +Static Public Member Functions

    static int get_id_from_string (std::string url)
     Get the object type from the uri. More...
     
    +

    Detailed Description

    +

    Class for API objects.

    +

    Constructor & Destructor Documentation

    + +

    ◆ ApiObject()

    + +
    +
    + + + + + +
    + + + + + + + + +
    FDP::ApiObject::ApiObject (Json::Value obj)
    +     		+inline
    +
    + +

    Construct a new Api Object object.

    +
    Parameters
    + + +
    uriuri of the api object e.g. http://127.0.0.1/object/1
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ get_first_component()

    + +
    +
    + + + + + + + +
    std::string FDP::ApiObject::get_first_component () const
    +
    + +

    Get the first component of the object.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_id()

    + +
    +
    + + + + + + + +
    int FDP::ApiObject::get_id ()
    +
    + +

    Get the object id from the uri.

    +

    Returns the object id from the object uri_.

    +
    Returns
    int object id e.g. if the uri is http://127.0.0.1/object/1 the object id will be 1
    +
    +int of the object id
    + +
    +
    + +

    ◆ get_id_from_string()

    + +
    +
    + + + + + +
    + + + + + + + + +
    int FDP::ApiObject::get_id_from_string (std::string url)
    +     		+static
    +
    + +

    Get the object type from the uri.

    +
    Returns
    std::string the object type (table) e.g. if the uri is http://127.0.0.1/object/1 the object type will be object
    + +
    +
    + +

    ◆ get_object()

    + +
    +
    + + + + + +
    + + + + + + + +
    Json::Value FDP::ApiObject::get_object ()
    +     		+inline
    +
    + +

    Get the object as a Json::Value.

    +
    Returns
    Json::Value
    + +
    +
    + +

    ◆ get_type()

    + +
    +
    + + + + + + + +
    std::string FDP::ApiObject::get_type ()
    +
    + +

    Returns the object type from the object uri_ (table)

    +
    Returns
    std::string The object type
    + +
    +
    + +

    ◆ get_uri()

    + +
    +
    + + + + + + + +
    std::string FDP::ApiObject::get_uri () const
    +
    + +

    Get the object uri.

    +
    Returns
    std::string the uri of the object e.g. http://127.0.0.1/object/1
    + +
    +
    + +

    ◆ get_value_as_int()

    + +
    +
    + + + + + + + + +
    int FDP::ApiObject::get_value_as_int (std::string key) const
    +
    + +

    Get the value of a given key as int object.

    +
    Parameters
    + + +
    key
    +
    +
    +
    Returns
    int
    + +
    +
    + +

    ◆ get_value_as_string()

    + +
    +
    + + + + + + + + +
    std::string FDP::ApiObject::get_value_as_string (std::string key) const
    +
    + +

    Get the value of a given key as string object.

    +
    Parameters
    + + +
    key
    +
    +
    +
    Returns
    std::string
    + +
    +
    + +

    ◆ is_empty()

    + +
    +
    + + + + + + + +
    bool FDP::ApiObject::is_empty ()
    +
    + +

    Check to see if the object is empty.

    +
    Returns
    true the object does not contain any data
    +
    +false the object contains data
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_config-members.html b/class_f_d_p_1_1_config-members.html new file mode 100644 index 0000000..144807a --- /dev/null +++ b/class_f_d_p_1_1_config-members.html @@ -0,0 +1,107 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::Config Member List
    +
    +
    + +

    This is the complete list of members for FDP::Config, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Config(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)FDP::Config
    config_reads_() constFDP::Config
    config_writes_() constFDP::Config
    finalise()FDP::Config
    get_api()FDP::Configinline
    get_api_url() constFDP::Configinline
    get_code_run_uuid() constFDP::Config
    get_config_data() constFDP::Configinline
    get_config_directory() constFDP::Config
    get_config_file_path() constFDP::Configinline
    get_data_store() constFDP::Config
    get_default_input_namespace() constFDP::Config
    get_default_output_namespace() constFDP::Config
    get_rest_api_location()FDP::Configinline
    get_script_file_path() constFDP::Configinline
    get_token() constFDP::Configinline
    has_inputs() constFDP::Config
    has_outputs() constFDP::Config
    has_reads() constFDP::Config
    has_writes() constFDP::Config
    link_read(std::string &data_product)FDP::Config
    link_write(std::string &data_product)FDP::Config
    meta_data_() constFDP::Config
    parse_yaml(ghc::filesystem::path yaml_path)FDP::Configstatic
    ~Config()FDP::Config
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_config.html b/class_f_d_p_1_1_config.html new file mode 100644 index 0000000..76a4937 --- /dev/null +++ b/class_f_d_p_1_1_config.html @@ -0,0 +1,766 @@ + + + + + + + +cppDataPipeline: FDP::Config Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    FDP::Config Class Reference
    +
    +
    + +

    class for interacting with confifurations + More...

    + +

    #include <fdp/objects/config.hxx>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Config (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
     Construct a new Config object. More...
     
    + ~Config ()
     Destroy the Config object.
     
    YAML::Node meta_data_ () const
     Returns the meta_data Yaml Node from the config. More...
     
    YAML::Node config_writes_ () const
     Returns the writes Yaml Node from the config. More...
     
    YAML::Node config_reads_ () const
     Returns the reads Yaml Node from the config. More...
     
    bool has_reads () const
     Check whether the config has reads. More...
     
    bool has_writes () const
     Check whether the config has writes. More...
     
    bool has_outputs () const
     Check whether any outputs have been added. More...
     
    bool has_inputs () const
     Check whether any inputs have been added. More...
     
    ghc::filesystem::path get_config_file_path () const
     Get the config file path object. More...
     
    ghc::filesystem::path get_script_file_path () const
     Get the script file path object. More...
     
    std::string get_token () const
     Get the token as a string. More...
     
    std::string get_api_url () const
     Get the api url. More...
     
    ghc::filesystem::path get_data_store () const
     Get the data store path. More...
     
    std::string get_default_input_namespace () const
     Get the default input namespace. More...
     
    std::string get_default_output_namespace () const
     Get the default output namespace. More...
     
    std::string get_config_directory () const
     Get the config directory path as a string. More...
     
    std::string get_code_run_uuid () const
     Get the code run uuid. More...
     
    ghc::filesystem::path link_write (std::string &data_product)
     Provide a tempory file path for a given data product to be written whilst recording metadata. More...
     
    ghc::filesystem::path link_read (std::string &data_product)
     Return the filepath to a given data product. More...
     
    +void finalise ()
     Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their new filename(s): <file hash>.<extension>
     
    YAML::Node get_config_data () const
     Get the config data as a Yaml Node. More...
     
    std::shared_ptr< API > get_api ()
     Get the api object (used to interact with the pipeline directly) More...
     
    RESTAPI get_rest_api_location ()
     Get the rest api location (local / remote) More...
     
    + + + + +

    +Static Public Member Functions

    static YAML::Node parse_yaml (ghc::filesystem::path yaml_path)
     Read a given yaml file into a Yaml Node. More...
     
    +

    Detailed Description

    +

    class for interacting with confifurations

    +

    Constructor & Destructor Documentation

    + +

    ◆ Config()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FDP::Config::Config (const ghc::filesystem::path & config_file_path,
    const ghc::filesystem::path & script_file_path,
    const std::string & token,
    RESTAPI api_location 
    )
    +
    + +

    Construct a new Config object.

    +
    Parameters
    + + + + + +
    config_file_paththe path to the config file
    script_file_paththe path to the script file
    tokenthe API token as a String
    api_locationwhether or not the api is local
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ config_reads_()

    + +
    +
    + + + + + + + +
    YAML::Node FDP::Config::config_reads_ () const
    +
    + +

    Returns the reads Yaml Node from the config.

    +
    Returns
    YAML::Node
    + +
    +
    + +

    ◆ config_writes_()

    + +
    +
    + + + + + + + +
    YAML::Node FDP::Config::config_writes_ () const
    +
    + +

    Returns the writes Yaml Node from the config.

    +
    Returns
    YAML::Node
    + +
    +
    + +

    ◆ get_api()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::shared_ptr< API > FDP::Config::get_api ()
    +     		+inline
    +
    + +

    Get the api object (used to interact with the pipeline directly)

    +
    Returns
    std::shared_ptr<API>
    + +
    +
    + +

    ◆ get_api_url()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::Config::get_api_url () const
    +     		+inline
    +
    + +

    Get the api url.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_code_run_uuid()

    + +
    +
    + + + + + + + +
    std::string FDP::Config::get_code_run_uuid () const
    +
    + +

    Get the code run uuid.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_config_data()

    + +
    +
    + + + + + +
    + + + + + + + +
    YAML::Node FDP::Config::get_config_data () const
    +     		+inline
    +
    + +

    Get the config data as a Yaml Node.

    +
    Returns
    YAML::Node
    + +
    +
    + +

    ◆ get_config_directory()

    + +
    +
    + + + + + + + +
    std::string FDP::Config::get_config_directory () const
    +
    + +

    Get the config directory path as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_config_file_path()

    + +
    +
    + + + + + +
    + + + + + + + +
    ghc::filesystem::path FDP::Config::get_config_file_path () const
    +     		+inline
    +
    + +

    Get the config file path object.

    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ get_data_store()

    + +
    +
    + + + + + + + +
    ghc::filesystem::path FDP::Config::get_data_store () const
    +
    + +

    Get the data store path.

    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ get_default_input_namespace()

    + +
    +
    + + + + + + + +
    std::string FDP::Config::get_default_input_namespace () const
    +
    + +

    Get the default input namespace.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_default_output_namespace()

    + +
    +
    + + + + + + + +
    std::string FDP::Config::get_default_output_namespace () const
    +
    + +

    Get the default output namespace.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_rest_api_location()

    + +
    +
    + + + + + +
    + + + + + + + +
    RESTAPI FDP::Config::get_rest_api_location ()
    +     		+inline
    +
    + +

    Get the rest api location (local / remote)

    +
    Returns
    RESTAPI
    + +
    +
    + +

    ◆ get_script_file_path()

    + +
    +
    + + + + + +
    + + + + + + + +
    ghc::filesystem::path FDP::Config::get_script_file_path () const
    +     		+inline
    +
    + +

    Get the script file path object.

    +
    Returns
    ghc::filesystem::path
    +

    Get the script file path object

    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ get_token()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::Config::get_token () const
    +     		+inline
    +
    + +

    Get the token as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ has_inputs()

    + +
    +
    + + + + + + + +
    bool FDP::Config::has_inputs () const
    +
    + +

    Check whether any inputs have been added.

    +
    Returns
    true inputs have been added
    +
    +false inputs have not been added
    + +
    +
    + +

    ◆ has_outputs()

    + +
    +
    + + + + + + + +
    bool FDP::Config::has_outputs () const
    +
    + +

    Check whether any outputs have been added.

    +
    Returns
    true outputs have been added
    +
    +false outputs have not been added
    + +
    +
    + +

    ◆ has_reads()

    + +
    +
    + + + + + + + +
    bool FDP::Config::has_reads () const
    +
    + +

    Check whether the config has reads.

    +
    Returns
    true config has reads
    +
    +false config does not have reads
    + +
    +
    + +

    ◆ has_writes()

    + +
    +
    + + + + + + + +
    bool FDP::Config::has_writes () const
    +
    + +

    Check whether the config has writes.

    +
    Returns
    true the config has writes
    +
    +false the config does not have writes
    + +
    +
    + +

    ◆ link_read()

    + +
    +
    + + + + + + + + +
    ghc::filesystem::path FDP::Config::link_read (std::string & data_product)
    +
    + +

    Return the filepath to a given data product.

    +
    Parameters
    + + +
    data_product
    +
    +
    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ link_write()

    + +
    +
    + + + + + + + + +
    ghc::filesystem::path FDP::Config::link_write (std::string & data_product)
    +
    + +

    Provide a tempory file path for a given data product to be written whilst recording metadata.

    +
    Parameters
    + + +
    data_product
    +
    +
    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ meta_data_()

    + +
    +
    + + + + + + + +
    YAML::Node FDP::Config::meta_data_ () const
    +
    + +

    Returns the meta_data Yaml Node from the config.

    +
    Returns
    YAML::Node
    + +
    +
    + +

    ◆ parse_yaml()

    + +
    +
    + + + + + +
    + + + + + + + + +
    YAML::Node FDP::Config::parse_yaml (ghc::filesystem::path yaml_path)
    +     		+static
    +
    + +

    Read a given yaml file into a Yaml Node.

    +
    Parameters
    + + +
    yaml_path
    +
    +
    +
    Returns
    YAML::Node
    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • include/fdp/objects/config.hxx
      • +
    • src/objects/config.cxx
      • +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_data_pipeline-members.html b/class_f_d_p_1_1_data_pipeline-members.html new file mode 100644 index 0000000..abed8ce --- /dev/null +++ b/class_f_d_p_1_1_data_pipeline-members.html @@ -0,0 +1,91 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::DataPipeline Member List
    +
    +
    + +

    This is the complete list of members for FDP::DataPipeline, including all inherited members.

    + + + + + + + + + + +
    DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)FDP::DataPipelineinlineexplicit
    DataPipeline(DataPipeline &&rhs) noexcept (defined in FDP::DataPipeline)FDP::DataPipeline
    DataPipeline(const DataPipeline &rhs) (defined in FDP::DataPipeline)FDP::DataPipeline
    finalise()FDP::DataPipeline
    link_read(std::string &data_product)FDP::DataPipeline
    link_write(std::string &data_product)FDP::DataPipeline
    operator=(DataPipeline &&rhs) noexcept (defined in FDP::DataPipeline)FDP::DataPipeline
    operator=(const DataPipeline &rhs) (defined in FDP::DataPipeline)FDP::DataPipeline
    ~DataPipeline()FDP::DataPipeline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_data_pipeline.html b/class_f_d_p_1_1_data_pipeline.html new file mode 100644 index 0000000..c9bbade --- /dev/null +++ b/class_f_d_p_1_1_data_pipeline.html @@ -0,0 +1,241 @@ + + + + + + + +cppDataPipeline: FDP::DataPipeline Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::DataPipeline Class Reference
    +
    +
    + +

    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline. + More...

    + +

    #include <fdp/fdp.hxx>

    + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     DataPipeline (const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
     Construct a new Data Pipeline (PIMPL) More...
     
    + ~DataPipeline ()
     Destroy the Data Pipeline object.
     
    + DataPipeline (DataPipeline &&rhs) noexcept
     
    +DataPipeline & operator= (DataPipeline &&rhs) noexcept
     
    + DataPipeline (const DataPipeline &rhs)
     
    +DataPipeline & operator= (const DataPipeline &rhs)
     
    ghc::filesystem::path link_read (std::string &data_product)
     Return a path to a given data product Whilst recording it's meta data for the code run. More...
     
    ghc::filesystem::path link_write (std::string &data_product)
     Return a path to be used for a given data product whilst recording it's meta data. More...
     
    +void finalise ()
     Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
     
    +

    Detailed Description

    +

    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.

    +

    Constructor & Destructor Documentation

    + +

    ◆ DataPipeline()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FDP::DataPipeline::DataPipeline (const std::string & config_file_path,
    const std::string & script_file_path,
    std::string token = "",
    spdlog::level::level_enum log_level = spdlog::level::info 
    )
    +     		+inlineexplicit
    +
    + +

    Construct a new Data Pipeline (PIMPL)

    +
    Parameters
    + + + + + +
    config_file_path
    script_file_path
    token
    log_level
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ link_read()

    + +
    +
    + + + + + + + + +
    ghc::filesystem::path FDP::DataPipeline::link_read (std::string & data_product)
    +
    + +

    Return a path to a given data product Whilst recording it's meta data for the code run.

    +
    Parameters
    + + +
    data_product
    +
    +
    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ link_write()

    + +
    +
    + + + + + + + + +
    ghc::filesystem::path FDP::DataPipeline::link_write (std::string & data_product)
    +
    + +

    Return a path to be used for a given data product whilst recording it's meta data.

    +
    Parameters
    + + +
    data_product
    +
    +
    +
    Returns
    ghc::filesystem::path
    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • include/fdp/fdp.hxx
      • +
    • src/fdp.cxx
      • +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_data_pipeline_impl__-members.html b/class_f_d_p_1_1_data_pipeline_impl__-members.html new file mode 100644 index 0000000..264bf16 --- /dev/null +++ b/class_f_d_p_1_1_data_pipeline_impl__-members.html @@ -0,0 +1,89 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::DataPipelineImpl_ Member List
    +
    +
    + +

    This is the complete list of members for FDP::DataPipelineImpl_, including all inherited members.

    + + + + + + + + +
    DataPipelineImpl_(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)FDP::DataPipelineImpl_
    DataPipelineImpl_(const DataPipelineImpl_ &dp) (defined in FDP::DataPipelineImpl_)FDP::DataPipelineImpl_inline
    finalise()FDP::DataPipelineImpl_
    get_code_run_uuid()FDP::DataPipelineImpl_
    link_read(std::string &data_product)FDP::DataPipelineImpl_
    link_write(std::string &data_product)FDP::DataPipelineImpl_
    ~DataPipelineImpl_()=defaultFDP::DataPipelineImpl_
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_data_pipeline_impl__.html b/class_f_d_p_1_1_data_pipeline_impl__.html new file mode 100644 index 0000000..dc8971b --- /dev/null +++ b/class_f_d_p_1_1_data_pipeline_impl__.html @@ -0,0 +1,257 @@ + + + + + + + +cppDataPipeline: FDP::DataPipelineImpl_ Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::DataPipelineImpl_ Class Reference
    +
    +
    + +

    private pointer-to-implementation class containing all backend methods + More...

    + +

    #include <fdp/registry/datapipeline.hxx>

    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     DataPipelineImpl_ (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
     construct a DataPipelineImpl_ instance from configurations and setup More...
     
    + DataPipelineImpl_ (const DataPipelineImpl_ &dp)
     
    + ~DataPipelineImpl_ ()=default
     Default Destructor.
     
    ghc::filesystem::path link_read (std::string &data_product)
     Return a path to a given data product Whilst recording it's meta data for the code run. More...
     
    ghc::filesystem::path link_write (std::string &data_product)
     Return a path to be used for a given data product whilst recording it's meta data. More...
     
    +void finalise ()
     Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
     
    std::string get_code_run_uuid ()
     Get the code run uuid. More...
     
    +

    Detailed Description

    +

    private pointer-to-implementation class containing all backend methods

    +
    +

    This class performs all behind the scenes operations acting as the backend to the user called FDP::DataPipeline class. This structure has been chosen to allow for unit tests to be created to test all methods including private ones.

    +
    Warning
    The class should not be used directly during implementation, but rather via an FDP::DataPipeline instance.
    +

    Constructor & Destructor Documentation

    + +

    ◆ DataPipelineImpl_()

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FDP::DataPipelineImpl_::DataPipelineImpl_ (const ghc::filesystem::path & config_file_path,
    const ghc::filesystem::path & file_system_path,
    const std::string token,
    spdlog::level::level_enum log_level = spdlog::level::info,
    RESTAPI api_location = RESTAPI::LOCAL 
    )
    +
    + +

    construct a DataPipelineImpl_ instance from configurations and setup

    +
    +
    Parameters
    + + + + + +
    config_file_pathlocation of the local configuration file
    access_token_fileAPI authorisation token where required
    log_levellevel for the output logging statements
    api_locationwhether to use local/remote RestAPI endpoint
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ get_code_run_uuid()

    + +
    +
    + + + + + + + +
    std::string FDP::DataPipelineImpl_::get_code_run_uuid ()
    +
    + +

    Get the code run uuid.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ link_read()

    + +
    +
    + + + + + + + + +
    ghc::filesystem::path FDP::DataPipelineImpl_::link_read (std::string & data_product)
    +
    + +

    Return a path to a given data product Whilst recording it's meta data for the code run.

    +
    Parameters
    + + +
    data_product
    +
    +
    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ link_write()

    + +
    +
    + + + + + + + + +
    ghc::filesystem::path FDP::DataPipelineImpl_::link_write (std::string & data_product)
    +
    + +

    Return a path to be used for a given data product whilst recording it's meta data.

    +
    Parameters
    + + +
    data_product
    +
    +
    +
    Returns
    ghc::filesystem::path
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_i_o_object-members.html b/class_f_d_p_1_1_i_o_object-members.html new file mode 100644 index 0000000..be7e5c7 --- /dev/null +++ b/class_f_d_p_1_1_i_o_object-members.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::IOObject Member List
    +
    +
    + +

    This is the complete list of members for FDP::IOObject, including all inherited members.

    + + + + + + + + + + + + + + + + + +
    get_component_description()FDP::IOObjectinline
    get_component_object()FDP::IOObjectinline
    get_data_product()FDP::IOObjectinline
    get_data_product_description()FDP::IOObjectinline
    get_data_product_object()FDP::IOObjectinline
    get_path()FDP::IOObjectinline
    get_use_component()FDP::IOObjectinline
    get_use_data_product()FDP::IOObjectinline
    get_use_namespace()FDP::IOObjectinline
    get_use_version()FDP::IOObjectinline
    IOObject()FDP::IOObjectinline
    IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)FDP::IOObjectinline
    IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)FDP::IOObjectinline
    is_public()FDP::IOObjectinline
    set_component_object(ApiObject &component_obj)FDP::IOObjectinline
    set_data_product_object(ApiObject &data_product_obj)FDP::IOObjectinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_i_o_object.html b/class_f_d_p_1_1_i_o_object.html new file mode 100644 index 0000000..c17166e --- /dev/null +++ b/class_f_d_p_1_1_i_o_object.html @@ -0,0 +1,685 @@ + + + + + + + +cppDataPipeline: FDP::IOObject Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::IOObject Class Reference
    +
    +
    + +

    Class for API objects. + More...

    + +

    #include <fdp/objects/io_object.hxx>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + IOObject ()
     Construct a new IOObject object (empty constructor)
     
     IOObject (std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)
     Construct a new IOObject object Used to store inputs and outputs for in the config. More...
     
     IOObject (std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
     Construct a new IOObject object Used to store inputs and outputs for in the config. More...
     
    std::string get_data_product ()
     Get the data product as a string. More...
     
    std::string get_use_data_product ()
     Get the use data product as a string. More...
     
    std::string get_use_component ()
     Get the use component as a string. More...
     
    std::string get_use_version ()
     Get the use version as a string. More...
     
    std::string get_use_namespace ()
     Get the use namespace as a string. More...
     
    ghc::filesystem::path get_path ()
     Get the path of the data product. More...
     
    std::string get_data_product_description ()
     Get the data product description as a string. More...
     
    std::string get_component_description ()
     Get the component description as a string. More...
     
    bool is_public ()
     Check whether the data product is public. More...
     
    std::shared_ptr< ApiObject > get_component_object ()
     Get the component object object. More...
     
    std::shared_ptr< ApiObject > get_data_product_object ()
     Get the data product object object. More...
     
    void set_component_object (ApiObject &component_obj)
     Set the component object object. More...
     
    void set_data_product_object (ApiObject &data_product_obj)
     Set the data product object object. More...
     
    +

    Detailed Description

    +

    Class for API objects.

    +

    Constructor & Destructor Documentation

    + +

    ◆ IOObject() [1/2]

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FDP::IOObject::IOObject (std::string data_product,
    std::string use_data_product,
    std::string use_version,
    std::string use_namespace,
    ghc::filesystem::path path,
    std::string data_product_description,
    bool isPublic 
    )
    +     		+inline
    +
    + +

    Construct a new IOObject object Used to store inputs and outputs for in the config.

    +
    Parameters
    + + + + + + + + +
    data_productdata_product name as string
    use_data_productdata_product name to be used as string
    use_versiondata_product version to be used as string
    use_namespacenamespace to be used as string
    pathfile path to data_product
    data_product_descriptiondata product description
    isPublicwhether or not the data product should be public
    +
    +
    + +
    +
    + +

    ◆ IOObject() [2/2]

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FDP::IOObject::IOObject (std::string data_product,
    std::string use_data_product,
    std::string use_version,
    std::string use_namespace,
    ghc::filesystem::path path,
    ApiObject & component_obj,
    ApiObject & data_product_obj 
    )
    +     		+inline
    +
    + +

    Construct a new IOObject object Used to store inputs and outputs for in the config.

    +
    Parameters
    + + + + + + + + +
    data_productdata_product name as string
    use_data_productdata_product name to be used as string
    use_versiondata_product version to be used as string
    use_namespacenamespace to be used as string
    pathfile path to data_product
    component_objthe data_product component object as a shared pointer
    data_product_objthe data_product object as a shared pointer
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ get_component_description()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_component_description ()
    +     		+inline
    +
    + +

    Get the component description as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_component_object()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::shared_ptr< ApiObject > FDP::IOObject::get_component_object ()
    +     		+inline
    +
    + +

    Get the component object object.

    +
    Returns
    std::shared_ptr<ApiObject>
    + +
    +
    + +

    ◆ get_data_product()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_data_product ()
    +     		+inline
    +
    + +

    Get the data product as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_data_product_description()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_data_product_description ()
    +     		+inline
    +
    + +

    Get the data product description as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_data_product_object()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::shared_ptr< ApiObject > FDP::IOObject::get_data_product_object ()
    +     		+inline
    +
    + +

    Get the data product object object.

    +
    Returns
    std::shared_ptr<ApiObject>
    + +
    +
    + +

    ◆ get_path()

    + +
    +
    + + + + + +
    + + + + + + + +
    ghc::filesystem::path FDP::IOObject::get_path ()
    +     		+inline
    +
    + +

    Get the path of the data product.

    +
    Returns
    ghc::filesystem::path
    + +
    +
    + +

    ◆ get_use_component()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_use_component ()
    +     		+inline
    +
    + +

    Get the use component as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_use_data_product()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_use_data_product ()
    +     		+inline
    +
    + +

    Get the use data product as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_use_namespace()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_use_namespace ()
    +     		+inline
    +
    + +

    Get the use namespace as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ get_use_version()

    + +
    +
    + + + + + +
    + + + + + + + +
    std::string FDP::IOObject::get_use_version ()
    +     		+inline
    +
    + +

    Get the use version as a string.

    +
    Returns
    std::string
    + +
    +
    + +

    ◆ is_public()

    + +
    +
    + + + + + +
    + + + + + + + +
    bool FDP::IOObject::is_public ()
    +     		+inline
    +
    + +

    Check whether the data product is public.

    +
    Returns
    true the data product is public
    +
    +false the data product is not public
    + +
    +
    + +

    ◆ set_component_object()

    + +
    +
    + + + + + +
    + + + + + + + + +
    void FDP::IOObject::set_component_object (ApiObject & component_obj)
    +     		+inline
    +
    + +

    Set the component object object.

    +
    Parameters
    + + +
    component_obj
    +
    +
    + +
    +
    + +

    ◆ set_data_product_object()

    + +
    +
    + + + + + +
    + + + + + + + + +
    void FDP::IOObject::set_data_product_object (ApiObject & data_product_obj)
    +     		+inline
    +
    + +

    Set the data product object object.

    +
    Parameters
    + + +
    data_product_obj
    +
    +
    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_versioning_1_1version-members.html b/class_f_d_p_1_1_versioning_1_1version-members.html new file mode 100644 index 0000000..818e1da --- /dev/null +++ b/class_f_d_p_1_1_versioning_1_1version-members.html @@ -0,0 +1,101 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::Versioning::version Member List
    +
    +
    + +

    This is the complete list of members for FDP::Versioning::version, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + +
    alpha() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    beta() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    bump_major() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    bump_minor() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    bump_patch() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    operator!= (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    operator< (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    operator<< (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    operator<= (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    operator== (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    operator> (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    operator>= (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
    prerelease() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    release() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    to_string() const (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    version()=defaultFDP::Versioning::version
    version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")FDP::Versioning::versioninline
    version(const std::string version_str) (defined in FDP::Versioning::version)FDP::Versioning::version
    version(const version &v) (defined in FDP::Versioning::version)FDP::Versioning::versioninline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1_versioning_1_1version.html b/class_f_d_p_1_1_versioning_1_1version.html new file mode 100644 index 0000000..bd46aed --- /dev/null +++ b/class_f_d_p_1_1_versioning_1_1version.html @@ -0,0 +1,268 @@ + + + + + + + +cppDataPipeline: FDP::Versioning::version Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Friends | +List of all members
    +
    FDP::Versioning::version Class Reference
    +
    +
    + +

    class describing the semantic version of an object + More...

    + +

    #include <fdp/utilities/semver.hxx>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     version ()=default
     Construct a new version with the default start value of 0.1.0 More...
     
     version (unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
     Construct a new version from integer representation. More...
     
    + version (const std::string version_str)
     
    + version (const version &v)
     
    +void bump_major ()
     
    +void bump_minor ()
     
    +void bump_patch ()
     
    +void alpha ()
     
    +void beta ()
     
    +void prerelease ()
     
    +void release ()
     
    +std::string to_string () const
     
    + + + + + + + + + + + + + + + +

    +Friends

    +std::ostream & operator<< (std::ostream &os, const version &v)
     
    +bool operator< (const version &v1, const version &v2)
     
    +bool operator> (const version &v1, const version &v2)
     
    +bool operator== (const version &v1, const version &v2)
     
    +bool operator!= (const version &v1, const version &v2)
     
    +bool operator<= (const version &v1, const version &v2)
     
    +bool operator>= (const version &v1, const version &v2)
     
    +

    Detailed Description

    +

    class describing the semantic version of an object

    +
    +
    Author
    K. Zarebski (UKAEA)
    +

    This class allows the comparison and validation of semantic version numbers and ensures that all data objects handled follow the same protocol

    +

    Constructor & Destructor Documentation

    + +

    ◆ version() [1/2]

    + +
    +
    + + + + + +
    + + + + + + + +
    FDP::Versioning::version::version ()
    +     		+default
    +
    + +

    Construct a new version with the default start value of 0.1.0

    +
    +
    Author
    K. Zarebski (UKAEA)
    + +
    +
    + +

    ◆ version() [2/2]

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FDP::Versioning::version::version (unsigned int major,
    unsigned int minor,
    unsigned int patch,
    meta_tag tag = meta_tag::RELEASE,
    unsigned int tag_v = 1E9,
    std::string meta_data = "" 
    )
    +     		+inline
    +
    + +

    Construct a new version from integer representation.

    +
    +

    Constructs a version object with the forms:

    +

    MAJOR.MINOR.PATCH-<tag>.<tag-version>+<meta-data>

    +

    where parts in <> are optional. The default for tag_v of 1E9 is used to, as a default, represent a version that is a full release

    +
    Parameters
    + + + + + + + +
    majorthe MAJOR release number
    minorthe MINOR release number
    patchthe PATCH release number
    tagif applicable, whether release is alpha, beta etc.
    tag_vif applicable, the version of the tag, e.g. -alpha.2
    meta_dataif applicable, additional metadata, e.g. +<build_num>
    +
    +
    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • include/fdp/utilities/semver.hxx
      • +
    • src/utilities/semver.cxx
      • +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1config__parsing__error-members.html b/class_f_d_p_1_1config__parsing__error-members.html new file mode 100644 index 0000000..2f05944 --- /dev/null +++ b/class_f_d_p_1_1config__parsing__error-members.html @@ -0,0 +1,83 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::config_parsing_error Member List
    +
    +
    + +

    This is the complete list of members for FDP::config_parsing_error, including all inherited members.

    + + +
    config_parsing_error(const std::string message) (defined in FDP::config_parsing_error)FDP::config_parsing_errorinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1config__parsing__error.html b/class_f_d_p_1_1config__parsing__error.html new file mode 100644 index 0000000..e7e8bd5 --- /dev/null +++ b/class_f_d_p_1_1config__parsing__error.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: FDP::config_parsing_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::config_parsing_error Class Reference
    +
    +
    +
    +Inheritance diagram for FDP::config_parsing_error:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + config_parsing_error (const std::string message)
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1config__parsing__error.png b/class_f_d_p_1_1config__parsing__error.png new file mode 100644 index 0000000000000000000000000000000000000000..5cdd69ce549046b406fc469c3b392294ec111f6c GIT binary patch literal 645 zcmeAS@N?(olHy`uVBq!ia0vp^i-9D2pH{!6NUX>K); zkCsx&oNjo0+fB2$SN>{0lXve*O8K4V2 z-95V|_e~Oc{w^b}ESKTjQ?`P_x&t4}cJF(_Z*fmlU;ig}U*vU$^a*_og_i^s{H&Oc zc)B-OyyOs2mt}mkMA>0Z2}{Rhgyc_u*|TT#_}B_Ep{iH*6|+t)&SkK8uy)e#Vxw7$ z_sWzF{5B*=e zZP)&l{%%|MXU28UFD*8;d3*fa#@qdQYUhvD9-3eE{qsHE7iBZwe^Tmabhm%L?OHTr z?D>4Fb#Ys^CWlS^zAV}Pg!azIe|PL%z5Uzc9m#*~wkbYa`nh!Py6(5T)-5d;xo~Pn zZtv8CmhwBFFJ-oP(0hH}!yPq-r-gWWuCp`96nV+*Ht+2*UsASC`2aiA + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::json_parse_error Member List
    +
    +
    + +

    This is the complete list of members for FDP::json_parse_error, including all inherited members.

    + + +
    json_parse_error(const std::string message) (defined in FDP::json_parse_error)FDP::json_parse_errorinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1json__parse__error.html b/class_f_d_p_1_1json__parse__error.html new file mode 100644 index 0000000..3c099b1 --- /dev/null +++ b/class_f_d_p_1_1json__parse__error.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: FDP::json_parse_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::json_parse_error Class Reference
    +
    +
    +
    +Inheritance diagram for FDP::json_parse_error:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + json_parse_error (const std::string message)
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1json__parse__error.png b/class_f_d_p_1_1json__parse__error.png new file mode 100644 index 0000000000000000000000000000000000000000..952c6b194eef05fe2e6e0ea271907d006d689bf4 GIT binary patch literal 612 zcmeAS@N?(olHy`uVBq!ia0vp^y+9nm!3-pY71+{%lth3}i0l9V|AEXGZ@!lHADRGU zf$@O@2Ut7r$OE|?B|(0{3_wL7aP?G(5d#C`XHOT$kP61PbMH=DtRTR)I{(w&|I+6* zn0PPGdUNc}!!u=lsZ;JVN$oj$CP&i1Gpc3F#3eI8ID5A8d(Vl#j}^D~s@y%ivNyL` z&;0u1Z+rH>H4f^YGTk|6{o^Rj&b>X}6P8RgmY)3U>bzHvXH;pJE9>81{d1S9<0Ln| zoT>npv%l>p{}C0R?xQ@(q;O|Yee&kNf1IwCsa)<*@r`l$IQihb^JmWs)L%cgr0(yA zj}Mh^R@CM#y*2NXEbqrxo4uzN_yIZ{9N1p zBCk00Z%X)tzdgP7@r37bw^hC?UQN6z_RHe=4#}KnJ2EYw-~A!?yvOqV{x2(c%$dDW zG5lxFg<6;6EIiIqpYCsw4Aa^)Q_4Q`Nq_FKea{%Ua+dA*D0(k?W!b$ma+l{x?S5IA z%N+A|<-R$=@#|$ZuP=RPHSOMJP4*v`&9V#|yyLc1UXwk*`@~#EK`oadY1(E(;M1& literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1rest__apiquery__error-members.html b/class_f_d_p_1_1rest__apiquery__error-members.html new file mode 100644 index 0000000..fb05518 --- /dev/null +++ b/class_f_d_p_1_1rest__apiquery__error-members.html @@ -0,0 +1,83 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::rest_apiquery_error Member List
    +
    +
    + +

    This is the complete list of members for FDP::rest_apiquery_error, including all inherited members.

    + + +
    rest_apiquery_error(const std::string message) (defined in FDP::rest_apiquery_error)FDP::rest_apiquery_errorinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1rest__apiquery__error.html b/class_f_d_p_1_1rest__apiquery__error.html new file mode 100644 index 0000000..2a58bbf --- /dev/null +++ b/class_f_d_p_1_1rest__apiquery__error.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: FDP::rest_apiquery_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::rest_apiquery_error Class Reference
    +
    +
    +
    +Inheritance diagram for FDP::rest_apiquery_error:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + rest_apiquery_error (const std::string message)
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1rest__apiquery__error.png b/class_f_d_p_1_1rest__apiquery__error.png new file mode 100644 index 0000000000000000000000000000000000000000..7077bcba3a0b2ceae269e903b0a9ac940da5f74c GIT binary patch literal 651 zcmeAS@N?(olHy`uVBq!ia0vp^bAUL2gBeKP_Ia}bNJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?y~NqM?BhEy=VoqMzFumTUOyZ+Aq|Bv^Y zPuO#$@6qK;!cqOs1`iw;eCV1PxjJFe6}4EuNk%1>o~H^t^YT8ediwe1-_3gh{U*J8 z>T|Abf{(en!Ibv=FK%{N}OSOs#C`a7EAGb56_*SsxVDwXtlTqu`g~m3M3I zuXLL9&2su`>8$6u{|>9vzcrukBj{=M;MAtHCvEooSDm()q^ab|K1cnCr$(Rh_OsJw zKlNF4-R)ey?a4=9vrk8Dy1L&yr}lrvt4*`lZq3*AzGQd5x~8|Y;8U@pr~8-Yc!)DE zJXO&=9DMG~nm~rUCyW=gbWhvL@!sC5^Svbd`nt@W^VTw0?vin6(_^2o@HAt}iy{U| z+}s~(md2aI4l>+Y0#({|XO7(E^py-24_@5toxHZF?#;t6E(YsAPDj2!ZTsz&mlM$x z)#ZI`-ZLfxOFLN#-7cg6U}dzW)HSBVO%@0s-3|Ip*qdxhs& zckX!Z<$hg7uP9)BqEW)xG!FwMai#5(qSZFU&J!=nyH`aceIRdr|#YH{E*wNsny0sPs{T*&vx22E!H}`|G#3ichHZIho=0UZ1C@|`Vlo} zhHHDiZu5V#%z5dT{Yv5I=S^RJe!k1Qv*myLo8=dng8YB&>6tT9PuaV!#LU=y@b4aA P%3<(y^>bP0l+XkKF{L}K literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1sync__error-members.html b/class_f_d_p_1_1sync__error-members.html new file mode 100644 index 0000000..e4cce84 --- /dev/null +++ b/class_f_d_p_1_1sync__error-members.html @@ -0,0 +1,83 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::sync_error Member List
    +
    +
    + +

    This is the complete list of members for FDP::sync_error, including all inherited members.

    + + +
    sync_error(const std::string message) (defined in FDP::sync_error)FDP::sync_errorinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1sync__error.html b/class_f_d_p_1_1sync__error.html new file mode 100644 index 0000000..04154aa --- /dev/null +++ b/class_f_d_p_1_1sync__error.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: FDP::sync_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::sync_error Class Reference
    +
    +
    +
    +Inheritance diagram for FDP::sync_error:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + sync_error (const std::string message)
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1sync__error.png b/class_f_d_p_1_1sync__error.png new file mode 100644 index 0000000000000000000000000000000000000000..116ee2e84fd5540855b43ac2972d3618ccd4fa69 GIT binary patch literal 521 zcmV+k0`~ohP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0004)Nkl7**p)`_Re#a!EKZ(CI!k~%wj^Qq%g&y8^g&oil((#p-&x=*Sw{q(Av z_f3WauO3b(fPa|eOMkdzYIVP#XL#$+Z)c7pnOYt5<;8>_ukSvYUh_<<<&Ni%QL?sN z+0T-nK2(z#{_o_{&Clvv+rRgFwqI_N^j!0Pkfb?{*st z9L!sALxH1te?C7a45IHQf6}uU00QNC{<&7A0T84|ytO{?wzckB-0~K*uX2f*Drb0~XW&Z;Q?43A z|NI(WbAH9_u|O?u{b00ucYS`h8ditrCw!fkeIN6B3HK)NFwC#)!0VjfhrIIs9Z2;A zT_$w%vs7)MQ{R_sFXYF(&hUJ*0ldl>o`DCNntd%00000 LNkvXXu0mjf-)8x7 literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1validation__error-members.html b/class_f_d_p_1_1validation__error-members.html new file mode 100644 index 0000000..674d4f5 --- /dev/null +++ b/class_f_d_p_1_1validation__error-members.html @@ -0,0 +1,83 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::validation_error Member List
    +
    +
    + +

    This is the complete list of members for FDP::validation_error, including all inherited members.

    + + +
    validation_error(const std::string message) (defined in FDP::validation_error)FDP::validation_errorinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1validation__error.html b/class_f_d_p_1_1validation__error.html new file mode 100644 index 0000000..466ea2a --- /dev/null +++ b/class_f_d_p_1_1validation__error.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: FDP::validation_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::validation_error Class Reference
    +
    +
    +
    +Inheritance diagram for FDP::validation_error:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + validation_error (const std::string message)
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1validation__error.png b/class_f_d_p_1_1validation__error.png new file mode 100644 index 0000000000000000000000000000000000000000..ddce92693b4852486811e78e7695f19c1a1ae888 GIT binary patch literal 571 zcmV-B0>u4^P)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0005XNklsV>Nr?ITFoxb@W_GzSNxE1`kra|N>YSqb ze}eq3d(RqPrI4i8wWP3Zk>%lL+REG49)Y7t`KUm9A2&*I_BPHT$=Qm+q;9Qr6r;DI zHWClryZOGwA<5YZMc?$ru>NI|w{>&L6eY>q>5lw|V*B|GImVGpQIfo!WapE`oyTHM z-TzXU)NP{h=^s}wtUOu)U{IKQDgpdW zYl^n8HuS+&;!~^ZIX_|;8iY6=;Vm6&Yd8CIie~XuZQ=9&aS8Pi98+EdijWt*3ZvVZ z&sBMf@uM&O$5>2TS5r7lweSrTeuZzKSVsR>v6wRdIYk^~u6UjoukJ{@FNS-d25CPE z^BLI>ML0x$8GguPW8)kje}k9%_!kr8zgbcMj7o|?VP + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FDP::write_error Member List
    +
    +
    + +

    This is the complete list of members for FDP::write_error, including all inherited members.

    + + +
    write_error(const std::string message) (defined in FDP::write_error)FDP::write_errorinline
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1write__error.html b/class_f_d_p_1_1write__error.html new file mode 100644 index 0000000..131149c --- /dev/null +++ b/class_f_d_p_1_1write__error.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: FDP::write_error Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    FDP::write_error Class Reference
    +
    +
    +
    +Inheritance diagram for FDP::write_error:
    +
    +
    + +
    + + + + +

    +Public Member Functions

    + write_error (const std::string message)
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_f_d_p_1_1write__error.png b/class_f_d_p_1_1write__error.png new file mode 100644 index 0000000000000000000000000000000000000000..463a5ddb86bfbafe75bf68d4cd993bafa144529d GIT binary patch literal 509 zcmeAS@N?(olHy`uVBq!ia0vp^`9K`N!3-o7%x`M}DTx4|5ZC|z{{xvX-h3_XKQsZz z0^9#0p?kP61Pb1zP6R^V~jnL9Z&AF^~j6*b=6ct|C4#w2ym!e0jYFXtRJ`1{SRV|&G`90>U)shmiFPE41>f4$hle9U%BrGdC_uDnq6{o&DG&O%8%_ALWJ*S!T&taAL zzIN|ralilWIXv6G&iZ<#O7QyJeK9P5s%n3y?0Poy%BjBR{eheI?b$rv)c$WsY}$|c z-KP`l%H z%Kvuuli3AUJYhVdS;iD%p2_{o~T- z*M=U*K)2N?H!y1OoazC(G%?8MzudheY7_3!KZTYcZH?6a@>e_8rJ u{q + + + + + + +cppDataPipeline: Class Index + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Class Index
    +
    +
    +
    A | C | D | I | J | R | S | V | W
    +
    +
    +
    A
    +
    API (FDP)
    ApiObject (FDP)
    +
    +
    C
    +
    Config (FDP)
    config_parsing_error (FDP)
    +
    +
    D
    +
    DataPipeline (FDP)
    DataPipelineImpl_ (FDP)
    +
    +
    I
    +
    IOObject (FDP)
    +
    +
    J
    +
    json_parse_error (FDP)
    +
    +
    R
    +
    rest_apiquery_error (FDP)
    +
    +
    S
    +
    sync_error (FDP)
    +
    +
    V
    +
    validation_error (FDP)
    version (FDP::Versioning)
    +
    +
    W
    +
    write_error (FDP)
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/config_8hxx.html b/config_8hxx.html new file mode 100644 index 0000000..a545175 --- /dev/null +++ b/config_8hxx.html @@ -0,0 +1,105 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/config.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes
    +
    config.hxx File Reference
    +
    +
    +
    #include <string>
    +#include <ghc/filesystem.hpp>
    +#include <yaml-cpp/yaml.h>
    +#include <regex>
    +#include <map>
    +#include <stdio.h>
    +#include "fdp/objects/metadata.hxx"
    +#include "fdp/registry/api.hxx"
    +#include "fdp/objects/api_object.hxx"
    +#include "fdp/objects/io_object.hxx"
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    class  FDP::Config
     class for interacting with confifurations More...
     
    +

    Detailed Description

    +
    Author
    your name (you@d.nosp@m.omai.nosp@m.n.com)
    +
    Version
    0.1
    +
    Date
    2021-11-20
    +
    Copyright
    Copyright (c) 2021
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/config_8hxx_source.html b/config_8hxx_source.html new file mode 100644 index 0000000..8e20f2a --- /dev/null +++ b/config_8hxx_source.html @@ -0,0 +1,221 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/config.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    config.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    12#ifndef __FDP_CONFIG_HXX__
    +
    13#define __FDP_CONFIG_HXX__
    +
    14
    +
    15#include <string>
    +
    16#include <ghc/filesystem.hpp>
    +
    17#include <yaml-cpp/yaml.h>
    +
    18#include <regex>
    +
    19#include <map>
    +
    20#include <ghc/filesystem.hpp>
    +
    21#include <stdio.h>
    +
    22
    +
    23#include "fdp/objects/metadata.hxx"
    +
    24#include "fdp/registry/api.hxx"
    +
    25#include "fdp/objects/api_object.hxx"
    +
    26#include "fdp/objects/io_object.hxx"
    +
    27
    +
    28namespace FDP {
    +
    34 class Config {
    +
    35 private:
    +
    36 const ghc::filesystem::path config_file_path_;
    +
    37 const ghc::filesystem::path config_dir_;
    +
    38 const ghc::filesystem::path script_file_path_;
    +
    39 YAML::Node config_data_;
    +
    40 std::string api_url_;
    +
    41 std::string token_;
    +
    42 std::shared_ptr<API> api_;
    +
    43
    +
    44 std::unique_ptr<ApiObject> user_;
    +
    45 std::unique_ptr<ApiObject> author_;
    +
    46
    +
    47 std::unique_ptr<ApiObject> config_storage_root_;
    +
    48 std::unique_ptr<ApiObject> config_storage_location_;
    +
    49 std::unique_ptr<ApiObject> config_file_type_;
    +
    50 std::unique_ptr<ApiObject> config_obj_;
    +
    51
    +
    52 std::unique_ptr<ApiObject> script_storage_root_;
    +
    53 std::unique_ptr<ApiObject> script_storage_location_;
    +
    54 std::unique_ptr<ApiObject> script_file_type_;
    +
    55 std::unique_ptr<ApiObject> script_obj_;
    +
    56
    +
    57 std::unique_ptr<ApiObject> code_repo_storage_root_;
    +
    58 std::unique_ptr<ApiObject> code_repo_storage_location_;
    +
    59 std::unique_ptr<ApiObject> code_repo_obj_;
    +
    60
    +
    61 std::unique_ptr<ApiObject> code_run_;
    +
    62
    +
    63 std::map<std::string, IOObject> writes_;
    +
    64 std::map<std::string, IOObject> reads_;
    +
    65
    +
    66 std::map<std::string, IOObject> outputs_;
    +
    67 std::map<std::string, IOObject> inputs_;
    +
    68
    +
    69 RESTAPI rest_api_location_ = RESTAPI::LOCAL;
    +
    70
    +
    71 bool config_has_writes() const;
    +
    72 bool config_has_reads() const;
    +
    73
    +
    74 void initialise(RESTAPI api_location);
    +
    75 void validate_config(ghc::filesystem::path yaml_path, RESTAPI api_location);
    +
    76
    +
    77 public:
    +
    78
    +
    87 Config(const ghc::filesystem::path &config_file_path,
    +
    88 const ghc::filesystem::path &script_file_path,
    +
    89 const std::string &token,
    +
    90 RESTAPI api_location);
    +
    91
    +
    96 ~Config();
    +
    97
    +
    103 YAML::Node meta_data_() const;
    +
    109 YAML::Node config_writes_() const;
    +
    110
    +
    116 YAML::Node config_reads_() const;
    +
    117
    +
    124 bool has_reads() const;
    +
    131 bool has_writes() const;
    +
    138 bool has_outputs() const;
    +
    145 bool has_inputs() const;
    +
    146
    +
    153 ghc::filesystem::path get_config_file_path() const {return config_file_path_;}
    +
    165 ghc::filesystem::path get_script_file_path() const {return script_file_path_;}
    +
    166
    +
    172 std::string get_token() const {return token_;}
    +
    173
    +
    179 std::string get_api_url() const {return api_url_;}
    +
    185 ghc::filesystem::path get_data_store() const;
    +
    186
    +
    192 std::string get_default_input_namespace() const;
    +
    193
    +
    199 std::string get_default_output_namespace() const;
    +
    200
    +
    206 std::string get_config_directory() const;
    +
    207
    +
    213 std::string get_code_run_uuid() const;
    +
    214
    +
    222 ghc::filesystem::path link_write(std::string &data_product);
    +
    223
    +
    230 ghc::filesystem::path link_read(std::string &data_product);
    +
    231
    +
    238 void finalise();
    +
    239
    +
    246 static YAML::Node parse_yaml(ghc::filesystem::path yaml_path);
    +
    247
    +
    253 YAML::Node get_config_data() const {return config_data_;}
    +
    254
    +
    260 std::shared_ptr<API> get_api(){return api_;}
    +
    261
    +
    267 RESTAPI get_rest_api_location(){return rest_api_location_;}
    +
    268
    +
    269 };
    +
    270};
    +
    271#endif
    +
    api.hxx
    File containing classes and methods for connecting to the RestAPI.
    +
    FDP::RESTAPI
    RESTAPI
    selection of either local or remote pipeline running
    Definition: api.hxx:37
    +
    FDP::Config
    class for interacting with confifurations
    Definition: config.hxx:34
    +
    FDP::Config::config_writes_
    YAML::Node config_writes_() const
    Returns the writes Yaml Node from the config.
    Definition: config.cxx:27
    +
    FDP::Config::parse_yaml
    static YAML::Node parse_yaml(ghc::filesystem::path yaml_path)
    Read a given yaml file into a Yaml Node.
    Definition: config.cxx:17
    +
    FDP::Config::get_token
    std::string get_token() const
    Get the token as a string.
    Definition: config.hxx:172
    +
    FDP::Config::get_rest_api_location
    RESTAPI get_rest_api_location()
    Get the rest api location (local / remote)
    Definition: config.hxx:267
    +
    FDP::Config::Config
    Config(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
    Construct a new Config object.
    Definition: config.cxx:4
    +
    FDP::Config::has_inputs
    bool has_inputs() const
    Check whether any inputs have been added.
    Definition: config.cxx:57
    +
    FDP::Config::get_default_input_namespace
    std::string get_default_input_namespace() const
    Get the default input namespace.
    Definition: config.cxx:70
    +
    FDP::Config::get_data_store
    ghc::filesystem::path get_data_store() const
    Get the data store path.
    Definition: config.cxx:65
    +
    FDP::Config::has_reads
    bool has_reads() const
    Check whether the config has reads.
    Definition: config.cxx:53
    +
    FDP::Config::~Config
    ~Config()
    Destroy the Config object.
    Definition: config.cxx:13
    +
    FDP::Config::get_script_file_path
    ghc::filesystem::path get_script_file_path() const
    Get the script file path object.
    Definition: config.hxx:165
    +
    FDP::Config::meta_data_
    YAML::Node meta_data_() const
    Returns the meta_data Yaml Node from the config.
    Definition: config.cxx:23
    +
    FDP::Config::get_api
    std::shared_ptr< API > get_api()
    Get the api object (used to interact with the pipeline directly)
    Definition: config.hxx:260
    +
    FDP::Config::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:420
    +
    FDP::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:528
    +
    FDP::Config::get_config_file_path
    ghc::filesystem::path get_config_file_path() const
    Get the config file path object.
    Definition: config.hxx:153
    +
    FDP::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:336
    +
    FDP::Config::has_writes
    bool has_writes() const
    Check whether the config has writes.
    Definition: config.cxx:49
    +
    FDP::Config::has_outputs
    bool has_outputs() const
    Check whether any outputs have been added.
    Definition: config.cxx:61
    +
    FDP::Config::get_config_data
    YAML::Node get_config_data() const
    Get the config data as a Yaml Node.
    Definition: config.hxx:253
    +
    FDP::Config::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:341
    +
    FDP::Config::get_default_output_namespace
    std::string get_default_output_namespace() const
    Get the default output namespace.
    Definition: config.cxx:74
    +
    FDP::Config::get_api_url
    std::string get_api_url() const
    Get the api url.
    Definition: config.hxx:179
    +
    FDP::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:332
    +
    FDP::Config::config_reads_
    YAML::Node config_reads_() const
    Returns the reads Yaml Node from the config.
    Definition: config.cxx:31
    +
    metadata.hxx
    File containing methods for handling of metadata.
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/data__io_8hxx_source.html b/data__io_8hxx_source.html new file mode 100644 index 0000000..666ecfc --- /dev/null +++ b/data__io_8hxx_source.html @@ -0,0 +1,150 @@ + + + + + + + +cppDataPipeline: include/fdp/registry/data_io.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    data_io.hxx
    +
    +
    +
    1
    +
    11#ifndef __FDP_DATA_IO_HXX__
    +
    12#define __FDP_DATA_IO_HXX__
    +
    13
    +
    14#include "toml.hpp"
    +
    15#include <cstdlib>
    +
    16#include <ghc/filesystem.hpp>
    +
    17#include <stdexcept>
    +
    18#include <string>
    +
    19#include <vector>
    +
    20#include <yaml-cpp/yaml.h>
    +
    21#include <ghc/filesystem.hpp>
    +
    22
    +
    23#include <iostream>
    +
    24
    +
    25#include "fdp/objects/config.hxx"
    +
    26#include "fdp/objects/metadata.hxx"
    +
    27#include "fdp/utilities/logging.hxx"
    +
    28#include "fdp/utilities/semver.hxx"
    +
    29
    +
    30namespace FDP {
    +
    31
    +
    47double read_point_estimate_from_toml(const ghc::filesystem::path var_address);
    +
    48
    +
    59template <typename T>
    +
    60ghc::filesystem::path create_estimate(T &value,
    +
    61 const ghc::filesystem::path &data_product,
    +
    62 const Versioning::version &version_num,
    +
    63 const Config *config
    +
    64 ) {
    +
    65 const std::string param_name_ = data_product.stem().string();
    +
    66 const std::string namespace_ = config->get_default_output_namespace();
    +
    67 const ghc::filesystem::path data_store_ = config->get_data_store();
    +
    68 const toml::value data_{
    +
    69 {param_name_, {{"type", "point-estimate"}, {"value", value}}}};
    +
    70
    +
    71 const ghc::filesystem::path output_filename_ =
    +
    72 data_store_ / namespace_ / data_product.parent_path() /
    +
    73 std::string(version_num.to_string() + ".toml");
    +
    74 std::ofstream toml_out_;
    +
    75
    +
    76 if (!ghc::filesystem::exists(output_filename_.parent_path())) {
    +
    77 ghc::filesystem::create_directories(output_filename_.parent_path());
    +
    78 }
    +
    79
    +
    80 toml_out_.open(output_filename_);
    +
    81
    +
    82 if (!toml_out_) {
    +
    83 throw std::runtime_error("Failed to open TOML file for writing");
    +
    84 }
    +
    85
    +
    86 toml_out_ << toml::format(data_);
    +
    87
    +
    88 toml_out_.close();
    +
    89
    +
    90 APILogger->debug("FileSystem:CreateEstimate: Wrote point estimate to '{0}'",
    +
    91 output_filename_.string());
    +
    92
    +
    93 return output_filename_;
    +
    94}
    +
    95
    +
    102std::string get_first_key_(const toml::value data_table);
    +
    103
    +
    104}; // namespace FDP
    +
    105
    +
    106#endif
    + +
    logging.hxx
    File contains pointers for creating global logger during session.
    +
    FDP::APILogger
    const std::shared_ptr< spdlog::logger > APILogger
    Global logger used across all FDP scripts.
    Definition: logging.hxx:31
    +
    metadata.hxx
    File containing methods for handling of metadata.
    +
    semver.hxx
    File contains classes and types for validating semantic versioning.
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/datapipeline_8hxx.html b/datapipeline_8hxx.html new file mode 100644 index 0000000..c8909c8 --- /dev/null +++ b/datapipeline_8hxx.html @@ -0,0 +1,110 @@ + + + + + + + +cppDataPipeline: include/fdp/registry/datapipeline.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes
    +
    datapipeline.hxx File Reference
    +
    +
    + +

    File containing classes for interaction with the FDP data pipeline. +More...

    +
    #include <algorithm>
    +#include <fstream>
    +#include <iostream>
    +#include <string>
    +#include "spdlog/spdlog.h"
    +#include "json/json.h"
    +#include "fdp/objects/config.hxx"
    +#include "fdp/objects/metadata.hxx"
    +#include "fdp/registry/api.hxx"
    +#include "fdp/registry/data_io.hxx"
    +#include "fdp/utilities/logging.hxx"
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    class  FDP::DataPipelineImpl_
     private pointer-to-implementation class containing all backend methods More...
     
    +

    Detailed Description

    +

    File containing classes for interaction with the FDP data pipeline.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Date
    2021-05-06
    +

    The classes within this file form the core objects for handling interaction with the FDP FAIR Data pipeline. They contain methods which parse configurations and control calls to the RestAPI itself.

    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/datapipeline_8hxx_source.html b/datapipeline_8hxx_source.html new file mode 100644 index 0000000..75e5f40 --- /dev/null +++ b/datapipeline_8hxx_source.html @@ -0,0 +1,144 @@ + + + + + + + +cppDataPipeline: include/fdp/registry/datapipeline.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    datapipeline.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    11#ifndef __FDP_DATAPIPELINE_HXX__
    +
    12#define __FDP_DATAPIPELINE_HXX__
    +
    13
    +
    14#include <algorithm>
    +
    15#include <fstream>
    +
    16#include <iostream>
    +
    17#include <string>
    +
    18
    +
    19#include "spdlog/spdlog.h"
    +
    20#include "json/json.h"
    +
    21
    +
    22#include "fdp/objects/config.hxx"
    +
    23#include "fdp/objects/metadata.hxx"
    +
    24#include "fdp/registry/api.hxx"
    +
    25#include "fdp/registry/data_io.hxx"
    +
    26#include "fdp/utilities/logging.hxx"
    +
    27
    +
    28namespace FDP {
    +
    29
    +
    43class DataPipelineImpl_ {
    +
    44 private:
    +
    45 std::unique_ptr<Config> config_;
    +
    46
    +
    47 ghc::filesystem::path config_file_path_() const {return config_->get_config_file_path();}
    +
    48 ghc::filesystem::path script_file_path_() const {return config_->get_script_file_path();}
    +
    49 std::string token_() const {return config_->get_token();}
    +
    50 RESTAPI api_location_() {return config_->get_rest_api_location();}
    +
    51public:
    +
    52
    +
    61 DataPipelineImpl_(const ghc::filesystem::path &config_file_path,
    +
    62 const ghc::filesystem::path &file_system_path,
    +
    63 const std::string token,
    +
    64 spdlog::level::level_enum log_level = spdlog::level::info,
    +
    65 RESTAPI api_location = RESTAPI::LOCAL);
    +
    66
    +
    67 DataPipelineImpl_(const DataPipelineImpl_ &dp){
    +
    68 DataPipelineImpl_(dp.config_file_path_(), dp.script_file_path_(), token_(), spdlog::level::info, api_location_());}
    +
    69
    +
    74 ~DataPipelineImpl_() = default;
    +
    75
    +
    83 ghc::filesystem::path link_read(std::string &data_product);
    +
    84
    +
    92 ghc::filesystem::path link_write(std::string &data_product);
    +
    93
    +
    100 void finalise();
    +
    101
    +
    107 std::string get_code_run_uuid();
    +
    108
    +
    109};
    +
    110}; // namespace FDP
    +
    111
    +
    112#endif
    +
    api.hxx
    File containing classes and methods for connecting to the RestAPI.
    +
    FDP::RESTAPI
    RESTAPI
    selection of either local or remote pipeline running
    Definition: api.hxx:37
    +
    FDP::DataPipelineImpl_
    private pointer-to-implementation class containing all backend methods
    Definition: datapipeline.hxx:43
    +
    FDP::DataPipelineImpl_::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: datapipeline.cxx:25
    +
    FDP::DataPipelineImpl_::DataPipelineImpl_
    DataPipelineImpl_(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
    construct a DataPipelineImpl_ instance from configurations and setup
    Definition: datapipeline.cxx:5
    +
    FDP::DataPipelineImpl_::get_code_run_uuid
    std::string get_code_run_uuid()
    Get the code run uuid.
    Definition: datapipeline.cxx:35
    +
    FDP::DataPipelineImpl_::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: datapipeline.cxx:28
    +
    FDP::DataPipelineImpl_::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: datapipeline.cxx:31
    +
    FDP::DataPipelineImpl_::~DataPipelineImpl_
    ~DataPipelineImpl_()=default
    Default Destructor.
    + +
    logging.hxx
    File contains pointers for creating global logger during session.
    +
    metadata.hxx
    File containing methods for handling of metadata.
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/md__c_h_a_n_g_e_l_o_g.html b/dir_39f1df2935b9bcc0c6b792c5d1359e85.html similarity index 73% rename from md__c_h_a_n_g_e_l_o_g.html rename to dir_39f1df2935b9bcc0c6b792c5d1359e85.html index 40c63a8..c81592b 100644 --- a/md__c_h_a_n_g_e_l_o_g.html +++ b/dir_39f1df2935b9bcc0c6b792c5d1359e85.html @@ -5,7 +5,7 @@ -cppDataPipeline: Unreleased +cppDataPipeline: include/fdp Directory Reference @@ -23,7 +23,7 @@
    cppDataPipeline 0.3.0
    -
    C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
    +
    C++ Implementation of the FAIR Data Pipeline API
    @@ -61,23 +61,20 @@
    • +
    -
    -
    Unreleased
    +
    +
    fdp Directory Reference
    -
      -
    • Added functions for reading requested objects in the configuration file.
      • -
    • Reading of configuration YAML file using yaml-cpp.
      • -
    • Reading and writing of TOML files to represent parameters and distributions using toml11.
      • -
    • Reading and writing of arrays to/from a HDF5 file.
      • -
    • Hashing of file names and file content via SHA1.
      • -
    • Semantic versioning via a dedicated version class.
      • -
    • Added ability to talk to the RestAPI via the CURL library.
      • -
    • Use of spdlog as a logging library for plenty of output during debugging.
      • -
    -
    -
    + + +

    +Directories

    +
    Generated by doxygen 1.9.2 diff --git a/pages.html b/dir_68267d1309a1af8e8297ef4c3efbcdba.html similarity index 72% rename from pages.html rename to dir_68267d1309a1af8e8297ef4c3efbcdba.html index 697dba0..1ed80cb 100644 --- a/pages.html +++ b/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -5,7 +5,7 @@ -cppDataPipeline: Related Pages +cppDataPipeline: src Directory Reference @@ -23,7 +23,7 @@
    cppDataPipeline 0.3.0
    -
    C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
    +
    C++ Implementation of the FAIR Data Pipeline API
    @@ -47,7 +47,6 @@ /* @license-end */ -
    + +
    -
    Related Pages
    +
    src Directory Reference
    -
    Here is a list of all related documentation pages:
    - - - - +
     Unreleased
     FAIR Data Pipeline C++ API
     SCRC Software checklist
    +

    +Directories

    -
    diff --git a/dir_7b5d38f1875f1b693f62ca6a108a1129.html b/dir_7b5d38f1875f1b693f62ca6a108a1129.html new file mode 100644 index 0000000..ed5fd9c --- /dev/null +++ b/dir_7b5d38f1875f1b693f62ca6a108a1129.html @@ -0,0 +1,79 @@ + + + + + + + +cppDataPipeline: src/utilities Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    utilities Directory Reference
    +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/dir_a7fa5847c07dc92c5227f8a150238560.html b/dir_a7fa5847c07dc92c5227f8a150238560.html new file mode 100644 index 0000000..a0f6b98 --- /dev/null +++ b/dir_a7fa5847c07dc92c5227f8a150238560.html @@ -0,0 +1,79 @@ + + + + + + + +cppDataPipeline: src/objects Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    objects Directory Reference
    +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/dir_ac6c6686346e4bb6ee59787dd26cbe81.html b/dir_ac6c6686346e4bb6ee59787dd26cbe81.html new file mode 100644 index 0000000..cf86882 --- /dev/null +++ b/dir_ac6c6686346e4bb6ee59787dd26cbe81.html @@ -0,0 +1,92 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    utilities Directory Reference
    +
    +
    + + + + + + + + + + + +

    +Files

    file  json.hxx [code]
     File contains methods relating to handling of JSON based data.
     
    file  logging.hxx [code]
     File contains pointers for creating global logger during session.
     
    file  semver.hxx [code]
     File contains classes and types for validating semantic versioning.
     
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/dir_cb3c39cc4ab347a95dfc53ab4ca55b3c.html b/dir_cb3c39cc4ab347a95dfc53ab4ca55b3c.html new file mode 100644 index 0000000..3ed7099 --- /dev/null +++ b/dir_cb3c39cc4ab347a95dfc53ab4ca55b3c.html @@ -0,0 +1,79 @@ + + + + + + + +cppDataPipeline: src/registry Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    registry Directory Reference
    +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/dir_d44c64559bbebec7f509842c48db8b23.html b/dir_d44c64559bbebec7f509842c48db8b23.html new file mode 100644 index 0000000..bea703a --- /dev/null +++ b/dir_d44c64559bbebec7f509842c48db8b23.html @@ -0,0 +1,83 @@ + + + + + + + +cppDataPipeline: include Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    include Directory Reference
    +
    +
    + + +

    +Directories

    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/dir_d98af0b859cb0744225e11c767d17cdb.html b/dir_d98af0b859cb0744225e11c767d17cdb.html new file mode 100644 index 0000000..31274cb --- /dev/null +++ b/dir_d98af0b859cb0744225e11c767d17cdb.html @@ -0,0 +1,89 @@ + + + + + + + +cppDataPipeline: include/fdp/registry Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    registry Directory Reference
    +
    +
    + + + + + + + + +

    +Files

    file  api.hxx [code]
     File containing classes and methods for connecting to the RestAPI.
     
    file  datapipeline.hxx [code]
     File containing classes for interaction with the FDP data pipeline.
     
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/dir_f537a5f098b413116eae11cd84c41a43.html b/dir_f537a5f098b413116eae11cd84c41a43.html new file mode 100644 index 0000000..92eca82 --- /dev/null +++ b/dir_f537a5f098b413116eae11cd84c41a43.html @@ -0,0 +1,88 @@ + + + + + + + +cppDataPipeline: include/fdp/objects Directory Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    objects Directory Reference
    +
    +
    + + + + + + + +

    +Files

    file  config.hxx [code]
     
    file  metadata.hxx [code]
     File containing methods for handling of metadata.
     
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/exceptions_8hxx_source.html b/exceptions_8hxx_source.html new file mode 100644 index 0000000..71b05da --- /dev/null +++ b/exceptions_8hxx_source.html @@ -0,0 +1,127 @@ + + + + + + + +cppDataPipeline: include/fdp/exceptions.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    exceptions.hxx
    +
    +
    +
    1#ifndef __FDP_EXCEPTIONS_HXX__
    +
    2#define __FDP_EXCEPTIONS_HXX__
    +
    3
    +
    4#include <stdexcept>
    +
    5#include <string>
    +
    6
    +
    7namespace FDP {
    +
    8class config_parsing_error : public std::runtime_error {
    +
    9public:
    +
    10 config_parsing_error(const std::string message)
    +
    11 : std::runtime_error(message) {}
    +
    12};
    +
    13
    +
    14class rest_apiquery_error : public std::runtime_error {
    +
    15public:
    +
    16 rest_apiquery_error(const std::string message)
    +
    17 : std::runtime_error(message) {}
    +
    18};
    +
    19
    +
    20class json_parse_error : public std::runtime_error {
    +
    21public:
    +
    22 json_parse_error(const std::string message) : std::runtime_error(message) {}
    +
    23};
    +
    24
    +
    25class validation_error : public std::runtime_error {
    +
    26public:
    +
    27 validation_error(const std::string message) : std::runtime_error(message) {}
    +
    28};
    +
    29
    +
    30class sync_error : public std::runtime_error {
    +
    31public:
    +
    32 sync_error(const std::string message) : std::runtime_error(message) {}
    +
    33};
    +
    34
    +
    35class write_error : public std::runtime_error {
    +
    36public:
    +
    37 write_error(const std::string message) : std::runtime_error(message) {}
    +
    38};
    +
    39
    +
    40}; // namespace FDP
    +
    41
    +
    42#endif
    +
    FDP::config_parsing_error
    Definition: exceptions.hxx:8
    +
    FDP::json_parse_error
    Definition: exceptions.hxx:20
    +
    FDP::rest_apiquery_error
    Definition: exceptions.hxx:14
    +
    FDP::sync_error
    Definition: exceptions.hxx:30
    +
    FDP::validation_error
    Definition: exceptions.hxx:25
    +
    FDP::write_error
    Definition: exceptions.hxx:35
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/fdp_8hxx_source.html b/fdp_8hxx_source.html new file mode 100644 index 0000000..f66af57 --- /dev/null +++ b/fdp_8hxx_source.html @@ -0,0 +1,125 @@ + + + + + + + +cppDataPipeline: include/fdp/fdp.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    fdp.hxx
    +
    +
    +
    1#include "fdp/registry/datapipeline.hxx"
    +
    2
    +
    3namespace FDP {
    +
    9class DataPipeline {
    +
    10public:
    +
    19 explicit DataPipeline(
    +
    20 const std::string &config_file_path,
    +
    21 const std::string &script_file_path,
    +
    22 std::string token = "",
    +
    23 spdlog::level::level_enum log_level = spdlog::level::info)
    +
    24 : pimpl_(std::make_shared<DataPipelineImpl_>(ghc::filesystem::path(config_file_path), ghc::filesystem::path(script_file_path), token,
    +
    25 log_level)) {
    +
    26
    +
    27 APILogger->debug("DataPipeline: Initialising session '{0}'", Pimpl()->get_code_run_uuid());
    +
    28 }
    +
    29
    +
    34 ~DataPipeline();
    +
    35
    +
    36 DataPipeline(DataPipeline &&rhs) noexcept;
    +
    37 DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    +
    38
    +
    39 DataPipeline(const DataPipeline &rhs);
    +
    40 DataPipeline &operator=(const DataPipeline &rhs);
    +
    41
    +
    49 ghc::filesystem::path link_read(std::string &data_product);
    +
    50
    +
    58 ghc::filesystem::path link_write(std::string &data_product);
    +
    59
    +
    66 void finalise();
    +
    67
    +
    68private:
    +
    69 const DataPipelineImpl_* Pimpl() const {return pimpl_.get();}
    +
    70 DataPipelineImpl_* Pimpl() {return pimpl_.get();}
    +
    71
    +
    72 std::shared_ptr<DataPipelineImpl_> pimpl_;
    +
    73};
    +
    74}; // namespace FDP
    +
    FDP::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:9
    +
    FDP::DataPipeline::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:23
    +
    FDP::DataPipeline::~DataPipeline
    ~DataPipeline()
    Destroy the Data Pipeline object.
    +
    FDP::DataPipeline::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:20
    +
    FDP::DataPipeline::DataPipeline
    DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.hxx:19
    +
    FDP::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:26
    +
    FDP::DataPipelineImpl_
    private pointer-to-implementation class containing all backend methods
    Definition: datapipeline.hxx:43
    +
    datapipeline.hxx
    File containing classes for interaction with the FDP data pipeline.
    +
    FDP::APILogger
    const std::shared_ptr< spdlog::logger > APILogger
    Global logger used across all FDP scripts.
    Definition: logging.hxx:31
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/files.html b/files.html new file mode 100644 index 0000000..c40da3b --- /dev/null +++ b/files.html @@ -0,0 +1,96 @@ + + + + + + + +cppDataPipeline: File List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    File List
    +
    +
    +
    Here is a list of all documented files with brief descriptions:
    +
    [detail level 1234]
    + + + + + + + + + + + + + + + + + +
     ▼ include
     ▼ fdp
     ▼ objects
     api_object.hxx
     config.hxx
     io_object.hxx
     metadata.hxxFile containing methods for handling of metadata
     ▼ registry
     api.hxxFile containing classes and methods for connecting to the RestAPI
     data_io.hxx
     datapipeline.hxxFile containing classes for interaction with the FDP data pipeline
     ▼ utilities
     json.hxxFile contains methods relating to handling of JSON based data
     logging.hxxFile contains pointers for creating global logger during session
     semver.hxxFile contains classes and types for validating semantic versioning
     exceptions.hxx
     fdp.hxx
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/functions.html b/functions.html new file mode 100644 index 0000000..c17c2b7 --- /dev/null +++ b/functions.html @@ -0,0 +1,199 @@ + + + + + + + +cppDataPipeline: Class Members + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Here is a list of all documented class members with links to the class documentation for each member:
    + +

    - a -

    + + +

    - c -

    + + +

    - d -

    + + +

    - e -

    + + +

    - f -

    + + +

    - g -

    + + +

    - h -

    + + +

    - i -

    + + +

    - j -

    + + +

    - l -

    + + +

    - m -

    + + +

    - p -

    + + +

    - r -

      +
    • remove_leading_forward_slash() : FDP::API
      • +
    + + +

    - s -

    + + +

    - v -

    + + +

    - ~ -

    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/functions_func.html b/functions_func.html new file mode 100644 index 0000000..46d09d1 --- /dev/null +++ b/functions_func.html @@ -0,0 +1,199 @@ + + + + + + + +cppDataPipeline: Class Members - Functions + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +  + +

    - a -

    + + +

    - c -

    + + +

    - d -

    + + +

    - e -

    + + +

    - f -

    + + +

    - g -

    + + +

    - h -

    + + +

    - i -

    + + +

    - j -

    + + +

    - l -

    + + +

    - m -

    + + +

    - p -

    + + +

    - r -

      +
    • remove_leading_forward_slash() : FDP::API
      • +
    + + +

    - s -

    + + +

    - v -

    + + +

    - ~ -

    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 0000000..64c0752 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1,93 @@ + + + + + + + +cppDataPipeline: Class Hierarchy + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Class Hierarchy
    +
    +
    +
    This inheritance list is sorted roughly, but not completely, alphabetically:
    +
    [detail level 12]
    + + + + + + + + + + + + + + +
     CFDP::APIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CFDP::ApiObjectClass for API objects
     CFDP::ConfigClass for interacting with confifurations
     CFDP::DataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     CFDP::DataPipelineImpl_Private pointer-to-implementation class containing all backend methods
     CFDP::IOObjectClass for API objects
     ▼Cstd::runtime_error
     CFDP::config_parsing_error
     CFDP::json_parse_error
     CFDP::rest_apiquery_error
     CFDP::sync_error
     CFDP::validation_error
     CFDP::write_error
     CFDP::Versioning::versionClass describing the semantic version of an object
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/index.html b/index.html index e65cbf1..a67365b 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ -cppDataPipeline: Main Page +cppDataPipeline: FAIR Data Pipeline C++ API @@ -23,7 +23,7 @@
    cppDataPipeline 0.3.0
    -
    C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
    +
    C++ Implementation of the FAIR Data Pipeline API
    @@ -62,10 +62,43 @@ -
    -
    cppDataPipeline Documentation
    +
    +
    FAIR Data Pipeline C++ API
    +

    FDP C++ API License: LGPL v3 software-checklist DOI

    +

    +Contents

    + +

    +Installation

    +

    You can build and test the library using CMake, this implementation requires C++11.

    +

    It is recomended that you install CURL prior to installation of this API

    +

    compile the library and tests by running:

    +
    $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
    +
    $ cmake --build build
    +

    Important For multi-config compilers such as Visual Studio xcode or ninja the config type needs to be set to Release otherwise the API will not build for example:

    $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
    +
    $ cmake --build build --config=Release
    +

    +Outline

    +

    The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

    +

    +Unit Tests

    +

    The unit tests use the local registry, this needs to be running prior to running the tests see: the CLI documentation

    +

    Tests can be lauched using the following command:

    +

    +Unix

    +
    $ ./build/bin/fdpapi-tests
    +

    +Windows

    +
    $ build\bin\Release\fdpapi-tests.exe
    +
    diff --git a/io__object_8hxx_source.html b/io__object_8hxx_source.html new file mode 100644 index 0000000..6cb05e2 --- /dev/null +++ b/io__object_8hxx_source.html @@ -0,0 +1,185 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/io_object.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    io_object.hxx
    +
    +
    +
    1#ifndef __FDP_IOOBJECT_HXX__
    +
    2#define __FDP_IOOBJECT_HXX__
    +
    3
    +
    4#include <string>
    +
    5#include <cstddef>
    +
    6#include <json/value.h>
    +
    7
    +
    8#include "fdp/utilities/logging.hxx"
    +
    9#include "fdp/objects/api_object.hxx"
    +
    10
    +
    11namespace FDP {
    +
    16 class IOObject {
    +
    17 private:
    +
    18 std::string data_product_;
    +
    19 std::string use_data_product_;
    +
    20 std::string use_component_ = "None";
    +
    21 std::string use_version_;
    +
    22 std::string use_namespace_;
    +
    23 ghc::filesystem::path path_;
    +
    24 std::string data_product_description_ = "None";
    +
    25 std::string component_description_ = "None";
    +
    26 bool public_ = false;
    +
    27
    +
    28 std::shared_ptr<ApiObject> component_obj_;
    +
    29 std::shared_ptr<ApiObject> data_product_obj_;
    +
    30
    +
    31 public:
    +
    36 IOObject(){};
    +
    49 IOObject(std::string data_product,
    +
    50 std::string use_data_product,
    +
    51 std::string use_version,
    +
    52 std::string use_namespace,
    +
    53 ghc::filesystem::path path,
    +
    54 std::string data_product_description,
    +
    55 bool isPublic):
    +
    56 data_product_(data_product),
    +
    57 use_data_product_(use_data_product),
    +
    58 use_version_(use_version),
    +
    59 use_namespace_(use_namespace),
    +
    60 path_(path),
    +
    61 data_product_description_(data_product_description),
    +
    62 public_(isPublic){};
    +
    63
    +
    76 IOObject(std::string data_product,
    +
    77 std::string use_data_product,
    +
    78 std::string use_version,
    +
    79 std::string use_namespace,
    +
    80 ghc::filesystem::path path,
    +
    81 ApiObject &component_obj,
    +
    82 ApiObject &data_product_obj):
    +
    83 data_product_(data_product),
    +
    84 use_data_product_(use_data_product),
    +
    85 use_version_(use_version),
    +
    86 use_namespace_(use_namespace),
    +
    87 path_(path),
    +
    88 component_obj_(std::make_shared<ApiObject>(component_obj)),
    +
    89 data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
    +
    90
    +
    96 std::string get_data_product() {return data_product_;}
    +
    97
    +
    103 std::string get_use_data_product() {return use_data_product_;}
    +
    104
    +
    110 std::string get_use_component() {return use_component_;}
    +
    111
    +
    117 std::string get_use_version() {return use_version_;}
    +
    118
    +
    124 std::string get_use_namespace() {return use_namespace_;}
    +
    125
    +
    131 ghc::filesystem::path get_path() {return path_;}
    +
    132
    +
    138 std::string get_data_product_description() {return data_product_description_;}
    +
    139
    +
    145 std::string get_component_description() {return component_description_;}
    +
    146
    +
    153 bool is_public() {return public_;}
    +
    154
    +
    160 std::shared_ptr<ApiObject> get_component_object() {return component_obj_;}
    +
    161
    +
    167 std::shared_ptr<ApiObject> get_data_product_object() {return data_product_obj_;}
    +
    168
    +
    174 void set_component_object(ApiObject &component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
    +
    175
    +
    181 void set_data_product_object(ApiObject &data_product_obj){data_product_obj_ = std::make_shared<ApiObject>(data_product_obj);}
    +
    182 };
    +
    183};
    +
    184
    +
    185#endif
    +
    FDP::ApiObject
    Class for API objects.
    Definition: api_object.hxx:15
    +
    FDP::IOObject
    Class for API objects.
    Definition: io_object.hxx:16
    +
    FDP::IOObject::get_use_component
    std::string get_use_component()
    Get the use component as a string.
    Definition: io_object.hxx:110
    +
    FDP::IOObject::get_use_namespace
    std::string get_use_namespace()
    Get the use namespace as a string.
    Definition: io_object.hxx:124
    +
    FDP::IOObject::get_use_data_product
    std::string get_use_data_product()
    Get the use data product as a string.
    Definition: io_object.hxx:103
    +
    FDP::IOObject::get_component_object
    std::shared_ptr< ApiObject > get_component_object()
    Get the component object object.
    Definition: io_object.hxx:160
    +
    FDP::IOObject::set_data_product_object
    void set_data_product_object(ApiObject &data_product_obj)
    Set the data product object object.
    Definition: io_object.hxx:181
    +
    FDP::IOObject::get_component_description
    std::string get_component_description()
    Get the component description as a string.
    Definition: io_object.hxx:145
    +
    FDP::IOObject::IOObject
    IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)
    Construct a new IOObject object Used to store inputs and outputs for in the config.
    Definition: io_object.hxx:49
    +
    FDP::IOObject::IOObject
    IOObject()
    Construct a new IOObject object (empty constructor)
    Definition: io_object.hxx:36
    +
    FDP::IOObject::get_data_product
    std::string get_data_product()
    Get the data product as a string.
    Definition: io_object.hxx:96
    +
    FDP::IOObject::is_public
    bool is_public()
    Check whether the data product is public.
    Definition: io_object.hxx:153
    +
    FDP::IOObject::IOObject
    IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
    Construct a new IOObject object Used to store inputs and outputs for in the config.
    Definition: io_object.hxx:76
    +
    FDP::IOObject::get_use_version
    std::string get_use_version()
    Get the use version as a string.
    Definition: io_object.hxx:117
    +
    FDP::IOObject::get_path
    ghc::filesystem::path get_path()
    Get the path of the data product.
    Definition: io_object.hxx:131
    +
    FDP::IOObject::set_component_object
    void set_component_object(ApiObject &component_obj)
    Set the component object object.
    Definition: io_object.hxx:174
    +
    FDP::IOObject::get_data_product_object
    std::shared_ptr< ApiObject > get_data_product_object()
    Get the data product object object.
    Definition: io_object.hxx:167
    +
    FDP::IOObject::get_data_product_description
    std::string get_data_product_description()
    Get the data product description as a string.
    Definition: io_object.hxx:138
    +
    logging.hxx
    File contains pointers for creating global logger during session.
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/json_8hxx.html b/json_8hxx.html new file mode 100644 index 0000000..247bd5b --- /dev/null +++ b/json_8hxx.html @@ -0,0 +1,133 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities/json.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Functions
    +
    json.hxx File Reference
    +
    +
    + +

    File contains methods relating to handling of JSON based data. +More...

    +
    #include <json/writer.h>
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Functions

    std::string FDP::json_to_string (Json::Value &json_data)
     convert a JSON object to string form More...
     
    +

    Detailed Description

    +

    File contains methods relating to handling of JSON based data.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Date
    2021-05-06
    +

    This file contains methods which modify/change the form of data which is held as a JSON string

    +

    Function Documentation

    + +

    ◆ json_to_string()

    + +
    +
    + + + + + + + + +
    std::string FDP::json_to_string (Json::Value & json_data)
    +
    + +

    convert a JSON object to string form

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Parameters
    + + +
    json_dataJSON data held in a Json::Value object
    +
    +
    +
    Returns
    the data as a JSON string
    +

    +Test Case

    +

    test/test_utilities.cxx: TestJSONString

    +

    This unit test checks that the JSON string constructed from a Json::Value object matches expectation

    +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/json_8hxx_source.html b/json_8hxx_source.html new file mode 100644 index 0000000..dbc6377 --- /dev/null +++ b/json_8hxx_source.html @@ -0,0 +1,91 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities/json.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    json.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    10#ifndef __FDP_JSON_HXX__
    +
    11#define __FDP_JSON_HXX__
    +
    12
    +
    13#include <json/writer.h>
    +
    14
    +
    15namespace FDP {
    +
    31std::string json_to_string(Json::Value &json_data);
    +
    32}; // namespace FDP
    +
    33
    +
    34#endif
    +
    FDP::json_to_string
    std::string json_to_string(Json::Value &json_data)
    convert a JSON object to string form
    Definition: json.cxx:4
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/logging_8hxx.html b/logging_8hxx.html new file mode 100644 index 0000000..25206d8 --- /dev/null +++ b/logging_8hxx.html @@ -0,0 +1,149 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities/logging.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Functions | +Variables
    +
    logging.hxx File Reference
    +
    +
    + +

    File contains pointers for creating global logger during session. +More...

    +
    #include "spdlog/sinks/stdout_color_sinks.h"
    +#include "spdlog/spdlog.h"
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Functions

    std::shared_ptr< spdlog::logger > FDP::create_logger_ ()
     Create a the global logger pointer. More...
     
    + + + + +

    +Variables

    const std::shared_ptr< spdlog::logger > FDP::APILogger = create_logger_()
     Global logger used across all FDP scripts. More...
     
    +

    Detailed Description

    +

    File contains pointers for creating global logger during session.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Date
    2021-05-06
    +

    This file should be included in all FDP header files as it allows all debug/error information to be output to the same logger and hence the same terminal session. It uses the SPDLog library.

    +

    Function Documentation

    + +

    ◆ create_logger_()

    + +
    +
    + + + + + + + +
    std::shared_ptr< spdlog::logger > FDP::create_logger_ ()
    +
    + +

    Create a the global logger pointer.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Returns
    a shared pointer to the global logger instance
    + +
    +
    +

    Variable Documentation

    + +

    ◆ APILogger

    + +
    +
    + + + + +
    const std::shared_ptr<spdlog::logger> FDP::APILogger = create_logger_()
    +
    + +

    Global logger used across all FDP scripts.

    +
    Author
    K. Zarebski (UKAEA)
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/logging_8hxx_source.html b/logging_8hxx_source.html new file mode 100644 index 0000000..c74ab23 --- /dev/null +++ b/logging_8hxx_source.html @@ -0,0 +1,95 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities/logging.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    logging.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    11#ifndef __FDP_LOGGING_HXX__
    +
    12#define __FDP_LOGGING_HXX__
    +
    13
    +
    14#include "spdlog/sinks/stdout_color_sinks.h"
    +
    15#include "spdlog/spdlog.h"
    +
    16
    +
    17namespace FDP {
    +
    24std::shared_ptr<spdlog::logger> create_logger_();
    +
    25
    +
    31const std::shared_ptr<spdlog::logger> APILogger = create_logger_();
    +
    32} // namespace FDP
    +
    33
    +
    34#endif
    +
    FDP::APILogger
    const std::shared_ptr< spdlog::logger > APILogger
    Global logger used across all FDP scripts.
    Definition: logging.hxx:31
    +
    FDP::create_logger_
    std::shared_ptr< spdlog::logger > create_logger_()
    Create a the global logger pointer.
    Definition: logging.cxx:4
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/md__r_e_a_d_m_e.html b/md__r_e_a_d_m_e.html deleted file mode 100644 index ed2d41c..0000000 --- a/md__r_e_a_d_m_e.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - -cppDataPipeline: FAIR Data Pipeline C++ API - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    FAIR Data Pipeline C++ API
    -
    -
    -

    FDP C++ API License: LGPL v3 software-checklist DOI

    -

    -Contents

    - -

    -Installation

    -

    You can build and test the library using CMake, this implementation requires C++11.

    -

    It is recomended that you install CURL prior to installation of this API

    -

    compile the library and tests by running:

    -
    $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
    -
    $ cmake --build build
    -

    Important For multi-config compilers such as Visual Studio xcode or ninja the config type needs to be set to Release otherwise the API will not build for example:

    $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
    -
    $ cmake --build build --config=Release
    -

    -Outline

    -

    The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

    -

    -Unit Tests

    -

    The unit tests use the local registry, this needs to be running prior to running the tests see: the CLI documentation

    -

    Tests can be lauched using the following command:

    -

    -Unix

    -
    $ ./build/bin/fdpapi-tests
    -

    -Windows

    -
    $ build\bin\Release\fdpapi-tests.exe
    -
    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/md_software_checklist.html b/md_software_checklist.html deleted file mode 100644 index da6f893..0000000 --- a/md_software_checklist.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - - -cppDataPipeline: SCRC Software checklist - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    SCRC Software checklist
    -
    -
    -

    This checklist has been developed by the Scottish Covid-19 Response Consortium and has been used to assess the software engineering aspects of "model readiness" for our six epidemiological models. This is intended to be part of a broader scheme to evaluate and describe suitability of model results to be used in decision making so this checklist covers only the software implementation and assumes that other documents cover questions about model validation, quality of science, data provenance and quality and policy readiness.

    -

    In order to use this checklist for the SCRC FAIR data pipeline components, three questions that apply only to software producing scientific results have been marked "models only" and for other software an N/A response can be given.

    -

    -Software details

    -

    -Model / software name

    -
    -

    cppDataPipeline

    -
    -

    -Date

    -
    -

    18/01/22

    -
    -

    -Version identifier

    -
    -

    v0.2.0

    -
    -

    -This assessment

    -

    -Filled in by

    -

    Name

    -
    -

    Ryan Field

    -
    -

    Role on project:

    -
    -

    RSE

    -
    -

    Person identifier:

    -
    -

    https://github.com/RyanJField

    -
    -

    -Overall statement

    -

    Do we have sufficient confidence in the correctness of the software to trust the results?

    -

    This is your overall judgement on the level of confidence based on all the aspects of the checklist. There is no formulaic way to arrive at this overall assessment based on the individual checklist answers but please explain how the measures in place combine to reach this level of confidence and make clear any caveats (eg applies for certain ways of using the software and not others).

    -
    -

    - [ ] Yes

      -
    • [x] Yes, with caveats
      • -
    • [ ] No
      • -
    -

    The code is well written and tested through unit tests and continous integration, the documentation is still a work in progress.

    -
    -

    -Checklist

    -

    Please use a statement from this list: "Sufficiently addressed", "Some work remaining or caveats", or "Needs to be addressed" to begin each response.

    -

    Additionally, for each question please explain the situation and include any relevant links (eg tool dashboards, documentation). The sub bullet points are to make the scope of the question clear and should be covered if relevant but do not have to be answered individually.

    -

    -Can a run be repeated and reproduce exactly the same results? (models only)

    -
      -
    • How is stochasticity handled?
      • -
    • Is sufficient meta-data logged to enable a run to be reproduced: Is the exact code version recorded (and whether the repository was "clean"), including versions of dependent libraries (e.g. an environment.yml file or similar) along with all command line arguments and the content of any configuration files?
      • -
    • Is there up-to-date documentation which explains precisely how to run the code to reproduce existing results?
      • -
    -
    -

    - [ ] Sufficiently addressed

      -
    • [ ] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    • [x] N/A
      • -
    -
    -

    -Are there appropriate tests? (And are they automated?)

    -
      -
    • Are there unit tests? What is covered?
      • -
    • System and integration tests? Automated model validation tests?
      • -
    • Regression tests? (Which show whether changes to the code lead to changes in the output. Changes to the model will be expected to change the output, but many other changes, such as refactoring and adding new features, should not. Having these tests gives confidence that the code hasn't developed bugs due to unintentional changes.)
      • -
    • Is there CI?
      • -
    • Is everything you need to run the tests (including documentation) in the repository (or the data pipeline where appropriate)?
      • -
    -
    -

    - [ ] Sufficiently addressed

      -
    • [x] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    -

    Tests are run via GitHub Actions CI ([![software-checklist][https://img.shields.io/badge/software-checklist-3891A6]][https://github.com/FAIRDataPipeline/cppDataPipeline/blob/main/software-checklist.md]) with good code coverage.

    -
    -

    -Are the scientific results of runs robust to different ways of running the code? (models only)

    -
      -
    • Running on a different machine?
      • -
    • With different number of processes?
      • -
    • With different compilers and optimisation levels?
      • -
    • Running in debug mode?
      • -
    -

    (We don't require bitwise identical results here, but the broad conclusions after looking at the results of the test case should be the same.)

    -
    -

    - [ ] Sufficiently addressed

      -
    • [ ] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    • [x] N/A
      • -
    -
    -

    -Has any sort of automated code checking been applied?

    -
      -
    • For C++, this might just be the compiler output when run with "all warnings". It could also be more extensive static analysis. For other languages, it could be e.g. pylint, StaticLint.jl, etc.
      • -
    • If there are possible issues reported by such a tool, have they all been either fixed or understood to not be important?
      • -
    -
    -

    - [ ] Sufficiently addressed

      -
    • [x] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    -

    Minimal warnings are present with some notes.

    -
    -

    -Is the code clean, generally understandable and readable and written according to good software engineering principles?

    -
      -
    • Is it modular? Are the internal implementation details of one module hidden from other modules?
      • -
    • Commented where necessary?
      • -
    • Avoiding red flags such as very long functions, global variables, copy and pasted code, etc.?
      • -
    -
    -

    - [ ] Sufficiently addressed

      -
    • [x] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    -

    The code is organised and follows best practice but requires some refactoring to remove redundant code.

    -
    -

    -Is there sufficient documentation?

    -
      -
    • Is there a readme?
      • -
    • Does the code have user documentation?
      • -
    • Does the code have developer documentation?
      • -
    • Does the code have algorithm documentation? e.g. something that describes how the model is actually simulated, or inference is performed?
      • -
    • Is all the documentation up to date?
      • -
    -
    -

    - [ ] Sufficiently addressed

      -
    • [x] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    -

    There is a readme, however the code is in need of proper documentation.

    -
    -

    -Is there suitable collaboration infrastructure?

    -
      -
    • Is the code in a version-controlled repository?
      • -
    • Is there a license?
      • -
    • Is an issue tracker used?
      • -
    • Are there contribution guidelines?
      • -
    -
    -

    - [x] Sufficiently addressed

      -
    • [ ] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    -

    The code is stored in a GitHub, includes a license and uses github issues, for issue tracking.

    -
    -

    -Are software dependencies listed and of appropriate quality?

    -
    -

    - [x] Sufficiently addressed

      -
    • [ ] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    -

    Dependencies are listed in the readme, with most being automatically included.

    -
    -

    -Is input and output data handled carefully? (Models only)

    -
      -
    • Does the code use the data pipeline for all inputs and outputs?
      • -
    • Is the code appropriately parameterized (i.e. have hard coded parameters been removed)?
      • -
    -
    -

    - [ ] Sufficiently addressed

      -
    • [ ] Some work remaining or caveats
      • -
    • [ ] Needs to be addressed
      • -
    • [x] N/A
      • -
    -
    -
    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/menudata.js b/menudata.js index 752f4f4..bf9dfed 100644 --- a/menudata.js +++ b/menudata.js @@ -24,4 +24,49 @@ */ var menudata={children:[ {text:"Main Page",url:"index.html"}, -{text:"Related Pages",url:"pages.html"}]} +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}, +{text:"Namespace Members",url:"namespacemembers.html",children:[ +{text:"All",url:"namespacemembers.html"}, +{text:"Enumerations",url:"namespacemembers_enum.html"}]}]}, +{text:"Classes",url:"annotated.html",children:[ +{text:"Class List",url:"annotated.html"}, +{text:"Class Index",url:"classes.html"}, +{text:"Class Hierarchy",url:"hierarchy.html"}, +{text:"Class Members",url:"functions.html",children:[ +{text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, +{text:"c",url:"functions.html#index_c"}, +{text:"d",url:"functions.html#index_d"}, +{text:"e",url:"functions.html#index_e"}, +{text:"f",url:"functions.html#index_f"}, +{text:"g",url:"functions.html#index_g"}, +{text:"h",url:"functions.html#index_h"}, +{text:"i",url:"functions.html#index_i"}, +{text:"j",url:"functions.html#index_j"}, +{text:"l",url:"functions.html#index_l"}, +{text:"m",url:"functions.html#index_m"}, +{text:"p",url:"functions.html#index_p"}, +{text:"r",url:"functions.html#index_r"}, +{text:"s",url:"functions.html#index_s"}, +{text:"v",url:"functions.html#index_v"}, +{text:"~",url:"functions.html#index__7E"}]}, +{text:"Functions",url:"functions_func.html",children:[ +{text:"a",url:"functions_func.html#index_a"}, +{text:"c",url:"functions_func.html#index_c"}, +{text:"d",url:"functions_func.html#index_d"}, +{text:"e",url:"functions_func.html#index_e"}, +{text:"f",url:"functions_func.html#index_f"}, +{text:"g",url:"functions_func.html#index_g"}, +{text:"h",url:"functions_func.html#index_h"}, +{text:"i",url:"functions_func.html#index_i"}, +{text:"j",url:"functions_func.html#index_j"}, +{text:"l",url:"functions_func.html#index_l"}, +{text:"m",url:"functions_func.html#index_m"}, +{text:"p",url:"functions_func.html#index_p"}, +{text:"r",url:"functions_func.html#index_r"}, +{text:"s",url:"functions_func.html#index_s"}, +{text:"v",url:"functions_func.html#index_v"}, +{text:"~",url:"functions_func.html#index__7E"}]}]}]}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}]}]} diff --git a/metadata_8hxx.html b/metadata_8hxx.html new file mode 100644 index 0000000..ec1ae73 --- /dev/null +++ b/metadata_8hxx.html @@ -0,0 +1,341 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/metadata.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Functions
    +
    metadata.hxx File Reference
    +
    +
    + +

    File containing methods for handling of metadata. +More...

    +
    #include <ctime>
    +#include <ghc/filesystem.hpp>
    +#include <fstream>
    +#include <iomanip>
    +#include <iostream>
    +#include <sstream>
    +#include <random>
    +#include <chrono>
    +#include <regex>
    +#include "digestpp.hpp"
    +#include <unistd.h>
    +
    +

    Go to the source code of this file.

    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Functions

    std::string FDP::calculate_hash_from_file (const ghc::filesystem::path &)
     calculates a hash from a given input file via SHA1 More...
     
    std::string FDP::calculate_hash_from_string (const std::string &input)
     calculates a hash from a given string via SHA1 More...
     
    std::string FDP::generate_random_hash ()
     Generate a random hash. More...
     
    std::string FDP::current_time_stamp (bool file_name=false)
     returns the current time as a timestamp More...
     
    std::string FDP::remove_local_from_root (const std::string &root)
     remove the file:// from a given root More...
     
    std::string FDP::remove_backslash_from_path (const std::string &path)
     replace backslashes with forward slashes in a given path More...
     
    bool FDP::file_exists (const std::string &Filename)
     check whether a given file exists More...
     
    std::string FDP::read_token (const ghc::filesystem::path &token_path)
     read a token from a given file More...
     
    +

    Detailed Description

    +

    File containing methods for handling of metadata.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Date
    2021-05-05
    +

    The functions contained within this file process or create metadata related to the versioning of objects and runs.

    +

    Function Documentation

    + +

    ◆ calculate_hash_from_file()

    + +
    +
    + + + + + + + + +
    std::string FDP::calculate_hash_from_file (const ghc::filesystem::path & file_path)
    +
    + +

    calculates a hash from a given input file via SHA1

    +
    +
    Returns
    the hash obtained from the file contents
    + +
    +
    + +

    ◆ calculate_hash_from_string()

    + +
    +
    + + + + + + + + +
    std::string FDP::calculate_hash_from_string (const std::string & input)
    +
    + +

    calculates a hash from a given string via SHA1

    +
    +
    Parameters
    + + +
    inputstring to be hashed
    +
    +
    +
    Returns
    the hash obtained from the string contents
    + +
    +
    + +

    ◆ current_time_stamp()

    + +
    +
    + + + + + + + + +
    std::string FDP::current_time_stamp (bool file_name = false)
    +
    + +

    returns the current time as a timestamp

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Parameters
    + + +
    file_nameif true, format the timestamp to be filename friendly
    +
    +
    +
    Returns
    timestamp for the current time
    + +
    +
    + +

    ◆ file_exists()

    + +
    +
    + + + + + + + + +
    bool FDP::file_exists (const std::string & Filename)
    +
    + +

    check whether a given file exists

    +
    Parameters
    + + +
    Filename
    +
    +
    +
    Returns
    true file exists
    +
    +false file does not exist
    + +
    +
    + +

    ◆ generate_random_hash()

    + +
    +
    + + + + + + + +
    std::string FDP::generate_random_hash ()
    +
    + +

    Generate a random hash.

    +
    Returns
    std::string a random hash
    + +
    +
    + +

    ◆ read_token()

    + +
    +
    + + + + + + + + +
    std::string FDP::read_token (const ghc::filesystem::path & token_path)
    +
    + +

    read a token from a given file

    +
    Parameters
    + + +
    token_path
    +
    +
    +
    Returns
    std::string
    + +
    +
    + +

    ◆ remove_backslash_from_path()

    + +
    +
    + + + + + + + + +
    std::string FDP::remove_backslash_from_path (const std::string & path)
    +
    + +

    replace backslashes with forward slashes in a given path

    +
    Parameters
    + + +
    path
    +
    +
    +
    Returns
    std::string
    + +
    +
    + +

    ◆ remove_local_from_root()

    + +
    +
    + + + + + + + + +
    std::string FDP::remove_local_from_root (const std::string & root)
    +
    + +

    remove the file:// from a given root

    +
    Parameters
    + + +
    root
    +
    +
    +
    Returns
    std::string
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/metadata_8hxx_source.html b/metadata_8hxx_source.html new file mode 100644 index 0000000..d77f4da --- /dev/null +++ b/metadata_8hxx_source.html @@ -0,0 +1,130 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/metadata.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    metadata.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    10#ifndef __FDP_METADATA_HXX__
    +
    11#define __FDP_METADATA_HXX__
    +
    12
    +
    13#include <ctime>
    +
    14#include <ghc/filesystem.hpp>
    +
    15#include <fstream>
    +
    16#include <iomanip>
    +
    17#include <iostream>
    +
    18#include <sstream>
    +
    19#include <random>
    +
    20#include <chrono>
    +
    21#include <regex>
    +
    22
    +
    23#include "digestpp.hpp"
    +
    24
    +
    25#ifdef _WIN32
    +
    26 #include <io.h>
    +
    27 #define access _access_s
    +
    28#else
    +
    29 #include <unistd.h>
    +
    30#endif
    +
    31
    +
    32namespace FDP {
    +
    38std::string calculate_hash_from_file(const ghc::filesystem::path &);
    +
    39
    +
    46std::string calculate_hash_from_string(const std::string &input);
    +
    47
    +
    53std::string generate_random_hash();
    +
    54
    +
    62std::string current_time_stamp(bool file_name = false);
    +
    63
    +
    70std::string remove_local_from_root(const std::string &root);
    +
    71
    +
    78std::string remove_backslash_from_path(const std::string &path);
    +
    79
    +
    87bool file_exists( const std::string &Filename );
    +
    88
    +
    95std::string read_token(const ghc::filesystem::path &token_path);
    +
    96
    +
    97}; // namespace FDP
    +
    98
    +
    99#endif
    +
    FDP::current_time_stamp
    std::string current_time_stamp(bool file_name=false)
    returns the current time as a timestamp
    Definition: metadata.cxx:52
    +
    FDP::remove_local_from_root
    std::string remove_local_from_root(const std::string &root)
    remove the file:// from a given root
    Definition: metadata.cxx:67
    +
    FDP::remove_backslash_from_path
    std::string remove_backslash_from_path(const std::string &path)
    replace backslashes with forward slashes in a given path
    Definition: metadata.cxx:71
    +
    FDP::read_token
    std::string read_token(const ghc::filesystem::path &token_path)
    read a token from a given file
    Definition: metadata.cxx:80
    +
    FDP::file_exists
    bool file_exists(const std::string &Filename)
    check whether a given file exists
    Definition: metadata.cxx:75
    +
    FDP::generate_random_hash
    std::string generate_random_hash()
    Generate a random hash.
    Definition: metadata.cxx:22
    +
    FDP::calculate_hash_from_string
    std::string calculate_hash_from_string(const std::string &input)
    calculates a hash from a given string via SHA1
    Definition: metadata.cxx:18
    +
    FDP::calculate_hash_from_file
    std::string calculate_hash_from_file(const ghc::filesystem::path &)
    calculates a hash from a given input file via SHA1
    Definition: metadata.cxx:4
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/namespace_f_d_p_1_1_versioning.html b/namespace_f_d_p_1_1_versioning.html new file mode 100644 index 0000000..8082e77 --- /dev/null +++ b/namespace_f_d_p_1_1_versioning.html @@ -0,0 +1,144 @@ + + + + + + + +cppDataPipeline: FDP::Versioning Namespace Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Enumerations
    +
    FDP::Versioning Namespace Reference
    +
    +
    + +

    namespace containing all semantic versioning types and classes +More...

    + + + + + +

    +Classes

    class  version
     class describing the semantic version of an object More...
     
    + + + + +

    +Enumerations

    enum class  meta_tag { ALPHA +, BETA +, RELEASE_CANDIDATE +, RELEASE + }
     the allowed tags for versions describing version state More...
     
    +

    Detailed Description

    +

    namespace containing all semantic versioning types and classes

    +
    +
    Author
    K. Zarebski (UKAEA)
    +

    Enumeration Type Documentation

    + +

    ◆ meta_tag

    + +
    +
    + + + + + +
    + + + + +
    enum class FDP::Versioning::meta_tag
    +     		+strong
    +
    + +

    the allowed tags for versions describing version state

    +
    +
    Author
    K. Zarebski (UKAEA)
    +

    This enum class contains all permitted release state classifiers which describe whether the code/data object is a full release or still under review by the authors

    + + + + + +
    Enumerator
    ALPHA 

    Release is an Alpha release

    +
    BETA 

    Release is an Beta release

    +
    RELEASE_CANDIDATE 

    Release is a candidate for full release

    +
    RELEASE 

    Release is a full release

    +
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/namespacemembers.html b/namespacemembers.html new file mode 100644 index 0000000..eaef37e --- /dev/null +++ b/namespacemembers.html @@ -0,0 +1,75 @@ + + + + + + + +cppDataPipeline: Namespace Members + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Here is a list of all documented namespace members with links to the namespaces they belong to:
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/namespacemembers_enum.html b/namespacemembers_enum.html new file mode 100644 index 0000000..25cb595 --- /dev/null +++ b/namespacemembers_enum.html @@ -0,0 +1,75 @@ + + + + + + + +cppDataPipeline: Namespace Members + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +  +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/namespaces.html b/namespaces.html new file mode 100644 index 0000000..93d16aa --- /dev/null +++ b/namespaces.html @@ -0,0 +1,94 @@ + + + + + + + +cppDataPipeline: Namespace List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Namespace List
    +
    +
    +
    Here is a list of all documented namespaces with brief descriptions:
    +
    [detail level 123]
    + + + + + + + + + + + + + + + +
     ▼NFDP
     ▼NVersioningNamespace containing all semantic versioning types and classes
     CversionClass describing the semantic version of an object
     CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CApiObjectClass for API objects
     CConfigClass for interacting with confifurations
     Cconfig_parsing_error
     CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
     CIOObjectClass for API objects
     Cjson_parse_error
     Crest_apiquery_error
     Csync_error
     Cvalidation_error
     Cwrite_error
    +
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/search/all_0.js b/search/all_0.js index 59482d3..999c0fe 100644 --- a/search/all_0.js +++ b/search/all_0.js @@ -1,4 +1,9 @@ var searchData= [ - ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../md__r_e_a_d_m_e.html',1,'']]] + ['alpha_0',['ALPHA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a002101f8725e5c78d9f30d87f3fa4c87',1,'FDP::Versioning']]], + ['api_1',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API::API()'],['../class_f_d_p_1_1_a_p_i.html',1,'FDP::API']]], + ['api_2ehxx_2',['api.hxx',['../api_8hxx.html',1,'']]], + ['apilogger_3',['APILogger',['../logging_8hxx.html#a86cb9217b28d11ce2d889dbbe92bcb2b',1,'FDP']]], + ['apiobject_4',['ApiObject',['../class_f_d_p_1_1_api_object.html#a6db277989caee23fb8ca73c76f629b8a',1,'FDP::ApiObject::ApiObject()'],['../class_f_d_p_1_1_api_object.html',1,'FDP::ApiObject']]], + ['append_5fwith_5fforward_5fslash_5',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] ]; diff --git a/search/all_1.js b/search/all_1.js index 5e2db56..ccd8dc2 100644 --- a/search/all_1.js +++ b/search/all_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['scrc_20software_20checklist_0',['SCRC Software checklist',['../md_software_checklist.html',1,'']]] + ['beta_0',['BETA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a36b84f8e3fba5bf993e3ba352d62d146',1,'FDP::Versioning']]] ]; diff --git a/search/pages_1.html b/search/all_10.html similarity index 95% rename from search/pages_1.html rename to search/all_10.html index 37ed0d6..9501164 100644 --- a/search/pages_1.html +++ b/search/all_10.html @@ -4,7 +4,7 @@ - + diff --git a/search/all_10.js b/search/all_10.js new file mode 100644 index 0000000..9bd96a8 --- /dev/null +++ b/search/all_10.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['write_5ferror_0',['write_error',['../class_f_d_p_1_1write__error.html',1,'FDP']]], + ['write_5ffunc_5f_1',['write_func_',['../api_8hxx.html#aafe123714129a23215ddd6799c699af6',1,'FDP']]] +]; diff --git a/search/pages_2.html b/search/all_11.html similarity index 95% rename from search/pages_2.html rename to search/all_11.html index 878d7ec..d0712de 100644 --- a/search/pages_2.html +++ b/search/all_11.html @@ -4,7 +4,7 @@ - + diff --git a/search/all_11.js b/search/all_11.js new file mode 100644 index 0000000..d5162b8 --- /dev/null +++ b/search/all_11.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['_7econfig_0',['~Config',['../class_f_d_p_1_1_config.html#a5078af487531c263fef8fbe08a4191df',1,'FDP::Config']]], + ['_7edatapipeline_1',['~DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#a67f8a0f07ef29d1c4661e74bdd79ce38',1,'FDP::DataPipeline']]], + ['_7edatapipelineimpl_5f_2',['~DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#afa07a6b6e5620aa823f87fbc9cb6d931',1,'FDP::DataPipelineImpl_']]] +]; diff --git a/search/all_2.js b/search/all_2.js index cd0d928..047f583 100644 --- a/search/all_2.js +++ b/search/all_2.js @@ -1,4 +1,12 @@ var searchData= [ - ['unreleased_0',['Unreleased',['../md__c_h_a_n_g_e_l_o_g.html',1,'']]] + ['calculate_5fhash_5ffrom_5ffile_0',['calculate_hash_from_file',['../metadata_8hxx.html#aef5b5dab5a6743bed9e9d0842ec8e0b9',1,'FDP']]], + ['calculate_5fhash_5ffrom_5fstring_1',['calculate_hash_from_string',['../metadata_8hxx.html#add1040168fb281b0753ca26cd445d8ee',1,'FDP']]], + ['config_2',['Config',['../class_f_d_p_1_1_config.html#a3428bf5e0bf7158d4e6b98ab088e034f',1,'FDP::Config::Config()'],['../class_f_d_p_1_1_config.html',1,'FDP::Config']]], + ['config_2ehxx_3',['config.hxx',['../config_8hxx.html',1,'']]], + ['config_5fparsing_5ferror_4',['config_parsing_error',['../class_f_d_p_1_1config__parsing__error.html',1,'FDP']]], + ['config_5freads_5f_5',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], + ['config_5fwrites_5f_6',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], + ['create_5flogger_5f_7',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], + ['current_5ftime_5fstamp_8',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] ]; diff --git a/search/all_3.html b/search/all_3.html new file mode 100644 index 0000000..fdb6e19 --- /dev/null +++ b/search/all_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_3.js b/search/all_3.js new file mode 100644 index 0000000..0d8504d --- /dev/null +++ b/search/all_3.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline::DataPipeline()'],['../class_f_d_p_1_1_data_pipeline.html',1,'FDP::DataPipeline']]], + ['datapipeline_2ehxx_1',['datapipeline.hxx',['../datapipeline_8hxx.html',1,'']]], + ['datapipelineimpl_5f_2',['DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#a2f3af03f6bb27804e256875ea0b94264',1,'FDP::DataPipelineImpl_::DataPipelineImpl_()'],['../class_f_d_p_1_1_data_pipeline_impl__.html',1,'FDP::DataPipelineImpl_']]] +]; diff --git a/search/all_4.html b/search/all_4.html new file mode 100644 index 0000000..1a50c46 --- /dev/null +++ b/search/all_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_4.js b/search/all_4.js new file mode 100644 index 0000000..41a0804 --- /dev/null +++ b/search/all_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['escape_5fspace_0',['escape_space',['../class_f_d_p_1_1_a_p_i.html#a98101859c913eea13166a115a97b9e64',1,'FDP::API']]] +]; diff --git a/search/all_5.html b/search/all_5.html new file mode 100644 index 0000000..4dce5e7 --- /dev/null +++ b/search/all_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_5.js b/search/all_5.js new file mode 100644 index 0000000..f7fb506 --- /dev/null +++ b/search/all_5.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../index.html',1,'']]], + ['file_5fexists_1',['file_exists',['../metadata_8hxx.html#a7d885b9af9988c944d23eedbff430272',1,'FDP']]], + ['finalise_2',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#aa6b0b27726c312a089a6face0351410d',1,'FDP::DataPipelineImpl_::finalise()']]], + ['versioning_3',['Versioning',['../namespace_f_d_p_1_1_versioning.html',1,'FDP']]] +]; diff --git a/search/all_6.html b/search/all_6.html new file mode 100644 index 0000000..bb28b19 --- /dev/null +++ b/search/all_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_6.js b/search/all_6.js new file mode 100644 index 0000000..6650db9 --- /dev/null +++ b/search/all_6.js @@ -0,0 +1,37 @@ +var searchData= +[ + ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], + ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a63a726148d6e0f18c057d36f3cfa8aeb',1,'FDP::Config']]], + ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], + ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], + ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_impl__.html#a7c8b64bf66c46cebc334e2e0e3fcd0f6',1,'FDP::DataPipelineImpl_::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], + ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#a4d3ab4dc8d8b0754b612dad823abbd1c',1,'FDP::IOObject']]], + ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#a3da2459b081a3296e76e02f407fd3920',1,'FDP::IOObject']]], + ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], + ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], + ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], + ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#aa89e39ad7c6346a82ba3d8aca722dfe5',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#af7e308602e39909c3c95f5ce621f7e60',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af19cf9bf9bc20d169a8b00a3458c266f',1,'FDP::IOObject']]], + ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], + ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], + ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], + ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], + ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], + ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], + ['get_5fobject_19',['get_object',['../class_f_d_p_1_1_api_object.html#af71a87df669ce569548f04cb6579e5b2',1,'FDP::ApiObject']]], + ['get_5fpath_20',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], + ['get_5frequest_21',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], + ['get_5frest_5fapi_5flocation_22',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], + ['get_5fscript_5ffile_5fpath_23',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], + ['get_5ftoken_24',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], + ['get_5ftype_25',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], + ['get_5furi_26',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], + ['get_5furl_5froot_27',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], + ['get_5fuse_5fcomponent_28',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], + ['get_5fuse_5fdata_5fproduct_29',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], + ['get_5fuse_5fnamespace_30',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], + ['get_5fuse_5fversion_31',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], + ['get_5fvalue_5fas_5fint_32',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], + ['get_5fvalue_5fas_5fstring_33',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] +]; diff --git a/search/all_7.html b/search/all_7.html new file mode 100644 index 0000000..ee4017e --- /dev/null +++ b/search/all_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_7.js b/search/all_7.js new file mode 100644 index 0000000..54d93b0 --- /dev/null +++ b/search/all_7.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['has_5finputs_0',['has_inputs',['../class_f_d_p_1_1_config.html#a3575ed8e0f6a51f99b4428bd575bfc24',1,'FDP::Config']]], + ['has_5foutputs_1',['has_outputs',['../class_f_d_p_1_1_config.html#ab3424fed4132fd1adda88f1566293de4',1,'FDP::Config']]], + ['has_5freads_2',['has_reads',['../class_f_d_p_1_1_config.html#a4d652212cbb50a0e92afc41ea64815de',1,'FDP::Config']]], + ['has_5fwrites_3',['has_writes',['../class_f_d_p_1_1_config.html#ab2c81212fdb00aeda1f7881df61e60a7',1,'FDP::Config']]] +]; diff --git a/search/all_8.html b/search/all_8.html new file mode 100644 index 0000000..e2c6307 --- /dev/null +++ b/search/all_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_8.js b/search/all_8.js new file mode 100644 index 0000000..130c37f --- /dev/null +++ b/search/all_8.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['ioobject_0',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP::IOObject'],['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['is_5fempty_1',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], + ['is_5fpublic_2',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] +]; diff --git a/search/all_9.html b/search/all_9.html new file mode 100644 index 0000000..768d5c9 --- /dev/null +++ b/search/all_9.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_9.js b/search/all_9.js new file mode 100644 index 0000000..ee3fc51 --- /dev/null +++ b/search/all_9.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['json_2ehxx_0',['json.hxx',['../json_8hxx.html',1,'']]], + ['json_5fparse_5ferror_1',['json_parse_error',['../class_f_d_p_1_1json__parse__error.html',1,'FDP']]], + ['json_5fto_5fquery_5fstring_2',['json_to_query_string',['../class_f_d_p_1_1_a_p_i.html#ad91263a71029cccc94e9e49cd4a37568',1,'FDP::API']]], + ['json_5fto_5fstring_3',['json_to_string',['../json_8hxx.html#a77f24139171b28c1fc719b55846938f1',1,'FDP']]] +]; diff --git a/search/all_a.html b/search/all_a.html new file mode 100644 index 0000000..e3ec122 --- /dev/null +++ b/search/all_a.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_a.js b/search/all_a.js new file mode 100644 index 0000000..c0d9881 --- /dev/null +++ b/search/all_a.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a074dacc234b734a6a3bb0e86d07042ad',1,'FDP::DataPipelineImpl_::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a7d13934d76ca915232755c886bc59306',1,'FDP::DataPipelineImpl_::link_write()']]], + ['local_2',['LOCAL',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa54b4c4075463b2e02cd69f5cd139b5b2',1,'FDP']]], + ['logging_2ehxx_3',['logging.hxx',['../logging_8hxx.html',1,'']]] +]; diff --git a/search/all_b.html b/search/all_b.html new file mode 100644 index 0000000..80b5a71 --- /dev/null +++ b/search/all_b.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_b.js b/search/all_b.js new file mode 100644 index 0000000..f1322a6 --- /dev/null +++ b/search/all_b.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['meta_5fdata_5f_0',['meta_data_',['../class_f_d_p_1_1_config.html#a6202b2d39b4dbd977340b90f5382a4fb',1,'FDP::Config']]], + ['meta_5ftag_1',['meta_tag',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08',1,'FDP::Versioning']]], + ['metadata_2ehxx_2',['metadata.hxx',['../metadata_8hxx.html',1,'']]] +]; diff --git a/search/all_c.html b/search/all_c.html new file mode 100644 index 0000000..6e724a0 --- /dev/null +++ b/search/all_c.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_c.js b/search/all_c.js new file mode 100644 index 0000000..dd59b81 --- /dev/null +++ b/search/all_c.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['parse_5fyaml_0',['parse_yaml',['../class_f_d_p_1_1_config.html#a12c5d3bb7298854078dfb5bf70e31443',1,'FDP::Config']]], + ['post_1',['post',['../class_f_d_p_1_1_a_p_i.html#a2479874abf32bcaaeb269972b3aaef90',1,'FDP::API']]] +]; diff --git a/search/all_d.html b/search/all_d.html new file mode 100644 index 0000000..67677b0 --- /dev/null +++ b/search/all_d.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_d.js b/search/all_d.js new file mode 100644 index 0000000..9a228a2 --- /dev/null +++ b/search/all_d.js @@ -0,0 +1,12 @@ +var searchData= +[ + ['read_5ftoken_0',['read_token',['../metadata_8hxx.html#a5dbd216ab20d3b4329231ba5965b34e3',1,'FDP']]], + ['release_1',['RELEASE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a7d649ef069df9885e382417c79f3d5cd',1,'FDP::Versioning']]], + ['release_5fcandidate_2',['RELEASE_CANDIDATE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a29fa7e21ab006777c5d8f86d893bfa53',1,'FDP::Versioning']]], + ['remote_3',['REMOTE',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa62f728a9642195060871a70b9b60c937',1,'FDP']]], + ['remove_5fbackslash_5ffrom_5fpath_4',['remove_backslash_from_path',['../metadata_8hxx.html#a45be90ccf712b64441d38e0a1ed324f4',1,'FDP']]], + ['remove_5fleading_5fforward_5fslash_5',['remove_leading_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a69448057f09381a313980bec41b3d4cd',1,'FDP::API']]], + ['remove_5flocal_5ffrom_5froot_6',['remove_local_from_root',['../metadata_8hxx.html#a1f7e1d16c6056d8117113a16d806e75d',1,'FDP']]], + ['rest_5fapiquery_5ferror_7',['rest_apiquery_error',['../class_f_d_p_1_1rest__apiquery__error.html',1,'FDP']]], + ['restapi_8',['RESTAPI',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45f',1,'FDP']]] +]; diff --git a/search/all_e.html b/search/all_e.html new file mode 100644 index 0000000..c1f4e6e --- /dev/null +++ b/search/all_e.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_e.js b/search/all_e.js new file mode 100644 index 0000000..26a767b --- /dev/null +++ b/search/all_e.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['semver_2ehxx_0',['semver.hxx',['../semver_8hxx.html',1,'']]], + ['set_5fcomponent_5fobject_1',['set_component_object',['../class_f_d_p_1_1_i_o_object.html#ac4ec3246d12c759041bb2ca099afffac',1,'FDP::IOObject']]], + ['set_5fdata_5fproduct_5fobject_2',['set_data_product_object',['../class_f_d_p_1_1_i_o_object.html#a4a3cd1518aa9138c15c52cf925f3f1e3',1,'FDP::IOObject']]], + ['sync_5ferror_3',['sync_error',['../class_f_d_p_1_1sync__error.html',1,'FDP']]] +]; diff --git a/search/all_f.html b/search/all_f.html new file mode 100644 index 0000000..df25328 --- /dev/null +++ b/search/all_f.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_f.js b/search/all_f.js new file mode 100644 index 0000000..202a0d3 --- /dev/null +++ b/search/all_f.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['validation_5ferror_0',['validation_error',['../class_f_d_p_1_1validation__error.html',1,'FDP']]], + ['version_1',['version',['../class_f_d_p_1_1_versioning_1_1version.html',1,'FDP::Versioning::version'],['../class_f_d_p_1_1_versioning_1_1version.html#aa9be4a03ccee8827e226ea4154781bc6',1,'FDP::Versioning::version::version()=default'],['../class_f_d_p_1_1_versioning_1_1version.html#ac46f9e049c31b63fb6552409d7d2d7b1',1,'FDP::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] +]; diff --git a/search/classes_0.html b/search/classes_0.html new file mode 100644 index 0000000..4112ea7 --- /dev/null +++ b/search/classes_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_0.js b/search/classes_0.js new file mode 100644 index 0000000..fc23376 --- /dev/null +++ b/search/classes_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['api_0',['API',['../class_f_d_p_1_1_a_p_i.html',1,'FDP']]], + ['apiobject_1',['ApiObject',['../class_f_d_p_1_1_api_object.html',1,'FDP']]] +]; diff --git a/search/classes_1.html b/search/classes_1.html new file mode 100644 index 0000000..1f92ba8 --- /dev/null +++ b/search/classes_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_1.js b/search/classes_1.js new file mode 100644 index 0000000..543cc44 --- /dev/null +++ b/search/classes_1.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['config_0',['Config',['../class_f_d_p_1_1_config.html',1,'FDP']]], + ['config_5fparsing_5ferror_1',['config_parsing_error',['../class_f_d_p_1_1config__parsing__error.html',1,'FDP']]] +]; diff --git a/search/classes_2.html b/search/classes_2.html new file mode 100644 index 0000000..b65ed72 --- /dev/null +++ b/search/classes_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_2.js b/search/classes_2.js new file mode 100644 index 0000000..dbe86d6 --- /dev/null +++ b/search/classes_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html',1,'FDP']]], + ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html',1,'FDP']]] +]; diff --git a/search/classes_3.html b/search/classes_3.html new file mode 100644 index 0000000..11b019a --- /dev/null +++ b/search/classes_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_3.js b/search/classes_3.js new file mode 100644 index 0000000..86ec3df --- /dev/null +++ b/search/classes_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ioobject_0',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP']]] +]; diff --git a/search/classes_4.html b/search/classes_4.html new file mode 100644 index 0000000..56c3689 --- /dev/null +++ b/search/classes_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_4.js b/search/classes_4.js new file mode 100644 index 0000000..ee83dc0 --- /dev/null +++ b/search/classes_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['json_5fparse_5ferror_0',['json_parse_error',['../class_f_d_p_1_1json__parse__error.html',1,'FDP']]] +]; diff --git a/search/classes_5.html b/search/classes_5.html new file mode 100644 index 0000000..9b2fcaa --- /dev/null +++ b/search/classes_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_5.js b/search/classes_5.js new file mode 100644 index 0000000..5d19101 --- /dev/null +++ b/search/classes_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['rest_5fapiquery_5ferror_0',['rest_apiquery_error',['../class_f_d_p_1_1rest__apiquery__error.html',1,'FDP']]] +]; diff --git a/search/classes_6.html b/search/classes_6.html new file mode 100644 index 0000000..16163e7 --- /dev/null +++ b/search/classes_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_6.js b/search/classes_6.js new file mode 100644 index 0000000..0a01a4d --- /dev/null +++ b/search/classes_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['sync_5ferror_0',['sync_error',['../class_f_d_p_1_1sync__error.html',1,'FDP']]] +]; diff --git a/search/classes_7.html b/search/classes_7.html new file mode 100644 index 0000000..2fc3931 --- /dev/null +++ b/search/classes_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_7.js b/search/classes_7.js new file mode 100644 index 0000000..a751baa --- /dev/null +++ b/search/classes_7.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['validation_5ferror_0',['validation_error',['../class_f_d_p_1_1validation__error.html',1,'FDP']]], + ['version_1',['version',['../class_f_d_p_1_1_versioning_1_1version.html',1,'FDP::Versioning']]] +]; diff --git a/search/classes_8.html b/search/classes_8.html new file mode 100644 index 0000000..bc0d5ca --- /dev/null +++ b/search/classes_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_8.js b/search/classes_8.js new file mode 100644 index 0000000..be6390b --- /dev/null +++ b/search/classes_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5ferror_0',['write_error',['../class_f_d_p_1_1write__error.html',1,'FDP']]] +]; diff --git a/search/enums_0.html b/search/enums_0.html new file mode 100644 index 0000000..3071d59 --- /dev/null +++ b/search/enums_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/enums_0.js b/search/enums_0.js new file mode 100644 index 0000000..416e3bc --- /dev/null +++ b/search/enums_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['meta_5ftag_0',['meta_tag',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08',1,'FDP::Versioning']]] +]; diff --git a/search/enums_1.html b/search/enums_1.html new file mode 100644 index 0000000..4b930ac --- /dev/null +++ b/search/enums_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/enums_1.js b/search/enums_1.js new file mode 100644 index 0000000..f61498a --- /dev/null +++ b/search/enums_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['restapi_0',['RESTAPI',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45f',1,'FDP']]] +]; diff --git a/search/enumvalues_0.html b/search/enumvalues_0.html new file mode 100644 index 0000000..31cb0f6 --- /dev/null +++ b/search/enumvalues_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/enumvalues_0.js b/search/enumvalues_0.js new file mode 100644 index 0000000..80cdc28 --- /dev/null +++ b/search/enumvalues_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['alpha_0',['ALPHA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a002101f8725e5c78d9f30d87f3fa4c87',1,'FDP::Versioning']]] +]; diff --git a/search/enumvalues_1.html b/search/enumvalues_1.html new file mode 100644 index 0000000..770368b --- /dev/null +++ b/search/enumvalues_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/enumvalues_1.js b/search/enumvalues_1.js new file mode 100644 index 0000000..ccd8dc2 --- /dev/null +++ b/search/enumvalues_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['beta_0',['BETA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a36b84f8e3fba5bf993e3ba352d62d146',1,'FDP::Versioning']]] +]; diff --git a/search/enumvalues_2.html b/search/enumvalues_2.html new file mode 100644 index 0000000..9f464a7 --- /dev/null +++ b/search/enumvalues_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/enumvalues_2.js b/search/enumvalues_2.js new file mode 100644 index 0000000..a30f4a9 --- /dev/null +++ b/search/enumvalues_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['local_0',['LOCAL',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa54b4c4075463b2e02cd69f5cd139b5b2',1,'FDP']]] +]; diff --git a/search/enumvalues_3.html b/search/enumvalues_3.html new file mode 100644 index 0000000..08a159b --- /dev/null +++ b/search/enumvalues_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/enumvalues_3.js b/search/enumvalues_3.js new file mode 100644 index 0000000..c3ed804 --- /dev/null +++ b/search/enumvalues_3.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['release_0',['RELEASE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a7d649ef069df9885e382417c79f3d5cd',1,'FDP::Versioning']]], + ['release_5fcandidate_1',['RELEASE_CANDIDATE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a29fa7e21ab006777c5d8f86d893bfa53',1,'FDP::Versioning']]], + ['remote_2',['REMOTE',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa62f728a9642195060871a70b9b60c937',1,'FDP']]] +]; diff --git a/search/files_0.html b/search/files_0.html new file mode 100644 index 0000000..e284084 --- /dev/null +++ b/search/files_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_0.js b/search/files_0.js new file mode 100644 index 0000000..a9561d0 --- /dev/null +++ b/search/files_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['api_2ehxx_0',['api.hxx',['../api_8hxx.html',1,'']]] +]; diff --git a/search/files_1.html b/search/files_1.html new file mode 100644 index 0000000..2e6e1e1 --- /dev/null +++ b/search/files_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_1.js b/search/files_1.js new file mode 100644 index 0000000..09bcd02 --- /dev/null +++ b/search/files_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['config_2ehxx_0',['config.hxx',['../config_8hxx.html',1,'']]] +]; diff --git a/search/files_2.html b/search/files_2.html new file mode 100644 index 0000000..7a0a2e1 --- /dev/null +++ b/search/files_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_2.js b/search/files_2.js new file mode 100644 index 0000000..0fc2c3a --- /dev/null +++ b/search/files_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['datapipeline_2ehxx_0',['datapipeline.hxx',['../datapipeline_8hxx.html',1,'']]] +]; diff --git a/search/files_3.html b/search/files_3.html new file mode 100644 index 0000000..418f304 --- /dev/null +++ b/search/files_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_3.js b/search/files_3.js new file mode 100644 index 0000000..4ddb543 --- /dev/null +++ b/search/files_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['json_2ehxx_0',['json.hxx',['../json_8hxx.html',1,'']]] +]; diff --git a/search/files_4.html b/search/files_4.html new file mode 100644 index 0000000..d5e4577 --- /dev/null +++ b/search/files_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_4.js b/search/files_4.js new file mode 100644 index 0000000..2965f28 --- /dev/null +++ b/search/files_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['logging_2ehxx_0',['logging.hxx',['../logging_8hxx.html',1,'']]] +]; diff --git a/search/files_5.html b/search/files_5.html new file mode 100644 index 0000000..c1ae5d6 --- /dev/null +++ b/search/files_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_5.js b/search/files_5.js new file mode 100644 index 0000000..f5067bf --- /dev/null +++ b/search/files_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['metadata_2ehxx_0',['metadata.hxx',['../metadata_8hxx.html',1,'']]] +]; diff --git a/search/files_6.html b/search/files_6.html new file mode 100644 index 0000000..fe47781 --- /dev/null +++ b/search/files_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/files_6.js b/search/files_6.js new file mode 100644 index 0000000..6050d04 --- /dev/null +++ b/search/files_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['semver_2ehxx_0',['semver.hxx',['../semver_8hxx.html',1,'']]] +]; diff --git a/search/functions_0.html b/search/functions_0.html new file mode 100644 index 0000000..ce45090 --- /dev/null +++ b/search/functions_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_0.js b/search/functions_0.js new file mode 100644 index 0000000..2922d2e --- /dev/null +++ b/search/functions_0.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['api_0',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API']]], + ['apiobject_1',['ApiObject',['../class_f_d_p_1_1_api_object.html#a6db277989caee23fb8ca73c76f629b8a',1,'FDP::ApiObject']]], + ['append_5fwith_5fforward_5fslash_2',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] +]; diff --git a/search/functions_1.html b/search/functions_1.html new file mode 100644 index 0000000..9b97441 --- /dev/null +++ b/search/functions_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_1.js b/search/functions_1.js new file mode 100644 index 0000000..52090c1 --- /dev/null +++ b/search/functions_1.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['calculate_5fhash_5ffrom_5ffile_0',['calculate_hash_from_file',['../metadata_8hxx.html#aef5b5dab5a6743bed9e9d0842ec8e0b9',1,'FDP']]], + ['calculate_5fhash_5ffrom_5fstring_1',['calculate_hash_from_string',['../metadata_8hxx.html#add1040168fb281b0753ca26cd445d8ee',1,'FDP']]], + ['config_2',['Config',['../class_f_d_p_1_1_config.html#a3428bf5e0bf7158d4e6b98ab088e034f',1,'FDP::Config']]], + ['config_5freads_5f_3',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], + ['config_5fwrites_5f_4',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], + ['create_5flogger_5f_5',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], + ['current_5ftime_5fstamp_6',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] +]; diff --git a/search/functions_10.html b/search/functions_10.html new file mode 100644 index 0000000..0a62f42 --- /dev/null +++ b/search/functions_10.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_10.js b/search/functions_10.js new file mode 100644 index 0000000..d5162b8 --- /dev/null +++ b/search/functions_10.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['_7econfig_0',['~Config',['../class_f_d_p_1_1_config.html#a5078af487531c263fef8fbe08a4191df',1,'FDP::Config']]], + ['_7edatapipeline_1',['~DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#a67f8a0f07ef29d1c4661e74bdd79ce38',1,'FDP::DataPipeline']]], + ['_7edatapipelineimpl_5f_2',['~DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#afa07a6b6e5620aa823f87fbc9cb6d931',1,'FDP::DataPipelineImpl_']]] +]; diff --git a/search/functions_2.html b/search/functions_2.html new file mode 100644 index 0000000..43aea53 --- /dev/null +++ b/search/functions_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_2.js b/search/functions_2.js new file mode 100644 index 0000000..adeea97 --- /dev/null +++ b/search/functions_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline']]], + ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#a2f3af03f6bb27804e256875ea0b94264',1,'FDP::DataPipelineImpl_']]] +]; diff --git a/search/functions_3.html b/search/functions_3.html new file mode 100644 index 0000000..6c0090f --- /dev/null +++ b/search/functions_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_3.js b/search/functions_3.js new file mode 100644 index 0000000..41a0804 --- /dev/null +++ b/search/functions_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['escape_5fspace_0',['escape_space',['../class_f_d_p_1_1_a_p_i.html#a98101859c913eea13166a115a97b9e64',1,'FDP::API']]] +]; diff --git a/search/functions_4.html b/search/functions_4.html new file mode 100644 index 0000000..2966937 --- /dev/null +++ b/search/functions_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_4.js b/search/functions_4.js new file mode 100644 index 0000000..6a618b8 --- /dev/null +++ b/search/functions_4.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['file_5fexists_0',['file_exists',['../metadata_8hxx.html#a7d885b9af9988c944d23eedbff430272',1,'FDP']]], + ['finalise_1',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#aa6b0b27726c312a089a6face0351410d',1,'FDP::DataPipelineImpl_::finalise()']]] +]; diff --git a/search/functions_5.html b/search/functions_5.html new file mode 100644 index 0000000..ad6be4c --- /dev/null +++ b/search/functions_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_5.js b/search/functions_5.js new file mode 100644 index 0000000..6650db9 --- /dev/null +++ b/search/functions_5.js @@ -0,0 +1,37 @@ +var searchData= +[ + ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], + ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a63a726148d6e0f18c057d36f3cfa8aeb',1,'FDP::Config']]], + ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], + ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], + ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_impl__.html#a7c8b64bf66c46cebc334e2e0e3fcd0f6',1,'FDP::DataPipelineImpl_::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], + ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#a4d3ab4dc8d8b0754b612dad823abbd1c',1,'FDP::IOObject']]], + ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#a3da2459b081a3296e76e02f407fd3920',1,'FDP::IOObject']]], + ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], + ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], + ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], + ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#aa89e39ad7c6346a82ba3d8aca722dfe5',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#af7e308602e39909c3c95f5ce621f7e60',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af19cf9bf9bc20d169a8b00a3458c266f',1,'FDP::IOObject']]], + ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], + ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], + ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], + ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], + ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], + ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], + ['get_5fobject_19',['get_object',['../class_f_d_p_1_1_api_object.html#af71a87df669ce569548f04cb6579e5b2',1,'FDP::ApiObject']]], + ['get_5fpath_20',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], + ['get_5frequest_21',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], + ['get_5frest_5fapi_5flocation_22',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], + ['get_5fscript_5ffile_5fpath_23',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], + ['get_5ftoken_24',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], + ['get_5ftype_25',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], + ['get_5furi_26',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], + ['get_5furl_5froot_27',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], + ['get_5fuse_5fcomponent_28',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], + ['get_5fuse_5fdata_5fproduct_29',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], + ['get_5fuse_5fnamespace_30',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], + ['get_5fuse_5fversion_31',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], + ['get_5fvalue_5fas_5fint_32',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], + ['get_5fvalue_5fas_5fstring_33',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] +]; diff --git a/search/functions_6.html b/search/functions_6.html new file mode 100644 index 0000000..ebb5d2b --- /dev/null +++ b/search/functions_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_6.js b/search/functions_6.js new file mode 100644 index 0000000..54d93b0 --- /dev/null +++ b/search/functions_6.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['has_5finputs_0',['has_inputs',['../class_f_d_p_1_1_config.html#a3575ed8e0f6a51f99b4428bd575bfc24',1,'FDP::Config']]], + ['has_5foutputs_1',['has_outputs',['../class_f_d_p_1_1_config.html#ab3424fed4132fd1adda88f1566293de4',1,'FDP::Config']]], + ['has_5freads_2',['has_reads',['../class_f_d_p_1_1_config.html#a4d652212cbb50a0e92afc41ea64815de',1,'FDP::Config']]], + ['has_5fwrites_3',['has_writes',['../class_f_d_p_1_1_config.html#ab2c81212fdb00aeda1f7881df61e60a7',1,'FDP::Config']]] +]; diff --git a/search/functions_7.html b/search/functions_7.html new file mode 100644 index 0000000..eb4b6cc --- /dev/null +++ b/search/functions_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_7.js b/search/functions_7.js new file mode 100644 index 0000000..fe8c5d7 --- /dev/null +++ b/search/functions_7.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['ioobject_0',['IOObject',['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['is_5fempty_1',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], + ['is_5fpublic_2',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] +]; diff --git a/search/functions_8.html b/search/functions_8.html new file mode 100644 index 0000000..e25ede7 --- /dev/null +++ b/search/functions_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_8.js b/search/functions_8.js new file mode 100644 index 0000000..e1738cd --- /dev/null +++ b/search/functions_8.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['json_5fto_5fquery_5fstring_0',['json_to_query_string',['../class_f_d_p_1_1_a_p_i.html#ad91263a71029cccc94e9e49cd4a37568',1,'FDP::API']]], + ['json_5fto_5fstring_1',['json_to_string',['../json_8hxx.html#a77f24139171b28c1fc719b55846938f1',1,'FDP']]] +]; diff --git a/search/functions_9.html b/search/functions_9.html new file mode 100644 index 0000000..25c3a65 --- /dev/null +++ b/search/functions_9.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_9.js b/search/functions_9.js new file mode 100644 index 0000000..843a3fc --- /dev/null +++ b/search/functions_9.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a074dacc234b734a6a3bb0e86d07042ad',1,'FDP::DataPipelineImpl_::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a7d13934d76ca915232755c886bc59306',1,'FDP::DataPipelineImpl_::link_write()']]] +]; diff --git a/search/functions_a.html b/search/functions_a.html new file mode 100644 index 0000000..7e08e7b --- /dev/null +++ b/search/functions_a.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_a.js b/search/functions_a.js new file mode 100644 index 0000000..84407a8 --- /dev/null +++ b/search/functions_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['meta_5fdata_5f_0',['meta_data_',['../class_f_d_p_1_1_config.html#a6202b2d39b4dbd977340b90f5382a4fb',1,'FDP::Config']]] +]; diff --git a/search/functions_b.html b/search/functions_b.html new file mode 100644 index 0000000..73a6a2d --- /dev/null +++ b/search/functions_b.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_b.js b/search/functions_b.js new file mode 100644 index 0000000..dd59b81 --- /dev/null +++ b/search/functions_b.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['parse_5fyaml_0',['parse_yaml',['../class_f_d_p_1_1_config.html#a12c5d3bb7298854078dfb5bf70e31443',1,'FDP::Config']]], + ['post_1',['post',['../class_f_d_p_1_1_a_p_i.html#a2479874abf32bcaaeb269972b3aaef90',1,'FDP::API']]] +]; diff --git a/search/functions_c.html b/search/functions_c.html new file mode 100644 index 0000000..e0df942 --- /dev/null +++ b/search/functions_c.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_c.js b/search/functions_c.js new file mode 100644 index 0000000..7d93398 --- /dev/null +++ b/search/functions_c.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['read_5ftoken_0',['read_token',['../metadata_8hxx.html#a5dbd216ab20d3b4329231ba5965b34e3',1,'FDP']]], + ['remove_5fbackslash_5ffrom_5fpath_1',['remove_backslash_from_path',['../metadata_8hxx.html#a45be90ccf712b64441d38e0a1ed324f4',1,'FDP']]], + ['remove_5fleading_5fforward_5fslash_2',['remove_leading_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a69448057f09381a313980bec41b3d4cd',1,'FDP::API']]], + ['remove_5flocal_5ffrom_5froot_3',['remove_local_from_root',['../metadata_8hxx.html#a1f7e1d16c6056d8117113a16d806e75d',1,'FDP']]] +]; diff --git a/search/functions_d.html b/search/functions_d.html new file mode 100644 index 0000000..43b4b65 --- /dev/null +++ b/search/functions_d.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_d.js b/search/functions_d.js new file mode 100644 index 0000000..681bae3 --- /dev/null +++ b/search/functions_d.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['set_5fcomponent_5fobject_0',['set_component_object',['../class_f_d_p_1_1_i_o_object.html#ac4ec3246d12c759041bb2ca099afffac',1,'FDP::IOObject']]], + ['set_5fdata_5fproduct_5fobject_1',['set_data_product_object',['../class_f_d_p_1_1_i_o_object.html#a4a3cd1518aa9138c15c52cf925f3f1e3',1,'FDP::IOObject']]] +]; diff --git a/search/functions_e.html b/search/functions_e.html new file mode 100644 index 0000000..16a88cf --- /dev/null +++ b/search/functions_e.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_e.js b/search/functions_e.js new file mode 100644 index 0000000..8f39951 --- /dev/null +++ b/search/functions_e.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['version_0',['version',['../class_f_d_p_1_1_versioning_1_1version.html#aa9be4a03ccee8827e226ea4154781bc6',1,'FDP::Versioning::version::version()=default'],['../class_f_d_p_1_1_versioning_1_1version.html#ac46f9e049c31b63fb6552409d7d2d7b1',1,'FDP::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] +]; diff --git a/search/functions_f.html b/search/functions_f.html new file mode 100644 index 0000000..555578c --- /dev/null +++ b/search/functions_f.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/functions_f.js b/search/functions_f.js new file mode 100644 index 0000000..86e8349 --- /dev/null +++ b/search/functions_f.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5ffunc_5f_0',['write_func_',['../api_8hxx.html#aafe123714129a23215ddd6799c699af6',1,'FDP']]] +]; diff --git a/search/namespaces_0.html b/search/namespaces_0.html new file mode 100644 index 0000000..4bedca0 --- /dev/null +++ b/search/namespaces_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/namespaces_0.js b/search/namespaces_0.js new file mode 100644 index 0000000..fe3cecd --- /dev/null +++ b/search/namespaces_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['versioning_0',['Versioning',['../namespace_f_d_p_1_1_versioning.html',1,'FDP']]] +]; diff --git a/search/pages_0.js b/search/pages_0.js index 59482d3..a7c8fdf 100644 --- a/search/pages_0.js +++ b/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../md__r_e_a_d_m_e.html',1,'']]] + ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../index.html',1,'']]] ]; diff --git a/search/pages_1.js b/search/pages_1.js deleted file mode 100644 index 5e2db56..0000000 --- a/search/pages_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['scrc_20software_20checklist_0',['SCRC Software checklist',['../md_software_checklist.html',1,'']]] -]; diff --git a/search/pages_2.js b/search/pages_2.js deleted file mode 100644 index cd0d928..0000000 --- a/search/pages_2.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['unreleased_0',['Unreleased',['../md__c_h_a_n_g_e_l_o_g.html',1,'']]] -]; diff --git a/search/searchdata.js b/search/searchdata.js index 2c6df75..6237b70 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,18 +1,39 @@ var indexSectionsWithContent = { - 0: "fsu", - 1: "fsu" + 0: "abcdefghijlmprsvw~", + 1: "acdijrsvw", + 2: "f", + 3: "acdjlms", + 4: "acdefghijlmprsvw~", + 5: "a", + 6: "mr", + 7: "ablr", + 8: "f" }; var indexSectionNames = { 0: "all", - 1: "pages" + 1: "classes", + 2: "namespaces", + 3: "files", + 4: "functions", + 5: "variables", + 6: "enums", + 7: "enumvalues", + 8: "pages" }; var indexSectionLabels = { 0: "All", - 1: "Pages" + 1: "Classes", + 2: "Namespaces", + 3: "Files", + 4: "Functions", + 5: "Variables", + 6: "Enumerations", + 7: "Enumerator", + 8: "Pages" }; diff --git a/search/variables_0.html b/search/variables_0.html new file mode 100644 index 0000000..7778cf0 --- /dev/null +++ b/search/variables_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/variables_0.js b/search/variables_0.js new file mode 100644 index 0000000..2344e2f --- /dev/null +++ b/search/variables_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['apilogger_0',['APILogger',['../logging_8hxx.html#a86cb9217b28d11ce2d889dbbe92bcb2b',1,'FDP']]] +]; diff --git a/semver_8hxx.html b/semver_8hxx.html new file mode 100644 index 0000000..87af2bb --- /dev/null +++ b/semver_8hxx.html @@ -0,0 +1,120 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities/semver.hxx File Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Namespaces | +Enumerations
    +
    semver.hxx File Reference
    +
    +
    + +

    File contains classes and types for validating semantic versioning. +More...

    +
    #include <ostream>
    +#include <string>
    +#include <vector>
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    class  FDP::Versioning::version
     class describing the semantic version of an object More...
     
    + + + + +

    +Namespaces

    namespace  FDP::Versioning
     namespace containing all semantic versioning types and classes
     
    + + + + +

    +Enumerations

    enum class  FDP::Versioning::meta_tag { FDP::Versioning::ALPHA +, FDP::Versioning::BETA +, FDP::Versioning::RELEASE_CANDIDATE +, FDP::Versioning::RELEASE + }
     the allowed tags for versions describing version state More...
     
    +

    Detailed Description

    +

    File contains classes and types for validating semantic versioning.

    +
    +
    Author
    K. Zarebski (UKAEA)
    +
    Date
    2021-05-06
    +

    This file contains all classes and types required to ensure that data objects follow strict semantic versioning. This is important for tracking which values are used during code runs.

    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/semver_8hxx_source.html b/semver_8hxx_source.html new file mode 100644 index 0000000..c5b09b9 --- /dev/null +++ b/semver_8hxx_source.html @@ -0,0 +1,234 @@ + + + + + + + +cppDataPipeline: include/fdp/utilities/semver.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    semver.hxx
    +
    +
    +Go to the documentation of this file.
    1
    +
    12#ifndef __FDP_SEMVER_HXX__
    +
    13#define __FDP_SEMVER_HXX__
    +
    14
    +
    15#include <ostream>
    +
    16#include <string>
    +
    17#include <vector>
    +
    18
    +
    19namespace FDP {
    +
    26namespace Versioning {
    +
    27
    +
    38enum class meta_tag {
    +
    39 ALPHA,
    +
    40 BETA,
    +
    41 RELEASE_CANDIDATE,
    +
    42 RELEASE
    +
    43};
    +
    44
    +
    53class version {
    +
    54public:
    +
    60 version() = default;
    +
    61
    +
    80 version(unsigned int major, unsigned int minor, unsigned int patch,
    +
    81 meta_tag tag = meta_tag::RELEASE, unsigned int tag_v = 1E9,
    +
    82 std::string meta_data = "")
    +
    83 : major_(major), minor_(minor), patch_(patch), meta_tag_(tag),
    +
    84 tag_v_(tag_v), meta_data_(meta_data) {}
    +
    85
    +
    86 version(const std::string version_str);
    +
    87
    +
    88 version(const version &v)
    +
    89 : major_(v.major_), minor_(v.minor_), patch_(v.patch_),
    +
    90 meta_tag_(v.meta_tag_), tag_v_(v.tag_v_), meta_data_(v.meta_data_) {}
    +
    91
    +
    92 void bump_major() { major_ += 1; }
    +
    93 void bump_minor() { minor_ += 1; }
    +
    94 void bump_patch() { patch_ += 1; }
    +
    95
    +
    96 void alpha() {
    +
    97 tag_v_ = (meta_tag_ == meta_tag::ALPHA) ? tag_v_ + 1 : 0;
    +
    98 meta_tag_ = meta_tag::ALPHA;
    +
    99 }
    +
    100
    +
    101 void beta() {
    +
    102 tag_v_ = (meta_tag_ == meta_tag::BETA) ? tag_v_ + 1 : 0;
    +
    103 meta_tag_ = meta_tag::BETA;
    +
    104 }
    +
    105
    +
    106 void prerelease() {
    +
    107 tag_v_ = (meta_tag_ == meta_tag::RELEASE_CANDIDATE) ? tag_v_ + 1 : 0;
    +
    108 meta_tag_ = meta_tag::RELEASE_CANDIDATE;
    +
    109 }
    +
    110
    +
    111 void release() {
    +
    112 tag_v_ = 1E9;
    +
    113 meta_tag_ = meta_tag::RELEASE;
    +
    114 }
    +
    115
    +
    116 std::string to_string() const {
    +
    117 std::string out_str_;
    +
    118
    +
    119 out_str_ += std::to_string(major_) + ".";
    +
    120 out_str_ += std::to_string(minor_) + ".";
    +
    121 out_str_ += std::to_string(patch_);
    +
    122
    +
    123 if (meta_tag_ != meta_tag::RELEASE) {
    +
    124 out_str_ += "-" + get_tag_str();
    +
    125
    +
    126 if (tag_v_ != 1E9) {
    +
    127 out_str_ += std::to_string(tag_v_);
    +
    128 }
    +
    129 }
    +
    130 if (!meta_data_.empty()) {
    +
    131 out_str_ += "+" + meta_data_;
    +
    132 }
    +
    133
    +
    134 return out_str_;
    +
    135 }
    +
    136
    +
    137 friend std::ostream &operator<<(std::ostream &os, const version &v) {
    +
    138 os << v.to_string();
    +
    139 return os;
    +
    140 }
    +
    141
    +
    142 friend bool operator<(const version &v1, const version &v2) {
    +
    143 if (v1.major_ < v2.major_)
    +
    144 return true;
    +
    145 else if (v2.major_ < v1.major_)
    +
    146 return false;
    +
    147 if (v1.minor_ < v2.minor_)
    +
    148 return true;
    +
    149 else if (v2.minor_ < v1.minor_)
    +
    150 return false;
    +
    151 if (v1.patch_ < v2.patch_)
    +
    152 return true;
    +
    153 else if (v2.patch_ < v1.patch_)
    +
    154 return false;
    +
    155 if (v1.meta_tag_ < v2.meta_tag_)
    +
    156 return true;
    +
    157 else if (v2.meta_tag_ < v1.meta_tag_)
    +
    158 return false;
    +
    159 if (v1.tag_v_ < v2.tag_v_)
    +
    160 return true;
    +
    161 else if (v2.tag_v_ < v1.tag_v_)
    +
    162 return false;
    +
    163 return false;
    +
    164 }
    +
    165
    +
    166 friend bool operator>(const version &v1, const version &v2) {
    +
    167 return v2 < v1;
    +
    168 }
    +
    169
    +
    170 friend bool operator==(const version &v1, const version &v2) {
    +
    171 bool same_ = v1.major_ == v2.major_;
    +
    172 same_ = same_ && (v1.minor_ == v2.minor_);
    +
    173 same_ = same_ && (v1.patch_ == v2.patch_);
    +
    174 same_ = same_ && (v1.meta_tag_ == v2.meta_tag_);
    +
    175 same_ = same_ && (v1.tag_v_ == v2.tag_v_);
    +
    176 same_ = same_ && (v1.meta_data_ == v2.meta_data_);
    +
    177 return same_;
    +
    178 }
    +
    179
    +
    180 friend bool operator!=(const version &v1, const version &v2) {
    +
    181 return !(v1 == v2);
    +
    182 }
    +
    183
    +
    184 friend bool operator<=(const version &v1, const version &v2) {
    +
    185 return (v1 == v2) || v1 < v2;
    +
    186 }
    +
    187
    +
    188 friend bool operator>=(const version &v1, const version &v2) {
    +
    189 return (v1 == v2) || v1 > v2;
    +
    190 }
    +
    191
    +
    192private:
    +
    193 unsigned int major_ = 0;
    +
    194 unsigned int minor_ = 1;
    +
    195 unsigned int patch_ = 0;
    +
    196 meta_tag meta_tag_ = meta_tag::RELEASE;
    +
    197 unsigned int tag_v_ = 1E9;
    +
    198 std::string meta_data_ = "";
    +
    199 std::string get_tag_str() const;
    +
    200};
    +
    201}; // namespace Versioning
    +
    202}; // namespace FDP
    +
    203
    +
    204#endif
    +
    FDP::Versioning::version
    class describing the semantic version of an object
    Definition: semver.hxx:53
    +
    FDP::Versioning::version::version
    version()=default
    Construct a new version with the default start value of 0.1.0
    +
    FDP::Versioning::version::version
    version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
    Construct a new version from integer representation.
    Definition: semver.hxx:80
    +
    FDP::Versioning::meta_tag
    meta_tag
    the allowed tags for versions describing version state
    Definition: semver.hxx:38
    + + + + +
    + +
    +Generated by doxygen 1.9.2 +
    + + From db823feb0cd754e36f4c6a9af2c0ea93b866734e Mon Sep 17 00:00:00 2001 From: RyanJField Date: Wed, 9 Feb 2022 19:11:04 +0000 Subject: [PATCH 03/19] deploy: f485aa444d09e8da7af1d73eb3fb67bdbc371eef --- api__object_8hxx_source.html | 13 ++++------- class_f_d_p_1_1_api_object-members.html | 11 ++++----- class_f_d_p_1_1_api_object.html | 31 ------------------------- functions.html | 1 - functions_func.html | 1 - search/all_6.js | 29 +++++++++++------------ search/functions_5.js | 29 +++++++++++------------ 7 files changed, 38 insertions(+), 77 deletions(-) diff --git a/api__object_8hxx_source.html b/api__object_8hxx_source.html index 75b0068..445690b 100644 --- a/api__object_8hxx_source.html +++ b/api__object_8hxx_source.html @@ -98,13 +98,11 @@
    64
    70 std::string get_first_component() const;
    71
    -
    77 Json::Value get_object(){return obj_;}
    -
    78
    -
    85 bool is_empty();
    -
    86 };
    -
    87};
    -
    88
    -
    89#endif
    +
    78 bool is_empty();
    +
    79 };
    +
    80};
    +
    81
    +
    82#endif
    FDP::ApiObject
    Class for API objects.
    Definition: api_object.hxx:15
    FDP::ApiObject::get_value_as_int
    int get_value_as_int(std::string key) const
    Get the value of a given key as int object.
    Definition: api_object.cxx:40
    FDP::ApiObject::is_empty
    bool is_empty()
    Check to see if the object is empty.
    Definition: api_object.cxx:44
    @@ -115,7 +113,6 @@
    FDP::ApiObject::get_first_component
    std::string get_first_component() const
    Get the first component of the object.
    Definition: api_object.cxx:51
    FDP::ApiObject::ApiObject
    ApiObject(Json::Value obj)
    Construct a new Api Object object.
    Definition: api_object.hxx:25
    FDP::ApiObject::get_type
    std::string get_type()
    Returns the object type from the object uri_ (table)
    Definition: api_object.cxx:25
    -
    FDP::ApiObject::get_object
    Json::Value get_object()
    Get the object as a Json::Value.
    Definition: api_object.hxx:77
    logging.hxx
    File contains pointers for creating global logger during session.
    diff --git a/class_f_d_p_1_1_api_object-members.html b/class_f_d_p_1_1_api_object-members.html index 8ea1563..d6a7f78 100644 --- a/class_f_d_p_1_1_api_object-members.html +++ b/class_f_d_p_1_1_api_object-members.html @@ -78,12 +78,11 @@ get_first_component() constFDP::ApiObject get_id()FDP::ApiObject get_id_from_string(std::string url)FDP::ApiObjectstatic - get_object()FDP::ApiObjectinline - get_type()FDP::ApiObject - get_uri() constFDP::ApiObject - get_value_as_int(std::string key) constFDP::ApiObject - get_value_as_string(std::string key) constFDP::ApiObject - is_empty()FDP::ApiObject + get_type()FDP::ApiObject + get_uri() constFDP::ApiObject + get_value_as_int(std::string key) constFDP::ApiObject + get_value_as_string(std::string key) constFDP::ApiObject + is_empty()FDP::ApiObject
    diff --git a/class_f_d_p_1_1_api_object.html b/class_f_d_p_1_1_api_object.html index cfb14cf..1918287 100644 --- a/class_f_d_p_1_1_api_object.html +++ b/class_f_d_p_1_1_api_object.html @@ -103,9 +103,6 @@ std::string get_first_component () const  Get the first component of the object. More...
      -Json::Value get_object () - Get the object as a Json::Value. More...
    -  bool is_empty ()  Check to see if the object is empty. More...
      @@ -224,34 +221,6 @@

    Returns
    std::string the object type (table) e.g. if the uri is http://127.0.0.1/object/1 the object type will be object
    - - - -

    ◆ get_object()

    - -
    -
    - - - - - -
    - - - - - - - -
    Json::Value FDP::ApiObject::get_object ()
    -     		-inline
    -
    - -

    Get the object as a Json::Value.

    -
    Returns
    Json::Value
    -
    diff --git a/functions.html b/functions.html index c17c2b7..ab52149 100644 --- a/functions.html +++ b/functions.html @@ -114,7 +114,6 @@

    - g -

    • get_first_component() : FDP::ApiObject
    • get_id() : FDP::ApiObject
    • get_id_from_string() : FDP::ApiObject
      • -
    • get_object() : FDP::ApiObject
    • get_path() : FDP::IOObject
    • get_request() : FDP::API
    • get_rest_api_location() : FDP::Config
      • diff --git a/functions_func.html b/functions_func.html index 46d09d1..7356b09 100644 --- a/functions_func.html +++ b/functions_func.html @@ -114,7 +114,6 @@

      - g -

      • get_first_component() : FDP::ApiObject
      • get_id() : FDP::ApiObject
      • get_id_from_string() : FDP::ApiObject
        • -
      • get_object() : FDP::ApiObject
      • get_path() : FDP::IOObject
      • get_request() : FDP::API
      • get_rest_api_location() : FDP::Config
        • diff --git a/search/all_6.js b/search/all_6.js index 6650db9..a9ab26f 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -19,19 +19,18 @@ var searchData= ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], - ['get_5fobject_19',['get_object',['../class_f_d_p_1_1_api_object.html#af71a87df669ce569548f04cb6579e5b2',1,'FDP::ApiObject']]], - ['get_5fpath_20',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], - ['get_5frequest_21',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], - ['get_5frest_5fapi_5flocation_22',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], - ['get_5fscript_5ffile_5fpath_23',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], - ['get_5ftoken_24',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], - ['get_5ftype_25',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], - ['get_5furi_26',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], - ['get_5furl_5froot_27',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], - ['get_5fuse_5fcomponent_28',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], - ['get_5fuse_5fdata_5fproduct_29',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], - ['get_5fuse_5fnamespace_30',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], - ['get_5fuse_5fversion_31',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], - ['get_5fvalue_5fas_5fint_32',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], - ['get_5fvalue_5fas_5fstring_33',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] + ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], + ['get_5frequest_20',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], + ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], + ['get_5fscript_5ffile_5fpath_22',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], + ['get_5ftoken_23',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], + ['get_5ftype_24',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], + ['get_5furi_25',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], + ['get_5furl_5froot_26',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], + ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], + ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], + ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], + ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], + ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], + ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] ]; diff --git a/search/functions_5.js b/search/functions_5.js index 6650db9..a9ab26f 100644 --- a/search/functions_5.js +++ b/search/functions_5.js @@ -19,19 +19,18 @@ var searchData= ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], - ['get_5fobject_19',['get_object',['../class_f_d_p_1_1_api_object.html#af71a87df669ce569548f04cb6579e5b2',1,'FDP::ApiObject']]], - ['get_5fpath_20',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], - ['get_5frequest_21',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], - ['get_5frest_5fapi_5flocation_22',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], - ['get_5fscript_5ffile_5fpath_23',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], - ['get_5ftoken_24',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], - ['get_5ftype_25',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], - ['get_5furi_26',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], - ['get_5furl_5froot_27',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], - ['get_5fuse_5fcomponent_28',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], - ['get_5fuse_5fdata_5fproduct_29',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], - ['get_5fuse_5fnamespace_30',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], - ['get_5fuse_5fversion_31',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], - ['get_5fvalue_5fas_5fint_32',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], - ['get_5fvalue_5fas_5fstring_33',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] + ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], + ['get_5frequest_20',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], + ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], + ['get_5fscript_5ffile_5fpath_22',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], + ['get_5ftoken_23',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], + ['get_5ftype_24',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], + ['get_5furi_25',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], + ['get_5furl_5froot_26',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], + ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], + ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], + ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], + ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], + ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], + ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] ]; From 8470e850d589d344de500ec2b0ac6ab567e5a3d4 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Thu, 10 Feb 2022 12:29:43 +0000 Subject: [PATCH 04/19] deploy: d09b2207e6bc0d39c6a657968fe8eae678297e85 --- config_8hxx_source.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config_8hxx_source.html b/config_8hxx_source.html index 8e20f2a..075cd76 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -199,8 +199,8 @@
        FDP::Config::get_script_file_path
        ghc::filesystem::path get_script_file_path() const
        Get the script file path object.
        Definition: config.hxx:165
        FDP::Config::meta_data_
        YAML::Node meta_data_() const
        Returns the meta_data Yaml Node from the config.
        Definition: config.cxx:23
        FDP::Config::get_api
        std::shared_ptr< API > get_api()
        Get the api object (used to interact with the pipeline directly)
        Definition: config.hxx:260
        -
        FDP::Config::link_read
        ghc::filesystem::path link_read(std::string &data_product)
        Return the filepath to a given data product.
        Definition: config.cxx:420
        -
        FDP::Config::finalise
        void finalise()
        Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
        Definition: config.cxx:528
        +
        FDP::Config::link_read
        ghc::filesystem::path link_read(std::string &data_product)
        Return the filepath to a given data product.
        Definition: config.cxx:418
        +
        FDP::Config::finalise
        void finalise()
        Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
        Definition: config.cxx:524
        FDP::Config::get_config_file_path
        ghc::filesystem::path get_config_file_path() const
        Get the config file path object.
        Definition: config.hxx:153
        FDP::Config::get_code_run_uuid
        std::string get_code_run_uuid() const
        Get the code run uuid.
        Definition: config.cxx:336
        FDP::Config::has_writes
        bool has_writes() const
        Check whether the config has writes.
        Definition: config.cxx:49
        From a538d800de5749f1b623d8bc03ed96a1e33a8a0a Mon Sep 17 00:00:00 2001 From: RyanJField Date: Tue, 15 Feb 2022 13:20:00 +0000 Subject: [PATCH 05/19] deploy: 1592b2c02c7245e70ff3ee661a76da034dd97383 --- annotated.html | 17 +- api_8hxx_source.html | 122 ++++----- api__object_8hxx_source.html | 76 +++--- ...xx.html => class_data_pipeline_impl__.html | 46 +--- class_f_d_p_1_1_a_p_i-members.html | 1 + class_f_d_p_1_1_a_p_i.html | 7 + class_f_d_p_1_1_api_object-members.html | 27 +- class_f_d_p_1_1_api_object.html | 49 +++- class_f_d_p_1_1_config-members.html | 11 +- class_f_d_p_1_1_config.html | 79 ++---- class_f_d_p_1_1_data_pipeline-members.html | 2 +- class_f_d_p_1_1_data_pipeline.html | 8 +- ...d_p_1_1_data_pipeline_1_1impl-members.html | 21 +- ...class_f_d_p_1_1_data_pipeline_1_1impl.html | 102 ++++---- class_f_d_p_1_1_i_o_object-members.html | 4 +- class_f_d_p_1_1_i_o_object.html | 24 +- classes.html | 4 +- config_8hxx_source.html | 246 +++++++++--------- datapipeline_8hxx_source.html | 144 ---------- dir_d98af0b859cb0744225e11c767d17cdb.html | 3 - fdp_8hxx_source.html | 91 +++---- files.html | 13 +- functions.html | 21 +- functions_func.html | 21 +- hierarchy.html | 21 +- index.html | 2 +- io__object_8hxx_source.html | 151 +++++------ namespaces.html | 16 +- search/all_0.js | 2 +- search/all_11.js | 2 +- search/all_2.js | 7 +- search/all_3.js | 3 +- search/all_5.js | 2 +- search/all_6.js | 8 +- search/all_8.js | 7 +- search/all_a.js | 4 +- search/classes_2.js | 2 +- search/classes_3.js | 3 +- search/files_2.js | 2 +- search/files_3.js | 2 +- search/files_4.js | 2 +- search/files_5.js | 2 +- search/files_6.html | 37 --- search/files_6.js | 4 - search/functions_0.js | 3 +- search/functions_1.js | 6 +- search/functions_10.js | 2 +- search/functions_2.js | 3 +- search/functions_4.js | 2 +- search/functions_5.js | 8 +- search/functions_7.js | 7 +- search/functions_9.js | 4 +- search/searchdata.js | 2 +- 53 files changed, 637 insertions(+), 818 deletions(-) rename datapipeline_8hxx.html => class_data_pipeline_impl__.html (50%) rename class_f_d_p_1_1_data_pipeline_impl__-members.html => class_f_d_p_1_1_data_pipeline_1_1impl-members.html (55%) rename class_f_d_p_1_1_data_pipeline_impl__.html => class_f_d_p_1_1_data_pipeline_1_1impl.html (57%) delete mode 100644 datapipeline_8hxx_source.html delete mode 100644 search/files_6.html delete mode 100644 search/files_6.js diff --git a/annotated.html b/annotated.html index 5aadcb4..dade788 100644 --- a/annotated.html +++ b/annotated.html @@ -75,14 +75,15 @@  CApiObjectClass for API objects  CConfigClass for interacting with confifurations  Cconfig_parsing_error - CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline - CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods - CIOObjectClass for API objects - Cjson_parse_error - Crest_apiquery_error - Csync_error - Cvalidation_error - Cwrite_error + ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline + Cimpl + CIOObjectClass for API objects + Cjson_parse_error + Crest_apiquery_error + Csync_error + Cvalidation_error + Cwrite_error + CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods diff --git a/api_8hxx_source.html b/api_8hxx_source.html index 27b2956..a95268f 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -100,74 +100,76 @@
        53
        63class API {
        64public:
        -
        71 API(std::string url_root)
        -
        72 : url_root_(API::append_with_forward_slash(url_root)) {}
        -
        73
        -
        83 Json::Value get_request(const std::string &addr_path,
        -
        84 long expected_response = 200, std::string token = "");
        -
        85
        -
        86 Json::Value patch(const std::string addr_path, Json::Value &post_data,
        -
        87 const std::string &token, long expected_response = 200);
        -
        98 Json::Value post(const std::string addr_path, Json::Value &post_data,
        -
        99 const std::string &token, long expected_response = 201);
        -
        100
        -
        101 Json::Value post_storage_root(Json::Value &post_data, const std::string &token);
        +
        65 typedef std::shared_ptr< API > sptr;
        +
        66
        +
        73 API(std::string url_root)
        +
        74 : url_root_(API::append_with_forward_slash(url_root)) {}
        +
        75
        +
        85 Json::Value get_request(const std::string &addr_path,
        +
        86 long expected_response = 200, std::string token = "");
        +
        87
        +
        88 Json::Value patch(const std::string addr_path, Json::Value &post_data,
        +
        89 const std::string &token, long expected_response = 200);
        +
        100 Json::Value post(const std::string addr_path, Json::Value &post_data,
        +
        101 const std::string &token, long expected_response = 201);
        102
        -
        103 Json::Value get_by_json_query(const std::string &addr_path,
        -
        104 Json::Value &query_data,
        -
        105 long expected_response = 200,
        -
        106 std::string token = "");
        -
        107
        -
        116 Json::Value get_by_id(const std::string &table, int const &id,
        -
        117 long expected_response = 200, std::string token = "");
        -
        118
        -
        125 std::string get_url_root() const { return url_root_; }
        -
        126
        -
        135 std::string json_to_query_string(Json::Value &json_value);
        -
        136
        -
        145 std::string escape_space(std::string &str);
        -
        146
        -
        154 static std::string append_with_forward_slash(std::string string);
        -
        155
        -
        162 static std::string remove_leading_forward_slash(std::string str);
        -
        163
        -
        164private:
        -
        165 std::string url_root_;
        -
        166 CURL *setup_json_session_(std::string &addr_path, std::string *response,
        -
        167 long &http_code, std::string token = "");
        -
        168 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
        -
        169 FILE *file);
        -
        170
        -
        171 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
        -
        172 const std::string &token, long expected_response, bool PATCH = false);
        -
        173
        -
        174 // Legacy Method
        -
        175 Json::Value get_request(const ghc::filesystem::path &addr_path,
        -
        176 long expected_response = 200, std::string token = "");
        -
        177
        -
        178 void download_file(const ghc::filesystem::path &url,
        -
        179 ghc::filesystem::path out_path);
        -
        180};
        -
        181
        -
        182std::string url_encode(std::string url);
        +
        103 Json::Value post_storage_root(Json::Value &post_data, const std::string &token);
        +
        104
        +
        105 Json::Value get_by_json_query(const std::string &addr_path,
        +
        106 Json::Value &query_data,
        +
        107 long expected_response = 200,
        +
        108 std::string token = "");
        +
        109
        +
        118 Json::Value get_by_id(const std::string &table, int const &id,
        +
        119 long expected_response = 200, std::string token = "");
        +
        120
        +
        127 std::string get_url_root() const { return url_root_; }
        +
        128
        +
        137 std::string json_to_query_string(Json::Value &json_value);
        +
        138
        +
        147 std::string escape_space(std::string &str);
        +
        148
        +
        156 static std::string append_with_forward_slash(std::string string);
        +
        157
        +
        164 static std::string remove_leading_forward_slash(std::string str);
        +
        165
        +
        166private:
        +
        167 std::string url_root_;
        +
        168 CURL *setup_json_session_(std::string &addr_path, std::string *response,
        +
        169 long &http_code, std::string token = "");
        +
        170 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
        +
        171 FILE *file);
        +
        172
        +
        173 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
        +
        174 const std::string &token, long expected_response, bool PATCH = false);
        +
        175
        +
        176 // Legacy Method
        +
        177 Json::Value get_request(const ghc::filesystem::path &addr_path,
        +
        178 long expected_response = 200, std::string token = "");
        +
        179
        +
        180 void download_file(const ghc::filesystem::path &url,
        +
        181 ghc::filesystem::path out_path);
        +
        182};
        183
        -
        184}; // namespace FDP
        +
        184std::string url_encode(std::string url);
        185
        -
        186#endif
        +
        186}; // namespace FDP
        +
        187
        +
        188#endif
        FDP::write_func_
        size_t write_func_(void *ptr, size_t size, size_t nmemb, std::string *data)
        function for writing to file from a CURL call
        FDP::RESTAPI
        RESTAPI
        selection of either local or remote pipeline running
        Definition: api.hxx:37
        FDP::API
        a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
        Definition: api.hxx:63
        -
        FDP::API::post
        Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
        post information from a JSON value object to the RestAPI
        Definition: api.cxx:183
        -
        FDP::API::get_request
        Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
        sends the given 'packet' of information to the RestAPI
        Definition: api.cxx:83
        -
        FDP::API::append_with_forward_slash
        static std::string append_with_forward_slash(std::string string)
        Static function to append a given string with a "/" unless the string is empty or already ends with a...
        Definition: api.cxx:287
        -
        FDP::API::remove_leading_forward_slash
        static std::string remove_leading_forward_slash(std::string str)
        Remove the leading forward slash from a given string.
        Definition: api.cxx:300
        -
        FDP::API::escape_space
        std::string escape_space(std::string &str)
        escapes space " " characters within a string with it's html character code (%20)
        Definition: api.cxx:178
        -
        FDP::API::get_url_root
        std::string get_url_root() const
        returns the root URL for the RestAPI used by the API instance
        Definition: api.hxx:125
        -
        FDP::API::API
        API(std::string url_root)
        construct an API object using the given URL as the root
        Definition: api.hxx:71
        -
        FDP::API::json_to_query_string
        std::string json_to_query_string(Json::Value &json_value)
        Formats a json object into a string representation which can be used as a url endpoint query.
        Definition: api.cxx:142
        -
        FDP::API::get_by_id
        Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
        get an object from the api by it's id
        Definition: api.cxx:135
        +
        FDP::API::post
        Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
        post information from a JSON value object to the RestAPI
        Definition: api.cxx:184
        +
        FDP::API::get_request
        Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
        sends the given 'packet' of information to the RestAPI
        Definition: api.cxx:84
        +
        FDP::API::append_with_forward_slash
        static std::string append_with_forward_slash(std::string string)
        Static function to append a given string with a "/" unless the string is empty or already ends with a...
        Definition: api.cxx:288
        +
        FDP::API::remove_leading_forward_slash
        static std::string remove_leading_forward_slash(std::string str)
        Remove the leading forward slash from a given string.
        Definition: api.cxx:301
        +
        FDP::API::escape_space
        std::string escape_space(std::string &str)
        escapes space " " characters within a string with it's html character code (%20)
        Definition: api.cxx:179
        +
        FDP::API::get_url_root
        std::string get_url_root() const
        returns the root URL for the RestAPI used by the API instance
        Definition: api.hxx:127
        +
        FDP::API::API
        API(std::string url_root)
        construct an API object using the given URL as the root
        Definition: api.hxx:73
        +
        FDP::API::json_to_query_string
        std::string json_to_query_string(Json::Value &json_value)
        Formats a json object into a string representation which can be used as a url endpoint query.
        Definition: api.cxx:143
        +
        FDP::API::get_by_id
        Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
        get an object from the api by it's id
        Definition: api.cxx:136
        json.hxx
        File contains methods relating to handling of JSON based data.
        logging.hxx
        File contains pointers for creating global logger during session.
        diff --git a/api__object_8hxx_source.html b/api__object_8hxx_source.html index 445690b..3728c2b 100644 --- a/api__object_8hxx_source.html +++ b/api__object_8hxx_source.html @@ -83,36 +83,54 @@
        15 class ApiObject {
        16 private:
        17 Json::Value obj_;
        -
        18 public:
        -
        19 ApiObject() : obj_(Json::Value()){};
        -
        25 ApiObject(Json::Value obj) : obj_(obj){}
        -
        32 int get_id();
        -
        39 static int get_id_from_string(std::string url);
        -
        40
        -
        41 std::string get_type();
        -
        47 std::string get_uri() const;
        -
        48
        -
        55 std::string get_value_as_string(std::string key) const;
        -
        56
        -
        63 int get_value_as_int(std::string key) const;
        -
        64
        -
        70 std::string get_first_component() const;
        -
        71
        -
        78 bool is_empty();
        -
        79 };
        -
        80};
        -
        81
        -
        82#endif
        +
        18
        +
        19 ApiObject();
        +
        20
        +
        21 public:
        +
        22
        +
        23 typedef std::shared_ptr< ApiObject > sptr;
        +
        24
        +
        25 static sptr from_json( const Json::Value& j );
        +
        26
        +
        27 //static copy( const ApiObject& src );
        +
        28
        +
        35 static ApiObject::sptr construct( void );
        +
        36
        +
        37
        +
        38 int add( const std::string& key, int value );
        +
        39 int add( const std::string& key, float value );
        +
        40 int add( const std::string& key, double value );
        +
        41 int add( const std::string& key, const std::string& value );
        +
        42 int add( const std::string& key, const ApiObject& value );
        +
        43
        +
        44 int remove( const std::string& key );
        +
        51 int get_id();
        +
        58 static int get_id_from_string(std::string url);
        +
        59
        +
        60 std::string get_type();
        +
        66 std::string get_uri() const;
        +
        67
        +
        74 std::string get_value_as_string(std::string key) const;
        +
        75
        +
        82 int get_value_as_int(std::string key) const;
        +
        83
        +
        89 std::string get_first_component() const;
        +
        90
        +
        97 bool is_empty();
        +
        98 };
        +
        99};
        +
        100
        +
        101#endif
        FDP::ApiObject
        Class for API objects.
        Definition: api_object.hxx:15
        -
        FDP::ApiObject::get_value_as_int
        int get_value_as_int(std::string key) const
        Get the value of a given key as int object.
        Definition: api_object.cxx:40
        -
        FDP::ApiObject::is_empty
        bool is_empty()
        Check to see if the object is empty.
        Definition: api_object.cxx:44
        -
        FDP::ApiObject::get_id
        int get_id()
        Get the object id from the uri.
        Definition: api_object.cxx:9
        -
        FDP::ApiObject::get_id_from_string
        static int get_id_from_string(std::string url)
        Get the object type from the uri.
        Definition: api_object.cxx:13
        -
        FDP::ApiObject::get_uri
        std::string get_uri() const
        Get the object uri.
        Definition: api_object.cxx:33
        -
        FDP::ApiObject::get_value_as_string
        std::string get_value_as_string(std::string key) const
        Get the value of a given key as string object.
        Definition: api_object.cxx:37
        -
        FDP::ApiObject::get_first_component
        std::string get_first_component() const
        Get the first component of the object.
        Definition: api_object.cxx:51
        -
        FDP::ApiObject::ApiObject
        ApiObject(Json::Value obj)
        Construct a new Api Object object.
        Definition: api_object.hxx:25
        -
        FDP::ApiObject::get_type
        std::string get_type()
        Returns the object type from the object uri_ (table)
        Definition: api_object.cxx:25
        +
        FDP::ApiObject::get_value_as_int
        int get_value_as_int(std::string key) const
        Get the value of a given key as int object.
        Definition: api_object.cxx:96
        +
        FDP::ApiObject::is_empty
        bool is_empty()
        Check to see if the object is empty.
        Definition: api_object.cxx:100
        +
        FDP::ApiObject::get_id
        int get_id()
        Get the object id from the uri.
        Definition: api_object.cxx:65
        +
        FDP::ApiObject::get_id_from_string
        static int get_id_from_string(std::string url)
        Get the object type from the uri.
        Definition: api_object.cxx:69
        +
        FDP::ApiObject::get_uri
        std::string get_uri() const
        Get the object uri.
        Definition: api_object.cxx:89
        +
        FDP::ApiObject::get_value_as_string
        std::string get_value_as_string(std::string key) const
        Get the value of a given key as string object.
        Definition: api_object.cxx:93
        +
        FDP::ApiObject::get_first_component
        std::string get_first_component() const
        Get the first component of the object.
        Definition: api_object.cxx:107
        +
        FDP::ApiObject::construct
        static ApiObject::sptr construct(void)
        Construct a new Api Object object.
        Definition: api_object.cxx:17
        +
        FDP::ApiObject::get_type
        std::string get_type()
        Returns the object type from the object uri_ (table)
        Definition: api_object.cxx:81
        logging.hxx
        File contains pointers for creating global logger during session.
        diff --git a/datapipeline_8hxx.html b/class_data_pipeline_impl__.html similarity index 50% rename from datapipeline_8hxx.html rename to class_data_pipeline_impl__.html index c8909c8..a3a090e 100644 --- a/datapipeline_8hxx.html +++ b/class_data_pipeline_impl__.html @@ -5,7 +5,7 @@ -cppDataPipeline: include/fdp/registry/datapipeline.hxx File Reference +cppDataPipeline: DataPipelineImpl_ Class Reference @@ -61,47 +61,23 @@ -
        -
        -Classes
        -
        datapipeline.hxx File Reference
        +
        DataPipelineImpl_ Class Reference
        -

        File containing classes for interaction with the FDP data pipeline. -More...

        -
        #include <algorithm>
        -#include <fstream>
        -#include <iostream>
        -#include <string>
        -#include "spdlog/spdlog.h"
        -#include "json/json.h"
        -#include "fdp/objects/config.hxx"
        -#include "fdp/objects/metadata.hxx"
        -#include "fdp/registry/api.hxx"
        -#include "fdp/registry/data_io.hxx"
        -#include "fdp/utilities/logging.hxx"
        -
        -

        Go to the source code of this file.

        - - - - - -

        -Classes

        class  FDP::DataPipelineImpl_
         private pointer-to-implementation class containing all backend methods More...
         
        +

        private pointer-to-implementation class containing all backend methods + More...

        Detailed Description

        -

        File containing classes for interaction with the FDP data pipeline.

        +

        private pointer-to-implementation class containing all backend methods

        -
        Author
        K. Zarebski (UKAEA)
        -
        Date
        2021-05-06
        -

        The classes within this file form the core objects for handling interaction with the FDP FAIR Data pipeline. They contain methods which parse configurations and control calls to the RestAPI itself.

        -
        +

        This class performs all behind the scenes operations acting as the backend to the user called FDP::DataPipeline class. This structure has been chosen to allow for unit tests to be created to test all methods including private ones.

        +
        Warning
        The class should not be used directly during implementation, but rather via an FDP::DataPipeline instance.
        +
        The documentation for this class was generated from the following file:
          +
        • src/fdp.cxx
          • +
        +
        Generated by doxygen 1.9.2 diff --git a/class_f_d_p_1_1_a_p_i-members.html b/class_f_d_p_1_1_a_p_i-members.html index 9c02dff..4828ab9 100644 --- a/class_f_d_p_1_1_a_p_i-members.html +++ b/class_f_d_p_1_1_a_p_i-members.html @@ -85,6 +85,7 @@ post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)FDP::API post_storage_root(Json::Value &post_data, const std::string &token) (defined in FDP::API)FDP::API remove_leading_forward_slash(std::string str)FDP::APIstatic + sptr typedef (defined in FDP::API)FDP::API
        diff --git a/class_f_d_p_1_1_a_p_i.html b/class_f_d_p_1_1_a_p_i.html index bcffe11..c7374f2 100644 --- a/class_f_d_p_1_1_a_p_i.html +++ b/class_f_d_p_1_1_a_p_i.html @@ -68,6 +68,7 @@
        +Public Types | Public Member Functions | Static Public Member Functions | List of all members
        @@ -80,6 +81,12 @@

        #include <fdp/registry/api.hxx>

        + + + +

        +Public Types

        +typedef std::shared_ptr< API > sptr
         
        diff --git a/class_f_d_p_1_1_api_object-members.html b/class_f_d_p_1_1_api_object-members.html index d6a7f78..34efd0c 100644 --- a/class_f_d_p_1_1_api_object-members.html +++ b/class_f_d_p_1_1_api_object-members.html @@ -73,16 +73,23 @@

        This is the complete list of members for FDP::ApiObject, including all inherited members.

        Public Member Functions

         API (std::string url_root)
        - - - - - - - - - - + + + + + + + + + + + + + + + + +
        ApiObject() (defined in FDP::ApiObject)FDP::ApiObjectinline
        ApiObject(Json::Value obj)FDP::ApiObjectinline
        get_first_component() constFDP::ApiObject
        get_id()FDP::ApiObject
        get_id_from_string(std::string url)FDP::ApiObjectstatic
        get_type()FDP::ApiObject
        get_uri() constFDP::ApiObject
        get_value_as_int(std::string key) constFDP::ApiObject
        get_value_as_string(std::string key) constFDP::ApiObject
        is_empty()FDP::ApiObject
        add(const std::string &key, int value) (defined in FDP::ApiObject)FDP::ApiObject
        add(const std::string &key, float value) (defined in FDP::ApiObject)FDP::ApiObject
        add(const std::string &key, double value) (defined in FDP::ApiObject)FDP::ApiObject
        add(const std::string &key, const std::string &value) (defined in FDP::ApiObject)FDP::ApiObject
        add(const std::string &key, const ApiObject &value) (defined in FDP::ApiObject)FDP::ApiObject
        construct(void)FDP::ApiObjectstatic
        from_json(const Json::Value &j) (defined in FDP::ApiObject)FDP::ApiObjectstatic
        get_first_component() constFDP::ApiObject
        get_id()FDP::ApiObject
        get_id_from_string(std::string url)FDP::ApiObjectstatic
        get_type()FDP::ApiObject
        get_uri() constFDP::ApiObject
        get_value_as_int(std::string key) constFDP::ApiObject
        get_value_as_string(std::string key) constFDP::ApiObject
        is_empty()FDP::ApiObject
        remove(const std::string &key) (defined in FDP::ApiObject)FDP::ApiObject
        sptr typedef (defined in FDP::ApiObject)FDP::ApiObject
        diff --git a/class_f_d_p_1_1_api_object.html b/class_f_d_p_1_1_api_object.html index 1918287..366e849 100644 --- a/class_f_d_p_1_1_api_object.html +++ b/class_f_d_p_1_1_api_object.html @@ -68,6 +68,7 @@
        +Public Types | Public Member Functions | Static Public Member Functions | List of all members
        @@ -80,11 +81,32 @@

        #include <fdp/objects/api_object.hxx>

        + + + +

        +Public Types

        +typedef std::shared_ptr< ApiObject > sptr
         
        - - - + + + + + + + + + + + + @@ -109,15 +131,21 @@

        Public Member Functions

         ApiObject (Json::Value obj)
         Construct a new Api Object object. More...
         
        +int add (const std::string &key, int value)
         
        +int add (const std::string &key, float value)
         
        +int add (const std::string &key, double value)
         
        +int add (const std::string &key, const std::string &value)
         
        +int add (const std::string &key, const ApiObject &value)
         
        +int remove (const std::string &key)
         
        int get_id ()
         Get the object id from the uri. More...
         
        + + + + +

        Static Public Member Functions

        +static sptr from_json (const Json::Value &j)
         
        static ApiObject::sptr construct (void)
         Construct a new Api Object object. More...
         
        static int get_id_from_string (std::string url)
         Get the object type from the uri. More...
         

        Detailed Description

        Class for API objects.

        -

        Constructor & Destructor Documentation

        - -

        ◆ ApiObject()

        +

        Member Function Documentation

        + +

        ◆ construct()

        @@ -126,16 +154,16 @@

        - + - - + +
        FDP::ApiObject::ApiObject ApiObject::sptr FDP::ApiObject::construct (Json::Value obj)void )
        -inline +static

        @@ -150,7 +178,6 @@

        Member Function Documentation

        ◆ get_first_component()

        diff --git a/class_f_d_p_1_1_config-members.html b/class_f_d_p_1_1_config-members.html index 144807a..a8ccce0 100644 --- a/class_f_d_p_1_1_config-members.html +++ b/class_f_d_p_1_1_config-members.html @@ -73,11 +73,11 @@

        This is the complete list of members for FDP::Config, including all inherited members.

        - - - + + + - + @@ -97,7 +97,8 @@ - + +
        Config(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)FDP::Config
        config_reads_() constFDP::Config
        config_writes_() constFDP::Config
        config_reads_() constFDP::Config
        config_writes_() constFDP::Config
        construct(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location) (defined in FDP::Config)FDP::Configstatic
        finalise()FDP::Config
        get_api()FDP::Configinline
        get_api()FDP::Configinline
        get_api_url() constFDP::Configinline
        get_code_run_uuid() constFDP::Config
        get_config_data() constFDP::Configinline
        link_write(std::string &data_product)FDP::Config
        meta_data_() constFDP::Config
        parse_yaml(ghc::filesystem::path yaml_path)FDP::Configstatic
        ~Config()FDP::Config
        sptr typedef (defined in FDP::Config)FDP::Config
        ~Config()FDP::Config
        diff --git a/class_f_d_p_1_1_config.html b/class_f_d_p_1_1_config.html index 76a4937..c26aeed 100644 --- a/class_f_d_p_1_1_config.html +++ b/class_f_d_p_1_1_config.html @@ -68,6 +68,7 @@
        +Public Types | Public Member Functions | Static Public Member Functions | List of all members
        @@ -80,11 +81,14 @@

        #include <fdp/objects/config.hxx>

        + + + +

        +Public Types

        +typedef std::shared_ptr< Config > sptr
         
        - - - @@ -150,74 +154,25 @@ - - - + + +

        Public Member Functions

         Config (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
         Construct a new Config object. More...
         
         ~Config ()
         Destroy the Config object.
        YAML::Node get_config_data () const
         Get the config data as a Yaml Node. More...
         
        std::shared_ptr< API > get_api ()
         Get the api object (used to interact with the pipeline directly) More...
         
        API::sptr get_api ()
         Get the api object (used to interact with the pipeline directly) More...
         
        RESTAPI get_rest_api_location ()
         Get the rest api location (local / remote) More...
         
        + +

        Static Public Member Functions

        +static Config::sptr construct (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
         
        static YAML::Node parse_yaml (ghc::filesystem::path yaml_path)
         Read a given yaml file into a Yaml Node. More...
         

        Detailed Description

        class for interacting with confifurations

        -

        Constructor & Destructor Documentation

        - -

        ◆ Config()

        - -
        -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FDP::Config::Config (const ghc::filesystem::path & config_file_path,
        const ghc::filesystem::path & script_file_path,
        const std::string & token,
        RESTAPI api_location 
        )
        -
        - -

        Construct a new Config object.

        -
        Parameters
        - - - - - -
        config_file_paththe path to the config file
        script_file_paththe path to the script file
        tokenthe API token as a String
        api_locationwhether or not the api is local
        -
        -
        - -
        -
        -

        Member Function Documentation

        +

        Member Function Documentation

        ◆ config_reads_()

        @@ -258,8 +213,8 @@

        -

        ◆ get_api()

        + +

        ◆ get_api()

        @@ -268,7 +223,7 @@

        - + diff --git a/class_f_d_p_1_1_data_pipeline-members.html b/class_f_d_p_1_1_data_pipeline-members.html index abed8ce..610e0ed 100644 --- a/class_f_d_p_1_1_data_pipeline-members.html +++ b/class_f_d_p_1_1_data_pipeline-members.html @@ -73,7 +73,7 @@

        This is the complete list of members for FDP::DataPipeline, including all inherited members.

        std::shared_ptr< API > FDP::Config::get_api API::sptr FDP::Config::get_api ( )
        - + diff --git a/class_f_d_p_1_1_data_pipeline.html b/class_f_d_p_1_1_data_pipeline.html index c9bbade..6cb32be 100644 --- a/class_f_d_p_1_1_data_pipeline.html +++ b/class_f_d_p_1_1_data_pipeline.html @@ -68,6 +68,7 @@
        +Classes | Public Member Functions | List of all members
        FDP::DataPipeline Class Reference
        @@ -79,6 +80,11 @@

        #include <fdp/fdp.hxx>

        DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)FDP::DataPipelineinlineexplicit
        DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)FDP::DataPipelineexplicit
        DataPipeline(DataPipeline &&rhs) noexcept (defined in FDP::DataPipeline)FDP::DataPipeline
        DataPipeline(const DataPipeline &rhs) (defined in FDP::DataPipeline)FDP::DataPipeline
        finalise()FDP::DataPipeline
        + + + +

        +Classes

        class  impl
         
        @@ -155,7 +161,7 @@

        -inlineexplicit +explicit

        Public Member Functions

         DataPipeline (const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)

        diff --git a/class_f_d_p_1_1_data_pipeline_impl__-members.html b/class_f_d_p_1_1_data_pipeline_1_1impl-members.html similarity index 55% rename from class_f_d_p_1_1_data_pipeline_impl__-members.html rename to class_f_d_p_1_1_data_pipeline_1_1impl-members.html index 264bf16..d9532be 100644 --- a/class_f_d_p_1_1_data_pipeline_impl__-members.html +++ b/class_f_d_p_1_1_data_pipeline_1_1impl-members.html @@ -63,23 +63,24 @@

      -
      FDP::DataPipelineImpl_ Member List
      +
      FDP::DataPipeline::impl Member List
      -

      This is the complete list of members for FDP::DataPipelineImpl_, including all inherited members.

      +

      This is the complete list of members for FDP::DataPipeline::impl, including all inherited members.

      - - - - - - - + + + + + + + +
      DataPipelineImpl_(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)FDP::DataPipelineImpl_
      DataPipelineImpl_(const DataPipelineImpl_ &dp) (defined in FDP::DataPipelineImpl_)FDP::DataPipelineImpl_inline
      finalise()FDP::DataPipelineImpl_
      get_code_run_uuid()FDP::DataPipelineImpl_
      link_read(std::string &data_product)FDP::DataPipelineImpl_
      link_write(std::string &data_product)FDP::DataPipelineImpl_
      ~DataPipelineImpl_()=defaultFDP::DataPipelineImpl_
      finalise()FDP::DataPipeline::impl
      get_code_run_uuid()FDP::DataPipeline::impl
      impl(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)FDP::DataPipeline::impl
      impl(const impl &dp) (defined in FDP::DataPipeline::impl)FDP::DataPipeline::impl
      link_read(std::string &data_product)FDP::DataPipeline::impl
      link_write(std::string &data_product)FDP::DataPipeline::impl
      sptr typedef (defined in FDP::DataPipeline::impl)FDP::DataPipeline::impl
      ~impl()=defaultFDP::DataPipeline::impl
      diff --git a/class_f_d_p_1_1_data_pipeline_impl__.html b/class_f_d_p_1_1_data_pipeline_1_1impl.html similarity index 57% rename from class_f_d_p_1_1_data_pipeline_impl__.html rename to class_f_d_p_1_1_data_pipeline_1_1impl.html index dc8971b..e5974bb 100644 --- a/class_f_d_p_1_1_data_pipeline_impl__.html +++ b/class_f_d_p_1_1_data_pipeline_1_1impl.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::DataPipelineImpl_ Class Reference +cppDataPipeline: FDP::DataPipeline::impl Class Reference @@ -63,62 +63,59 @@
    +Public Types | Public Member Functions | -List of all members
    -
    FDP::DataPipelineImpl_ Class Reference
    +List of all members
    +
    FDP::DataPipeline::impl Class Reference
    - -

    private pointer-to-implementation class containing all backend methods - More...

    - -

    #include <fdp/registry/datapipeline.hxx>

    + + + +

    +Public Types

    +typedef std::shared_ptr< impl > sptr
     
    - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - + + + + +

    Public Member Functions

     DataPipelineImpl_ (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
     construct a DataPipelineImpl_ instance from configurations and setup More...
     
    - DataPipelineImpl_ (const DataPipelineImpl_ &dp)
     
    - ~DataPipelineImpl_ ()=default
     Default Destructor.
     
    ghc::filesystem::path link_read (std::string &data_product)
     Return a path to a given data product Whilst recording it's meta data for the code run. More...
     
    ghc::filesystem::path link_write (std::string &data_product)
     Return a path to be used for a given data product whilst recording it's meta data. More...
     
    +
     impl (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
     construct a DataPipelineImpl_ instance from configurations and setup More...
     
    + impl (const impl &dp)
     
    + ~impl ()=default
     Default Destructor.
     
    ghc::filesystem::path link_read (std::string &data_product)
     Return a path to a given data product Whilst recording it's meta data for the code run. More...
     
    ghc::filesystem::path link_write (std::string &data_product)
     Return a path to be used for a given data product whilst recording it's meta data. More...
     
    void finalise ()
     Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
     
    std::string get_code_run_uuid ()
     Get the code run uuid. More...
     
     Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
     
    std::string get_code_run_uuid ()
     Get the code run uuid. More...
     
    -

    Detailed Description

    -

    private pointer-to-implementation class containing all backend methods

    -
    -

    This class performs all behind the scenes operations acting as the backend to the user called FDP::DataPipeline class. This structure has been chosen to allow for unit tests to be created to test all methods including private ones.

    -
    Warning
    The class should not be used directly during implementation, but rather via an FDP::DataPipeline instance.
    -

    Constructor & Destructor Documentation

    - -

    ◆ DataPipelineImpl_()

    +

    Constructor & Destructor Documentation

    + +

    ◆ impl()

    - + @@ -155,7 +152,7 @@

    -

    construct a DataPipelineImpl_ instance from configurations and setup

    +

    construct a DataPipelineImpl_ instance from configurations and setup

    Parameters

    FDP::DataPipelineImpl_::DataPipelineImpl_ FDP::DataPipeline::impl::impl ( const ghc::filesystem::path &  config_file_path,
    @@ -170,14 +167,14 @@

    Member Function Documentation

    - -

    ◆ get_code_run_uuid()

    + +

    ◆ get_code_run_uuid()

    - + @@ -190,14 +187,14 @@

    -

    ◆ link_read()

    + +

    ◆ link_read()

    std::string FDP::DataPipelineImpl_::get_code_run_uuid std::string FDP::DataPipeline::impl::get_code_run_uuid ( )
    - + @@ -217,14 +214,14 @@

    -

    ◆ link_write()

    + +

    ◆ link_write()

    ghc::filesystem::path FDP::DataPipelineImpl_::link_read ghc::filesystem::path FDP::DataPipeline::impl::link_read ( std::string &  data_product)
    - + @@ -244,9 +241,8 @@

    datapipeline.hxx -
  • src/registry/datapipeline.cxx
    • +
    The documentation for this class was generated from the following file:
      +
    • src/fdp.cxx
    diff --git a/class_f_d_p_1_1_i_o_object-members.html b/class_f_d_p_1_1_i_o_object-members.html index be7e5c7..c4cdb94 100644 --- a/class_f_d_p_1_1_i_o_object-members.html +++ b/class_f_d_p_1_1_i_o_object-members.html @@ -74,10 +74,10 @@

    This is the complete list of members for FDP::IOObject, including all inherited members.

    ghc::filesystem::path FDP::DataPipelineImpl_::link_write ghc::filesystem::path FDP::DataPipeline::impl::link_write ( std::string &  data_product)
    - + - + diff --git a/class_f_d_p_1_1_i_o_object.html b/class_f_d_p_1_1_i_o_object.html index c17166e..7596c3d 100644 --- a/class_f_d_p_1_1_i_o_object.html +++ b/class_f_d_p_1_1_i_o_object.html @@ -118,12 +118,12 @@ - - - - - - + + + + + + @@ -323,8 +323,8 @@

    -

    ◆ get_component_object()

    + +

    ◆ get_component_object()

    @@ -333,7 +333,7 @@

    get_component_description()FDP::IOObjectinline
    get_component_object()FDP::IOObjectinline
    get_component_object()FDP::IOObjectinline
    get_data_product()FDP::IOObjectinline
    get_data_product_description()FDP::IOObjectinline
    get_data_product_object()FDP::IOObjectinline
    get_data_product_object()FDP::IOObjectinline
    get_path()FDP::IOObjectinline
    get_use_component()FDP::IOObjectinline
    get_use_data_product()FDP::IOObjectinline
    bool is_public ()
     Check whether the data product is public. More...
     
    std::shared_ptr< ApiObject > get_component_object ()
     Get the component object object. More...
     
    std::shared_ptr< ApiObject > get_data_product_object ()
     Get the data product object object. More...
     
    ApiObject::sptr get_component_object ()
     Get the component object object. More...
     
    ApiObject::sptr get_data_product_object ()
     Get the data product object object. More...
     
    void set_component_object (ApiObject &component_obj)
     Set the component object object. More...
     
    - + @@ -407,8 +407,8 @@

    -

    ◆ get_data_product_object()

    + +

    ◆ get_data_product_object()

    @@ -417,7 +417,7 @@

    std::shared_ptr< ApiObject > FDP::IOObject::get_component_object ApiObject::sptr FDP::IOObject::get_component_object ( )
    - + diff --git a/classes.html b/classes.html index 18c21c1..958f053 100644 --- a/classes.html +++ b/classes.html @@ -76,10 +76,10 @@
    Config (FDP)
    config_parsing_error (FDP)
    D
    -
    DataPipeline (FDP)
    DataPipelineImpl_ (FDP)
    +
    DataPipeline (FDP)
    DataPipelineImpl_
    I
    -
    IOObject (FDP)
    +
    DataPipeline::impl (FDP)
    IOObject (FDP)
    J
    json_parse_error (FDP)
    diff --git a/config_8hxx_source.html b/config_8hxx_source.html index 075cd76..6383367 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -88,129 +88,135 @@
    26#include "fdp/objects/io_object.hxx"
    27
    28namespace FDP {
    -
    34 class Config {
    -
    35 private:
    -
    36 const ghc::filesystem::path config_file_path_;
    -
    37 const ghc::filesystem::path config_dir_;
    -
    38 const ghc::filesystem::path script_file_path_;
    -
    39 YAML::Node config_data_;
    -
    40 std::string api_url_;
    -
    41 std::string token_;
    -
    42 std::shared_ptr<API> api_;
    -
    43
    -
    44 std::unique_ptr<ApiObject> user_;
    -
    45 std::unique_ptr<ApiObject> author_;
    -
    46
    -
    47 std::unique_ptr<ApiObject> config_storage_root_;
    -
    48 std::unique_ptr<ApiObject> config_storage_location_;
    -
    49 std::unique_ptr<ApiObject> config_file_type_;
    -
    50 std::unique_ptr<ApiObject> config_obj_;
    -
    51
    -
    52 std::unique_ptr<ApiObject> script_storage_root_;
    -
    53 std::unique_ptr<ApiObject> script_storage_location_;
    -
    54 std::unique_ptr<ApiObject> script_file_type_;
    -
    55 std::unique_ptr<ApiObject> script_obj_;
    -
    56
    -
    57 std::unique_ptr<ApiObject> code_repo_storage_root_;
    -
    58 std::unique_ptr<ApiObject> code_repo_storage_location_;
    -
    59 std::unique_ptr<ApiObject> code_repo_obj_;
    -
    60
    -
    61 std::unique_ptr<ApiObject> code_run_;
    -
    62
    -
    63 std::map<std::string, IOObject> writes_;
    -
    64 std::map<std::string, IOObject> reads_;
    -
    65
    -
    66 std::map<std::string, IOObject> outputs_;
    -
    67 std::map<std::string, IOObject> inputs_;
    -
    68
    -
    69 RESTAPI rest_api_location_ = RESTAPI::LOCAL;
    -
    70
    -
    71 bool config_has_writes() const;
    -
    72 bool config_has_reads() const;
    -
    73
    -
    74 void initialise(RESTAPI api_location);
    -
    75 void validate_config(ghc::filesystem::path yaml_path, RESTAPI api_location);
    -
    76
    -
    77 public:
    -
    78
    -
    87 Config(const ghc::filesystem::path &config_file_path,
    -
    88 const ghc::filesystem::path &script_file_path,
    -
    89 const std::string &token,
    -
    90 RESTAPI api_location);
    +
    33 class Config {
    +
    34 private:
    +
    35 const ghc::filesystem::path config_file_path_;
    +
    36 const ghc::filesystem::path config_dir_;
    +
    37 const ghc::filesystem::path script_file_path_;
    +
    38 YAML::Node config_data_;
    +
    39 std::string api_url_;
    +
    40 std::string token_;
    +
    41 API::sptr api_;
    +
    42
    +
    43 ApiObject::sptr user_;
    +
    44 ApiObject::sptr author_;
    +
    45
    +
    46 ApiObject::sptr config_storage_root_;
    +
    47 ApiObject::sptr config_storage_location_;
    +
    48 ApiObject::sptr config_file_type_;
    +
    49 ApiObject::sptr config_obj_;
    +
    50
    +
    51 ApiObject::sptr script_storage_root_;
    +
    52 ApiObject::sptr script_storage_location_;
    +
    53 ApiObject::sptr script_file_type_;
    +
    54 ApiObject::sptr script_obj_;
    +
    55
    +
    56 ApiObject::sptr code_repo_storage_root_;
    +
    57 ApiObject::sptr code_repo_storage_location_;
    +
    58 ApiObject::sptr code_repo_obj_;
    +
    59
    +
    60 ApiObject::sptr code_run_;
    +
    61
    +
    62 std::map<std::string, IOObject> writes_;
    +
    63 std::map<std::string, IOObject> reads_;
    +
    64
    +
    65 std::map<std::string, IOObject> outputs_;
    +
    66 std::map<std::string, IOObject> inputs_;
    +
    67
    +
    68 RESTAPI rest_api_location_ = RESTAPI::LOCAL;
    +
    69
    +
    70 bool config_has_writes() const;
    +
    71 bool config_has_reads() const;
    +
    72
    +
    73 void initialise(RESTAPI api_location);
    +
    74 void validate_config(ghc::filesystem::path yaml_path, RESTAPI api_location);
    +
    83 Config(const ghc::filesystem::path &config_file_path,
    +
    84 const ghc::filesystem::path &script_file_path,
    +
    85 const std::string &token,
    +
    86 RESTAPI api_location);
    +
    87
    +
    88
    +
    89 public:
    +
    90 typedef std::shared_ptr< Config > sptr;
    91
    -
    96 ~Config();
    -
    97
    -
    103 YAML::Node meta_data_() const;
    -
    109 YAML::Node config_writes_() const;
    -
    110
    -
    116 YAML::Node config_reads_() const;
    -
    117
    -
    124 bool has_reads() const;
    -
    131 bool has_writes() const;
    -
    138 bool has_outputs() const;
    -
    145 bool has_inputs() const;
    -
    146
    -
    153 ghc::filesystem::path get_config_file_path() const {return config_file_path_;}
    -
    165 ghc::filesystem::path get_script_file_path() const {return script_file_path_;}
    -
    166
    -
    172 std::string get_token() const {return token_;}
    -
    173
    -
    179 std::string get_api_url() const {return api_url_;}
    -
    185 ghc::filesystem::path get_data_store() const;
    -
    186
    -
    192 std::string get_default_input_namespace() const;
    -
    193
    -
    199 std::string get_default_output_namespace() const;
    -
    200
    -
    206 std::string get_config_directory() const;
    -
    207
    -
    213 std::string get_code_run_uuid() const;
    -
    214
    -
    222 ghc::filesystem::path link_write(std::string &data_product);
    -
    223
    -
    230 ghc::filesystem::path link_read(std::string &data_product);
    -
    231
    -
    238 void finalise();
    -
    239
    -
    246 static YAML::Node parse_yaml(ghc::filesystem::path yaml_path);
    -
    247
    -
    253 YAML::Node get_config_data() const {return config_data_;}
    -
    254
    -
    260 std::shared_ptr<API> get_api(){return api_;}
    -
    261
    -
    267 RESTAPI get_rest_api_location(){return rest_api_location_;}
    -
    268
    -
    269 };
    -
    270};
    -
    271#endif
    +
    92 static Config::sptr construct(const ghc::filesystem::path &config_file_path,
    +
    93 const ghc::filesystem::path &script_file_path,
    +
    94 const std::string &token,
    +
    95 RESTAPI api_location);
    +
    96
    +
    97
    +
    102 ~Config();
    +
    103
    +
    109 YAML::Node meta_data_() const;
    +
    115 YAML::Node config_writes_() const;
    +
    116
    +
    122 YAML::Node config_reads_() const;
    +
    123
    +
    130 bool has_reads() const;
    +
    137 bool has_writes() const;
    +
    144 bool has_outputs() const;
    +
    151 bool has_inputs() const;
    +
    152
    +
    159 ghc::filesystem::path get_config_file_path() const {return config_file_path_;}
    +
    171 ghc::filesystem::path get_script_file_path() const {return script_file_path_;}
    +
    172
    +
    178 std::string get_token() const {return token_;}
    +
    179
    +
    185 std::string get_api_url() const {return api_url_;}
    +
    191 ghc::filesystem::path get_data_store() const;
    +
    192
    +
    198 std::string get_default_input_namespace() const;
    +
    199
    +
    205 std::string get_default_output_namespace() const;
    +
    206
    +
    212 std::string get_config_directory() const;
    +
    213
    +
    219 std::string get_code_run_uuid() const;
    +
    220
    +
    228 ghc::filesystem::path link_write(std::string &data_product);
    +
    229
    +
    236 ghc::filesystem::path link_read(std::string &data_product);
    +
    237
    +
    244 void finalise();
    +
    245
    +
    252 static YAML::Node parse_yaml(ghc::filesystem::path yaml_path);
    +
    253
    +
    259 YAML::Node get_config_data() const {return config_data_;}
    +
    260
    +
    266 API::sptr get_api(){return api_;}
    +
    267
    +
    273 RESTAPI get_rest_api_location(){return rest_api_location_;}
    +
    274
    +
    275 };
    +
    276};
    +
    277#endif
    api.hxx
    File containing classes and methods for connecting to the RestAPI.
    FDP::RESTAPI
    RESTAPI
    selection of either local or remote pipeline running
    Definition: api.hxx:37
    -
    FDP::Config
    class for interacting with confifurations
    Definition: config.hxx:34
    -
    FDP::Config::config_writes_
    YAML::Node config_writes_() const
    Returns the writes Yaml Node from the config.
    Definition: config.cxx:27
    -
    FDP::Config::parse_yaml
    static YAML::Node parse_yaml(ghc::filesystem::path yaml_path)
    Read a given yaml file into a Yaml Node.
    Definition: config.cxx:17
    -
    FDP::Config::get_token
    std::string get_token() const
    Get the token as a string.
    Definition: config.hxx:172
    -
    FDP::Config::get_rest_api_location
    RESTAPI get_rest_api_location()
    Get the rest api location (local / remote)
    Definition: config.hxx:267
    -
    FDP::Config::Config
    Config(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
    Construct a new Config object.
    Definition: config.cxx:4
    -
    FDP::Config::has_inputs
    bool has_inputs() const
    Check whether any inputs have been added.
    Definition: config.cxx:57
    -
    FDP::Config::get_default_input_namespace
    std::string get_default_input_namespace() const
    Get the default input namespace.
    Definition: config.cxx:70
    -
    FDP::Config::get_data_store
    ghc::filesystem::path get_data_store() const
    Get the data store path.
    Definition: config.cxx:65
    -
    FDP::Config::has_reads
    bool has_reads() const
    Check whether the config has reads.
    Definition: config.cxx:53
    -
    FDP::Config::~Config
    ~Config()
    Destroy the Config object.
    Definition: config.cxx:13
    -
    FDP::Config::get_script_file_path
    ghc::filesystem::path get_script_file_path() const
    Get the script file path object.
    Definition: config.hxx:165
    -
    FDP::Config::meta_data_
    YAML::Node meta_data_() const
    Returns the meta_data Yaml Node from the config.
    Definition: config.cxx:23
    -
    FDP::Config::get_api
    std::shared_ptr< API > get_api()
    Get the api object (used to interact with the pipeline directly)
    Definition: config.hxx:260
    -
    FDP::Config::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:418
    -
    FDP::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:524
    -
    FDP::Config::get_config_file_path
    ghc::filesystem::path get_config_file_path() const
    Get the config file path object.
    Definition: config.hxx:153
    -
    FDP::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:336
    -
    FDP::Config::has_writes
    bool has_writes() const
    Check whether the config has writes.
    Definition: config.cxx:49
    -
    FDP::Config::has_outputs
    bool has_outputs() const
    Check whether any outputs have been added.
    Definition: config.cxx:61
    -
    FDP::Config::get_config_data
    YAML::Node get_config_data() const
    Get the config data as a Yaml Node.
    Definition: config.hxx:253
    -
    FDP::Config::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:341
    -
    FDP::Config::get_default_output_namespace
    std::string get_default_output_namespace() const
    Get the default output namespace.
    Definition: config.cxx:74
    -
    FDP::Config::get_api_url
    std::string get_api_url() const
    Get the api url.
    Definition: config.hxx:179
    -
    FDP::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:332
    -
    FDP::Config::config_reads_
    YAML::Node config_reads_() const
    Returns the reads Yaml Node from the config.
    Definition: config.cxx:31
    +
    FDP::Config
    class for interacting with confifurations
    Definition: config.hxx:33
    +
    FDP::Config::config_writes_
    YAML::Node config_writes_() const
    Returns the writes Yaml Node from the config.
    Definition: config.cxx:43
    +
    FDP::Config::parse_yaml
    static YAML::Node parse_yaml(ghc::filesystem::path yaml_path)
    Read a given yaml file into a Yaml Node.
    Definition: config.cxx:33
    +
    FDP::Config::get_token
    std::string get_token() const
    Get the token as a string.
    Definition: config.hxx:178
    +
    FDP::Config::get_rest_api_location
    RESTAPI get_rest_api_location()
    Get the rest api location (local / remote)
    Definition: config.hxx:273
    +
    FDP::Config::has_inputs
    bool has_inputs() const
    Check whether any inputs have been added.
    Definition: config.cxx:73
    +
    FDP::Config::get_default_input_namespace
    std::string get_default_input_namespace() const
    Get the default input namespace.
    Definition: config.cxx:86
    +
    FDP::Config::get_data_store
    ghc::filesystem::path get_data_store() const
    Get the data store path.
    Definition: config.cxx:81
    +
    FDP::Config::has_reads
    bool has_reads() const
    Check whether the config has reads.
    Definition: config.cxx:69
    +
    FDP::Config::~Config
    ~Config()
    Destroy the Config object.
    Definition: config.cxx:29
    +
    FDP::Config::get_script_file_path
    ghc::filesystem::path get_script_file_path() const
    Get the script file path object.
    Definition: config.hxx:171
    +
    FDP::Config::meta_data_
    YAML::Node meta_data_() const
    Returns the meta_data Yaml Node from the config.
    Definition: config.cxx:39
    +
    FDP::Config::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:432
    +
    FDP::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:551
    +
    FDP::Config::get_config_file_path
    ghc::filesystem::path get_config_file_path() const
    Get the config file path object.
    Definition: config.hxx:159
    +
    FDP::Config::get_api
    API::sptr get_api()
    Get the api object (used to interact with the pipeline directly)
    Definition: config.hxx:266
    +
    FDP::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:350
    +
    FDP::Config::has_writes
    bool has_writes() const
    Check whether the config has writes.
    Definition: config.cxx:65
    +
    FDP::Config::has_outputs
    bool has_outputs() const
    Check whether any outputs have been added.
    Definition: config.cxx:77
    +
    FDP::Config::get_config_data
    YAML::Node get_config_data() const
    Get the config data as a Yaml Node.
    Definition: config.hxx:259
    +
    FDP::Config::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:355
    +
    FDP::Config::get_default_output_namespace
    std::string get_default_output_namespace() const
    Get the default output namespace.
    Definition: config.cxx:90
    +
    FDP::Config::get_api_url
    std::string get_api_url() const
    Get the api url.
    Definition: config.hxx:185
    +
    FDP::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:346
    +
    FDP::Config::config_reads_
    YAML::Node config_reads_() const
    Returns the reads Yaml Node from the config.
    Definition: config.cxx:47
    metadata.hxx
    File containing methods for handling of metadata.
    diff --git a/datapipeline_8hxx_source.html b/datapipeline_8hxx_source.html deleted file mode 100644 index 75e5f40..0000000 --- a/datapipeline_8hxx_source.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - -cppDataPipeline: include/fdp/registry/datapipeline.hxx Source File - - - - - - - - - -
    -
    -
    std::shared_ptr< ApiObject > FDP::IOObject::get_data_product_object ApiObject::sptr FDP::IOObject::get_data_product_object ( )
    - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    datapipeline.hxx
    -
    -
    -Go to the documentation of this file.
    1
    -
    11#ifndef __FDP_DATAPIPELINE_HXX__
    -
    12#define __FDP_DATAPIPELINE_HXX__
    -
    13
    -
    14#include <algorithm>
    -
    15#include <fstream>
    -
    16#include <iostream>
    -
    17#include <string>
    -
    18
    -
    19#include "spdlog/spdlog.h"
    -
    20#include "json/json.h"
    -
    21
    -
    22#include "fdp/objects/config.hxx"
    -
    23#include "fdp/objects/metadata.hxx"
    -
    24#include "fdp/registry/api.hxx"
    -
    25#include "fdp/registry/data_io.hxx"
    -
    26#include "fdp/utilities/logging.hxx"
    -
    27
    -
    28namespace FDP {
    -
    29
    -
    43class DataPipelineImpl_ {
    -
    44 private:
    -
    45 std::unique_ptr<Config> config_;
    -
    46
    -
    47 ghc::filesystem::path config_file_path_() const {return config_->get_config_file_path();}
    -
    48 ghc::filesystem::path script_file_path_() const {return config_->get_script_file_path();}
    -
    49 std::string token_() const {return config_->get_token();}
    -
    50 RESTAPI api_location_() {return config_->get_rest_api_location();}
    -
    51public:
    -
    52
    -
    61 DataPipelineImpl_(const ghc::filesystem::path &config_file_path,
    -
    62 const ghc::filesystem::path &file_system_path,
    -
    63 const std::string token,
    -
    64 spdlog::level::level_enum log_level = spdlog::level::info,
    -
    65 RESTAPI api_location = RESTAPI::LOCAL);
    -
    66
    -
    67 DataPipelineImpl_(const DataPipelineImpl_ &dp){
    -
    68 DataPipelineImpl_(dp.config_file_path_(), dp.script_file_path_(), token_(), spdlog::level::info, api_location_());}
    -
    69
    -
    74 ~DataPipelineImpl_() = default;
    -
    75
    -
    83 ghc::filesystem::path link_read(std::string &data_product);
    -
    84
    -
    92 ghc::filesystem::path link_write(std::string &data_product);
    -
    93
    -
    100 void finalise();
    -
    101
    -
    107 std::string get_code_run_uuid();
    -
    108
    -
    109};
    -
    110}; // namespace FDP
    -
    111
    -
    112#endif
    -
    api.hxx
    File containing classes and methods for connecting to the RestAPI.
    -
    FDP::RESTAPI
    RESTAPI
    selection of either local or remote pipeline running
    Definition: api.hxx:37
    -
    FDP::DataPipelineImpl_
    private pointer-to-implementation class containing all backend methods
    Definition: datapipeline.hxx:43
    -
    FDP::DataPipelineImpl_::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: datapipeline.cxx:25
    -
    FDP::DataPipelineImpl_::DataPipelineImpl_
    DataPipelineImpl_(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
    construct a DataPipelineImpl_ instance from configurations and setup
    Definition: datapipeline.cxx:5
    -
    FDP::DataPipelineImpl_::get_code_run_uuid
    std::string get_code_run_uuid()
    Get the code run uuid.
    Definition: datapipeline.cxx:35
    -
    FDP::DataPipelineImpl_::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: datapipeline.cxx:28
    -
    FDP::DataPipelineImpl_::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: datapipeline.cxx:31
    -
    FDP::DataPipelineImpl_::~DataPipelineImpl_
    ~DataPipelineImpl_()=default
    Default Destructor.
    - -
    logging.hxx
    File contains pointers for creating global logger during session.
    -
    metadata.hxx
    File containing methods for handling of metadata.
    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/dir_d98af0b859cb0744225e11c767d17cdb.html b/dir_d98af0b859cb0744225e11c767d17cdb.html index 31274cb..a2add24 100644 --- a/dir_d98af0b859cb0744225e11c767d17cdb.html +++ b/dir_d98af0b859cb0744225e11c767d17cdb.html @@ -76,9 +76,6 @@ file  api.hxx [code]  File containing classes and methods for connecting to the RestAPI.
      -file  datapipeline.hxx [code] - File containing classes for interaction with the FDP data pipeline.
    - 
    diff --git a/fdp_8hxx_source.html b/fdp_8hxx_source.html index f66af57..a526601 100644 --- a/fdp_8hxx_source.html +++ b/fdp_8hxx_source.html @@ -70,52 +70,53 @@
    fdp.hxx
    -
    1#include "fdp/registry/datapipeline.hxx"
    -
    2
    -
    3namespace FDP {
    -
    9class DataPipeline {
    -
    10public:
    -
    19 explicit DataPipeline(
    -
    20 const std::string &config_file_path,
    -
    21 const std::string &script_file_path,
    -
    22 std::string token = "",
    -
    23 spdlog::level::level_enum log_level = spdlog::level::info)
    -
    24 : pimpl_(std::make_shared<DataPipelineImpl_>(ghc::filesystem::path(config_file_path), ghc::filesystem::path(script_file_path), token,
    -
    25 log_level)) {
    -
    26
    -
    27 APILogger->debug("DataPipeline: Initialising session '{0}'", Pimpl()->get_code_run_uuid());
    -
    28 }
    -
    29
    -
    34 ~DataPipeline();
    -
    35
    -
    36 DataPipeline(DataPipeline &&rhs) noexcept;
    -
    37 DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    -
    38
    -
    39 DataPipeline(const DataPipeline &rhs);
    -
    40 DataPipeline &operator=(const DataPipeline &rhs);
    -
    41
    -
    49 ghc::filesystem::path link_read(std::string &data_product);
    -
    50
    -
    58 ghc::filesystem::path link_write(std::string &data_product);
    -
    59
    -
    66 void finalise();
    -
    67
    -
    68private:
    -
    69 const DataPipelineImpl_* Pimpl() const {return pimpl_.get();}
    -
    70 DataPipelineImpl_* Pimpl() {return pimpl_.get();}
    -
    71
    -
    72 std::shared_ptr<DataPipelineImpl_> pimpl_;
    -
    73};
    -
    74}; // namespace FDP
    -
    FDP::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:9
    -
    FDP::DataPipeline::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:23
    +
    1#ifndef __FDP__
    +
    2#define __FDP__
    +
    3
    +
    4#include "spdlog/spdlog.h"
    +
    5#include <ghc/filesystem.hpp>
    +
    6
    +
    7//#include "fdp/registry/datapipeline.hxx"
    +
    8
    +
    9namespace FDP {
    +
    15 class DataPipeline {
    +
    16
    +
    17 public:
    +
    26 explicit DataPipeline(
    +
    27 const std::string &config_file_path,
    +
    28 const std::string &script_file_path,
    +
    29 std::string token = "",
    +
    30 spdlog::level::level_enum log_level = spdlog::level::info);
    +
    31
    +
    36 ~DataPipeline();
    +
    37
    +
    38 DataPipeline(DataPipeline &&rhs) noexcept;
    +
    39 DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    +
    40
    +
    41 DataPipeline(const DataPipeline &rhs);
    +
    42 DataPipeline &operator=(const DataPipeline &rhs);
    +
    43
    +
    51 ghc::filesystem::path link_read(std::string &data_product);
    +
    52
    +
    60 ghc::filesystem::path link_write(std::string &data_product);
    +
    61
    +
    68 void finalise();
    +
    69
    +
    70 private:
    +
    71 class impl;
    +
    72
    +
    73 std::shared_ptr< DataPipeline::impl > pimpl_;
    +
    74 };
    +
    75}; // namespace FDP
    +
    76
    +
    77#endif
    +
    FDP::DataPipeline::impl
    Definition: fdp.cxx:30
    +
    FDP::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:15
    +
    FDP::DataPipeline::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:182
    FDP::DataPipeline::~DataPipeline
    ~DataPipeline()
    Destroy the Data Pipeline object.
    -
    FDP::DataPipeline::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:20
    -
    FDP::DataPipeline::DataPipeline
    DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.hxx:19
    -
    FDP::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:26
    -
    FDP::DataPipelineImpl_
    private pointer-to-implementation class containing all backend methods
    Definition: datapipeline.hxx:43
    -
    datapipeline.hxx
    File containing classes for interaction with the FDP data pipeline.
    -
    FDP::APILogger
    const std::shared_ptr< spdlog::logger > APILogger
    Global logger used across all FDP scripts.
    Definition: logging.hxx:31
    +
    FDP::DataPipeline::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:178
    +
    FDP::DataPipeline::DataPipeline
    DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.cxx:159
    +
    FDP::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:186
    diff --git a/files.html b/files.html index c40da3b..671d3aa 100644 --- a/files.html +++ b/files.html @@ -78,13 +78,12 @@  ▼ registry  api.hxxFile containing classes and methods for connecting to the RestAPI  data_io.hxx - datapipeline.hxxFile containing classes for interaction with the FDP data pipeline - ▼ utilities - json.hxxFile contains methods relating to handling of JSON based data - logging.hxxFile contains pointers for creating global logger during session - semver.hxxFile contains classes and types for validating semantic versioning - exceptions.hxx - fdp.hxx + ▼ utilities + json.hxxFile contains methods relating to handling of JSON based data + logging.hxxFile contains pointers for creating global logger during session + semver.hxxFile contains classes and types for validating semantic versioning + exceptions.hxx + fdp.hxx
    diff --git a/functions.html b/functions.html index ab52149..f4c4eba 100644 --- a/functions.html +++ b/functions.html @@ -67,21 +67,19 @@

    - a -

    - c -

    - d -

    @@ -91,23 +89,23 @@

    - e -

      - f -

      - g -

        -
      • get_api() : FDP::Config
        • +
      • get_api() : FDP::Config
      • get_api_url() : FDP::Config
      • get_by_id() : FDP::API
        • -
      • get_code_run_uuid() : FDP::Config, FDP::DataPipelineImpl_
        • +
      • get_code_run_uuid() : FDP::Config, FDP::DataPipeline::impl
      • get_component_description() : FDP::IOObject
        • -
      • get_component_object() : FDP::IOObject
        • +
      • get_component_object() : FDP::IOObject
      • get_config_data() : FDP::Config
      • get_config_directory() : FDP::Config
      • get_config_file_path() : FDP::Config
      • get_data_product() : FDP::IOObject
      • get_data_product_description() : FDP::IOObject
        • -
      • get_data_product_object() : FDP::IOObject
        • +
      • get_data_product_object() : FDP::IOObject
      • get_data_store() : FDP::Config
      • get_default_input_namespace() : FDP::Config
      • get_default_output_namespace() : FDP::Config
        • @@ -140,6 +138,7 @@

        - h -

          - i -

            +
          • impl() : FDP::DataPipeline::impl
          • IOObject() : FDP::IOObject
          • is_empty() : FDP::ApiObject
          • is_public() : FDP::IOObject
            • @@ -152,8 +151,8 @@

            - j -

              - l -

              @@ -187,7 +186,7 @@

              - v -

                - ~ -

                diff --git a/functions_func.html b/functions_func.html index 7356b09..741a903 100644 --- a/functions_func.html +++ b/functions_func.html @@ -67,21 +67,19 @@

                - a -

                - c -

                - d -

                @@ -91,23 +89,23 @@

                - e -

                  - f -

                  - g -

                    -
                  • get_api() : FDP::Config
                    • +
                  • get_api() : FDP::Config
                  • get_api_url() : FDP::Config
                  • get_by_id() : FDP::API
                    • -
                  • get_code_run_uuid() : FDP::Config, FDP::DataPipelineImpl_
                    • +
                  • get_code_run_uuid() : FDP::Config, FDP::DataPipeline::impl
                  • get_component_description() : FDP::IOObject
                    • -
                  • get_component_object() : FDP::IOObject
                    • +
                  • get_component_object() : FDP::IOObject
                  • get_config_data() : FDP::Config
                  • get_config_directory() : FDP::Config
                  • get_config_file_path() : FDP::Config
                  • get_data_product() : FDP::IOObject
                  • get_data_product_description() : FDP::IOObject
                    • -
                  • get_data_product_object() : FDP::IOObject
                    • +
                  • get_data_product_object() : FDP::IOObject
                  • get_data_store() : FDP::Config
                  • get_default_input_namespace() : FDP::Config
                  • get_default_output_namespace() : FDP::Config
                    • @@ -140,6 +138,7 @@

                    - h -

                      - i -

                        +
                      • impl() : FDP::DataPipeline::impl
                      • IOObject() : FDP::IOObject
                      • is_empty() : FDP::ApiObject
                      • is_public() : FDP::IOObject
                        • @@ -152,8 +151,8 @@

                        - j -

                          - l -

                          @@ -187,7 +186,7 @@

                          - v -

                            - ~ -

                            diff --git a/hierarchy.html b/hierarchy.html index 64c0752..5b69f45 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -72,16 +72,17 @@  CFDP::ApiObjectClass for API objects  CFDP::ConfigClass for interacting with confifurations  CFDP::DataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline - CFDP::DataPipelineImpl_Private pointer-to-implementation class containing all backend methods - CFDP::IOObjectClass for API objects - ▼Cstd::runtime_error - CFDP::config_parsing_error - CFDP::json_parse_error - CFDP::rest_apiquery_error - CFDP::sync_error - CFDP::validation_error - CFDP::write_error - CFDP::Versioning::versionClass describing the semantic version of an object + CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods + CFDP::DataPipeline::impl + CFDP::IOObjectClass for API objects + ▼Cstd::runtime_error + CFDP::config_parsing_error + CFDP::json_parse_error + CFDP::rest_apiquery_error + CFDP::sync_error + CFDP::validation_error + CFDP::write_error + CFDP::Versioning::versionClass describing the semantic version of an object diff --git a/index.html b/index.html index a67365b..996d2dc 100644 --- a/index.html +++ b/index.html @@ -87,7 +87,7 @@

                            $ cmake --build build --config=Release

                            Outline

                            -

                            The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

                            +

                            The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

                            Unit Tests

                            The unit tests use the local registry, this needs to be running prior to running the tests see: the CLI documentation

                            diff --git a/io__object_8hxx_source.html b/io__object_8hxx_source.html index 6cb05e2..19ee15a 100644 --- a/io__object_8hxx_source.html +++ b/io__object_8hxx_source.html @@ -93,88 +93,91 @@
                            25 std::string component_description_ = "None";
                            26 bool public_ = false;
                            27
                            -
                            28 std::shared_ptr<ApiObject> component_obj_;
                            -
                            29 std::shared_ptr<ApiObject> data_product_obj_;
                            +
                            28 ApiObject::sptr component_obj_;
                            +
                            29 ApiObject::sptr data_product_obj_;
                            30
                            31 public:
                            36 IOObject(){};
                            49 IOObject(std::string data_product,
                            -
                            50 std::string use_data_product,
                            -
                            51 std::string use_version,
                            -
                            52 std::string use_namespace,
                            -
                            53 ghc::filesystem::path path,
                            -
                            54 std::string data_product_description,
                            -
                            55 bool isPublic):
                            -
                            56 data_product_(data_product),
                            -
                            57 use_data_product_(use_data_product),
                            -
                            58 use_version_(use_version),
                            -
                            59 use_namespace_(use_namespace),
                            -
                            60 path_(path),
                            -
                            61 data_product_description_(data_product_description),
                            -
                            62 public_(isPublic){};
                            -
                            63
                            -
                            76 IOObject(std::string data_product,
                            -
                            77 std::string use_data_product,
                            -
                            78 std::string use_version,
                            -
                            79 std::string use_namespace,
                            -
                            80 ghc::filesystem::path path,
                            -
                            81 ApiObject &component_obj,
                            -
                            82 ApiObject &data_product_obj):
                            -
                            83 data_product_(data_product),
                            -
                            84 use_data_product_(use_data_product),
                            -
                            85 use_version_(use_version),
                            -
                            86 use_namespace_(use_namespace),
                            -
                            87 path_(path),
                            -
                            88 component_obj_(std::make_shared<ApiObject>(component_obj)),
                            -
                            89 data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
                            -
                            90
                            -
                            96 std::string get_data_product() {return data_product_;}
                            -
                            97
                            -
                            103 std::string get_use_data_product() {return use_data_product_;}
                            -
                            104
                            -
                            110 std::string get_use_component() {return use_component_;}
                            -
                            111
                            -
                            117 std::string get_use_version() {return use_version_;}
                            -
                            118
                            -
                            124 std::string get_use_namespace() {return use_namespace_;}
                            -
                            125
                            -
                            131 ghc::filesystem::path get_path() {return path_;}
                            -
                            132
                            -
                            138 std::string get_data_product_description() {return data_product_description_;}
                            -
                            139
                            -
                            145 std::string get_component_description() {return component_description_;}
                            -
                            146
                            -
                            153 bool is_public() {return public_;}
                            -
                            154
                            -
                            160 std::shared_ptr<ApiObject> get_component_object() {return component_obj_;}
                            -
                            161
                            -
                            167 std::shared_ptr<ApiObject> get_data_product_object() {return data_product_obj_;}
                            -
                            168
                            -
                            174 void set_component_object(ApiObject &component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
                            -
                            175
                            -
                            181 void set_data_product_object(ApiObject &data_product_obj){data_product_obj_ = std::make_shared<ApiObject>(data_product_obj);}
                            -
                            182 };
                            -
                            183};
                            -
                            184
                            -
                            185#endif
                            +
                            50 std::string use_data_product,
                            +
                            51 std::string use_version,
                            +
                            52 std::string use_namespace,
                            +
                            53 ghc::filesystem::path path,
                            +
                            54 std::string data_product_description,
                            +
                            55 bool isPublic)
                            +
                            56 :
                            +
                            57 data_product_(data_product),
                            +
                            58 use_data_product_(use_data_product),
                            +
                            59 use_version_(use_version),
                            +
                            60 use_namespace_(use_namespace),
                            +
                            61 path_(path),
                            +
                            62 data_product_description_(data_product_description),
                            +
                            63 public_(isPublic){};
                            +
                            64
                            +
                            77 IOObject(std::string data_product,
                            +
                            78 std::string use_data_product,
                            +
                            79 std::string use_version,
                            +
                            80 std::string use_namespace,
                            +
                            81 ghc::filesystem::path path,
                            +
                            82 ApiObject &component_obj,
                            +
                            83 ApiObject &data_product_obj)
                            +
                            84 :
                            +
                            85 data_product_(data_product),
                            +
                            86 use_data_product_(use_data_product),
                            +
                            87 use_version_(use_version),
                            +
                            88 use_namespace_(use_namespace),
                            +
                            89 path_(path),
                            +
                            90 component_obj_(std::make_shared<ApiObject>(component_obj)),
                            +
                            91 data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
                            +
                            92
                            +
                            98 std::string get_data_product() {return data_product_;}
                            +
                            99
                            +
                            105 std::string get_use_data_product() {return use_data_product_;}
                            +
                            106
                            +
                            112 std::string get_use_component() {return use_component_;}
                            +
                            113
                            +
                            119 std::string get_use_version() {return use_version_;}
                            +
                            120
                            +
                            126 std::string get_use_namespace() {return use_namespace_;}
                            +
                            127
                            +
                            133 ghc::filesystem::path get_path() {return path_;}
                            +
                            134
                            +
                            140 std::string get_data_product_description() {return data_product_description_;}
                            +
                            141
                            +
                            147 std::string get_component_description() {return component_description_;}
                            +
                            148
                            +
                            155 bool is_public() {return public_;}
                            +
                            156
                            +
                            162 ApiObject::sptr get_component_object() {return component_obj_;}
                            +
                            163
                            +
                            164
                            +
                            170 ApiObject::sptr get_data_product_object() {return data_product_obj_;}
                            +
                            171
                            +
                            177 void set_component_object(ApiObject& component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
                            +
                            178
                            +
                            184 void set_data_product_object(ApiObject &data_product_obj){data_product_obj_ = std::make_shared<ApiObject>(data_product_obj);}
                            +
                            185 };
                            +
                            186};
                            +
                            187
                            +
                            188#endif
                            FDP::ApiObject
                            Class for API objects.
                            Definition: api_object.hxx:15
                            FDP::IOObject
                            Class for API objects.
                            Definition: io_object.hxx:16
                            -
                            FDP::IOObject::get_use_component
                            std::string get_use_component()
                            Get the use component as a string.
                            Definition: io_object.hxx:110
                            -
                            FDP::IOObject::get_use_namespace
                            std::string get_use_namespace()
                            Get the use namespace as a string.
                            Definition: io_object.hxx:124
                            -
                            FDP::IOObject::get_use_data_product
                            std::string get_use_data_product()
                            Get the use data product as a string.
                            Definition: io_object.hxx:103
                            -
                            FDP::IOObject::get_component_object
                            std::shared_ptr< ApiObject > get_component_object()
                            Get the component object object.
                            Definition: io_object.hxx:160
                            -
                            FDP::IOObject::set_data_product_object
                            void set_data_product_object(ApiObject &data_product_obj)
                            Set the data product object object.
                            Definition: io_object.hxx:181
                            -
                            FDP::IOObject::get_component_description
                            std::string get_component_description()
                            Get the component description as a string.
                            Definition: io_object.hxx:145
                            +
                            FDP::IOObject::get_use_component
                            std::string get_use_component()
                            Get the use component as a string.
                            Definition: io_object.hxx:112
                            +
                            FDP::IOObject::get_use_namespace
                            std::string get_use_namespace()
                            Get the use namespace as a string.
                            Definition: io_object.hxx:126
                            +
                            FDP::IOObject::get_use_data_product
                            std::string get_use_data_product()
                            Get the use data product as a string.
                            Definition: io_object.hxx:105
                            +
                            FDP::IOObject::set_data_product_object
                            void set_data_product_object(ApiObject &data_product_obj)
                            Set the data product object object.
                            Definition: io_object.hxx:184
                            +
                            FDP::IOObject::get_component_description
                            std::string get_component_description()
                            Get the component description as a string.
                            Definition: io_object.hxx:147
                            FDP::IOObject::IOObject
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:49
                            FDP::IOObject::IOObject
                            IOObject()
                            Construct a new IOObject object (empty constructor)
                            Definition: io_object.hxx:36
                            -
                            FDP::IOObject::get_data_product
                            std::string get_data_product()
                            Get the data product as a string.
                            Definition: io_object.hxx:96
                            -
                            FDP::IOObject::is_public
                            bool is_public()
                            Check whether the data product is public.
                            Definition: io_object.hxx:153
                            -
                            FDP::IOObject::IOObject
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:76
                            -
                            FDP::IOObject::get_use_version
                            std::string get_use_version()
                            Get the use version as a string.
                            Definition: io_object.hxx:117
                            -
                            FDP::IOObject::get_path
                            ghc::filesystem::path get_path()
                            Get the path of the data product.
                            Definition: io_object.hxx:131
                            -
                            FDP::IOObject::set_component_object
                            void set_component_object(ApiObject &component_obj)
                            Set the component object object.
                            Definition: io_object.hxx:174
                            -
                            FDP::IOObject::get_data_product_object
                            std::shared_ptr< ApiObject > get_data_product_object()
                            Get the data product object object.
                            Definition: io_object.hxx:167
                            -
                            FDP::IOObject::get_data_product_description
                            std::string get_data_product_description()
                            Get the data product description as a string.
                            Definition: io_object.hxx:138
                            +
                            FDP::IOObject::get_data_product
                            std::string get_data_product()
                            Get the data product as a string.
                            Definition: io_object.hxx:98
                            +
                            FDP::IOObject::is_public
                            bool is_public()
                            Check whether the data product is public.
                            Definition: io_object.hxx:155
                            +
                            FDP::IOObject::IOObject
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:77
                            +
                            FDP::IOObject::get_use_version
                            std::string get_use_version()
                            Get the use version as a string.
                            Definition: io_object.hxx:119
                            +
                            FDP::IOObject::get_path
                            ghc::filesystem::path get_path()
                            Get the path of the data product.
                            Definition: io_object.hxx:133
                            +
                            FDP::IOObject::set_component_object
                            void set_component_object(ApiObject &component_obj)
                            Set the component object object.
                            Definition: io_object.hxx:177
                            +
                            FDP::IOObject::get_component_object
                            ApiObject::sptr get_component_object()
                            Get the component object object.
                            Definition: io_object.hxx:162
                            +
                            FDP::IOObject::get_data_product_object
                            ApiObject::sptr get_data_product_object()
                            Get the data product object object.
                            Definition: io_object.hxx:170
                            +
                            FDP::IOObject::get_data_product_description
                            std::string get_data_product_description()
                            Get the data product description as a string.
                            Definition: io_object.hxx:140
                            logging.hxx
                            File contains pointers for creating global logger during session.
                            diff --git a/namespaces.html b/namespaces.html index 93d16aa..7027042 100644 --- a/namespaces.html +++ b/namespaces.html @@ -75,14 +75,14 @@  CApiObjectClass for API objects  CConfigClass for interacting with confifurations  Cconfig_parsing_error - CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline - CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods - CIOObjectClass for API objects - Cjson_parse_error - Crest_apiquery_error - Csync_error - Cvalidation_error - Cwrite_error + ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline + Cimpl + CIOObjectClass for API objects + Cjson_parse_error + Crest_apiquery_error + Csync_error + Cvalidation_error + Cwrite_error diff --git a/search/all_0.js b/search/all_0.js index 999c0fe..750bc82 100644 --- a/search/all_0.js +++ b/search/all_0.js @@ -4,6 +4,6 @@ var searchData= ['api_1',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API::API()'],['../class_f_d_p_1_1_a_p_i.html',1,'FDP::API']]], ['api_2ehxx_2',['api.hxx',['../api_8hxx.html',1,'']]], ['apilogger_3',['APILogger',['../logging_8hxx.html#a86cb9217b28d11ce2d889dbbe92bcb2b',1,'FDP']]], - ['apiobject_4',['ApiObject',['../class_f_d_p_1_1_api_object.html#a6db277989caee23fb8ca73c76f629b8a',1,'FDP::ApiObject::ApiObject()'],['../class_f_d_p_1_1_api_object.html',1,'FDP::ApiObject']]], + ['apiobject_4',['ApiObject',['../class_f_d_p_1_1_api_object.html',1,'FDP']]], ['append_5fwith_5fforward_5fslash_5',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] ]; diff --git a/search/all_11.js b/search/all_11.js index d5162b8..cf3da40 100644 --- a/search/all_11.js +++ b/search/all_11.js @@ -2,5 +2,5 @@ var searchData= [ ['_7econfig_0',['~Config',['../class_f_d_p_1_1_config.html#a5078af487531c263fef8fbe08a4191df',1,'FDP::Config']]], ['_7edatapipeline_1',['~DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#a67f8a0f07ef29d1c4661e74bdd79ce38',1,'FDP::DataPipeline']]], - ['_7edatapipelineimpl_5f_2',['~DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#afa07a6b6e5620aa823f87fbc9cb6d931',1,'FDP::DataPipelineImpl_']]] + ['_7eimpl_2',['~impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a1c68d7867deda1530cbed05069b05b09',1,'FDP::DataPipeline::impl']]] ]; diff --git a/search/all_2.js b/search/all_2.js index 047f583..af979a8 100644 --- a/search/all_2.js +++ b/search/all_2.js @@ -2,11 +2,12 @@ var searchData= [ ['calculate_5fhash_5ffrom_5ffile_0',['calculate_hash_from_file',['../metadata_8hxx.html#aef5b5dab5a6743bed9e9d0842ec8e0b9',1,'FDP']]], ['calculate_5fhash_5ffrom_5fstring_1',['calculate_hash_from_string',['../metadata_8hxx.html#add1040168fb281b0753ca26cd445d8ee',1,'FDP']]], - ['config_2',['Config',['../class_f_d_p_1_1_config.html#a3428bf5e0bf7158d4e6b98ab088e034f',1,'FDP::Config::Config()'],['../class_f_d_p_1_1_config.html',1,'FDP::Config']]], + ['config_2',['Config',['../class_f_d_p_1_1_config.html',1,'FDP']]], ['config_2ehxx_3',['config.hxx',['../config_8hxx.html',1,'']]], ['config_5fparsing_5ferror_4',['config_parsing_error',['../class_f_d_p_1_1config__parsing__error.html',1,'FDP']]], ['config_5freads_5f_5',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], ['config_5fwrites_5f_6',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], - ['create_5flogger_5f_7',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], - ['current_5ftime_5fstamp_8',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] + ['construct_7',['construct',['../class_f_d_p_1_1_api_object.html#a52db6cca9c94d6bed3b00166c3c04b9c',1,'FDP::ApiObject']]], + ['create_5flogger_5f_8',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], + ['current_5ftime_5fstamp_9',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] ]; diff --git a/search/all_3.js b/search/all_3.js index 0d8504d..07c400f 100644 --- a/search/all_3.js +++ b/search/all_3.js @@ -1,6 +1,5 @@ var searchData= [ ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline::DataPipeline()'],['../class_f_d_p_1_1_data_pipeline.html',1,'FDP::DataPipeline']]], - ['datapipeline_2ehxx_1',['datapipeline.hxx',['../datapipeline_8hxx.html',1,'']]], - ['datapipelineimpl_5f_2',['DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#a2f3af03f6bb27804e256875ea0b94264',1,'FDP::DataPipelineImpl_::DataPipelineImpl_()'],['../class_f_d_p_1_1_data_pipeline_impl__.html',1,'FDP::DataPipelineImpl_']]] + ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]] ]; diff --git a/search/all_5.js b/search/all_5.js index f7fb506..2da5634 100644 --- a/search/all_5.js +++ b/search/all_5.js @@ -2,6 +2,6 @@ var searchData= [ ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../index.html',1,'']]], ['file_5fexists_1',['file_exists',['../metadata_8hxx.html#a7d885b9af9988c944d23eedbff430272',1,'FDP']]], - ['finalise_2',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#aa6b0b27726c312a089a6face0351410d',1,'FDP::DataPipelineImpl_::finalise()']]], + ['finalise_2',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aa8df96d2a875997a793d684f23b990db',1,'FDP::DataPipeline::impl::finalise()']]], ['versioning_3',['Versioning',['../namespace_f_d_p_1_1_versioning.html',1,'FDP']]] ]; diff --git a/search/all_6.js b/search/all_6.js index a9ab26f..2f3d593 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -1,18 +1,18 @@ var searchData= [ ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], - ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a63a726148d6e0f18c057d36f3cfa8aeb',1,'FDP::Config']]], + ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a88e0a7686c3adc7f5086282693cb9f91',1,'FDP::Config']]], ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], - ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_impl__.html#a7c8b64bf66c46cebc334e2e0e3fcd0f6',1,'FDP::DataPipelineImpl_::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], + ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aff9ead89c7d7a1f4a61be7ba0ff10bf9',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#a4d3ab4dc8d8b0754b612dad823abbd1c',1,'FDP::IOObject']]], - ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#a3da2459b081a3296e76e02f407fd3920',1,'FDP::IOObject']]], + ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#acb0f0956b8b86f49fca81588e82f6bd5',1,'FDP::IOObject']]], ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#aa89e39ad7c6346a82ba3d8aca722dfe5',1,'FDP::IOObject']]], ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#af7e308602e39909c3c95f5ce621f7e60',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af19cf9bf9bc20d169a8b00a3458c266f',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#ae3cb47196eaf7110356b1c8d8833b232',1,'FDP::IOObject']]], ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], diff --git a/search/all_8.js b/search/all_8.js index 130c37f..1d523bc 100644 --- a/search/all_8.js +++ b/search/all_8.js @@ -1,6 +1,7 @@ var searchData= [ - ['ioobject_0',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP::IOObject'],['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], - ['is_5fempty_1',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], - ['is_5fpublic_2',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] + ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html',1,'FDP::DataPipeline::impl'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad1e93a46095b2b484ef322f570fe8914',1,'FDP::DataPipeline::impl::impl()']]], + ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP::IOObject'],['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['is_5fempty_2',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], + ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] ]; diff --git a/search/all_a.js b/search/all_a.js index c0d9881..963f3da 100644 --- a/search/all_a.js +++ b/search/all_a.js @@ -1,7 +1,7 @@ var searchData= [ - ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a074dacc234b734a6a3bb0e86d07042ad',1,'FDP::DataPipelineImpl_::link_read()']]], - ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a7d13934d76ca915232755c886bc59306',1,'FDP::DataPipelineImpl_::link_write()']]], + ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ae8e7f7f1e7bbdbe93094d59c367210ad',1,'FDP::DataPipeline::impl::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a43686ff0e1cf0733770058808b7bd322',1,'FDP::DataPipeline::impl::link_write()']]], ['local_2',['LOCAL',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa54b4c4075463b2e02cd69f5cd139b5b2',1,'FDP']]], ['logging_2ehxx_3',['logging.hxx',['../logging_8hxx.html',1,'']]] ]; diff --git a/search/classes_2.js b/search/classes_2.js index dbe86d6..0fec80b 100644 --- a/search/classes_2.js +++ b/search/classes_2.js @@ -1,5 +1,5 @@ var searchData= [ ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html',1,'FDP']]], - ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html',1,'FDP']]] + ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]] ]; diff --git a/search/classes_3.js b/search/classes_3.js index 86ec3df..0024224 100644 --- a/search/classes_3.js +++ b/search/classes_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['ioobject_0',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP']]] + ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html',1,'FDP::DataPipeline']]], + ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP']]] ]; diff --git a/search/files_2.js b/search/files_2.js index 0fc2c3a..4ddb543 100644 --- a/search/files_2.js +++ b/search/files_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['datapipeline_2ehxx_0',['datapipeline.hxx',['../datapipeline_8hxx.html',1,'']]] + ['json_2ehxx_0',['json.hxx',['../json_8hxx.html',1,'']]] ]; diff --git a/search/files_3.js b/search/files_3.js index 4ddb543..2965f28 100644 --- a/search/files_3.js +++ b/search/files_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['json_2ehxx_0',['json.hxx',['../json_8hxx.html',1,'']]] + ['logging_2ehxx_0',['logging.hxx',['../logging_8hxx.html',1,'']]] ]; diff --git a/search/files_4.js b/search/files_4.js index 2965f28..f5067bf 100644 --- a/search/files_4.js +++ b/search/files_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['logging_2ehxx_0',['logging.hxx',['../logging_8hxx.html',1,'']]] + ['metadata_2ehxx_0',['metadata.hxx',['../metadata_8hxx.html',1,'']]] ]; diff --git a/search/files_5.js b/search/files_5.js index f5067bf..6050d04 100644 --- a/search/files_5.js +++ b/search/files_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['metadata_2ehxx_0',['metadata.hxx',['../metadata_8hxx.html',1,'']]] + ['semver_2ehxx_0',['semver.hxx',['../semver_8hxx.html',1,'']]] ]; diff --git a/search/files_6.html b/search/files_6.html deleted file mode 100644 index fe47781..0000000 --- a/search/files_6.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
                            -
                            Loading...
                            -
                            - -
                            Searching...
                            -
                            No Matches
                            - -
                            - - diff --git a/search/files_6.js b/search/files_6.js deleted file mode 100644 index 6050d04..0000000 --- a/search/files_6.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['semver_2ehxx_0',['semver.hxx',['../semver_8hxx.html',1,'']]] -]; diff --git a/search/functions_0.js b/search/functions_0.js index 2922d2e..9c4efce 100644 --- a/search/functions_0.js +++ b/search/functions_0.js @@ -1,6 +1,5 @@ var searchData= [ ['api_0',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API']]], - ['apiobject_1',['ApiObject',['../class_f_d_p_1_1_api_object.html#a6db277989caee23fb8ca73c76f629b8a',1,'FDP::ApiObject']]], - ['append_5fwith_5fforward_5fslash_2',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] + ['append_5fwith_5fforward_5fslash_1',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] ]; diff --git a/search/functions_1.js b/search/functions_1.js index 52090c1..cf42a29 100644 --- a/search/functions_1.js +++ b/search/functions_1.js @@ -2,9 +2,9 @@ var searchData= [ ['calculate_5fhash_5ffrom_5ffile_0',['calculate_hash_from_file',['../metadata_8hxx.html#aef5b5dab5a6743bed9e9d0842ec8e0b9',1,'FDP']]], ['calculate_5fhash_5ffrom_5fstring_1',['calculate_hash_from_string',['../metadata_8hxx.html#add1040168fb281b0753ca26cd445d8ee',1,'FDP']]], - ['config_2',['Config',['../class_f_d_p_1_1_config.html#a3428bf5e0bf7158d4e6b98ab088e034f',1,'FDP::Config']]], - ['config_5freads_5f_3',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], - ['config_5fwrites_5f_4',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], + ['config_5freads_5f_2',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], + ['config_5fwrites_5f_3',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], + ['construct_4',['construct',['../class_f_d_p_1_1_api_object.html#a52db6cca9c94d6bed3b00166c3c04b9c',1,'FDP::ApiObject']]], ['create_5flogger_5f_5',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], ['current_5ftime_5fstamp_6',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] ]; diff --git a/search/functions_10.js b/search/functions_10.js index d5162b8..cf3da40 100644 --- a/search/functions_10.js +++ b/search/functions_10.js @@ -2,5 +2,5 @@ var searchData= [ ['_7econfig_0',['~Config',['../class_f_d_p_1_1_config.html#a5078af487531c263fef8fbe08a4191df',1,'FDP::Config']]], ['_7edatapipeline_1',['~DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#a67f8a0f07ef29d1c4661e74bdd79ce38',1,'FDP::DataPipeline']]], - ['_7edatapipelineimpl_5f_2',['~DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#afa07a6b6e5620aa823f87fbc9cb6d931',1,'FDP::DataPipelineImpl_']]] + ['_7eimpl_2',['~impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a1c68d7867deda1530cbed05069b05b09',1,'FDP::DataPipeline::impl']]] ]; diff --git a/search/functions_2.js b/search/functions_2.js index adeea97..9ec1d93 100644 --- a/search/functions_2.js +++ b/search/functions_2.js @@ -1,5 +1,4 @@ var searchData= [ - ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline']]], - ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_f_d_p_1_1_data_pipeline_impl__.html#a2f3af03f6bb27804e256875ea0b94264',1,'FDP::DataPipelineImpl_']]] + ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline']]] ]; diff --git a/search/functions_4.js b/search/functions_4.js index 6a618b8..03312d9 100644 --- a/search/functions_4.js +++ b/search/functions_4.js @@ -1,5 +1,5 @@ var searchData= [ ['file_5fexists_0',['file_exists',['../metadata_8hxx.html#a7d885b9af9988c944d23eedbff430272',1,'FDP']]], - ['finalise_1',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#aa6b0b27726c312a089a6face0351410d',1,'FDP::DataPipelineImpl_::finalise()']]] + ['finalise_1',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aa8df96d2a875997a793d684f23b990db',1,'FDP::DataPipeline::impl::finalise()']]] ]; diff --git a/search/functions_5.js b/search/functions_5.js index a9ab26f..2f3d593 100644 --- a/search/functions_5.js +++ b/search/functions_5.js @@ -1,18 +1,18 @@ var searchData= [ ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], - ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a63a726148d6e0f18c057d36f3cfa8aeb',1,'FDP::Config']]], + ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a88e0a7686c3adc7f5086282693cb9f91',1,'FDP::Config']]], ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], - ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_impl__.html#a7c8b64bf66c46cebc334e2e0e3fcd0f6',1,'FDP::DataPipelineImpl_::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], + ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aff9ead89c7d7a1f4a61be7ba0ff10bf9',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#a4d3ab4dc8d8b0754b612dad823abbd1c',1,'FDP::IOObject']]], - ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#a3da2459b081a3296e76e02f407fd3920',1,'FDP::IOObject']]], + ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#acb0f0956b8b86f49fca81588e82f6bd5',1,'FDP::IOObject']]], ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#aa89e39ad7c6346a82ba3d8aca722dfe5',1,'FDP::IOObject']]], ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#af7e308602e39909c3c95f5ce621f7e60',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af19cf9bf9bc20d169a8b00a3458c266f',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#ae3cb47196eaf7110356b1c8d8833b232',1,'FDP::IOObject']]], ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], diff --git a/search/functions_7.js b/search/functions_7.js index fe8c5d7..f5080a4 100644 --- a/search/functions_7.js +++ b/search/functions_7.js @@ -1,6 +1,7 @@ var searchData= [ - ['ioobject_0',['IOObject',['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], - ['is_5fempty_1',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], - ['is_5fpublic_2',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] + ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad1e93a46095b2b484ef322f570fe8914',1,'FDP::DataPipeline::impl']]], + ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['is_5fempty_2',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], + ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] ]; diff --git a/search/functions_9.js b/search/functions_9.js index 843a3fc..0f20d38 100644 --- a/search/functions_9.js +++ b/search/functions_9.js @@ -1,5 +1,5 @@ var searchData= [ - ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a074dacc234b734a6a3bb0e86d07042ad',1,'FDP::DataPipelineImpl_::link_read()']]], - ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_impl__.html#a7d13934d76ca915232755c886bc59306',1,'FDP::DataPipelineImpl_::link_write()']]] + ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ae8e7f7f1e7bbdbe93094d59c367210ad',1,'FDP::DataPipeline::impl::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a43686ff0e1cf0733770058808b7bd322',1,'FDP::DataPipeline::impl::link_write()']]] ]; diff --git a/search/searchdata.js b/search/searchdata.js index 6237b70..e0b493e 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -3,7 +3,7 @@ var indexSectionsWithContent = 0: "abcdefghijlmprsvw~", 1: "acdijrsvw", 2: "f", - 3: "acdjlms", + 3: "acjlms", 4: "acdefghijlmprsvw~", 5: "a", 6: "mr", From 0d42120e8857c3533152e312316755fc8d26f210 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Tue, 15 Feb 2022 18:05:56 +0000 Subject: [PATCH 06/19] deploy: 5746701b98273fe7d3e6541083124127e184048d --- api_8hxx_source.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api_8hxx_source.html b/api_8hxx_source.html index a95268f..b154d54 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -161,15 +161,15 @@
                            FDP::API
                            a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
                            Definition: api.hxx:63
                            -
                            FDP::API::post
                            Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
                            post information from a JSON value object to the RestAPI
                            Definition: api.cxx:184
                            -
                            FDP::API::get_request
                            Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
                            sends the given 'packet' of information to the RestAPI
                            Definition: api.cxx:84
                            -
                            FDP::API::append_with_forward_slash
                            static std::string append_with_forward_slash(std::string string)
                            Static function to append a given string with a "/" unless the string is empty or already ends with a...
                            Definition: api.cxx:288
                            -
                            FDP::API::remove_leading_forward_slash
                            static std::string remove_leading_forward_slash(std::string str)
                            Remove the leading forward slash from a given string.
                            Definition: api.cxx:301
                            -
                            FDP::API::escape_space
                            std::string escape_space(std::string &str)
                            escapes space " " characters within a string with it's html character code (%20)
                            Definition: api.cxx:179
                            +
                            FDP::API::post
                            Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
                            post information from a JSON value object to the RestAPI
                            Definition: api.cxx:187
                            +
                            FDP::API::get_request
                            Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
                            sends the given 'packet' of information to the RestAPI
                            Definition: api.cxx:87
                            +
                            FDP::API::append_with_forward_slash
                            static std::string append_with_forward_slash(std::string string)
                            Static function to append a given string with a "/" unless the string is empty or already ends with a...
                            Definition: api.cxx:291
                            +
                            FDP::API::remove_leading_forward_slash
                            static std::string remove_leading_forward_slash(std::string str)
                            Remove the leading forward slash from a given string.
                            Definition: api.cxx:304
                            +
                            FDP::API::escape_space
                            std::string escape_space(std::string &str)
                            escapes space " " characters within a string with it's html character code (%20)
                            Definition: api.cxx:182
                            FDP::API::get_url_root
                            std::string get_url_root() const
                            returns the root URL for the RestAPI used by the API instance
                            Definition: api.hxx:127
                            FDP::API::API
                            API(std::string url_root)
                            construct an API object using the given URL as the root
                            Definition: api.hxx:73
                            -
                            FDP::API::json_to_query_string
                            std::string json_to_query_string(Json::Value &json_value)
                            Formats a json object into a string representation which can be used as a url endpoint query.
                            Definition: api.cxx:143
                            -
                            FDP::API::get_by_id
                            Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
                            get an object from the api by it's id
                            Definition: api.cxx:136
                            +
                            FDP::API::json_to_query_string
                            std::string json_to_query_string(Json::Value &json_value)
                            Formats a json object into a string representation which can be used as a url endpoint query.
                            Definition: api.cxx:146
                            +
                            FDP::API::get_by_id
                            Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
                            get an object from the api by it's id
                            Definition: api.cxx:139
                            json.hxx
                            File contains methods relating to handling of JSON based data.
                            logging.hxx
                            File contains pointers for creating global logger during session.
                            From 919d5e3c5c928205d6e94be0848ae45ecdf946c4 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Wed, 16 Feb 2022 13:06:15 +0000 Subject: [PATCH 07/19] deploy: ea29d6420f90f322bdfe93bce61c624d8dab5101 --- annotated.html | 11 +- api__object_8hxx_source.html | 77 +++---- class_f_d_p_1_1_api_object-members.html | 25 +-- class_f_d_p_1_1_api_object.html | 24 +-- class_f_d_p_1_1_config-members.html | 4 +- class_f_d_p_1_1_config.html | 26 +-- ...d_p_1_1_data_pipeline_1_1impl-members.html | 13 +- class_f_d_p_1_1_data_pipeline_1_1impl.html | 27 ++- class_f_d_p_1_1_i_o_object-members.html | 28 +-- class_f_d_p_1_1_i_o_object.html | 198 +++++++++--------- ...d_p_1_1config__parsing__error-members.html | 2 +- class_f_d_p_1_1config__parsing__error.html | 6 +- ...s_f_d_p_1_1json__parse__error-members.html | 2 +- class_f_d_p_1_1json__parse__error.html | 6 +- class_f_d_p_1_1logger-members.html | 83 ++++++++ class_f_d_p_1_1logger.html | 92 ++++++++ ..._d_p_1_1rest__apiquery__error-members.html | 2 +- class_f_d_p_1_1rest__apiquery__error.html | 6 +- class_f_d_p_1_1sync__error-members.html | 2 +- class_f_d_p_1_1sync__error.html | 6 +- class_f_d_p_1_1validation__error-members.html | 2 +- class_f_d_p_1_1validation__error.html | 6 +- class_f_d_p_1_1write__error-members.html | 2 +- class_f_d_p_1_1write__error.html | 6 +- classes.html | 11 +- config_8hxx_source.html | 8 +- data__io_8hxx_source.html | 4 +- exceptions_8hxx_source.html | 12 +- fdp_8hxx_source.html | 8 +- functions.html | 36 ++-- functions_func.html | 36 ++-- hierarchy.html | 17 +- io__object_8hxx_source.html | 70 +++---- logging_8hxx.html | 48 ++--- logging_8hxx_source.html | 18 +- namespaces.html | 9 +- search/all_0.js | 2 +- search/all_2.js | 3 +- search/all_6.js | 30 +-- search/all_8.js | 6 +- search/all_a.js | 3 +- search/classes_5.js | 2 +- search/classes_6.js | 2 +- search/classes_7.js | 3 +- search/classes_8.js | 3 +- search/classes_9.html | 37 ++++ search/classes_9.js | 4 + search/functions_1.js | 3 +- search/functions_5.js | 30 +-- search/functions_7.js | 6 +- search/searchdata.js | 2 +- search/variables_0.js | 2 +- 52 files changed, 637 insertions(+), 434 deletions(-) create mode 100644 class_f_d_p_1_1logger-members.html create mode 100644 class_f_d_p_1_1logger.html create mode 100644 search/classes_9.html create mode 100644 search/classes_9.js diff --git a/annotated.html b/annotated.html index dade788..d29da36 100644 --- a/annotated.html +++ b/annotated.html @@ -79,11 +79,12 @@  Cimpl  CIOObjectClass for API objects  Cjson_parse_error - Crest_apiquery_error - Csync_error - Cvalidation_error - Cwrite_error - CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods + Clogger + Crest_apiquery_error + Csync_error + Cvalidation_error + Cwrite_error + CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods diff --git a/api__object_8hxx_source.html b/api__object_8hxx_source.html index 3728c2b..5b88cde 100644 --- a/api__object_8hxx_source.html +++ b/api__object_8hxx_source.html @@ -84,53 +84,54 @@
                            16 private:
                            17 Json::Value obj_;
                            18
                            -
                            19 ApiObject();
                            -
                            20
                            -
                            21 public:
                            -
                            22
                            -
                            23 typedef std::shared_ptr< ApiObject > sptr;
                            -
                            24
                            -
                            25 static sptr from_json( const Json::Value& j );
                            -
                            26
                            -
                            27 //static copy( const ApiObject& src );
                            -
                            28
                            -
                            35 static ApiObject::sptr construct( void );
                            -
                            36
                            -
                            37
                            -
                            38 int add( const std::string& key, int value );
                            -
                            39 int add( const std::string& key, float value );
                            -
                            40 int add( const std::string& key, double value );
                            -
                            41 int add( const std::string& key, const std::string& value );
                            -
                            42 int add( const std::string& key, const ApiObject& value );
                            -
                            43
                            -
                            44 int remove( const std::string& key );
                            -
                            51 int get_id();
                            -
                            58 static int get_id_from_string(std::string url);
                            -
                            59
                            -
                            60 std::string get_type();
                            -
                            66 std::string get_uri() const;
                            -
                            67
                            -
                            74 std::string get_value_as_string(std::string key) const;
                            -
                            75
                            -
                            82 int get_value_as_int(std::string key) const;
                            -
                            83
                            -
                            89 std::string get_first_component() const;
                            -
                            90
                            -
                            97 bool is_empty();
                            -
                            98 };
                            -
                            99};
                            +
                            19 protected:
                            +
                            20 ApiObject();
                            +
                            21
                            +
                            22 public:
                            +
                            23
                            +
                            24 typedef std::shared_ptr< ApiObject > sptr;
                            +
                            25
                            +
                            26 static sptr from_json( const Json::Value& j );
                            +
                            27
                            +
                            28 //static copy( const ApiObject& src );
                            +
                            29
                            +
                            36 static ApiObject::sptr construct( void );
                            +
                            37
                            +
                            38
                            +
                            39 int add( const std::string& key, int value );
                            +
                            40 int add( const std::string& key, float value );
                            +
                            41 int add( const std::string& key, double value );
                            +
                            42 int add( const std::string& key, const std::string& value );
                            +
                            43 int add( const std::string& key, const ApiObject& value );
                            +
                            44
                            +
                            45 int remove( const std::string& key );
                            +
                            52 int get_id();
                            +
                            59 static int get_id_from_string(std::string url);
                            +
                            60
                            +
                            61 std::string get_type();
                            +
                            67 std::string get_uri() const;
                            +
                            68
                            +
                            75 std::string get_value_as_string( const std::string& key) const;
                            +
                            76
                            +
                            83 int get_value_as_int( const std::string& key) const;
                            +
                            84
                            +
                            90 std::string get_first_component() const;
                            +
                            91
                            +
                            98 bool is_empty();
                            +
                            99 };
                            100
                            -
                            101#endif
                            +
                            101}
                            +
                            102#endif
                            FDP::ApiObject
                            Class for API objects.
                            Definition: api_object.hxx:15
                            -
                            FDP::ApiObject::get_value_as_int
                            int get_value_as_int(std::string key) const
                            Get the value of a given key as int object.
                            Definition: api_object.cxx:96
                            FDP::ApiObject::is_empty
                            bool is_empty()
                            Check to see if the object is empty.
                            Definition: api_object.cxx:100
                            FDP::ApiObject::get_id
                            int get_id()
                            Get the object id from the uri.
                            Definition: api_object.cxx:65
                            FDP::ApiObject::get_id_from_string
                            static int get_id_from_string(std::string url)
                            Get the object type from the uri.
                            Definition: api_object.cxx:69
                            FDP::ApiObject::get_uri
                            std::string get_uri() const
                            Get the object uri.
                            Definition: api_object.cxx:89
                            -
                            FDP::ApiObject::get_value_as_string
                            std::string get_value_as_string(std::string key) const
                            Get the value of a given key as string object.
                            Definition: api_object.cxx:93
                            FDP::ApiObject::get_first_component
                            std::string get_first_component() const
                            Get the first component of the object.
                            Definition: api_object.cxx:107
                            FDP::ApiObject::construct
                            static ApiObject::sptr construct(void)
                            Construct a new Api Object object.
                            Definition: api_object.cxx:17
                            +
                            FDP::ApiObject::get_value_as_string
                            std::string get_value_as_string(const std::string &key) const
                            Get the value of a given key as string object.
                            Definition: api_object.cxx:93
                            FDP::ApiObject::get_type
                            std::string get_type()
                            Returns the object type from the object uri_ (table)
                            Definition: api_object.cxx:81
                            +
                            FDP::ApiObject::get_value_as_int
                            int get_value_as_int(const std::string &key) const
                            Get the value of a given key as int object.
                            Definition: api_object.cxx:96
                            logging.hxx
                            File contains pointers for creating global logger during session.
                            diff --git a/class_f_d_p_1_1_api_object-members.html b/class_f_d_p_1_1_api_object-members.html index 34efd0c..e6aa2db 100644 --- a/class_f_d_p_1_1_api_object-members.html +++ b/class_f_d_p_1_1_api_object-members.html @@ -78,18 +78,19 @@ add(const std::string &key, double value) (defined in FDP::ApiObject)FDP::ApiObject add(const std::string &key, const std::string &value) (defined in FDP::ApiObject)FDP::ApiObject add(const std::string &key, const ApiObject &value) (defined in FDP::ApiObject)FDP::ApiObject - construct(void)FDP::ApiObjectstatic - from_json(const Json::Value &j) (defined in FDP::ApiObject)FDP::ApiObjectstatic - get_first_component() constFDP::ApiObject - get_id()FDP::ApiObject - get_id_from_string(std::string url)FDP::ApiObjectstatic - get_type()FDP::ApiObject - get_uri() constFDP::ApiObject - get_value_as_int(std::string key) constFDP::ApiObject - get_value_as_string(std::string key) constFDP::ApiObject - is_empty()FDP::ApiObject - remove(const std::string &key) (defined in FDP::ApiObject)FDP::ApiObject - sptr typedef (defined in FDP::ApiObject)FDP::ApiObject + ApiObject() (defined in FDP::ApiObject)FDP::ApiObjectprotected + construct(void)FDP::ApiObjectstatic + from_json(const Json::Value &j) (defined in FDP::ApiObject)FDP::ApiObjectstatic + get_first_component() constFDP::ApiObject + get_id()FDP::ApiObject + get_id_from_string(std::string url)FDP::ApiObjectstatic + get_type()FDP::ApiObject + get_uri() constFDP::ApiObject + get_value_as_int(const std::string &key) constFDP::ApiObject + get_value_as_string(const std::string &key) constFDP::ApiObject + is_empty()FDP::ApiObject + remove(const std::string &key) (defined in FDP::ApiObject)FDP::ApiObject + sptr typedef (defined in FDP::ApiObject)FDP::ApiObject
                            diff --git a/class_f_d_p_1_1_api_object.html b/class_f_d_p_1_1_api_object.html index 366e849..71621b7 100644 --- a/class_f_d_p_1_1_api_object.html +++ b/class_f_d_p_1_1_api_object.html @@ -116,12 +116,12 @@ std::string get_uri () const  Get the object uri. More...
                              -std::string get_value_as_string (std::string key) const - Get the value of a given key as string object. More...
                            -  -int get_value_as_int (std::string key) const - Get the value of a given key as int object. More...
                            -  +std::string get_value_as_string (const std::string &key) const + Get the value of a given key as string object. More...
                            +  +int get_value_as_int (const std::string &key) const + Get the value of a given key as int object. More...
                            +  std::string get_first_component () const  Get the first component of the object. More...
                              @@ -290,8 +290,8 @@

                            -

                            ◆ get_value_as_int()

                            + +

                            ◆ get_value_as_int()

                            @@ -299,7 +299,7 @@

                            int FDP::ApiObject::get_value_as_int ( - std::string  + const std::string &  key) const @@ -317,8 +317,8 @@

                            -

                            ◆ get_value_as_string()

                            + +

                            ◆ get_value_as_string()

                            @@ -326,7 +326,7 @@

                            std::string FDP::ApiObject::get_value_as_string ( - std::string  + const std::string &  key) const diff --git a/class_f_d_p_1_1_config-members.html b/class_f_d_p_1_1_config-members.html index a8ccce0..1c48675 100644 --- a/class_f_d_p_1_1_config-members.html +++ b/class_f_d_p_1_1_config-members.html @@ -77,7 +77,7 @@ config_writes_() constFDP::Config construct(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location) (defined in FDP::Config)FDP::Configstatic finalise()FDP::Config - get_api()FDP::Configinline + get_api() constFDP::Configinline get_api_url() constFDP::Configinline get_code_run_uuid() constFDP::Config get_config_data() constFDP::Configinline @@ -86,7 +86,7 @@ get_data_store() constFDP::Config get_default_input_namespace() constFDP::Config get_default_output_namespace() constFDP::Config - get_rest_api_location()FDP::Configinline + get_rest_api_location() constFDP::Configinline get_script_file_path() constFDP::Configinline get_token() constFDP::Configinline has_inputs() constFDP::Config diff --git a/class_f_d_p_1_1_config.html b/class_f_d_p_1_1_config.html index c26aeed..734eb49 100644 --- a/class_f_d_p_1_1_config.html +++ b/class_f_d_p_1_1_config.html @@ -154,12 +154,12 @@ YAML::Node get_config_data () const  Get the config data as a Yaml Node. More...
                              -API::sptr get_api () - Get the api object (used to interact with the pipeline directly) More...
                            -  -RESTAPI get_rest_api_location () - Get the rest api location (local / remote) More...
                            -  +API::sptr get_api () const + Get the api object (used to interact with the pipeline directly) More...
                            +  +RESTAPI get_rest_api_location () const + Get the rest api location (local / remote) More...
                            +  @@ -213,8 +213,8 @@

                            -

                            ◆ get_api()

                            + +

                            ◆ get_api()

                            @@ -226,7 +226,7 @@

                            API::sptr FDP::Config::get_api

                            - +

                            Static Public Member Functions

                            ( ) const
                            @@ -285,7 +285,7 @@

                            Get the code run uuid.

                            -
                            Returns
                            std::string
                            +
                            Returns
                            const std::string&

                            @@ -425,8 +425,8 @@

                            -

                            ◆ get_rest_api_location()

                            + +

                            ◆ get_rest_api_location()

                            @@ -438,7 +438,7 @@

                            RESTAPI FDP::Config::get_rest_api_location ( ) - + const diff --git a/class_f_d_p_1_1_data_pipeline_1_1impl-members.html b/class_f_d_p_1_1_data_pipeline_1_1impl-members.html index d9532be..1e059f0 100644 --- a/class_f_d_p_1_1_data_pipeline_1_1impl-members.html +++ b/class_f_d_p_1_1_data_pipeline_1_1impl-members.html @@ -74,13 +74,12 @@

                            This is the complete list of members for FDP::DataPipeline::impl, including all inherited members.

                            - - - - - - - + + + + + +
                            finalise()FDP::DataPipeline::impl
                            get_code_run_uuid()FDP::DataPipeline::impl
                            impl(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)FDP::DataPipeline::impl
                            impl(const impl &dp) (defined in FDP::DataPipeline::impl)FDP::DataPipeline::impl
                            link_read(std::string &data_product)FDP::DataPipeline::impl
                            link_write(std::string &data_product)FDP::DataPipeline::impl
                            sptr typedef (defined in FDP::DataPipeline::impl)FDP::DataPipeline::impl
                            ~impl()=defaultFDP::DataPipeline::impl
                            get_code_run_uuid() constFDP::DataPipeline::impl
                            impl(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)FDP::DataPipeline::impl
                            link_read(std::string &data_product)FDP::DataPipeline::impl
                            link_write(std::string &data_product)FDP::DataPipeline::impl
                            sptr typedef (defined in FDP::DataPipeline::impl)FDP::DataPipeline::impl
                            ~impl()=defaultFDP::DataPipeline::impl

                            diff --git a/class_f_d_p_1_1_data_pipeline_1_1impl.html b/class_f_d_p_1_1_data_pipeline_1_1impl.html index e5974bb..c59ced0 100644 --- a/class_f_d_p_1_1_data_pipeline_1_1impl.html +++ b/class_f_d_p_1_1_data_pipeline_1_1impl.html @@ -83,12 +83,9 @@ - - - - - + + + @@ -103,13 +100,13 @@ void  - - - + + +

                            Public Member Functions

                             impl (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
                             construct a DataPipelineImpl_ instance from configurations and setup More...
                             
                            - impl (const impl &dp)
                             
                             impl (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
                             construct a DataPipelineImpl_ instance from configurations and setup More...
                             
                             ~impl ()=default
                             Default Destructor.
                            finalise ()
                             Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
                             
                            std::string get_code_run_uuid ()
                             Get the code run uuid. More...
                             
                            std::string get_code_run_uuid () const
                             Get the code run uuid. More...
                             

                            Constructor & Destructor Documentation

                            - -

                            ◆ impl()

                            + +

                            ◆ impl()

                            @@ -129,7 +126,7 @@

                            - const std::string  + const std::string &  token, @@ -167,8 +164,8 @@

                            Member Function Documentation

                            - -

                            ◆ get_code_run_uuid()

                            + +

                            ◆ get_code_run_uuid()

                            @@ -177,7 +174,7 @@

                            std::string FDP::DataPipeline::impl::get_code_run_uuid ( ) - + const

                            diff --git a/class_f_d_p_1_1_i_o_object-members.html b/class_f_d_p_1_1_i_o_object-members.html index c4cdb94..5663a1e 100644 --- a/class_f_d_p_1_1_i_o_object-members.html +++ b/class_f_d_p_1_1_i_o_object-members.html @@ -73,20 +73,20 @@

                            This is the complete list of members for FDP::IOObject, including all inherited members.

                            - - - - - - - - - - - - - - + + + + + + + + + + + + + +
                            get_component_description()FDP::IOObjectinline
                            get_component_object()FDP::IOObjectinline
                            get_data_product()FDP::IOObjectinline
                            get_data_product_description()FDP::IOObjectinline
                            get_data_product_object()FDP::IOObjectinline
                            get_path()FDP::IOObjectinline
                            get_use_component()FDP::IOObjectinline
                            get_use_data_product()FDP::IOObjectinline
                            get_use_namespace()FDP::IOObjectinline
                            get_use_version()FDP::IOObjectinline
                            IOObject()FDP::IOObjectinline
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)FDP::IOObjectinline
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)FDP::IOObjectinline
                            is_public()FDP::IOObjectinline
                            get_component_description()FDP::IOObjectinline
                            get_component_object() constFDP::IOObjectinline
                            get_data_product() constFDP::IOObjectinline
                            get_data_product_description() constFDP::IOObjectinline
                            get_data_product_object() constFDP::IOObjectinline
                            get_path() constFDP::IOObjectinline
                            get_use_component() constFDP::IOObjectinline
                            get_use_data_product() constFDP::IOObjectinline
                            get_use_namespace()FDP::IOObjectinline
                            get_use_version() constFDP::IOObjectinline
                            IOObject()=defaultFDP::IOObject
                            IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)FDP::IOObjectinline
                            IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)FDP::IOObjectinline
                            is_public() constFDP::IOObjectinline
                            set_component_object(ApiObject &component_obj)FDP::IOObjectinline
                            set_data_product_object(ApiObject &data_product_obj)FDP::IOObjectinline
                            diff --git a/class_f_d_p_1_1_i_o_object.html b/class_f_d_p_1_1_i_o_object.html index 7596c3d..87e83e6 100644 --- a/class_f_d_p_1_1_i_o_object.html +++ b/class_f_d_p_1_1_i_o_object.html @@ -81,49 +81,49 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -134,8 +134,8 @@

                            Detailed Description

                            Class for API objects.

                            Constructor & Destructor Documentation

                            - -

                            ◆ IOObject() [1/2]

                            + +

                            ◆ IOObject() [1/2]

                            @@ -146,25 +146,25 @@

                            FDP::IOObject::IOObject

                            - + - + - + - + @@ -176,7 +176,7 @@

                            - + @@ -214,8 +214,8 @@

                            -

                            ◆ IOObject() [2/2]

                            + +

                            ◆ IOObject() [2/2]

                            @@ -226,25 +226,25 @@

                            FDP::IOObject::IOObject

                            - + - + - + - + @@ -295,8 +295,8 @@

                            Member Function Documentation

                            - -

                            ◆ get_component_description()

                            + +

                            ◆ get_component_description()

                            @@ -305,7 +305,7 @@

                            Public Member Functions

                            - IOObject ()
                             Construct a new IOObject object (empty constructor)
                             
                             IOObject (std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)
                             Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                             
                             IOObject (std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                             Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                             
                            std::string get_data_product ()
                             Get the data product as a string. More...
                             
                            std::string get_use_data_product ()
                             Get the use data product as a string. More...
                             
                            std::string get_use_component ()
                             Get the use component as a string. More...
                             
                            std::string get_use_version ()
                             Get the use version as a string. More...
                             
                            std::string get_use_namespace ()
                             Get the use namespace as a string. More...
                             
                            ghc::filesystem::path get_path ()
                             Get the path of the data product. More...
                             
                            std::string get_data_product_description ()
                             Get the data product description as a string. More...
                             
                            std::string get_component_description ()
                             Get the component description as a string. More...
                             
                            bool is_public ()
                             Check whether the data product is public. More...
                             
                            ApiObject::sptr get_component_object ()
                             Get the component object object. More...
                             
                            ApiObject::sptr get_data_product_object ()
                             Get the data product object object. More...
                             
                            + IOObject ()=default
                             Construct a new IOObject object (empty constructor)
                             
                             IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
                             Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                             
                             IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                             Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                             
                            const std::string & get_data_product () const
                             Get the data product as a string. More...
                             
                            const std::string & get_use_data_product () const
                             Get the use data product as a string. More...
                             
                            const std::string & get_use_component () const
                             Get the use component as a string. More...
                             
                            const std::string & get_use_version () const
                             Get the use version as a string. More...
                             
                            const std::string & get_use_namespace ()
                             Get the use namespace as a string. More...
                             
                            ghc::filesystem::path get_path () const
                             Get the path of the data product. More...
                             
                            const std::string & get_data_product_description () const
                             Get the data product description as a string. More...
                             
                            const std::string & get_component_description ()
                             Get the component description as a string. More...
                             
                            bool is_public () const
                             Check whether the data product is public. More...
                             
                            ApiObject::sptr get_component_object () const
                             Get the component object object. More...
                             
                            ApiObject::sptr get_data_product_object () const
                             Get the data product object object. More...
                             
                            void set_component_object (ApiObject &component_obj)
                             Set the component object object. More...
                             
                            (std::string const std::string &  data_product,
                            std::string const std::string &  use_data_product,
                            std::string const std::string &  use_version,
                            std::string const std::string &  use_namespace,
                            std::string const std::string &  data_product_description,
                            (std::string const std::string &  data_product,
                            std::string const std::string &  use_data_product,
                            std::string const std::string &  use_version,
                            std::string const std::string &  use_namespace,
                            - + @@ -323,8 +323,8 @@

                            -

                            ◆ get_component_object()

                            + +

                            ◆ get_component_object()

                            @@ -336,7 +336,7 @@

                            ApiObject::sptr FDP::IOObject::get_component_object

                            - +
                            std::string FDP::IOObject::get_component_description const std::string & FDP::IOObject::get_component_description ( ) ( ) const
                            @@ -351,8 +351,8 @@

                            -

                            ◆ get_data_product()

                            + +

                            ◆ get_data_product()

                            @@ -361,10 +361,10 @@

                            - + - +
                            std::string FDP::IOObject::get_data_product const std::string & FDP::IOObject::get_data_product ( ) const
                            @@ -375,12 +375,12 @@

                            Get the data product as a string.

                            -
                            Returns
                            std::string
                            +
                            Returns
                            const std::string&

                            - -

                            ◆ get_data_product_description()

                            + +

                            ◆ get_data_product_description()

                            @@ -389,10 +389,10 @@

                            - + - +
                            std::string FDP::IOObject::get_data_product_description const std::string & FDP::IOObject::get_data_product_description ( ) const
                            @@ -407,8 +407,8 @@

                            -

                            ◆ get_data_product_object()

                            + +

                            ◆ get_data_product_object()

                            @@ -420,7 +420,7 @@

                            ApiObject::sptr FDP::IOObject::get_data_product_object ( ) - + const @@ -435,8 +435,8 @@

                            -

                            ◆ get_path()

                            + +

                            ◆ get_path()

                            @@ -448,7 +448,7 @@

                            ghc::filesystem::path FDP::IOObject::get_path ( ) - + const @@ -463,8 +463,8 @@

                            -

                            ◆ get_use_component()

                            + +

                            ◆ get_use_component()

                            @@ -473,10 +473,10 @@

                            - + - +
                            std::string FDP::IOObject::get_use_component const std::string & FDP::IOObject::get_use_component ( ) const
                            @@ -487,12 +487,12 @@

                            Get the use component as a string.

                            -
                            Returns
                            std::string
                            +
                            Returns
                            const std::string&

                            - -

                            ◆ get_use_data_product()

                            + +

                            ◆ get_use_data_product()

                            @@ -501,10 +501,10 @@

                            - + - +
                            std::string FDP::IOObject::get_use_data_product const std::string & FDP::IOObject::get_use_data_product ( ) const
                            @@ -515,12 +515,12 @@

                            Get the use data product as a string.

                            -
                            Returns
                            std::string
                            +
                            Returns
                            const std::string&

                            - -

                            ◆ get_use_namespace()

                            + +

                            ◆ get_use_namespace()

                            @@ -529,7 +529,7 @@

                            - + @@ -543,12 +543,12 @@

                            Get the use namespace as a string.

                            -
                            Returns
                            std::string
                            +
                            Returns
                            const std::string&
                            -                             -

                            ◆ get_use_version()

                            + +

                            ◆ get_use_version()

                            @@ -557,10 +557,10 @@

                            std::string FDP::IOObject::get_use_namespace const std::string & FDP::IOObject::get_use_namespace ( )
                            - + - +
                            std::string FDP::IOObject::get_use_version const std::string & FDP::IOObject::get_use_version ( ) const
                            @@ -571,12 +571,12 @@

                            Get the use version as a string.

                            -
                            Returns
                            std::string
                            +
                            Returns
                            const std::string&

                            - -

                            ◆ is_public()

                            + +

                            ◆ is_public()

                            @@ -588,7 +588,7 @@

                            bool FDP::IOObject::is_public ( ) - + const diff --git a/class_f_d_p_1_1config__parsing__error-members.html b/class_f_d_p_1_1config__parsing__error-members.html index 2f05944..9a61f97 100644 --- a/class_f_d_p_1_1config__parsing__error-members.html +++ b/class_f_d_p_1_1config__parsing__error-members.html @@ -73,7 +73,7 @@

                            This is the complete list of members for FDP::config_parsing_error, including all inherited members.

                            - +
                            config_parsing_error(const std::string message) (defined in FDP::config_parsing_error)FDP::config_parsing_errorinline
                            config_parsing_error(const std::string &message) (defined in FDP::config_parsing_error)FDP::config_parsing_errorinline

                            diff --git a/class_f_d_p_1_1config__parsing__error.html b/class_f_d_p_1_1config__parsing__error.html index e7e8bd5..6e17b5a 100644 --- a/class_f_d_p_1_1config__parsing__error.html +++ b/class_f_d_p_1_1config__parsing__error.html @@ -82,9 +82,9 @@ - - + +

                            Public Member Functions

                            - config_parsing_error (const std::string message)
                             
                            + config_parsing_error (const std::string &message)
                             
                            The documentation for this class was generated from the following file:
                            • include/fdp/exceptions.hxx
                              • diff --git a/class_f_d_p_1_1json__parse__error-members.html b/class_f_d_p_1_1json__parse__error-members.html index cb36e42..d030b68 100644 --- a/class_f_d_p_1_1json__parse__error-members.html +++ b/class_f_d_p_1_1json__parse__error-members.html @@ -73,7 +73,7 @@

                              This is the complete list of members for FDP::json_parse_error, including all inherited members.

                              - +
                              json_parse_error(const std::string message) (defined in FDP::json_parse_error)FDP::json_parse_errorinline
                              json_parse_error(const std::string &message) (defined in FDP::json_parse_error)FDP::json_parse_errorinline
                            diff --git a/class_f_d_p_1_1json__parse__error.html b/class_f_d_p_1_1json__parse__error.html index 3c099b1..1182990 100644 --- a/class_f_d_p_1_1json__parse__error.html +++ b/class_f_d_p_1_1json__parse__error.html @@ -82,9 +82,9 @@ - - + +

                            Public Member Functions

                            - json_parse_error (const std::string message)
                             
                            + json_parse_error (const std::string &message)
                             
                            The documentation for this class was generated from the following file:
                            • include/fdp/exceptions.hxx
                              • diff --git a/class_f_d_p_1_1logger-members.html b/class_f_d_p_1_1logger-members.html new file mode 100644 index 0000000..9ad5c15 --- /dev/null +++ b/class_f_d_p_1_1logger-members.html @@ -0,0 +1,83 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                              +
                              + + + + + + +
                              +
                              cppDataPipeline 0.3.0 +
                              +
                              C++ Implementation of the FAIR Data Pipeline API
                              +
                              +
                              + + + + + + + + +
                              +
                              + + +
                              + +
                              + + +
                              +
                              +
                              FDP::logger Member List
                              +
                              +
                              + +

                              This is the complete list of members for FDP::logger, including all inherited members.

                              + + +
                              sptr typedef (defined in FDP::logger)FDP::logger
                              + +
                              +Generated by doxygen 1.9.2 +
                              + + diff --git a/class_f_d_p_1_1logger.html b/class_f_d_p_1_1logger.html new file mode 100644 index 0000000..6299b90 --- /dev/null +++ b/class_f_d_p_1_1logger.html @@ -0,0 +1,92 @@ + + + + + + + +cppDataPipeline: FDP::logger Class Reference + + + + + + + + + +
                              +
                              + + + + + + +
                              +
                              cppDataPipeline 0.3.0 +
                              +
                              C++ Implementation of the FAIR Data Pipeline API
                              +
                              +
                              + + + + + + + + +
                              +
                              + + +
                              + +
                              + + +
                              +
                              +
                              +Public Types | +List of all members
                              +
                              FDP::logger Class Reference
                              +
                              +
                              + + + + +

                              +Public Types

                              +typedef std::shared_ptr< spdlog::logger > sptr
                               
                              +
                              The documentation for this class was generated from the following file: +
                              + +
                              +Generated by doxygen 1.9.2 +
                              + + diff --git a/class_f_d_p_1_1rest__apiquery__error-members.html b/class_f_d_p_1_1rest__apiquery__error-members.html index fb05518..72e95a5 100644 --- a/class_f_d_p_1_1rest__apiquery__error-members.html +++ b/class_f_d_p_1_1rest__apiquery__error-members.html @@ -73,7 +73,7 @@

                              This is the complete list of members for FDP::rest_apiquery_error, including all inherited members.

                              - +
                              rest_apiquery_error(const std::string message) (defined in FDP::rest_apiquery_error)FDP::rest_apiquery_errorinline
                              rest_apiquery_error(const std::string &message) (defined in FDP::rest_apiquery_error)FDP::rest_apiquery_errorinline

                            diff --git a/class_f_d_p_1_1rest__apiquery__error.html b/class_f_d_p_1_1rest__apiquery__error.html index 2a58bbf..ba1275c 100644 --- a/class_f_d_p_1_1rest__apiquery__error.html +++ b/class_f_d_p_1_1rest__apiquery__error.html @@ -82,9 +82,9 @@ - - + +

                            Public Member Functions

                            - rest_apiquery_error (const std::string message)
                             
                            + rest_apiquery_error (const std::string &message)
                             
                            The documentation for this class was generated from the following file:
                            • include/fdp/exceptions.hxx
                              • diff --git a/class_f_d_p_1_1sync__error-members.html b/class_f_d_p_1_1sync__error-members.html index e4cce84..8142277 100644 --- a/class_f_d_p_1_1sync__error-members.html +++ b/class_f_d_p_1_1sync__error-members.html @@ -73,7 +73,7 @@

                              This is the complete list of members for FDP::sync_error, including all inherited members.

                              - +
                              sync_error(const std::string message) (defined in FDP::sync_error)FDP::sync_errorinline
                              sync_error(const std::string &message) (defined in FDP::sync_error)FDP::sync_errorinline
                            diff --git a/class_f_d_p_1_1sync__error.html b/class_f_d_p_1_1sync__error.html index 04154aa..a9b6f6c 100644 --- a/class_f_d_p_1_1sync__error.html +++ b/class_f_d_p_1_1sync__error.html @@ -82,9 +82,9 @@ - - + +

                            Public Member Functions

                            - sync_error (const std::string message)
                             
                            + sync_error (const std::string &message)
                             
                            The documentation for this class was generated from the following file:
                            • include/fdp/exceptions.hxx
                              • diff --git a/class_f_d_p_1_1validation__error-members.html b/class_f_d_p_1_1validation__error-members.html index 674d4f5..a74ec8f 100644 --- a/class_f_d_p_1_1validation__error-members.html +++ b/class_f_d_p_1_1validation__error-members.html @@ -73,7 +73,7 @@

                              This is the complete list of members for FDP::validation_error, including all inherited members.

                              - +
                              validation_error(const std::string message) (defined in FDP::validation_error)FDP::validation_errorinline
                              validation_error(const std::string &message) (defined in FDP::validation_error)FDP::validation_errorinline

                            diff --git a/class_f_d_p_1_1validation__error.html b/class_f_d_p_1_1validation__error.html index 466ea2a..798f7aa 100644 --- a/class_f_d_p_1_1validation__error.html +++ b/class_f_d_p_1_1validation__error.html @@ -82,9 +82,9 @@ - - + +

                            Public Member Functions

                            - validation_error (const std::string message)
                             
                            + validation_error (const std::string &message)
                             
                            The documentation for this class was generated from the following file:
                            • include/fdp/exceptions.hxx
                              • diff --git a/class_f_d_p_1_1write__error-members.html b/class_f_d_p_1_1write__error-members.html index ee25ade..9385cde 100644 --- a/class_f_d_p_1_1write__error-members.html +++ b/class_f_d_p_1_1write__error-members.html @@ -73,7 +73,7 @@

                              This is the complete list of members for FDP::write_error, including all inherited members.

                              - +
                              write_error(const std::string message) (defined in FDP::write_error)FDP::write_errorinline
                              write_error(const std::string &message) (defined in FDP::write_error)FDP::write_errorinline
                            diff --git a/class_f_d_p_1_1write__error.html b/class_f_d_p_1_1write__error.html index 131149c..7ff950c 100644 --- a/class_f_d_p_1_1write__error.html +++ b/class_f_d_p_1_1write__error.html @@ -82,9 +82,9 @@ - - + +

                            Public Member Functions

                            - write_error (const std::string message)
                             
                            + write_error (const std::string &message)
                             
                            The documentation for this class was generated from the following file:
                            • include/fdp/exceptions.hxx
                              • diff --git a/classes.html b/classes.html index 958f053..e6fe1e6 100644 --- a/classes.html +++ b/classes.html @@ -66,7 +66,7 @@
                              Class Index

                            -
                            A | C | D | I | J | R | S | V | W
                            +
                            A | C | D | I | J | L | R | S | V | W
                            A
                            @@ -84,15 +84,18 @@
                            J
                            json_parse_error (FDP)
                            +
                            L
                            +
                            logger (FDP)
                            +
                            R
                            rest_apiquery_error (FDP)
                            -
                            +
                            S
                            sync_error (FDP)
                            -
                            +
                            V
                            validation_error (FDP)
                            version (FDP::Versioning)
                            -
                            +
                            W
                            write_error (FDP)
                            diff --git a/config_8hxx_source.html b/config_8hxx_source.html index 6383367..bdf8674 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -183,9 +183,9 @@
                            253
                            259 YAML::Node get_config_data() const {return config_data_;}
                            260
                            -
                            266 API::sptr get_api(){return api_;}
                            +
                            266 API::sptr get_api() const {return api_;}
                            267
                            -
                            273 RESTAPI get_rest_api_location(){return rest_api_location_;}
                            +
                            273 RESTAPI get_rest_api_location() const {return rest_api_location_;}
                            274
                            275 };
                            276};
                            @@ -196,7 +196,6 @@
                            FDP::Config::config_writes_
                            YAML::Node config_writes_() const
                            Returns the writes Yaml Node from the config.
                            Definition: config.cxx:43
                            FDP::Config::parse_yaml
                            static YAML::Node parse_yaml(ghc::filesystem::path yaml_path)
                            Read a given yaml file into a Yaml Node.
                            Definition: config.cxx:33
                            FDP::Config::get_token
                            std::string get_token() const
                            Get the token as a string.
                            Definition: config.hxx:178
                            -
                            FDP::Config::get_rest_api_location
                            RESTAPI get_rest_api_location()
                            Get the rest api location (local / remote)
                            Definition: config.hxx:273
                            FDP::Config::has_inputs
                            bool has_inputs() const
                            Check whether any inputs have been added.
                            Definition: config.cxx:73
                            FDP::Config::get_default_input_namespace
                            std::string get_default_input_namespace() const
                            Get the default input namespace.
                            Definition: config.cxx:86
                            FDP::Config::get_data_store
                            ghc::filesystem::path get_data_store() const
                            Get the data store path.
                            Definition: config.cxx:81
                            @@ -206,8 +205,9 @@
                            FDP::Config::meta_data_
                            YAML::Node meta_data_() const
                            Returns the meta_data Yaml Node from the config.
                            Definition: config.cxx:39
                            FDP::Config::link_read
                            ghc::filesystem::path link_read(std::string &data_product)
                            Return the filepath to a given data product.
                            Definition: config.cxx:432
                            FDP::Config::finalise
                            void finalise()
                            Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
                            Definition: config.cxx:551
                            +
                            FDP::Config::get_rest_api_location
                            RESTAPI get_rest_api_location() const
                            Get the rest api location (local / remote)
                            Definition: config.hxx:273
                            FDP::Config::get_config_file_path
                            ghc::filesystem::path get_config_file_path() const
                            Get the config file path object.
                            Definition: config.hxx:159
                            -
                            FDP::Config::get_api
                            API::sptr get_api()
                            Get the api object (used to interact with the pipeline directly)
                            Definition: config.hxx:266
                            +
                            FDP::Config::get_api
                            API::sptr get_api() const
                            Get the api object (used to interact with the pipeline directly)
                            Definition: config.hxx:266
                            FDP::Config::get_code_run_uuid
                            std::string get_code_run_uuid() const
                            Get the code run uuid.
                            Definition: config.cxx:350
                            FDP::Config::has_writes
                            bool has_writes() const
                            Check whether the config has writes.
                            Definition: config.cxx:65
                            FDP::Config::has_outputs
                            bool has_outputs() const
                            Check whether any outputs have been added.
                            Definition: config.cxx:77
                            diff --git a/data__io_8hxx_source.html b/data__io_8hxx_source.html index 666ecfc..765b5b5 100644 --- a/data__io_8hxx_source.html +++ b/data__io_8hxx_source.html @@ -125,7 +125,7 @@
                            87
                            88 toml_out_.close();
                            89
                            -
                            90 APILogger->debug("FileSystem:CreateEstimate: Wrote point estimate to '{0}'",
                            +
                            90 APILogger->debug("FileSystem:CreateEstimate: Wrote point estimate to '{0}'",
                            91 output_filename_.string());
                            92
                            93 return output_filename_;
                            @@ -138,7 +138,7 @@
                            106#endif
                            logging.hxx
                            File contains pointers for creating global logger during session.
                            -
                            FDP::APILogger
                            const std::shared_ptr< spdlog::logger > APILogger
                            Global logger used across all FDP scripts.
                            Definition: logging.hxx:31
                            +
                            FDP::APILogger
                            const logger::sptr APILogger
                            Global logger used across all FDP scripts.
                            Definition: logging.cxx:19
                            metadata.hxx
                            File containing methods for handling of metadata.
                            semver.hxx
                            File contains classes and types for validating semantic versioning.
                            diff --git a/exceptions_8hxx_source.html b/exceptions_8hxx_source.html index 71b05da..06533f0 100644 --- a/exceptions_8hxx_source.html +++ b/exceptions_8hxx_source.html @@ -79,34 +79,34 @@
                            7namespace FDP {
                            8class config_parsing_error : public std::runtime_error {
                            9public:
                            -
                            10 config_parsing_error(const std::string message)
                            +
                            10 config_parsing_error(const std::string& message)
                            11 : std::runtime_error(message) {}
                            12};
                            13
                            14class rest_apiquery_error : public std::runtime_error {
                            15public:
                            -
                            16 rest_apiquery_error(const std::string message)
                            +
                            16 rest_apiquery_error(const std::string& message)
                            17 : std::runtime_error(message) {}
                            18};
                            19
                            20class json_parse_error : public std::runtime_error {
                            21public:
                            -
                            22 json_parse_error(const std::string message) : std::runtime_error(message) {}
                            +
                            22 json_parse_error(const std::string& message) : std::runtime_error(message) {}
                            23};
                            24
                            25class validation_error : public std::runtime_error {
                            26public:
                            -
                            27 validation_error(const std::string message) : std::runtime_error(message) {}
                            +
                            27 validation_error(const std::string& message) : std::runtime_error(message) {}
                            28};
                            29
                            30class sync_error : public std::runtime_error {
                            31public:
                            -
                            32 sync_error(const std::string message) : std::runtime_error(message) {}
                            +
                            32 sync_error(const std::string& message) : std::runtime_error(message) {}
                            33};
                            34
                            35class write_error : public std::runtime_error {
                            36public:
                            -
                            37 write_error(const std::string message) : std::runtime_error(message) {}
                            +
                            37 write_error(const std::string& message) : std::runtime_error(message) {}
                            38};
                            39
                            40}; // namespace FDP
                            diff --git a/fdp_8hxx_source.html b/fdp_8hxx_source.html index a526601..dc3cf6d 100644 --- a/fdp_8hxx_source.html +++ b/fdp_8hxx_source.html @@ -112,11 +112,11 @@
                            77#endif
                            FDP::DataPipeline::impl
                            Definition: fdp.cxx:30
                            FDP::DataPipeline
                            DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
                            Definition: fdp.hxx:15
                            -
                            FDP::DataPipeline::link_write
                            ghc::filesystem::path link_write(std::string &data_product)
                            Return a path to be used for a given data product whilst recording it's meta data.
                            Definition: fdp.cxx:182
                            +
                            FDP::DataPipeline::link_write
                            ghc::filesystem::path link_write(std::string &data_product)
                            Return a path to be used for a given data product whilst recording it's meta data.
                            Definition: fdp.cxx:185
                            FDP::DataPipeline::~DataPipeline
                            ~DataPipeline()
                            Destroy the Data Pipeline object.
                            -
                            FDP::DataPipeline::link_read
                            ghc::filesystem::path link_read(std::string &data_product)
                            Return a path to a given data product Whilst recording it's meta data for the code run.
                            Definition: fdp.cxx:178
                            -
                            FDP::DataPipeline::DataPipeline
                            DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
                            Construct a new Data Pipeline (PIMPL)
                            Definition: fdp.cxx:159
                            -
                            FDP::DataPipeline::finalise
                            void finalise()
                            Finalise the pipeline Record all data products and meta data to the registry update the code run with...
                            Definition: fdp.cxx:186
                            +
                            FDP::DataPipeline::link_read
                            ghc::filesystem::path link_read(std::string &data_product)
                            Return a path to a given data product Whilst recording it's meta data for the code run.
                            Definition: fdp.cxx:181
                            +
                            FDP::DataPipeline::DataPipeline
                            DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
                            Construct a new Data Pipeline (PIMPL)
                            Definition: fdp.cxx:162
                            +
                            FDP::DataPipeline::finalise
                            void finalise()
                            Finalise the pipeline Record all data products and meta data to the registry update the code run with...
                            Definition: fdp.cxx:189

                            diff --git a/functions.html b/functions.html index f4c4eba..37f9ea3 100644 --- a/functions.html +++ b/functions.html @@ -94,38 +94,38 @@

                            - f -

                            diff --git a/io__object_8hxx_source.html b/io__object_8hxx_source.html index 19ee15a..57072d1 100644 --- a/io__object_8hxx_source.html +++ b/io__object_8hxx_source.html @@ -97,13 +97,13 @@
                            29 ApiObject::sptr data_product_obj_;
                            30
                            31 public:
                            -
                            36 IOObject(){};
                            -
                            49 IOObject(std::string data_product,
                            -
                            50 std::string use_data_product,
                            -
                            51 std::string use_version,
                            -
                            52 std::string use_namespace,
                            +
                            36 IOObject() = default;
                            +
                            49 IOObject (const std::string& data_product,
                            +
                            50 const std::string& use_data_product,
                            +
                            51 const std::string& use_version,
                            +
                            52 const std::string& use_namespace,
                            53 ghc::filesystem::path path,
                            -
                            54 std::string data_product_description,
                            +
                            54 const std::string& data_product_description,
                            55 bool isPublic)
                            56 :
                            57 data_product_(data_product),
                            @@ -114,10 +114,10 @@
                            62 data_product_description_(data_product_description),
                            63 public_(isPublic){};
                            64
                            -
                            77 IOObject(std::string data_product,
                            -
                            78 std::string use_data_product,
                            -
                            79 std::string use_version,
                            -
                            80 std::string use_namespace,
                            +
                            77 IOObject( const std::string& data_product,
                            +
                            78 const std::string& use_data_product,
                            +
                            79 const std::string& use_version,
                            +
                            80 const std::string& use_namespace,
                            81 ghc::filesystem::path path,
                            82 ApiObject &component_obj,
                            83 ApiObject &data_product_obj)
                            @@ -130,28 +130,28 @@
                            90 component_obj_(std::make_shared<ApiObject>(component_obj)),
                            91 data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
                            92
                            -
                            98 std::string get_data_product() {return data_product_;}
                            +
                            98 const std::string& get_data_product() const {return data_product_;}
                            99
                            -
                            105 std::string get_use_data_product() {return use_data_product_;}
                            +
                            105 const std::string& get_use_data_product() const {return use_data_product_;}
                            106
                            -
                            112 std::string get_use_component() {return use_component_;}
                            +
                            112 const std::string& get_use_component() const {return use_component_;}
                            113
                            -
                            119 std::string get_use_version() {return use_version_;}
                            +
                            119 const std::string& get_use_version() const {return use_version_;}
                            120
                            -
                            126 std::string get_use_namespace() {return use_namespace_;}
                            +
                            126 const std::string& get_use_namespace() {return use_namespace_;}
                            127
                            -
                            133 ghc::filesystem::path get_path() {return path_;}
                            +
                            133 ghc::filesystem::path get_path() const {return path_;}
                            134
                            -
                            140 std::string get_data_product_description() {return data_product_description_;}
                            +
                            140 const std::string& get_data_product_description() const {return data_product_description_;}
                            141
                            -
                            147 std::string get_component_description() {return component_description_;}
                            +
                            147 const std::string& get_component_description() {return component_description_;}
                            148
                            -
                            155 bool is_public() {return public_;}
                            +
                            155 bool is_public() const {return public_;}
                            156
                            -
                            162 ApiObject::sptr get_component_object() {return component_obj_;}
                            +
                            162 ApiObject::sptr get_component_object() const {return component_obj_;}
                            163
                            164
                            -
                            170 ApiObject::sptr get_data_product_object() {return data_product_obj_;}
                            +
                            170 ApiObject::sptr get_data_product_object() const {return data_product_obj_;}
                            171
                            177 void set_component_object(ApiObject& component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
                            178
                            @@ -162,22 +162,22 @@
                            188#endif
                            FDP::ApiObject
                            Class for API objects.
                            Definition: api_object.hxx:15
                            FDP::IOObject
                            Class for API objects.
                            Definition: io_object.hxx:16
                            -
                            FDP::IOObject::get_use_component
                            std::string get_use_component()
                            Get the use component as a string.
                            Definition: io_object.hxx:112
                            -
                            FDP::IOObject::get_use_namespace
                            std::string get_use_namespace()
                            Get the use namespace as a string.
                            Definition: io_object.hxx:126
                            -
                            FDP::IOObject::get_use_data_product
                            std::string get_use_data_product()
                            Get the use data product as a string.
                            Definition: io_object.hxx:105
                            +
                            FDP::IOObject::get_use_data_product
                            const std::string & get_use_data_product() const
                            Get the use data product as a string.
                            Definition: io_object.hxx:105
                            +
                            FDP::IOObject::IOObject
                            IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:77
                            +
                            FDP::IOObject::get_use_component
                            const std::string & get_use_component() const
                            Get the use component as a string.
                            Definition: io_object.hxx:112
                            FDP::IOObject::set_data_product_object
                            void set_data_product_object(ApiObject &data_product_obj)
                            Set the data product object object.
                            Definition: io_object.hxx:184
                            -
                            FDP::IOObject::get_component_description
                            std::string get_component_description()
                            Get the component description as a string.
                            Definition: io_object.hxx:147
                            -
                            FDP::IOObject::IOObject
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:49
                            -
                            FDP::IOObject::IOObject
                            IOObject()
                            Construct a new IOObject object (empty constructor)
                            Definition: io_object.hxx:36
                            -
                            FDP::IOObject::get_data_product
                            std::string get_data_product()
                            Get the data product as a string.
                            Definition: io_object.hxx:98
                            -
                            FDP::IOObject::is_public
                            bool is_public()
                            Check whether the data product is public.
                            Definition: io_object.hxx:155
                            -
                            FDP::IOObject::IOObject
                            IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:77
                            -
                            FDP::IOObject::get_use_version
                            std::string get_use_version()
                            Get the use version as a string.
                            Definition: io_object.hxx:119
                            -
                            FDP::IOObject::get_path
                            ghc::filesystem::path get_path()
                            Get the path of the data product.
                            Definition: io_object.hxx:133
                            +
                            FDP::IOObject::get_use_version
                            const std::string & get_use_version() const
                            Get the use version as a string.
                            Definition: io_object.hxx:119
                            +
                            FDP::IOObject::get_data_product
                            const std::string & get_data_product() const
                            Get the data product as a string.
                            Definition: io_object.hxx:98
                            +
                            FDP::IOObject::is_public
                            bool is_public() const
                            Check whether the data product is public.
                            Definition: io_object.hxx:155
                            +
                            FDP::IOObject::IOObject
                            IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
                            Construct a new IOObject object Used to store inputs and outputs for in the config.
                            Definition: io_object.hxx:49
                            +
                            FDP::IOObject::IOObject
                            IOObject()=default
                            Construct a new IOObject object (empty constructor)
                            +
                            FDP::IOObject::get_path
                            ghc::filesystem::path get_path() const
                            Get the path of the data product.
                            Definition: io_object.hxx:133
                            +
                            FDP::IOObject::get_component_description
                            const std::string & get_component_description()
                            Get the component description as a string.
                            Definition: io_object.hxx:147
                            FDP::IOObject::set_component_object
                            void set_component_object(ApiObject &component_obj)
                            Set the component object object.
                            Definition: io_object.hxx:177
                            -
                            FDP::IOObject::get_component_object
                            ApiObject::sptr get_component_object()
                            Get the component object object.
                            Definition: io_object.hxx:162
                            -
                            FDP::IOObject::get_data_product_object
                            ApiObject::sptr get_data_product_object()
                            Get the data product object object.
                            Definition: io_object.hxx:170
                            -
                            FDP::IOObject::get_data_product_description
                            std::string get_data_product_description()
                            Get the data product description as a string.
                            Definition: io_object.hxx:140
                            +
                            FDP::IOObject::get_data_product_description
                            const std::string & get_data_product_description() const
                            Get the data product description as a string.
                            Definition: io_object.hxx:140
                            +
                            FDP::IOObject::get_use_namespace
                            const std::string & get_use_namespace()
                            Get the use namespace as a string.
                            Definition: io_object.hxx:126
                            +
                            FDP::IOObject::get_component_object
                            ApiObject::sptr get_component_object() const
                            Get the component object object.
                            Definition: io_object.hxx:162
                            +
                            FDP::IOObject::get_data_product_object
                            ApiObject::sptr get_data_product_object() const
                            Get the data product object object.
                            Definition: io_object.hxx:170
                            logging.hxx
                            File contains pointers for creating global logger during session.

                            diff --git a/logging_8hxx.html b/logging_8hxx.html index 25206d8..8a56784 100644 --- a/logging_8hxx.html +++ b/logging_8hxx.html @@ -68,7 +68,7 @@
                            -Functions | +Classes | Variables
                            logging.hxx File Reference
                            @@ -81,17 +81,16 @@

                            Go to the source code of this file.

                            - - - - + + +

                            -Functions

                            std::shared_ptr< spdlog::logger > FDP::create_logger_ ()
                             Create a the global logger pointer. More...
                             

                            +Classes

                            class  FDP::logger
                             
                            - - - + + +

                            Variables

                            const std::shared_ptr< spdlog::logger > FDP::APILogger = create_logger_()
                             Global logger used across all FDP scripts. More...
                             
                            const logger::sptr FDP::APILogger = create_logger()
                             Global logger used across all FDP scripts. More...
                             

                            Detailed Description

                            File contains pointers for creating global logger during session.

                            @@ -99,38 +98,15 @@
                            Author
                            K. Zarebski (UKAEA)
                            Date
                            2021-05-06

                            This file should be included in all FDP header files as it allows all debug/error information to be output to the same logger and hence the same terminal session. It uses the SPDLog library.

                            -

                            Function Documentation

                            - -

                            ◆ create_logger_()

                            +

                            Variable Documentation

                            + +

                            ◆ APILogger

                            - - - - - -
                            std::shared_ptr< spdlog::logger > FDP::create_logger_ ()
                            -
                            - -

                            Create a the global logger pointer.

                            -
                            -
                            Author
                            K. Zarebski (UKAEA)
                            -
                            Returns
                            a shared pointer to the global logger instance
                            - -
                            -
                            -

                            Variable Documentation

                            - -

                            ◆ APILogger

                            - -
                            -
                            - - - +
                            const std::shared_ptr<spdlog::logger> FDP::APILogger = create_logger_()const logger::sptr FDP::APILogger = create_logger()
                            diff --git a/logging_8hxx_source.html b/logging_8hxx_source.html index c74ab23..c15ec63 100644 --- a/logging_8hxx_source.html +++ b/logging_8hxx_source.html @@ -78,14 +78,22 @@
                            15#include "spdlog/spdlog.h"
                            16
                            17namespace FDP {
                            -
                            24std::shared_ptr<spdlog::logger> create_logger_();
                            +
                            18
                            +
                            19 class logger
                            +
                            20 {
                            +
                            21 public:
                            +
                            22 typedef std::shared_ptr<spdlog::logger> sptr;
                            +
                            23 private:
                            +
                            24 };
                            25
                            -
                            31const std::shared_ptr<spdlog::logger> APILogger = create_logger_();
                            +
                            31 extern const logger::sptr APILogger;
                            32} // namespace FDP
                            33
                            -
                            34#endif
                            -
                            FDP::APILogger
                            const std::shared_ptr< spdlog::logger > APILogger
                            Global logger used across all FDP scripts.
                            Definition: logging.hxx:31
                            -
                            FDP::create_logger_
                            std::shared_ptr< spdlog::logger > create_logger_()
                            Create a the global logger pointer.
                            Definition: logging.cxx:4
                            +
                            34
                            +
                            35
                            +
                            36#endif
                            +
                            FDP::logger
                            Definition: logging.hxx:20
                            +
                            FDP::APILogger
                            const logger::sptr APILogger
                            Global logger used across all FDP scripts.
                            Definition: logging.cxx:19
                            diff --git a/namespaces.html b/namespaces.html index 7027042..56c9c90 100644 --- a/namespaces.html +++ b/namespaces.html @@ -79,10 +79,11 @@  Cimpl  CIOObjectClass for API objects  Cjson_parse_error - Crest_apiquery_error - Csync_error - Cvalidation_error - Cwrite_error + Clogger + Crest_apiquery_error + Csync_error + Cvalidation_error + Cwrite_error diff --git a/search/all_0.js b/search/all_0.js index 750bc82..e3da8b7 100644 --- a/search/all_0.js +++ b/search/all_0.js @@ -3,7 +3,7 @@ var searchData= ['alpha_0',['ALPHA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a002101f8725e5c78d9f30d87f3fa4c87',1,'FDP::Versioning']]], ['api_1',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API::API()'],['../class_f_d_p_1_1_a_p_i.html',1,'FDP::API']]], ['api_2ehxx_2',['api.hxx',['../api_8hxx.html',1,'']]], - ['apilogger_3',['APILogger',['../logging_8hxx.html#a86cb9217b28d11ce2d889dbbe92bcb2b',1,'FDP']]], + ['apilogger_3',['APILogger',['../logging_8hxx.html#a88c65a4f48c8dde03f5d414f29ac4b7a',1,'FDP']]], ['apiobject_4',['ApiObject',['../class_f_d_p_1_1_api_object.html',1,'FDP']]], ['append_5fwith_5fforward_5fslash_5',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] ]; diff --git a/search/all_2.js b/search/all_2.js index af979a8..28f7c4c 100644 --- a/search/all_2.js +++ b/search/all_2.js @@ -8,6 +8,5 @@ var searchData= ['config_5freads_5f_5',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], ['config_5fwrites_5f_6',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], ['construct_7',['construct',['../class_f_d_p_1_1_api_object.html#a52db6cca9c94d6bed3b00166c3c04b9c',1,'FDP::ApiObject']]], - ['create_5flogger_5f_8',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], - ['current_5ftime_5fstamp_9',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] + ['current_5ftime_5fstamp_8',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] ]; diff --git a/search/all_6.js b/search/all_6.js index 2f3d593..3ff3585 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -1,36 +1,36 @@ var searchData= [ ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], - ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a88e0a7686c3adc7f5086282693cb9f91',1,'FDP::Config']]], + ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a94caee3afb761dae494814264972c0b5',1,'FDP::Config']]], ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], - ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aff9ead89c7d7a1f4a61be7ba0ff10bf9',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], - ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#a4d3ab4dc8d8b0754b612dad823abbd1c',1,'FDP::IOObject']]], - ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#acb0f0956b8b86f49fca81588e82f6bd5',1,'FDP::IOObject']]], + ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad61c43afc5485c9fcfbef5174a68d78f',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], + ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#ac3145f3de8a58010d8a33e57fee67ec2',1,'FDP::IOObject']]], + ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#ad8d3ed9b24f406d20575ef45469ee8a0',1,'FDP::IOObject']]], ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], - ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#aa89e39ad7c6346a82ba3d8aca722dfe5',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#af7e308602e39909c3c95f5ce621f7e60',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#ae3cb47196eaf7110356b1c8d8833b232',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#a7c7acd56d99c4eda4618fdc6e8a236d1',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#ac76df715690e2af929a66470e9ca938f',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af927b241ff0f6f83fe646d24ac7cefa0',1,'FDP::IOObject']]], ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], - ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], + ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ab8bf366173b74a96e0f37b38c884536f',1,'FDP::IOObject']]], ['get_5frequest_20',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], - ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], + ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a7ddbba3e1add1f60e68780871cc72b5e',1,'FDP::Config']]], ['get_5fscript_5ffile_5fpath_22',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], ['get_5ftoken_23',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], ['get_5ftype_24',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], ['get_5furi_25',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], ['get_5furl_5froot_26',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], - ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], - ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], - ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], - ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], - ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], - ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] + ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a4439875ff61e85bf04f00004eb35ccc2',1,'FDP::IOObject']]], + ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a08e05013423139691db36810344cd5c0',1,'FDP::IOObject']]], + ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#acd94303a44a3d221a5aa369688faf05a',1,'FDP::IOObject']]], + ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#a6a1ab929bcc0d31a3af114bf9fe3a449',1,'FDP::IOObject']]], + ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#acbac01d71e5f888734b306115123bc20',1,'FDP::ApiObject']]], + ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a6acd61ea72aa94c5494689581f3fe0bc',1,'FDP::ApiObject']]] ]; diff --git a/search/all_8.js b/search/all_8.js index 1d523bc..a19c30f 100644 --- a/search/all_8.js +++ b/search/all_8.js @@ -1,7 +1,7 @@ var searchData= [ - ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html',1,'FDP::DataPipeline::impl'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad1e93a46095b2b484ef322f570fe8914',1,'FDP::DataPipeline::impl::impl()']]], - ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP::IOObject'],['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html',1,'FDP::DataPipeline::impl'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ac3b1ebeb2fbf90a729d8ef5784324445',1,'FDP::DataPipeline::impl::impl()']]], + ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP::IOObject'],['../class_f_d_p_1_1_i_o_object.html#ab02b513c6e8a608e11128a7790abc056',1,'FDP::IOObject::IOObject()=default'],['../class_f_d_p_1_1_i_o_object.html#aaf0df6076993057837e2727ec71f8e68',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#a1b252f1e63196516b77ff2737761c87a',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], ['is_5fempty_2',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], - ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] + ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#a8252f827930e78fa41ef284472e44ffe',1,'FDP::IOObject']]] ]; diff --git a/search/all_a.js b/search/all_a.js index 963f3da..7f82bef 100644 --- a/search/all_a.js +++ b/search/all_a.js @@ -3,5 +3,6 @@ var searchData= ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ae8e7f7f1e7bbdbe93094d59c367210ad',1,'FDP::DataPipeline::impl::link_read()']]], ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a43686ff0e1cf0733770058808b7bd322',1,'FDP::DataPipeline::impl::link_write()']]], ['local_2',['LOCAL',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa54b4c4075463b2e02cd69f5cd139b5b2',1,'FDP']]], - ['logging_2ehxx_3',['logging.hxx',['../logging_8hxx.html',1,'']]] + ['logger_3',['logger',['../class_f_d_p_1_1logger.html',1,'FDP']]], + ['logging_2ehxx_4',['logging.hxx',['../logging_8hxx.html',1,'']]] ]; diff --git a/search/classes_5.js b/search/classes_5.js index 5d19101..c8ad9bd 100644 --- a/search/classes_5.js +++ b/search/classes_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['rest_5fapiquery_5ferror_0',['rest_apiquery_error',['../class_f_d_p_1_1rest__apiquery__error.html',1,'FDP']]] + ['logger_0',['logger',['../class_f_d_p_1_1logger.html',1,'FDP']]] ]; diff --git a/search/classes_6.js b/search/classes_6.js index 0a01a4d..5d19101 100644 --- a/search/classes_6.js +++ b/search/classes_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['sync_5ferror_0',['sync_error',['../class_f_d_p_1_1sync__error.html',1,'FDP']]] + ['rest_5fapiquery_5ferror_0',['rest_apiquery_error',['../class_f_d_p_1_1rest__apiquery__error.html',1,'FDP']]] ]; diff --git a/search/classes_7.js b/search/classes_7.js index a751baa..0a01a4d 100644 --- a/search/classes_7.js +++ b/search/classes_7.js @@ -1,5 +1,4 @@ var searchData= [ - ['validation_5ferror_0',['validation_error',['../class_f_d_p_1_1validation__error.html',1,'FDP']]], - ['version_1',['version',['../class_f_d_p_1_1_versioning_1_1version.html',1,'FDP::Versioning']]] + ['sync_5ferror_0',['sync_error',['../class_f_d_p_1_1sync__error.html',1,'FDP']]] ]; diff --git a/search/classes_8.js b/search/classes_8.js index be6390b..a751baa 100644 --- a/search/classes_8.js +++ b/search/classes_8.js @@ -1,4 +1,5 @@ var searchData= [ - ['write_5ferror_0',['write_error',['../class_f_d_p_1_1write__error.html',1,'FDP']]] + ['validation_5ferror_0',['validation_error',['../class_f_d_p_1_1validation__error.html',1,'FDP']]], + ['version_1',['version',['../class_f_d_p_1_1_versioning_1_1version.html',1,'FDP::Versioning']]] ]; diff --git a/search/classes_9.html b/search/classes_9.html new file mode 100644 index 0000000..486e2a5 --- /dev/null +++ b/search/classes_9.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
                            +
                            Loading...
                            +
                            + +
                            Searching...
                            +
                            No Matches
                            + +
                            + + diff --git a/search/classes_9.js b/search/classes_9.js new file mode 100644 index 0000000..be6390b --- /dev/null +++ b/search/classes_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5ferror_0',['write_error',['../class_f_d_p_1_1write__error.html',1,'FDP']]] +]; diff --git a/search/functions_1.js b/search/functions_1.js index cf42a29..d62f6cf 100644 --- a/search/functions_1.js +++ b/search/functions_1.js @@ -5,6 +5,5 @@ var searchData= ['config_5freads_5f_2',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], ['config_5fwrites_5f_3',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], ['construct_4',['construct',['../class_f_d_p_1_1_api_object.html#a52db6cca9c94d6bed3b00166c3c04b9c',1,'FDP::ApiObject']]], - ['create_5flogger_5f_5',['create_logger_',['../logging_8hxx.html#a8d53e714640efd0381241689a58d039d',1,'FDP']]], - ['current_5ftime_5fstamp_6',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] + ['current_5ftime_5fstamp_5',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] ]; diff --git a/search/functions_5.js b/search/functions_5.js index 2f3d593..3ff3585 100644 --- a/search/functions_5.js +++ b/search/functions_5.js @@ -1,36 +1,36 @@ var searchData= [ ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], - ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a88e0a7686c3adc7f5086282693cb9f91',1,'FDP::Config']]], + ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a94caee3afb761dae494814264972c0b5',1,'FDP::Config']]], ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], - ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aff9ead89c7d7a1f4a61be7ba0ff10bf9',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], - ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#a4d3ab4dc8d8b0754b612dad823abbd1c',1,'FDP::IOObject']]], - ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#acb0f0956b8b86f49fca81588e82f6bd5',1,'FDP::IOObject']]], + ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad61c43afc5485c9fcfbef5174a68d78f',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], + ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#ac3145f3de8a58010d8a33e57fee67ec2',1,'FDP::IOObject']]], + ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#ad8d3ed9b24f406d20575ef45469ee8a0',1,'FDP::IOObject']]], ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], - ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#aa89e39ad7c6346a82ba3d8aca722dfe5',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#af7e308602e39909c3c95f5ce621f7e60',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#ae3cb47196eaf7110356b1c8d8833b232',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#a7c7acd56d99c4eda4618fdc6e8a236d1',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#ac76df715690e2af929a66470e9ca938f',1,'FDP::IOObject']]], + ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af927b241ff0f6f83fe646d24ac7cefa0',1,'FDP::IOObject']]], ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], - ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ac4161e9910273482f961705878545549',1,'FDP::IOObject']]], + ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ab8bf366173b74a96e0f37b38c884536f',1,'FDP::IOObject']]], ['get_5frequest_20',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], - ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a2fd76feced1f97b51b4092149d46b67b',1,'FDP::Config']]], + ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a7ddbba3e1add1f60e68780871cc72b5e',1,'FDP::Config']]], ['get_5fscript_5ffile_5fpath_22',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], ['get_5ftoken_23',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], ['get_5ftype_24',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], ['get_5furi_25',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], ['get_5furl_5froot_26',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], - ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a151da3a3dcae8711ad1e91ec0b1193ae',1,'FDP::IOObject']]], - ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a2645add38b47ff46dd2327c0c1607ec7',1,'FDP::IOObject']]], - ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#a16e89e4a7922a7f533148738a8466016',1,'FDP::IOObject']]], - ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#ac24c3406e84436ea849150dd7439de74',1,'FDP::IOObject']]], - ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#a2482d183eb0df5ed3a1d31026884a33a',1,'FDP::ApiObject']]], - ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a4ac893d1c943c2af0e364a4ce6aa9643',1,'FDP::ApiObject']]] + ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a4439875ff61e85bf04f00004eb35ccc2',1,'FDP::IOObject']]], + ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a08e05013423139691db36810344cd5c0',1,'FDP::IOObject']]], + ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#acd94303a44a3d221a5aa369688faf05a',1,'FDP::IOObject']]], + ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#a6a1ab929bcc0d31a3af114bf9fe3a449',1,'FDP::IOObject']]], + ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#acbac01d71e5f888734b306115123bc20',1,'FDP::ApiObject']]], + ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a6acd61ea72aa94c5494689581f3fe0bc',1,'FDP::ApiObject']]] ]; diff --git a/search/functions_7.js b/search/functions_7.js index f5080a4..b87c845 100644 --- a/search/functions_7.js +++ b/search/functions_7.js @@ -1,7 +1,7 @@ var searchData= [ - ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad1e93a46095b2b484ef322f570fe8914',1,'FDP::DataPipeline::impl']]], - ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html#aa77a3bba240265abc0655bccfc3241cb',1,'FDP::IOObject::IOObject()'],['../class_f_d_p_1_1_i_o_object.html#a5f01e95c98ade98a77dedd79f771a515',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, std::string data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#aac9557e066c3789f5d693eb6ccf51cc7',1,'FDP::IOObject::IOObject(std::string data_product, std::string use_data_product, std::string use_version, std::string use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ac3b1ebeb2fbf90a729d8ef5784324445',1,'FDP::DataPipeline::impl']]], + ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html#ab02b513c6e8a608e11128a7790abc056',1,'FDP::IOObject::IOObject()=default'],['../class_f_d_p_1_1_i_o_object.html#aaf0df6076993057837e2727ec71f8e68',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#a1b252f1e63196516b77ff2737761c87a',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], ['is_5fempty_2',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], - ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#aa8cb699d92dcd3dc0575e4343752f934',1,'FDP::IOObject']]] + ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#a8252f827930e78fa41ef284472e44ffe',1,'FDP::IOObject']]] ]; diff --git a/search/searchdata.js b/search/searchdata.js index e0b493e..063ab19 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,7 +1,7 @@ var indexSectionsWithContent = { 0: "abcdefghijlmprsvw~", - 1: "acdijrsvw", + 1: "acdijlrsvw", 2: "f", 3: "acjlms", 4: "acdefghijlmprsvw~", diff --git a/search/variables_0.js b/search/variables_0.js index 2344e2f..3254fe5 100644 --- a/search/variables_0.js +++ b/search/variables_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['apilogger_0',['APILogger',['../logging_8hxx.html#a86cb9217b28d11ce2d889dbbe92bcb2b',1,'FDP']]] + ['apilogger_0',['APILogger',['../logging_8hxx.html#a88c65a4f48c8dde03f5d414f29ac4b7a',1,'FDP']]] ]; From ce0f9f38994e1b4543d038aee5fc825d2cbdc0d2 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Thu, 10 Mar 2022 17:39:15 +0000 Subject: [PATCH 08/19] deploy: fa62b6cbf6f04ac986828aba14f7f4441f97a4f1 --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 996d2dc..df0dcd3 100644 --- a/index.html +++ b/index.html @@ -66,7 +66,7 @@
                            FAIR Data Pipeline C++ API
                            -

                            FDP C++ API License: LGPL v3 software-checklist DOI

                            +

                            FDP C++ API Coverage License: LGPL v3 software-checklist DOI

                            Contents

                              From 1afddca2b92f39ef737a8e1f1d8a3ec06158eb9f Mon Sep 17 00:00:00 2001 From: RyanJField Date: Sun, 24 Apr 2022 07:20:47 +0000 Subject: [PATCH 09/19] deploy: 1bcc48a6e1aa0ba1eda74141d85abdfdefef43e9 --- annotated.html | 45 ++- api_8hxx.html | 220 ----------- api_8hxx_source.html | 163 +++++---- api__object_8hxx_source.html | 49 ++- class_data_pipeline_impl__.html | 4 +- class_f_d_p_1_1_a_p_i-members.html | 95 ----- class_f_d_p_1_1_api_object-members.html | 100 ----- class_f_d_p_1_1_config-members.html | 108 ------ class_f_d_p_1_1_data_pipeline-members.html | 91 ----- class_f_d_p_1_1_i_o_object-members.html | 98 ----- ...d_p_1_1_versioning_1_1version-members.html | 101 ------ class_f_d_p_1_1config__parsing__error.png | Bin 645 -> 0 bytes class_f_d_p_1_1json__parse__error.png | Bin 612 -> 0 bytes class_f_d_p_1_1rest__apiquery__error.png | Bin 651 -> 0 bytes class_f_d_p_1_1sync__error.png | Bin 521 -> 0 bytes class_f_d_p_1_1validation__error.png | Bin 571 -> 0 bytes class_f_d_p_1_1write__error.png | Bin 509 -> 0 bytes ..._fair_data_pipeline_1_1_a_p_i-members.html | 95 +++++ ...=> class_fair_data_pipeline_1_1_a_p_i.html | 167 +++++---- ..._data_pipeline_1_1_api_object-members.html | 100 +++++ ...ass_fair_data_pipeline_1_1_api_object.html | 162 ++++----- ...fair_data_pipeline_1_1_config-members.html | 109 ++++++ ...> class_fair_data_pipeline_1_1_config.html | 305 ++++++++-------- ...ta_pipeline_1_1_data_pipeline-members.html | 88 +++++ ..._fair_data_pipeline_1_1_data_pipeline.html | 101 +++--- ...ine_1_1_data_pipeline_1_1impl-members.html | 20 +- ...ta_pipeline_1_1_data_pipeline_1_1impl.html | 101 +++--- ..._data_pipeline_1_1_i_o_object-members.html | 98 +++++ ...ass_fair_data_pipeline_1_1_i_o_object.html | 216 +++++------ ...ine_1_1_versioning_1_1version-members.html | 101 ++++++ ...ta_pipeline_1_1_versioning_1_1version.html | 94 ++--- ...ine_1_1config__parsing__error-members.html | 8 +- ...ta_pipeline_1_1config__parsing__error.html | 16 +- ...ata_pipeline_1_1config__parsing__error.png | Bin 0 -> 763 bytes ...ipeline_1_1json__parse__error-members.html | 8 +- ...r_data_pipeline_1_1json__parse__error.html | 16 +- ...ir_data_pipeline_1_1json__parse__error.png | Bin 0 -> 732 bytes ..._fair_data_pipeline_1_1logger-members.html | 84 +++++ class_fair_data_pipeline_1_1logger.html | 100 +++++ ...1_1logging_1_1_composite_sink-members.html | 93 +++++ ...ipeline_1_1logging_1_1_composite_sink.html | 189 ++++++++++ ...pipeline_1_1logging_1_1_composite_sink.png | Bin 0 -> 1281 bytes ...ipeline_1_1logging_1_1_logger-members.html | 95 +++++ ...r_data_pipeline_1_1logging_1_1_logger.html | 147 ++++++++ ...ng_1_1_logger_1_1_msg_builder-members.html | 86 +++++ ...1_1logging_1_1_logger_1_1_msg_builder.html | 108 ++++++ ..._1_1logging_1_1_o_stream_sink-members.html | 92 +++++ ...pipeline_1_1logging_1_1_o_stream_sink.html | 186 ++++++++++ ..._pipeline_1_1logging_1_1_o_stream_sink.png | Bin 0 -> 1275 bytes ..._pipeline_1_1logging_1_1_sink-members.html | 91 +++++ ...air_data_pipeline_1_1logging_1_1_sink.html | 138 +++++++ ...fair_data_pipeline_1_1logging_1_1_sink.png | Bin 0 -> 1757 bytes ...1_1logging_1_1_sink_formatter-members.html | 87 +++++ ...ipeline_1_1logging_1_1_sink_formatter.html | 158 ++++++++ ...pipeline_1_1logging_1_1_sink_formatter.png | Bin 0 -> 944 bytes ...line_1_1rest__apiquery__error-members.html | 8 +- ...ata_pipeline_1_1rest__apiquery__error.html | 16 +- ...data_pipeline_1_1rest__apiquery__error.png | Bin 0 -> 763 bytes ..._data_pipeline_1_1sync__error-members.html | 8 +- ...ass_fair_data_pipeline_1_1sync__error.html | 16 +- class_fair_data_pipeline_1_1sync__error.png | Bin 0 -> 676 bytes ...pipeline_1_1validation__error-members.html | 8 +- ...ir_data_pipeline_1_1validation__error.html | 16 +- ...air_data_pipeline_1_1validation__error.png | Bin 0 -> 715 bytes ...data_pipeline_1_1write__error-members.html | 8 +- ...ss_fair_data_pipeline_1_1write__error.html | 16 +- class_fair_data_pipeline_1_1write__error.png | Bin 0 -> 673 bytes classes.html | 28 +- config_8hxx.html | 8 +- config_8hxx_source.html | 259 ++++++------- data__io_8hxx_source.html | 34 +- ... dir_8c20949084a9f35c1e6bd2c48f358243.html | 12 +- dir_ac6c6686346e4bb6ee59787dd26cbe81.html | 13 - dir_d98af0b859cb0744225e11c767d17cdb.html | 7 - dir_f537a5f098b413116eae11cd84c41a43.html | 3 - exceptions_8hxx_source.html | 40 +- fdp_8hxx_source.html | 93 ++--- files.html | 13 +- functions.html | 123 +++---- functions_func.html | 123 +++---- hierarchy.html | 40 +- index.html | 9 +- io__object_8hxx_source.html | 83 +++-- json_8hxx.html | 133 ------- json_8hxx_source.html | 9 +- logging_8hxx.html | 125 ------- logging_8hxx_source.html | 221 +++++++++++- menudata.js | 2 - metadata_8hxx.html | 341 ------------------ metadata_8hxx_source.html | 30 +- ...ace_fair_data_pipeline_1_1_versioning.html | 38 +- namespacemembers.html | 2 +- namespacemembers_enum.html | 2 +- namespaces.html | 43 ++- search/all_0.js | 10 +- search/all_1.js | 2 +- search/all_10.js | 4 +- search/all_11.js | 4 +- search/{enums_1.html => all_12.html} | 2 +- search/all_12.js | 6 + search/all_2.js | 16 +- search/all_3.js | 2 +- search/all_4.js | 2 +- search/all_5.js | 5 +- search/all_6.js | 65 ++-- search/all_7.js | 8 +- search/all_8.js | 10 +- search/all_9.js | 6 +- search/all_a.js | 9 +- search/all_b.js | 6 +- search/all_c.js | 3 +- search/all_d.js | 11 +- search/all_e.js | 8 +- search/all_f.js | 7 +- search/classes_0.js | 4 +- search/classes_1.js | 5 +- search/classes_2.js | 2 +- search/classes_3.js | 6 +- search/classes_4.js | 2 +- search/classes_5.js | 3 +- search/classes_6.js | 2 +- search/classes_7.js | 2 +- search/classes_8.js | 3 +- search/classes_9.js | 4 +- search/{files_3.html => classes_a.html} | 2 +- search/classes_a.js | 5 + search/{files_1.html => classes_b.html} | 2 +- search/classes_b.js | 4 + search/enums_0.js | 2 +- search/enums_1.js | 4 - search/enumvalues_0.js | 2 +- search/enumvalues_1.js | 2 +- search/enumvalues_2.js | 3 +- search/enumvalues_3.html | 37 -- search/enumvalues_3.js | 6 - search/files_0.js | 2 +- search/files_1.js | 4 - search/files_2.html | 37 -- search/files_2.js | 4 - search/files_3.js | 4 - search/files_4.html | 37 -- search/files_4.js | 4 - search/files_5.html | 37 -- search/files_5.js | 4 - search/functions_0.js | 3 +- search/functions_1.js | 9 +- search/functions_10.html | 37 -- search/functions_10.js | 6 - search/functions_2.js | 2 +- search/functions_3.js | 2 +- search/functions_4.js | 34 +- search/functions_5.js | 37 +- search/functions_6.js | 7 +- search/functions_7.js | 5 +- search/functions_8.js | 4 +- search/functions_9.js | 3 +- search/functions_a.js | 3 +- search/functions_b.js | 3 +- search/functions_c.js | 6 +- search/functions_d.js | 3 +- search/functions_e.js | 4 +- search/functions_f.html | 37 -- search/functions_f.js | 4 - search/namespaces_0.js | 2 +- search/searchdata.js | 29 +- search/variables_0.html | 37 -- search/variables_0.js | 4 - semver_8hxx.html | 120 ------ semver_8hxx_source.html | 76 ++-- ...ipeline_1_1logging_1_1_i_sink-members.html | 85 +++++ ...r_data_pipeline_1_1logging_1_1_i_sink.html | 110 ++++++ ...ir_data_pipeline_1_1logging_1_1_i_sink.png | Bin 0 -> 1759 bytes ...1logging_1_1_i_sink_formatter-members.html | 85 +++++ ...eline_1_1logging_1_1_i_sink_formatter.html | 108 ++++++ ...peline_1_1logging_1_1_i_sink_formatter.png | Bin 0 -> 947 bytes ..._d_p_1_1logger.html => time_8h_source.html | 28 +- times_8h_source.html | 117 ++++++ 177 files changed, 4483 insertions(+), 3411 deletions(-) delete mode 100644 api_8hxx.html delete mode 100644 class_f_d_p_1_1_a_p_i-members.html delete mode 100644 class_f_d_p_1_1_api_object-members.html delete mode 100644 class_f_d_p_1_1_config-members.html delete mode 100644 class_f_d_p_1_1_data_pipeline-members.html delete mode 100644 class_f_d_p_1_1_i_o_object-members.html delete mode 100644 class_f_d_p_1_1_versioning_1_1version-members.html delete mode 100644 class_f_d_p_1_1config__parsing__error.png delete mode 100644 class_f_d_p_1_1json__parse__error.png delete mode 100644 class_f_d_p_1_1rest__apiquery__error.png delete mode 100644 class_f_d_p_1_1sync__error.png delete mode 100644 class_f_d_p_1_1validation__error.png delete mode 100644 class_f_d_p_1_1write__error.png create mode 100644 class_fair_data_pipeline_1_1_a_p_i-members.html rename class_f_d_p_1_1_a_p_i.html => class_fair_data_pipeline_1_1_a_p_i.html (62%) create mode 100644 class_fair_data_pipeline_1_1_api_object-members.html rename class_f_d_p_1_1_api_object.html => class_fair_data_pipeline_1_1_api_object.html (54%) create mode 100644 class_fair_data_pipeline_1_1_config-members.html rename class_f_d_p_1_1_config.html => class_fair_data_pipeline_1_1_config.html (51%) create mode 100644 class_fair_data_pipeline_1_1_data_pipeline-members.html rename class_f_d_p_1_1_data_pipeline.html => class_fair_data_pipeline_1_1_data_pipeline.html (54%) rename class_f_d_p_1_1_data_pipeline_1_1impl-members.html => class_fair_data_pipeline_1_1_data_pipeline_1_1impl-members.html (53%) rename class_f_d_p_1_1_data_pipeline_1_1impl.html => class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html (59%) create mode 100644 class_fair_data_pipeline_1_1_i_o_object-members.html rename class_f_d_p_1_1_i_o_object.html => class_fair_data_pipeline_1_1_i_o_object.html (57%) create mode 100644 class_fair_data_pipeline_1_1_versioning_1_1version-members.html rename class_f_d_p_1_1_versioning_1_1version.html => class_fair_data_pipeline_1_1_versioning_1_1version.html (62%) rename class_f_d_p_1_1config__parsing__error-members.html => class_fair_data_pipeline_1_1config__parsing__error-members.html (80%) rename class_f_d_p_1_1config__parsing__error.html => class_fair_data_pipeline_1_1config__parsing__error.html (80%) create mode 100644 class_fair_data_pipeline_1_1config__parsing__error.png rename class_f_d_p_1_1json__parse__error-members.html => class_fair_data_pipeline_1_1json__parse__error-members.html (81%) rename class_f_d_p_1_1json__parse__error.html => class_fair_data_pipeline_1_1json__parse__error.html (80%) create mode 100644 class_fair_data_pipeline_1_1json__parse__error.png create mode 100644 class_fair_data_pipeline_1_1logger-members.html create mode 100644 class_fair_data_pipeline_1_1logger.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_composite_sink-members.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_composite_sink.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_composite_sink.png create mode 100644 class_fair_data_pipeline_1_1logging_1_1_logger-members.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_logger.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder-members.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_o_stream_sink-members.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.png create mode 100644 class_fair_data_pipeline_1_1logging_1_1_sink-members.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_sink.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_sink.png create mode 100644 class_fair_data_pipeline_1_1logging_1_1_sink_formatter-members.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_sink_formatter.html create mode 100644 class_fair_data_pipeline_1_1logging_1_1_sink_formatter.png rename class_f_d_p_1_1rest__apiquery__error-members.html => class_fair_data_pipeline_1_1rest__apiquery__error-members.html (80%) rename class_f_d_p_1_1rest__apiquery__error.html => class_fair_data_pipeline_1_1rest__apiquery__error.html (80%) create mode 100644 class_fair_data_pipeline_1_1rest__apiquery__error.png rename class_f_d_p_1_1sync__error-members.html => class_fair_data_pipeline_1_1sync__error-members.html (82%) rename class_f_d_p_1_1sync__error.html => class_fair_data_pipeline_1_1sync__error.html (81%) create mode 100644 class_fair_data_pipeline_1_1sync__error.png rename class_f_d_p_1_1validation__error-members.html => class_fair_data_pipeline_1_1validation__error-members.html (81%) rename class_f_d_p_1_1validation__error.html => class_fair_data_pipeline_1_1validation__error.html (80%) create mode 100644 class_fair_data_pipeline_1_1validation__error.png rename class_f_d_p_1_1write__error-members.html => class_fair_data_pipeline_1_1write__error-members.html (82%) rename class_f_d_p_1_1write__error.html => class_fair_data_pipeline_1_1write__error.html (81%) create mode 100644 class_fair_data_pipeline_1_1write__error.png rename class_f_d_p_1_1logger-members.html => dir_8c20949084a9f35c1e6bd2c48f358243.html (79%) delete mode 100644 json_8hxx.html delete mode 100644 logging_8hxx.html delete mode 100644 metadata_8hxx.html rename namespace_f_d_p_1_1_versioning.html => namespace_fair_data_pipeline_1_1_versioning.html (66%) rename search/{enums_1.html => all_12.html} (95%) create mode 100644 search/all_12.js rename search/{files_3.html => classes_a.html} (95%) create mode 100644 search/classes_a.js rename search/{files_1.html => classes_b.html} (95%) create mode 100644 search/classes_b.js delete mode 100644 search/enums_1.js delete mode 100644 search/enumvalues_3.html delete mode 100644 search/enumvalues_3.js delete mode 100644 search/files_1.js delete mode 100644 search/files_2.html delete mode 100644 search/files_2.js delete mode 100644 search/files_3.js delete mode 100644 search/files_4.html delete mode 100644 search/files_4.js delete mode 100644 search/files_5.html delete mode 100644 search/files_5.js delete mode 100644 search/functions_10.html delete mode 100644 search/functions_10.js delete mode 100644 search/functions_f.html delete mode 100644 search/functions_f.js delete mode 100644 search/variables_0.html delete mode 100644 search/variables_0.js delete mode 100644 semver_8hxx.html create mode 100644 struct_fair_data_pipeline_1_1logging_1_1_i_sink-members.html create mode 100644 struct_fair_data_pipeline_1_1logging_1_1_i_sink.html create mode 100644 struct_fair_data_pipeline_1_1logging_1_1_i_sink.png create mode 100644 struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter-members.html create mode 100644 struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.html create mode 100644 struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.png rename class_f_d_p_1_1logger.html => time_8h_source.html (69%) create mode 100644 times_8h_source.html diff --git a/annotated.html b/annotated.html index d29da36..b9e35ce 100644 --- a/annotated.html +++ b/annotated.html @@ -67,24 +67,33 @@
                            Here are the classes, structs, unions and interfaces with brief descriptions:
                            -
                            [detail level 123]
                            - - - - - - - - - - - - - - - - - +
                            [detail level 1234]
                             ▼NFDP
                             ▼NVersioningNamespace containing all semantic versioning types and classes
                             CversionClass describing the semantic version of an object
                             CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
                             CApiObjectClass for API objects
                             CConfigClass for interacting with confifurations
                             Cconfig_parsing_error
                             ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
                             Cimpl
                             CIOObjectClass for API objects
                             Cjson_parse_error
                             Clogger
                             Crest_apiquery_error
                             Csync_error
                             Cvalidation_error
                             Cwrite_error
                             CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                             ▼NFairDataPipeline
                             ▼Nlogging
                             CCompositeSink
                             CISink
                             CISinkFormatter
                             ▼CLogger
                             CMsgBuilder
                             COStreamSink
                             CSink
                             CSinkFormatter
                             ▼NVersioningNamespace containing all semantic versioning types and classes
                             CversionClass describing the semantic version of an object
                             CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
                             CApiObjectClass for API objects
                             CConfigClass for interacting with confifurations
                             Cconfig_parsing_error
                             ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
                             Cimpl
                             CIOObjectClass for API objects
                             Cjson_parse_error
                             Clogger
                             Crest_apiquery_error
                             Csync_error
                             Cvalidation_error
                             Cwrite_error
                             CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
                            diff --git a/api_8hxx.html b/api_8hxx.html deleted file mode 100644 index 71c9d38..0000000 --- a/api_8hxx.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - - -cppDataPipeline: include/fdp/registry/api.hxx File Reference - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            -Classes | -Enumerations | -Functions
                            -
                            api.hxx File Reference
                            -
                            -
                            - -

                            File containing classes and methods for connecting to the RestAPI. -More...

                            -
                            #include <algorithm>
                            -#include <curl/curl.h>
                            -#include <ghc/filesystem.hpp>
                            -#include <iostream>
                            -#include <iterator>
                            -#include <json/reader.h>
                            -#include <map>
                            -#include <regex>
                            -#include <string>
                            -#include <vector>
                            -#include "fdp/exceptions.hxx"
                            -#include "fdp/objects/api_object.hxx"
                            -#include "fdp/utilities/json.hxx"
                            -#include "fdp/utilities/logging.hxx"
                            -
                            -

                            Go to the source code of this file.

                            - - - - - -

                            -Classes

                            class  FDP::API
                             a class which handles the fetching and posting of information to the FDP data pipeline RestAPI More...
                             
                            - - - - -

                            -Enumerations

                            enum class  FDP::RESTAPI { REMOTE -, LOCAL - }
                             selection of either local or remote pipeline running More...
                             
                            - - - - - - -

                            -Functions

                            size_t FDP::write_func_ (void *ptr, size_t size, size_t nmemb, std::string *data)
                             function for writing to file from a CURL call More...
                             
                            -std::string FDP::url_encode (std::string url)
                             
                            -

                            Detailed Description

                            -

                            File containing classes and methods for connecting to the RestAPI.

                            -
                            -
                            Author
                            K. Zarebski (UKAEA)
                            -
                            Date
                            2021-05-05
                            -

                            The classes and methods within this file are used to access the FDP Data Pipeline RestAPI, they handle sending of requests and retrieval of data as JSON strings

                            -

                            Enumeration Type Documentation

                            - -

                            ◆ RESTAPI

                            - -
                            -
                            - - - - - -
                            - - - - -
                            enum class FDP::RESTAPI
                            -                             		-strong
                            -
                            - -

                            selection of either local or remote pipeline running

                            -
                            -
                            Author
                            K. Zarebski (UKAEA) & R. Field
                            - - - -
                            Enumerator
                            REMOTE 

                            Run from remote registry

                            -
                            LOCAL 

                            Run from local registry

                            -
                            - -
                            -
                            -

                            Function Documentation

                            - -

                            ◆ write_func_()

                            - -
                            -
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            size_t FDP::write_func_ (void * ptr,
                            size_t size,
                            size_t nmemb,
                            std::string * data 
                            )
                            -
                            - -

                            function for writing to file from a CURL call

                            -
                            -
                            Author
                            K. Zarebski (UKAEA)
                            -
                            Parameters
                            - - - - - -
                            ptr
                            size
                            nmemb
                            data
                            -
                            -
                            -
                            Returns
                            size_t
                            - -
                            -
                            -
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/api_8hxx_source.html b/api_8hxx_source.html index b154d54..16ca504 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -70,7 +70,7 @@
                            api.hxx
                            -Go to the documentation of this file.
                            1
                            +
                            1
                            11#ifndef __FDP_API_HXX__
                            12#define __FDP_API_HXX__
                            13
                            @@ -87,91 +87,90 @@
                            24
                            25#include "fdp/exceptions.hxx"
                            26#include "fdp/objects/api_object.hxx"
                            -
                            27#include "fdp/utilities/json.hxx"
                            -
                            28#include "fdp/utilities/logging.hxx"
                            +
                            27#include "fdp/utilities/json.hxx"
                            +
                            28#include "fdp/utilities/logging.hxx"
                            29
                            -
                            30namespace FDP {
                            -
                            37enum class RESTAPI {
                            -
                            38 REMOTE,
                            -
                            39 LOCAL
                            +
                            30namespace FairDataPipeline {
                            +
                            37enum class RESTAPI {
                            +
                            38 REMOTE,
                            +
                            39 LOCAL
                            40};
                            41
                            -
                            52size_t write_func_(void *ptr, size_t size, size_t nmemb, std::string *data);
                            -
                            53
                            -
                            63class API {
                            -
                            64public:
                            -
                            65 typedef std::shared_ptr< API > sptr;
                            -
                            66
                            -
                            73 API(std::string url_root)
                            -
                            74 : url_root_(API::append_with_forward_slash(url_root)) {}
                            -
                            75
                            -
                            85 Json::Value get_request(const std::string &addr_path,
                            -
                            86 long expected_response = 200, std::string token = "");
                            -
                            87
                            -
                            88 Json::Value patch(const std::string addr_path, Json::Value &post_data,
                            -
                            89 const std::string &token, long expected_response = 200);
                            -
                            100 Json::Value post(const std::string addr_path, Json::Value &post_data,
                            -
                            101 const std::string &token, long expected_response = 201);
                            -
                            102
                            -
                            103 Json::Value post_storage_root(Json::Value &post_data, const std::string &token);
                            +
                            42#if 0
                            +
                            53size_t write_func_(void *ptr, size_t size, size_t nmemb, std::string *data);
                            +
                            54#endif
                            +
                            55
                            +
                            65class API {
                            +
                            66public:
                            +
                            67 typedef std::shared_ptr< API > sptr;
                            +
                            68
                            +
                            75 static sptr construct( const std::string& url_root );
                            +
                            76
                            +
                            77
                            +
                            87 Json::Value get_request(const std::string &addr_path,
                            +
                            88 long expected_response = 200, std::string token = "");
                            +
                            89
                            +
                            90 Json::Value patch(const std::string addr_path, Json::Value &post_data,
                            +
                            91 const std::string &token, long expected_response = 200);
                            +
                            102 Json::Value post(const std::string addr_path, Json::Value &post_data,
                            +
                            103 const std::string &token, long expected_response = 201);
                            104
                            -
                            105 Json::Value get_by_json_query(const std::string &addr_path,
                            -
                            106 Json::Value &query_data,
                            -
                            107 long expected_response = 200,
                            -
                            108 std::string token = "");
                            -
                            109
                            -
                            118 Json::Value get_by_id(const std::string &table, int const &id,
                            -
                            119 long expected_response = 200, std::string token = "");
                            -
                            120
                            -
                            127 std::string get_url_root() const { return url_root_; }
                            -
                            128
                            -
                            137 std::string json_to_query_string(Json::Value &json_value);
                            -
                            138
                            -
                            147 std::string escape_space(std::string &str);
                            -
                            148
                            -
                            156 static std::string append_with_forward_slash(std::string string);
                            -
                            157
                            -
                            164 static std::string remove_leading_forward_slash(std::string str);
                            -
                            165
                            -
                            166private:
                            -
                            167 std::string url_root_;
                            -
                            168 CURL *setup_json_session_(std::string &addr_path, std::string *response,
                            -
                            169 long &http_code, std::string token = "");
                            -
                            170 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
                            -
                            171 FILE *file);
                            -
                            172
                            -
                            173 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
                            -
                            174 const std::string &token, long expected_response, bool PATCH = false);
                            -
                            175
                            -
                            176 // Legacy Method
                            -
                            177 Json::Value get_request(const ghc::filesystem::path &addr_path,
                            -
                            178 long expected_response = 200, std::string token = "");
                            -
                            179
                            -
                            180 void download_file(const ghc::filesystem::path &url,
                            -
                            181 ghc::filesystem::path out_path);
                            -
                            182};
                            -
                            183
                            -
                            184std::string url_encode(std::string url);
                            -
                            185
                            -
                            186}; // namespace FDP
                            -
                            187
                            -
                            188#endif
                            -
                            FDP::write_func_
                            size_t write_func_(void *ptr, size_t size, size_t nmemb, std::string *data)
                            function for writing to file from a CURL call
                            -
                            FDP::RESTAPI
                            RESTAPI
                            selection of either local or remote pipeline running
                            Definition: api.hxx:37
                            - - -
                            FDP::API
                            a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
                            Definition: api.hxx:63
                            -
                            FDP::API::post
                            Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
                            post information from a JSON value object to the RestAPI
                            Definition: api.cxx:187
                            -
                            FDP::API::get_request
                            Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
                            sends the given 'packet' of information to the RestAPI
                            Definition: api.cxx:87
                            -
                            FDP::API::append_with_forward_slash
                            static std::string append_with_forward_slash(std::string string)
                            Static function to append a given string with a "/" unless the string is empty or already ends with a...
                            Definition: api.cxx:291
                            -
                            FDP::API::remove_leading_forward_slash
                            static std::string remove_leading_forward_slash(std::string str)
                            Remove the leading forward slash from a given string.
                            Definition: api.cxx:304
                            -
                            FDP::API::escape_space
                            std::string escape_space(std::string &str)
                            escapes space " " characters within a string with it's html character code (%20)
                            Definition: api.cxx:182
                            -
                            FDP::API::get_url_root
                            std::string get_url_root() const
                            returns the root URL for the RestAPI used by the API instance
                            Definition: api.hxx:127
                            -
                            FDP::API::API
                            API(std::string url_root)
                            construct an API object using the given URL as the root
                            Definition: api.hxx:73
                            -
                            FDP::API::json_to_query_string
                            std::string json_to_query_string(Json::Value &json_value)
                            Formats a json object into a string representation which can be used as a url endpoint query.
                            Definition: api.cxx:146
                            -
                            FDP::API::get_by_id
                            Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
                            get an object from the api by it's id
                            Definition: api.cxx:139
                            -
                            json.hxx
                            File contains methods relating to handling of JSON based data.
                            -
                            logging.hxx
                            File contains pointers for creating global logger during session.
                            +
                            105 Json::Value post_storage_root(Json::Value &post_data, const std::string &token);
                            +
                            106
                            +
                            107 Json::Value get_by_json_query(const std::string &addr_path,
                            +
                            108 Json::Value &query_data,
                            +
                            109 long expected_response = 200,
                            +
                            110 std::string token = "");
                            +
                            111
                            +
                            120 Json::Value get_by_id(const std::string &table, int const &id,
                            +
                            121 long expected_response = 200, std::string token = "");
                            +
                            122
                            +
                            129 std::string get_url_root() const { return url_root_; }
                            +
                            130
                            +
                            139 std::string json_to_query_string(Json::Value &json_value);
                            +
                            140
                            +
                            149 std::string escape_space(std::string &str);
                            +
                            150
                            +
                            158 static std::string append_with_forward_slash(std::string string);
                            +
                            159
                            +
                            166 static std::string remove_leading_forward_slash(std::string str);
                            +
                            167
                            +
                            168private:
                            +
                            169 API( const std::string& url_root)
                            +
                            170 : url_root_(API::append_with_forward_slash(url_root)) {}
                            +
                            171
                            +
                            172 std::string url_root_;
                            +
                            173 CURL *setup_json_session_(std::string &addr_path, std::string *response,
                            +
                            174 long &http_code, std::string token = "");
                            +
                            175 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
                            +
                            176 FILE *file);
                            +
                            177
                            +
                            178 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
                            +
                            179 const std::string &token, long expected_response, bool PATCH = false);
                            +
                            180
                            +
                            181 // Legacy Method
                            +
                            182 Json::Value get_request(const ghc::filesystem::path &addr_path,
                            +
                            183 long expected_response = 200, std::string token = "");
                            +
                            184
                            +
                            185 void download_file(const ghc::filesystem::path &url,
                            +
                            186 ghc::filesystem::path out_path);
                            +
                            187};
                            +
                            188
                            +
                            189std::string url_encode(const std::string& url);
                            +
                            190
                            +
                            191}; // namespace FairDataPipeline
                            +
                            192
                            +
                            193#endif
                            +
                            FairDataPipeline::API
                            a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
                            Definition: api.hxx:65
                            +
                            FairDataPipeline::API::json_to_query_string
                            std::string json_to_query_string(Json::Value &json_value)
                            Formats a json object into a string representation which can be used as a url endpoint query.
                            Definition: api.cxx:165
                            +
                            FairDataPipeline::API::remove_leading_forward_slash
                            static std::string remove_leading_forward_slash(std::string str)
                            Remove the leading forward slash from a given string.
                            Definition: api.cxx:332
                            +
                            FairDataPipeline::API::construct
                            static sptr construct(const std::string &url_root)
                            construct an API object using the given URL as the root
                            Definition: api.cxx:16
                            +
                            FairDataPipeline::API::append_with_forward_slash
                            static std::string append_with_forward_slash(std::string string)
                            Static function to append a given string with a "/" unless the string is empty or already ends with a...
                            Definition: api.cxx:319
                            +
                            FairDataPipeline::API::get_request
                            Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
                            sends the given 'packet' of information to the RestAPI
                            Definition: api.cxx:102
                            +
                            FairDataPipeline::API::escape_space
                            std::string escape_space(std::string &str)
                            escapes space " " characters within a string with it's html character code (%20)
                            Definition: api.cxx:201
                            +
                            FairDataPipeline::API::get_url_root
                            std::string get_url_root() const
                            returns the root URL for the RestAPI used by the API instance
                            Definition: api.hxx:129
                            +
                            FairDataPipeline::API::post
                            Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
                            post information from a JSON value object to the RestAPI
                            Definition: api.cxx:206
                            +
                            FairDataPipeline::API::get_by_id
                            Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
                            get an object from the api by it's id
                            Definition: api.cxx:158
                            diff --git a/api__object_8hxx_source.html b/api__object_8hxx_source.html index 5b88cde..1c81851 100644 --- a/api__object_8hxx_source.html +++ b/api__object_8hxx_source.html @@ -77,15 +77,15 @@
                            5#include <cstddef>
                            6#include <json/value.h>
                            7
                            -
                            8#include "fdp/utilities/logging.hxx"
                            +
                            8#include "fdp/utilities/logging.hxx"
                            9
                            -
                            10namespace FDP {
                            -
                            15 class ApiObject {
                            +
                            10namespace FairDataPipeline {
                            +
                            15 class ApiObject {
                            16 private:
                            17 Json::Value obj_;
                            18
                            19 protected:
                            -
                            20 ApiObject();
                            +
                            20 ApiObject();
                            21
                            22 public:
                            23
                            @@ -95,44 +95,43 @@
                            27
                            28 //static copy( const ApiObject& src );
                            29
                            -
                            36 static ApiObject::sptr construct( void );
                            +
                            36 static ApiObject::sptr construct( void );
                            37
                            38
                            39 int add( const std::string& key, int value );
                            40 int add( const std::string& key, float value );
                            41 int add( const std::string& key, double value );
                            42 int add( const std::string& key, const std::string& value );
                            -
                            43 int add( const std::string& key, const ApiObject& value );
                            +
                            43 int add( const std::string& key, const ApiObject& value );
                            44
                            45 int remove( const std::string& key );
                            -
                            52 int get_id();
                            -
                            59 static int get_id_from_string(std::string url);
                            +
                            52 int get_id() const ;
                            +
                            59 static int get_id_from_string(std::string url);
                            60
                            -
                            61 std::string get_type();
                            -
                            67 std::string get_uri() const;
                            +
                            61 std::string get_type() const ;
                            +
                            67 std::string get_uri() const;
                            68
                            -
                            75 std::string get_value_as_string( const std::string& key) const;
                            +
                            75 std::string get_value_as_string( const std::string& key) const;
                            76
                            -
                            83 int get_value_as_int( const std::string& key) const;
                            +
                            83 int get_value_as_int( const std::string& key) const;
                            84
                            -
                            90 std::string get_first_component() const;
                            +
                            90 std::string get_first_component() const;
                            91
                            -
                            98 bool is_empty();
                            +
                            98 bool is_empty();
                            99 };
                            100
                            101}
                            102#endif
                            -
                            FDP::ApiObject
                            Class for API objects.
                            Definition: api_object.hxx:15
                            -
                            FDP::ApiObject::is_empty
                            bool is_empty()
                            Check to see if the object is empty.
                            Definition: api_object.cxx:100
                            -
                            FDP::ApiObject::get_id
                            int get_id()
                            Get the object id from the uri.
                            Definition: api_object.cxx:65
                            -
                            FDP::ApiObject::get_id_from_string
                            static int get_id_from_string(std::string url)
                            Get the object type from the uri.
                            Definition: api_object.cxx:69
                            -
                            FDP::ApiObject::get_uri
                            std::string get_uri() const
                            Get the object uri.
                            Definition: api_object.cxx:89
                            -
                            FDP::ApiObject::get_first_component
                            std::string get_first_component() const
                            Get the first component of the object.
                            Definition: api_object.cxx:107
                            -
                            FDP::ApiObject::construct
                            static ApiObject::sptr construct(void)
                            Construct a new Api Object object.
                            Definition: api_object.cxx:17
                            -
                            FDP::ApiObject::get_value_as_string
                            std::string get_value_as_string(const std::string &key) const
                            Get the value of a given key as string object.
                            Definition: api_object.cxx:93
                            -
                            FDP::ApiObject::get_type
                            std::string get_type()
                            Returns the object type from the object uri_ (table)
                            Definition: api_object.cxx:81
                            -
                            FDP::ApiObject::get_value_as_int
                            int get_value_as_int(const std::string &key) const
                            Get the value of a given key as int object.
                            Definition: api_object.cxx:96
                            -
                            logging.hxx
                            File contains pointers for creating global logger during session.
                            +
                            FairDataPipeline::ApiObject
                            Class for API objects.
                            Definition: api_object.hxx:15
                            +
                            FairDataPipeline::ApiObject::construct
                            static ApiObject::sptr construct(void)
                            Construct a new Api Object object.
                            Definition: api_object.cxx:17
                            +
                            FairDataPipeline::ApiObject::get_value_as_int
                            int get_value_as_int(const std::string &key) const
                            Get the value of a given key as int object.
                            Definition: api_object.cxx:96
                            +
                            FairDataPipeline::ApiObject::get_value_as_string
                            std::string get_value_as_string(const std::string &key) const
                            Get the value of a given key as string object.
                            Definition: api_object.cxx:93
                            +
                            FairDataPipeline::ApiObject::get_id
                            int get_id() const
                            Get the object id from the uri.
                            Definition: api_object.cxx:65
                            +
                            FairDataPipeline::ApiObject::get_uri
                            std::string get_uri() const
                            Get the object uri.
                            Definition: api_object.cxx:89
                            +
                            FairDataPipeline::ApiObject::is_empty
                            bool is_empty()
                            Check to see if the object is empty.
                            Definition: api_object.cxx:100
                            +
                            FairDataPipeline::ApiObject::get_first_component
                            std::string get_first_component() const
                            Get the first component of the object.
                            Definition: api_object.cxx:107
                            +
                            FairDataPipeline::ApiObject::get_id_from_string
                            static int get_id_from_string(std::string url)
                            Get the object type from the uri.
                            Definition: api_object.cxx:69
                            +
                            FairDataPipeline::ApiObject::get_type
                            std::string get_type() const
                            Returns the object type from the object uri_ (table)
                            Definition: api_object.cxx:81
                            diff --git a/class_data_pipeline_impl__.html b/class_data_pipeline_impl__.html index a3a090e..96c471e 100644 --- a/class_data_pipeline_impl__.html +++ b/class_data_pipeline_impl__.html @@ -72,8 +72,8 @@

                            Detailed Description

                            private pointer-to-implementation class containing all backend methods

                            -

                            This class performs all behind the scenes operations acting as the backend to the user called FDP::DataPipeline class. This structure has been chosen to allow for unit tests to be created to test all methods including private ones.

                            -
                            Warning
                            The class should not be used directly during implementation, but rather via an FDP::DataPipeline instance.
                            +

                            This class performs all behind the scenes operations acting as the backend to the user called FairDataPipeline::DataPipeline class. This structure has been chosen to allow for unit tests to be created to test all methods including private ones.

                            +
                            Warning
                            The class should not be used directly during implementation, but rather via an FairDataPipeline::DataPipeline instance.
                            The documentation for this class was generated from the following file:
                            • src/fdp.cxx
                            diff --git a/class_f_d_p_1_1_a_p_i-members.html b/class_f_d_p_1_1_a_p_i-members.html deleted file mode 100644 index 4828ab9..0000000 --- a/class_f_d_p_1_1_a_p_i-members.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            FDP::API Member List
                            -
                            -
                            - -

                            This is the complete list of members for FDP::API, including all inherited members.

                            - - - - - - - - - - - - - - -
                            API(std::string url_root)FDP::APIinline
                            append_with_forward_slash(std::string string)FDP::APIstatic
                            escape_space(std::string &str)FDP::API
                            get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")FDP::API
                            get_by_json_query(const std::string &addr_path, Json::Value &query_data, long expected_response=200, std::string token="") (defined in FDP::API)FDP::API
                            get_request(const std::string &addr_path, long expected_response=200, std::string token="")FDP::API
                            get_url_root() constFDP::APIinline
                            json_to_query_string(Json::Value &json_value)FDP::API
                            patch(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=200) (defined in FDP::API)FDP::API
                            post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)FDP::API
                            post_storage_root(Json::Value &post_data, const std::string &token) (defined in FDP::API)FDP::API
                            remove_leading_forward_slash(std::string str)FDP::APIstatic
                            sptr typedef (defined in FDP::API)FDP::API
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/class_f_d_p_1_1_api_object-members.html b/class_f_d_p_1_1_api_object-members.html deleted file mode 100644 index e6aa2db..0000000 --- a/class_f_d_p_1_1_api_object-members.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            FDP::ApiObject Member List
                            -
                            -
                            - -

                            This is the complete list of members for FDP::ApiObject, including all inherited members.

                            - - - - - - - - - - - - - - - - - - - -
                            add(const std::string &key, int value) (defined in FDP::ApiObject)FDP::ApiObject
                            add(const std::string &key, float value) (defined in FDP::ApiObject)FDP::ApiObject
                            add(const std::string &key, double value) (defined in FDP::ApiObject)FDP::ApiObject
                            add(const std::string &key, const std::string &value) (defined in FDP::ApiObject)FDP::ApiObject
                            add(const std::string &key, const ApiObject &value) (defined in FDP::ApiObject)FDP::ApiObject
                            ApiObject() (defined in FDP::ApiObject)FDP::ApiObjectprotected
                            construct(void)FDP::ApiObjectstatic
                            from_json(const Json::Value &j) (defined in FDP::ApiObject)FDP::ApiObjectstatic
                            get_first_component() constFDP::ApiObject
                            get_id()FDP::ApiObject
                            get_id_from_string(std::string url)FDP::ApiObjectstatic
                            get_type()FDP::ApiObject
                            get_uri() constFDP::ApiObject
                            get_value_as_int(const std::string &key) constFDP::ApiObject
                            get_value_as_string(const std::string &key) constFDP::ApiObject
                            is_empty()FDP::ApiObject
                            remove(const std::string &key) (defined in FDP::ApiObject)FDP::ApiObject
                            sptr typedef (defined in FDP::ApiObject)FDP::ApiObject
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/class_f_d_p_1_1_config-members.html b/class_f_d_p_1_1_config-members.html deleted file mode 100644 index 1c48675..0000000 --- a/class_f_d_p_1_1_config-members.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            FDP::Config Member List
                            -
                            -
                            - -

                            This is the complete list of members for FDP::Config, including all inherited members.

                            - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            config_reads_() constFDP::Config
                            config_writes_() constFDP::Config
                            construct(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location) (defined in FDP::Config)FDP::Configstatic
                            finalise()FDP::Config
                            get_api() constFDP::Configinline
                            get_api_url() constFDP::Configinline
                            get_code_run_uuid() constFDP::Config
                            get_config_data() constFDP::Configinline
                            get_config_directory() constFDP::Config
                            get_config_file_path() constFDP::Configinline
                            get_data_store() constFDP::Config
                            get_default_input_namespace() constFDP::Config
                            get_default_output_namespace() constFDP::Config
                            get_rest_api_location() constFDP::Configinline
                            get_script_file_path() constFDP::Configinline
                            get_token() constFDP::Configinline
                            has_inputs() constFDP::Config
                            has_outputs() constFDP::Config
                            has_reads() constFDP::Config
                            has_writes() constFDP::Config
                            link_read(std::string &data_product)FDP::Config
                            link_write(std::string &data_product)FDP::Config
                            meta_data_() constFDP::Config
                            parse_yaml(ghc::filesystem::path yaml_path)FDP::Configstatic
                            sptr typedef (defined in FDP::Config)FDP::Config
                            ~Config()FDP::Config
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/class_f_d_p_1_1_data_pipeline-members.html b/class_f_d_p_1_1_data_pipeline-members.html deleted file mode 100644 index 610e0ed..0000000 --- a/class_f_d_p_1_1_data_pipeline-members.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            FDP::DataPipeline Member List
                            -
                            -
                            - -

                            This is the complete list of members for FDP::DataPipeline, including all inherited members.

                            - - - - - - - - - - -
                            DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)FDP::DataPipelineexplicit
                            DataPipeline(DataPipeline &&rhs) noexcept (defined in FDP::DataPipeline)FDP::DataPipeline
                            DataPipeline(const DataPipeline &rhs) (defined in FDP::DataPipeline)FDP::DataPipeline
                            finalise()FDP::DataPipeline
                            link_read(std::string &data_product)FDP::DataPipeline
                            link_write(std::string &data_product)FDP::DataPipeline
                            operator=(DataPipeline &&rhs) noexcept (defined in FDP::DataPipeline)FDP::DataPipeline
                            operator=(const DataPipeline &rhs) (defined in FDP::DataPipeline)FDP::DataPipeline
                            ~DataPipeline()FDP::DataPipeline
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/class_f_d_p_1_1_i_o_object-members.html b/class_f_d_p_1_1_i_o_object-members.html deleted file mode 100644 index 5663a1e..0000000 --- a/class_f_d_p_1_1_i_o_object-members.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            FDP::IOObject Member List
                            -
                            -
                            - -

                            This is the complete list of members for FDP::IOObject, including all inherited members.

                            - - - - - - - - - - - - - - - - - -
                            get_component_description()FDP::IOObjectinline
                            get_component_object() constFDP::IOObjectinline
                            get_data_product() constFDP::IOObjectinline
                            get_data_product_description() constFDP::IOObjectinline
                            get_data_product_object() constFDP::IOObjectinline
                            get_path() constFDP::IOObjectinline
                            get_use_component() constFDP::IOObjectinline
                            get_use_data_product() constFDP::IOObjectinline
                            get_use_namespace()FDP::IOObjectinline
                            get_use_version() constFDP::IOObjectinline
                            IOObject()=defaultFDP::IOObject
                            IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)FDP::IOObjectinline
                            IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)FDP::IOObjectinline
                            is_public() constFDP::IOObjectinline
                            set_component_object(ApiObject &component_obj)FDP::IOObjectinline
                            set_data_product_object(ApiObject &data_product_obj)FDP::IOObjectinline
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/class_f_d_p_1_1_versioning_1_1version-members.html b/class_f_d_p_1_1_versioning_1_1version-members.html deleted file mode 100644 index 818e1da..0000000 --- a/class_f_d_p_1_1_versioning_1_1version-members.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
                            -
                            - - - - - - -
                            -
                            cppDataPipeline 0.3.0 -
                            -
                            C++ Implementation of the FAIR Data Pipeline API
                            -
                            -
                            - - - - - - - - -
                            -
                            - - -
                            - -
                            - - -
                            -
                            -
                            FDP::Versioning::version Member List
                            -
                            -
                            - -

                            This is the complete list of members for FDP::Versioning::version, including all inherited members.

                            - - - - - - - - - - - - - - - - - - - - -
                            alpha() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            beta() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            bump_major() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            bump_minor() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            bump_patch() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            operator!= (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            operator< (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            operator<< (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            operator<= (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            operator== (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            operator> (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            operator>= (defined in FDP::Versioning::version)FDP::Versioning::versionfriend
                            prerelease() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            release() (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            to_string() const (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            version()=defaultFDP::Versioning::version
                            version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")FDP::Versioning::versioninline
                            version(const std::string version_str) (defined in FDP::Versioning::version)FDP::Versioning::version
                            version(const version &v) (defined in FDP::Versioning::version)FDP::Versioning::versioninline
                            - -
                            -Generated by doxygen 1.9.2 -
                            - - diff --git a/class_f_d_p_1_1config__parsing__error.png b/class_f_d_p_1_1config__parsing__error.png deleted file mode 100644 index 5cdd69ce549046b406fc469c3b392294ec111f6c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 645 zcmeAS@N?(olHy`uVBq!ia0vp^i-9D2pH{!6NUX>K); zkCsx&oNjo0+fB2$SN>{0lXve*O8K4V2 z-95V|_e~Oc{w^b}ESKTjQ?`P_x&t4}cJF(_Z*fmlU;ig}U*vU$^a*_og_i^s{H&Oc zc)B-OyyOs2mt}mkMA>0Z2}{Rhgyc_u*|TT#_}B_Ep{iH*6|+t)&SkK8uy)e#Vxw7$ z_sWzF{5B*=e zZP)&l{%%|MXU28UFD*8;d3*fa#@qdQYUhvD9-3eE{qsHE7iBZwe^Tmabhm%L?OHTr z?D>4Fb#Ys^CWlS^zAV}Pg!azIe|PL%z5Uzc9m#*~wkbYa`nh!Py6(5T)-5d;xo~Pn zZtv8CmhwBFFJ-oP(0hH}!yPq-r-gWWuCp`96nV+*Ht+2*UsASC`2aiAH4f^YGTk|6{o^Rj&b>X}6P8RgmY)3U>bzHvXH;pJE9>81{d1S9<0Ln| zoT>npv%l>p{}C0R?xQ@(q;O|Yee&kNf1IwCsa)<*@r`l$IQihb^JmWs)L%cgr0(yA zj}Mh^R@CM#y*2NXEbqrxo4uzN_yIZ{9N1p zBCk00Z%X)tzdgP7@r37bw^hC?UQN6z_RHe=4#}KnJ2EYw-~A!?yvOqV{x2(c%$dDW zG5lxFg<6;6EIiIqpYCsw4Aa^)Q_4Q`Nq_FKea{%Ua+dA*D0(k?W!b$ma+l{x?S5IA z%N+A|<-R$=@#|$ZuP=RPHSOMJP4*v`&9V#|yyLc1UXwk*`@~#EK`oadY1(E(;M1& diff --git a/class_f_d_p_1_1rest__apiquery__error.png b/class_f_d_p_1_1rest__apiquery__error.png deleted file mode 100644 index 7077bcba3a0b2ceae269e903b0a9ac940da5f74c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 651 zcmeAS@N?(olHy`uVBq!ia0vp^bAUL2gBeKP_Ia}bNJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?y~NqM?BhEy=VoqMzFumTUOyZ+Aq|Bv^Y zPuO#$@6qK;!cqOs1`iw;eCV1PxjJFe6}4EuNk%1>o~H^t^YT8ediwe1-_3gh{U*J8 z>T|Abf{(en!Ibv=FK%{N}OSOs#C`a7EAGb56_*SsxVDwXtlTqu`g~m3M3I zuXLL9&2su`>8$6u{|>9vzcrukBj{=M;MAtHCvEooSDm()q^ab|K1cnCr$(Rh_OsJw zKlNF4-R)ey?a4=9vrk8Dy1L&yr}lrvt4*`lZq3*AzGQd5x~8|Y;8U@pr~8-Yc!)DE zJXO&=9DMG~nm~rUCyW=gbWhvL@!sC5^Svbd`nt@W^VTw0?vin6(_^2o@HAt}iy{U| z+}s~(md2aI4l>+Y0#({|XO7(E^py-24_@5toxHZF?#;t6E(YsAPDj2!ZTsz&mlM$x z)#ZI`-ZLfxOFLN#-7cg6U}dzW)HSBVO%@0s-3|Ip*qdxhs& zckX!Z<$hg7uP9)BqEW)xG!FwMai#5(qSZFU&J!=nyH`aceIRdr|#YH{E*wNsny0sPs{T*&vx22E!H}`|G#3ichHZIho=0UZ1C@|`Vlo} zhHHDiZu5V#%z5dT{Yv5I=S^RJe!k1Qv*myLo8=dng8YB&>6tT9PuaV!#LU=y@b4aA P%3<(y^>bP0l+XkKF{L}K diff --git a/class_f_d_p_1_1sync__error.png b/class_f_d_p_1_1sync__error.png deleted file mode 100644 index 116ee2e84fd5540855b43ac2972d3618ccd4fa69..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 521 zcmV+k0`~ohP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0004)Nkl7**p)`_Re#a!EKZ(CI!k~%wj^Qq%g&y8^g&oil((#p-&x=*Sw{q(Av z_f3WauO3b(fPa|eOMkdzYIVP#XL#$+Z)c7pnOYt5<;8>_ukSvYUh_<<<&Ni%QL?sN z+0T-nK2(z#{_o_{&Clvv+rRgFwqI_N^j!0Pkfb?{*st z9L!sALxH1te?C7a45IHQf6}uU00QNC{<&7A0T84|ytO{?wzckB-0~K*uX2f*Drb0~XW&Z;Q?43A z|NI(WbAH9_u|O?u{b00ucYS`h8ditrCw!fkeIN6B3HK)NFwC#)!0VjfhrIIs9Z2;A zT_$w%vs7)MQ{R_sFXYF(&hUJ*0ldl>o`DCNntd%00000 LNkvXXu0mjf-)8x7 diff --git a/class_f_d_p_1_1validation__error.png b/class_f_d_p_1_1validation__error.png deleted file mode 100644 index ddce92693b4852486811e78e7695f19c1a1ae888..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 571 zcmV-B0>u4^P)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0005XNklsV>Nr?ITFoxb@W_GzSNxE1`kra|N>YSqb ze}eq3d(RqPrI4i8wWP3Zk>%lL+REG49)Y7t`KUm9A2&*I_BPHT$=Qm+q;9Qr6r;DI zHWClryZOGwA<5YZMc?$ru>NI|w{>&L6eY>q>5lw|V*B|GImVGpQIfo!WapE`oyTHM z-TzXU)NP{h=^s}wtUOu)U{IKQDgpdW zYl^n8HuS+&;!~^ZIX_|;8iY6=;Vm6&Yd8CIie~XuZQ=9&aS8Pi98+EdijWt*3ZvVZ z&sBMf@uM&O$5>2TS5r7lweSrTeuZzKSVsR>v6wRdIYk^~u6UjoukJ{@FNS-d25CPE z^BLI>ML0x$8GguPW8)kje}k9%_!kr8zgbcMj7o|?VP9#0p?kP61Pb1zP6R^V~jnL9Z&AF^~j6*b=6ct|C4#w2ym!e0jYFXtRJ`1{SRV|&G`90>U)shmiFPE41>f4$hle9U%BrGdC_uDnq6{o&DG&O%8%_ALWJ*S!T&taAL zzIN|ralilWIXv6G&iZ<#O7QyJeK9P5s%n3y?0Poy%BjBR{eheI?b$rv)c$WsY}$|c z-KP`l%H z%Kvuuli3AUJYhVdS;iD%p2_{o~T- z*M=U*K)2N?H!y1OoazC(G%?8MzudheY7_3!KZTYcZH?6a@>e_8rJ u{q + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                            +
                            + + + + + + +
                            +
                            cppDataPipeline 0.3.0 +
                            +
                            C++ Implementation of the FAIR Data Pipeline API
                            +
                            +
                            + + + + + + + + +
                            +
                            + + +
                            + +
                            + + +
                            +
                            +
                            FairDataPipeline::API Member List
                            +
                            +
                            + +

                            This is the complete list of members for FairDataPipeline::API, including all inherited members.

                            + + + + + + + + + + + + + + +
                            append_with_forward_slash(std::string string)FairDataPipeline::APIstatic
                            construct(const std::string &url_root)FairDataPipeline::APIstatic
                            escape_space(std::string &str)FairDataPipeline::API
                            get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")FairDataPipeline::API
                            get_by_json_query(const std::string &addr_path, Json::Value &query_data, long expected_response=200, std::string token="") (defined in FairDataPipeline::API)FairDataPipeline::API
                            get_request(const std::string &addr_path, long expected_response=200, std::string token="")FairDataPipeline::API
                            get_url_root() constFairDataPipeline::APIinline
                            json_to_query_string(Json::Value &json_value)FairDataPipeline::API
                            patch(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=200) (defined in FairDataPipeline::API)FairDataPipeline::API
                            post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)FairDataPipeline::API
                            post_storage_root(Json::Value &post_data, const std::string &token) (defined in FairDataPipeline::API)FairDataPipeline::API
                            remove_leading_forward_slash(std::string str)FairDataPipeline::APIstatic
                            sptr typedef (defined in FairDataPipeline::API)FairDataPipeline::API
                            + +
                            +Generated by doxygen 1.9.2 +
                            + + diff --git a/class_f_d_p_1_1_a_p_i.html b/class_fair_data_pipeline_1_1_a_p_i.html similarity index 62% rename from class_f_d_p_1_1_a_p_i.html rename to class_fair_data_pipeline_1_1_a_p_i.html index c7374f2..c09bffa 100644 --- a/class_f_d_p_1_1_a_p_i.html +++ b/class_fair_data_pipeline_1_1_a_p_i.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::API Class Reference +cppDataPipeline: FairDataPipeline::API Class Reference @@ -63,7 +63,7 @@

                          @@ -71,72 +71,72 @@ Public Types | Public Member Functions | Static Public Member Functions | -List of all members
                          -
                          FDP::API Class Reference
                          +List of all members +
                          FairDataPipeline::API Class Reference

                          a class which handles the fetching and posting of information to the FDP data pipeline RestAPI - More...

                          + More...

                          #include <fdp/registry/api.hxx>

                          - - + +

                          Public Types

                          -typedef std::shared_ptr< API > sptr
                           
                          +typedef std::shared_ptr< API > sptr
                           
                          - - - - - - - + + + - - - - - + + + + - - + - - - - - - - - - - - - - + + + + + + + + + + + + +

                          Public Member Functions

                           API (std::string url_root)
                           construct an API object using the given URL as the root More...
                           
                          Json::Value get_request (const std::string &addr_path, long expected_response=200, std::string token="")
                           sends the given 'packet' of information to the RestAPI More...
                           
                          +
                          Json::Value get_request (const std::string &addr_path, long expected_response=200, std::string token="")
                           sends the given 'packet' of information to the RestAPI More...
                           
                          Json::Value patch (const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=200)
                           
                          Json::Value post (const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
                           post information from a JSON value object to the RestAPI More...
                           
                          +
                           
                          Json::Value post (const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
                           post information from a JSON value object to the RestAPI More...
                           
                          Json::Value post_storage_root (Json::Value &post_data, const std::string &token)
                           
                          +
                           
                          Json::Value get_by_json_query (const std::string &addr_path, Json::Value &query_data, long expected_response=200, std::string token="")
                           
                          Json::Value get_by_id (const std::string &table, int const &id, long expected_response=200, std::string token="")
                           get an object from the api by it's id More...
                           
                          std::string get_url_root () const
                           returns the root URL for the RestAPI used by the API instance More...
                           
                          std::string json_to_query_string (Json::Value &json_value)
                           Formats a json object into a string representation which can be used as a url endpoint query. More...
                           
                          std::string escape_space (std::string &str)
                           escapes space " " characters within a string with it's html character code (%20) More...
                           
                           
                          Json::Value get_by_id (const std::string &table, int const &id, long expected_response=200, std::string token="")
                           get an object from the api by it's id More...
                           
                          std::string get_url_root () const
                           returns the root URL for the RestAPI used by the API instance More...
                           
                          std::string json_to_query_string (Json::Value &json_value)
                           Formats a json object into a string representation which can be used as a url endpoint query. More...
                           
                          std::string escape_space (std::string &str)
                           escapes space " " characters within a string with it's html character code (%20) More...
                           
                          - - - - - - + + + + + + + + +

                          Static Public Member Functions

                          static std::string append_with_forward_slash (std::string string)
                           Static function to append a given string with a "/" unless the string is empty or already ends with a "/". More...
                           
                          static std::string remove_leading_forward_slash (std::string str)
                           Remove the leading forward slash from a given string. More...
                           
                          static sptr construct (const std::string &url_root)
                           construct an API object using the given URL as the root More...
                           
                          static std::string append_with_forward_slash (std::string string)
                           Static function to append a given string with a "/" unless the string is empty or already ends with a "/". More...
                           
                          static std::string remove_leading_forward_slash (std::string str)
                           Remove the leading forward slash from a given string. More...
                           

                          Detailed Description

                          a class which handles the fetching and posting of information to the FDP data pipeline RestAPI

                          Author
                          K. Zarebski (UKAEA) & R. Field
                          -

                          The API class has know specific knowledge about the RestAPI but rather provides the interface for sending/receiving data as JSON strings

                          -

                          Constructor & Destructor Documentation

                          - -

                          ◆ API()

                          +

                          The API class has know specific knowledge about the RestAPI but rather provides the interface for sending/receiving data as JSON strings

                          +

                          Member Function Documentation

                          + +

                          ◆ append_with_forward_slash()

                          @@ -145,35 +145,33 @@

                          - + - +
                          FDP::API::API std::string FairDataPipeline::API::append_with_forward_slash ( std::string url_root)string)
                          -inline +static

                          -

                          construct an API object using the given URL as the root

                          -
                          -
                          Author
                          K. Zarebski (UKAEA)
                          +

                          Static function to append a given string with a "/" unless the string is empty or already ends with a "/".

                          Parameters
                          - +
                          url_rootthe root of the query address, e.g. localhost:8000/api
                          stringString to be appended with "/"
                          +
                          Returns
                          std::string Appended string
                          -

                          Member Function Documentation

                          - -

                          ◆ append_with_forward_slash()

                          + +

                          ◆ construct()

                          @@ -182,10 +180,10 @@

                          - + - - + +
                          std::string FDP::API::append_with_forward_slash API::sptr FairDataPipeline::API::construct (std::string string)const std::string & url_root)
                          @@ -196,25 +194,26 @@

                          -

                          Static function to append a given string with a "/" unless the string is empty or already ends with a "/".

                          +

                          construct an API object using the given URL as the root

                          +
                          +
                          Author
                          K. Zarebski (UKAEA)
                          Parameters
                          - +
                          stringString to be appended with "/"
                          url_rootthe root of the query address, e.g. localhost:8000/api
                          -
                          Returns
                          std::string Appended string

                          - -

                          ◆ escape_space()

                          + +

                          ◆ escape_space()

                          - + @@ -234,14 +233,14 @@

                          -

                          ◆ get_by_id()

                          + +

                          ◆ get_by_id()

                          std::string FDP::API::escape_space std::string FairDataPipeline::API::escape_space ( std::string &  str)
                          - + @@ -285,14 +284,14 @@

                          -

                          ◆ get_request()

                          + +

                          ◆ get_request()

                          Json::Value FDP::API::get_by_id Json::Value FairDataPipeline::API::get_by_id ( const std::string &  table,
                          - + @@ -330,8 +329,8 @@

                          -

                          ◆ get_url_root()

                          + +

                          ◆ get_url_root()

                          @@ -340,7 +339,7 @@

                          Json::Value FDP::API::get_request Json::Value FairDataPipeline::API::get_request ( const std::string &  addr_path,
                          - + @@ -353,21 +352,21 @@

                          -

                          returns the root URL for the RestAPI used by the API instance

                          +

                          returns the root URL for the RestAPI used by the API instance

                          Author
                          K. Zarebski (UKAEA)
                          Returns
                          URL of the RestAPI query endpoint
                          - -

                          ◆ json_to_query_string()

                          + +

                          ◆ json_to_query_string()

                          std::string FDP::API::get_url_root std::string FairDataPipeline::API::get_url_root ( ) const
                          - + @@ -387,14 +386,14 @@

                          -

                          ◆ post()

                          + +

                          ◆ post()

                          std::string FDP::API::json_to_query_string std::string FairDataPipeline::API::json_to_query_string ( Json::Value &  json_value)
                          - + @@ -437,12 +436,12 @@

                          Returns
                          the result of the API post as a JSON object
                          +
                          Returns
                          the result of the API post as a JSON object
                          - -

                          ◆ remove_leading_forward_slash()

                          + +

                          ◆ remove_leading_forward_slash()

                          @@ -451,7 +450,7 @@

                          Json::Value FDP::API::post Json::Value FairDataPipeline::API::post ( const std::string  addr_path,
                          - + diff --git a/class_fair_data_pipeline_1_1_api_object-members.html b/class_fair_data_pipeline_1_1_api_object-members.html new file mode 100644 index 0000000..f1431ab --- /dev/null +++ b/class_fair_data_pipeline_1_1_api_object-members.html @@ -0,0 +1,100 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                          +
                          +
                          std::string FDP::API::remove_leading_forward_slash std::string FairDataPipeline::API::remove_leading_forward_slash ( std::string  str)
                          + + + + + +
                          +
                          cppDataPipeline 0.3.0 +
                          +
                          C++ Implementation of the FAIR Data Pipeline API
                          +
                          +
                          + + + + + + + + +
                          +
                          + + +
                          + +
                          + +                           +
                          +
                          +
                          FairDataPipeline::ApiObject Member List
                          +
                          +
                          + +

                          This is the complete list of members for FairDataPipeline::ApiObject, including all inherited members.

                          + + + + + + + + + + + + + + + + + + + +
                          add(const std::string &key, int value) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          add(const std::string &key, float value) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          add(const std::string &key, double value) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          add(const std::string &key, const std::string &value) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          add(const std::string &key, const ApiObject &value) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          ApiObject() (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObjectprotected
                          construct(void)FairDataPipeline::ApiObjectstatic
                          from_json(const Json::Value &j) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObjectstatic
                          get_first_component() constFairDataPipeline::ApiObject
                          get_id() constFairDataPipeline::ApiObject
                          get_id_from_string(std::string url)FairDataPipeline::ApiObjectstatic
                          get_type() constFairDataPipeline::ApiObject
                          get_uri() constFairDataPipeline::ApiObject
                          get_value_as_int(const std::string &key) constFairDataPipeline::ApiObject
                          get_value_as_string(const std::string &key) constFairDataPipeline::ApiObject
                          is_empty()FairDataPipeline::ApiObject
                          remove(const std::string &key) (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          sptr typedef (defined in FairDataPipeline::ApiObject)FairDataPipeline::ApiObject
                          + +
                          +Generated by doxygen 1.9.2 +
                          + + diff --git a/class_f_d_p_1_1_api_object.html b/class_fair_data_pipeline_1_1_api_object.html similarity index 54% rename from class_f_d_p_1_1_api_object.html rename to class_fair_data_pipeline_1_1_api_object.html index 71621b7..eef6d96 100644 --- a/class_f_d_p_1_1_api_object.html +++ b/class_fair_data_pipeline_1_1_api_object.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::ApiObject Class Reference +cppDataPipeline: FairDataPipeline::ApiObject Class Reference @@ -63,7 +63,7 @@
                        @@ -71,81 +71,81 @@ Public Types | Public Member Functions | Static Public Member Functions | -List of all members
                        -
                        FDP::ApiObject Class Reference
                        +List of all members +
                        FairDataPipeline::ApiObject Class Reference
                        -

                        Class for API objects. - More...

                        +

                        Class for API objects. + More...

                        #include <fdp/objects/api_object.hxx>

                        - - + +

                        Public Types

                        -typedef std::shared_ptr< ApiObject > sptr
                         
                        +typedef std::shared_ptr< ApiObject > sptr
                         
                        - - - + - - + - - + - - - - + + + - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

                        Public Member Functions

                        +
                        int add (const std::string &key, int value)
                         
                        +
                         
                        int add (const std::string &key, float value)
                         
                        +
                         
                        int add (const std::string &key, double value)
                         
                        +
                         
                        int add (const std::string &key, const std::string &value)
                         
                        -int add (const std::string &key, const ApiObject &value)
                         
                        +
                         
                        +int add (const std::string &key, const ApiObject &value)
                         
                        int remove (const std::string &key)
                         
                        int get_id ()
                         Get the object id from the uri. More...
                         
                        std::string get_type ()
                         Returns the object type from the object uri_ (table) More...
                         
                        std::string get_uri () const
                         Get the object uri. More...
                         
                        std::string get_value_as_string (const std::string &key) const
                         Get the value of a given key as string object. More...
                         
                        int get_value_as_int (const std::string &key) const
                         Get the value of a given key as int object. More...
                         
                        std::string get_first_component () const
                         Get the first component of the object. More...
                         
                        bool is_empty ()
                         Check to see if the object is empty. More...
                         
                         
                        int get_id () const
                         Get the object id from the uri. More...
                         
                        std::string get_type () const
                         Returns the object type from the object uri_ (table) More...
                         
                        std::string get_uri () const
                         Get the object uri. More...
                         
                        std::string get_value_as_string (const std::string &key) const
                         Get the value of a given key as string object. More...
                         
                        int get_value_as_int (const std::string &key) const
                         Get the value of a given key as int object. More...
                         
                        std::string get_first_component () const
                         Get the first component of the object. More...
                         
                        bool is_empty ()
                         Check to see if the object is empty. More...
                         
                        - - - - - - - - + + + + + + +

                        Static Public Member Functions

                        +
                        static sptr from_json (const Json::Value &j)
                         
                        static ApiObject::sptr construct (void)
                         Construct a new Api Object object. More...
                         
                        static int get_id_from_string (std::string url)
                         Get the object type from the uri. More...
                         
                         
                        static ApiObject::sptr construct (void)
                         Construct a new Api Object object. More...
                         
                        static int get_id_from_string (std::string url)
                         Get the object type from the uri. More...
                         

                        Detailed Description

                        -

                        Class for API objects.

                        +

                        Class for API objects.

                        Member Function Documentation

                        - -

                        ◆ construct()

                        + +

                        ◆ construct()

                        @@ -154,7 +154,7 @@

                        - + @@ -178,14 +178,14 @@

                        -

                        ◆ get_first_component()

                        + +

                        ◆ get_first_component()

                        ApiObject::sptr FDP::ApiObject::construct ApiObject::sptr FairDataPipeline::ApiObject::construct ( void  )
                         - + @@ -198,17 +198,17 @@

                        -

                        ◆ get_id()

                        + +

                        ◆ get_id()

                        std::string FDP::ApiObject::get_first_component std::string FairDataPipeline::ApiObject::get_first_component ( ) const
                        - + - +
                        int FDP::ApiObject::get_id int FairDataPipeline::ApiObject::get_id ( ) const

                        @@ -221,8 +221,8 @@

                        -

                        ◆ get_id_from_string()

                        + +

                        ◆ get_id_from_string()

                        @@ -231,7 +231,7 @@

                        - + @@ -250,17 +250,17 @@

                        -

                        ◆ get_type()

                        + +

                        ◆ get_type()

                        int FDP::ApiObject::get_id_from_string int FairDataPipeline::ApiObject::get_id_from_string ( std::string  url)
                         - + - +
                        std::string FDP::ApiObject::get_type std::string FairDataPipeline::ApiObject::get_type ( ) const

                        @@ -270,14 +270,14 @@

                        -

                        ◆ get_uri()

                        + +

                        ◆ get_uri()

                        - + @@ -290,14 +290,14 @@

                        -

                        ◆ get_value_as_int()

                        + +

                        ◆ get_value_as_int()

                        std::string FDP::ApiObject::get_uri std::string FairDataPipeline::ApiObject::get_uri ( ) const
                        - + @@ -317,14 +317,14 @@

                        -

                        ◆ get_value_as_string()

                        + +

                        ◆ get_value_as_string()

                        int FDP::ApiObject::get_value_as_int int FairDataPipeline::ApiObject::get_value_as_int ( const std::string &  key)
                        - + @@ -344,14 +344,14 @@

                        -

                        ◆ is_empty()

                        + +

                        ◆ is_empty()

                        std::string FDP::ApiObject::get_value_as_string std::string FairDataPipeline::ApiObject::get_value_as_string ( const std::string &  key)
                        - + diff --git a/class_fair_data_pipeline_1_1_config-members.html b/class_fair_data_pipeline_1_1_config-members.html new file mode 100644 index 0000000..bcdcef9 --- /dev/null +++ b/class_fair_data_pipeline_1_1_config-members.html @@ -0,0 +1,109 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                        +
                        +
                        bool FDP::ApiObject::is_empty bool FairDataPipeline::ApiObject::is_empty ( )
                        + + + + + +
                        +
                        cppDataPipeline 0.3.0 +
                        +
                        C++ Implementation of the FAIR Data Pipeline API
                        +
                        +
                        + + + + + + + + +
                        +
                        + + +
                        + +
                        + + +
                        +
                        +
                        FairDataPipeline::Config Member List
                        +
                        +
                        + +

                        This is the complete list of members for FairDataPipeline::Config, including all inherited members.

                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                        config_reads_() constFairDataPipeline::Config
                        config_writes_() constFairDataPipeline::Config
                        construct(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location) (defined in FairDataPipeline::Config)FairDataPipeline::Configstatic
                        finalise()FairDataPipeline::Config
                        get_api() constFairDataPipeline::Configinline
                        get_api_url() constFairDataPipeline::Configinline
                        get_code_run_uuid() constFairDataPipeline::Config
                        get_config_data() constFairDataPipeline::Configinline
                        get_config_directory() constFairDataPipeline::Config
                        get_config_file_path() constFairDataPipeline::Configinline
                        get_data_store() constFairDataPipeline::Config
                        get_default_input_namespace() constFairDataPipeline::Config
                        get_default_output_namespace() constFairDataPipeline::Config
                        get_rest_api_location() constFairDataPipeline::Configinline
                        get_script_file_path() constFairDataPipeline::Configinline
                        get_token() constFairDataPipeline::Configinline
                        has_inputs() constFairDataPipeline::Config
                        has_outputs() constFairDataPipeline::Config
                        has_reads() constFairDataPipeline::Config
                        has_writes() constFairDataPipeline::Config
                        link_read(const std::string &data_product)FairDataPipeline::Config
                        link_write(const std::string &data_product)FairDataPipeline::Config
                        map_type typedef (defined in FairDataPipeline::Config)FairDataPipeline::Config
                        meta_data_() constFairDataPipeline::Config
                        parse_yaml(ghc::filesystem::path yaml_path)FairDataPipeline::Configstatic
                        sptr typedef (defined in FairDataPipeline::Config)FairDataPipeline::Config
                        ~Config()FairDataPipeline::Config
                        + +
                        +Generated by doxygen 1.9.2 +
                        + + diff --git a/class_f_d_p_1_1_config.html b/class_fair_data_pipeline_1_1_config.html similarity index 51% rename from class_f_d_p_1_1_config.html rename to class_fair_data_pipeline_1_1_config.html index 734eb49..77f8122 100644 --- a/class_f_d_p_1_1_config.html +++ b/class_fair_data_pipeline_1_1_config.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::Config Class Reference +cppDataPipeline: FairDataPipeline::Config Class Reference @@ -63,7 +63,7 @@

                      @@ -71,116 +71,119 @@ Public Types | Public Member Functions | Static Public Member Functions | -List of all members
                      -
                      FDP::Config Class Reference
                      +List of all members +
                      FairDataPipeline::Config Class Reference

                      class for interacting with confifurations - More...

                      + More...

                      #include <fdp/objects/config.hxx>

                      - - + + + +

                      Public Types

                      -typedef std::shared_ptr< Config > sptr
                       
                      +typedef std::shared_ptr< Config > sptr
                       
                      +typedef std::map< std::string, IOObject > map_type
                       
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + +

                      Public Member Functions

                      +
                       ~Config ()
                       Destroy the Config object.
                       
                      YAML::Node meta_data_ () const
                       Returns the meta_data Yaml Node from the config. More...
                       
                      YAML::Node config_writes_ () const
                       Returns the writes Yaml Node from the config. More...
                       
                      YAML::Node config_reads_ () const
                       Returns the reads Yaml Node from the config. More...
                       
                      bool has_reads () const
                       Check whether the config has reads. More...
                       
                      bool has_writes () const
                       Check whether the config has writes. More...
                       
                      bool has_outputs () const
                       Check whether any outputs have been added. More...
                       
                      bool has_inputs () const
                       Check whether any inputs have been added. More...
                       
                      ghc::filesystem::path get_config_file_path () const
                       Get the config file path object. More...
                       
                      ghc::filesystem::path get_script_file_path () const
                       Get the script file path object. More...
                       
                      std::string get_token () const
                       Get the token as a string. More...
                       
                      std::string get_api_url () const
                       Get the api url. More...
                       
                      ghc::filesystem::path get_data_store () const
                       Get the data store path. More...
                       
                      std::string get_default_input_namespace () const
                       Get the default input namespace. More...
                       
                      std::string get_default_output_namespace () const
                       Get the default output namespace. More...
                       
                      std::string get_config_directory () const
                       Get the config directory path as a string. More...
                       
                      std::string get_code_run_uuid () const
                       Get the code run uuid. More...
                       
                      ghc::filesystem::path link_write (std::string &data_product)
                       Provide a tempory file path for a given data product to be written whilst recording metadata. More...
                       
                      ghc::filesystem::path link_read (std::string &data_product)
                       Return the filepath to a given data product. More...
                       
                      +
                       Destroy the Config object.
                       
                      YAML::Node meta_data_ () const
                       Returns the meta_data Yaml Node from the config. More...
                       
                      YAML::Node config_writes_ () const
                       Returns the writes Yaml Node from the config. More...
                       
                      YAML::Node config_reads_ () const
                       Returns the reads Yaml Node from the config. More...
                       
                      bool has_reads () const
                       Check whether the config has reads. More...
                       
                      bool has_writes () const
                       Check whether the config has writes. More...
                       
                      bool has_outputs () const
                       Check whether any outputs have been added. More...
                       
                      bool has_inputs () const
                       Check whether any inputs have been added. More...
                       
                      ghc::filesystem::path get_config_file_path () const
                       Get the config file path object. More...
                       
                      ghc::filesystem::path get_script_file_path () const
                       Get the script file path object. More...
                       
                      std::string get_token () const
                       Get the token as a string. More...
                       
                      std::string get_api_url () const
                       Get the api url. More...
                       
                      ghc::filesystem::path get_data_store () const
                       Get the data store path. More...
                       
                      std::string get_default_input_namespace () const
                       Get the default input namespace. More...
                       
                      std::string get_default_output_namespace () const
                       Get the default output namespace. More...
                       
                      std::string get_config_directory () const
                       Get the config directory path as a string. More...
                       
                      std::string get_code_run_uuid () const
                       Get the code run uuid. More...
                       
                      ghc::filesystem::path link_write (const std::string &data_product)
                       Provide a tempory file path for a given data product to be written whilst recording metadata. More...
                       
                      ghc::filesystem::path link_read (const std::string &data_product)
                       Return the filepath to a given data product. More...
                       
                      void finalise ()
                       Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their new filename(s): <file hash>.<extension>
                       
                      YAML::Node get_config_data () const
                       Get the config data as a Yaml Node. More...
                       
                      API::sptr get_api () const
                       Get the api object (used to interact with the pipeline directly) More...
                       
                      RESTAPI get_rest_api_location () const
                       Get the rest api location (local / remote) More...
                       
                       Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their new filename(s): <file hash>.<extension>
                       
                      YAML::Node get_config_data () const
                       Get the config data as a Yaml Node. More...
                       
                      API::sptr get_api () const
                       Get the api object (used to interact with the pipeline directly) More...
                       
                      RESTAPI get_rest_api_location () const
                       Get the rest api location (local / remote) More...
                       
                      - - - - - + + + + +

                      Static Public Member Functions

                      -static Config::sptr construct (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
                       
                      static YAML::Node parse_yaml (ghc::filesystem::path yaml_path)
                       Read a given yaml file into a Yaml Node. More...
                       
                      +static Config::sptr construct (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &script_file_path, const std::string &token, RESTAPI api_location)
                       
                      static YAML::Node parse_yaml (ghc::filesystem::path yaml_path)
                       Read a given yaml file into a Yaml Node. More...
                       

                      Detailed Description

                      class for interacting with confifurations

                      Member Function Documentation

                      - -

                      ◆ config_reads_()

                      + +

                      ◆ config_reads_()

                      - + @@ -193,14 +196,14 @@

                      -

                      ◆ config_writes_()

                      + +

                      ◆ config_writes_()

                      YAML::Node FDP::Config::config_reads_ YAML::Node FairDataPipeline::Config::config_reads_ ( ) const
                      - + @@ -213,8 +216,8 @@

                      -

                      ◆ get_api()

                      + +

                      ◆ get_api()

                      @@ -223,7 +226,7 @@

                      YAML::Node FDP::Config::config_writes_ YAML::Node FairDataPipeline::Config::config_writes_ ( ) const
                      - + @@ -241,8 +244,8 @@

                      -

                      ◆ get_api_url()

                      + +

                      ◆ get_api_url()

                      @@ -251,7 +254,7 @@

                      API::sptr FDP::Config::get_api API::sptr FairDataPipeline::Config::get_api ( ) const
                      - + @@ -269,14 +272,14 @@

                      -

                      ◆ get_code_run_uuid()

                      + +

                      ◆ get_code_run_uuid()

                      std::string FDP::Config::get_api_url std::string FairDataPipeline::Config::get_api_url ( ) const
                      - + @@ -289,8 +292,8 @@

                      -

                      ◆ get_config_data()

                      + +

                      ◆ get_config_data()

                      @@ -299,7 +302,7 @@

                      std::string FDP::Config::get_code_run_uuid std::string FairDataPipeline::Config::get_code_run_uuid ( ) const
                      - + @@ -317,14 +320,14 @@

                      -

                      ◆ get_config_directory()

                      + +

                      ◆ get_config_directory()

                      YAML::Node FDP::Config::get_config_data YAML::Node FairDataPipeline::Config::get_config_data ( ) const
                      - + @@ -337,8 +340,8 @@

                      -

                      ◆ get_config_file_path()

                      + +

                      ◆ get_config_file_path()

                      @@ -347,7 +350,7 @@

                      std::string FDP::Config::get_config_directory std::string FairDataPipeline::Config::get_config_directory ( ) const
                      - + @@ -365,14 +368,14 @@

                      -

                      ◆ get_data_store()

                      + +

                      ◆ get_data_store()

                      ghc::filesystem::path FDP::Config::get_config_file_path ghc::filesystem::path FairDataPipeline::Config::get_config_file_path ( ) const
                      - + @@ -385,14 +388,14 @@

                      -

                      ◆ get_default_input_namespace()

                      + +

                      ◆ get_default_input_namespace()

                      ghc::filesystem::path FDP::Config::get_data_store ghc::filesystem::path FairDataPipeline::Config::get_data_store ( ) const
                      - + @@ -405,14 +408,14 @@

                      -

                      ◆ get_default_output_namespace()

                      + +

                      ◆ get_default_output_namespace()

                      std::string FDP::Config::get_default_input_namespace std::string FairDataPipeline::Config::get_default_input_namespace ( ) const
                      - + @@ -425,8 +428,8 @@

                      -

                      ◆ get_rest_api_location()

                      + +

                      ◆ get_rest_api_location()

                      @@ -435,7 +438,7 @@

                      std::string FDP::Config::get_default_output_namespace std::string FairDataPipeline::Config::get_default_output_namespace ( ) const
                      - + @@ -453,8 +456,8 @@

                      -

                      ◆ get_script_file_path()

                      + +

                      ◆ get_script_file_path()

                      @@ -463,7 +466,7 @@

                      RESTAPI FDP::Config::get_rest_api_location RESTAPI FairDataPipeline::Config::get_rest_api_location ( ) const
                      - + @@ -483,8 +486,8 @@

                      -

                      ◆ get_token()

                      + +

                      ◆ get_token()

                      @@ -493,7 +496,7 @@

                      ghc::filesystem::path FDP::Config::get_script_file_path ghc::filesystem::path FairDataPipeline::Config::get_script_file_path ( ) const
                      - + @@ -511,14 +514,14 @@

                      -

                      ◆ has_inputs()

                      + +

                      ◆ has_inputs()

                      std::string FDP::Config::get_token std::string FairDataPipeline::Config::get_token ( ) const
                      - + @@ -533,14 +536,14 @@

                      -

                      ◆ has_outputs()

                      + +

                      ◆ has_outputs()

                      bool FDP::Config::has_inputs bool FairDataPipeline::Config::has_inputs ( ) const
                      - + @@ -555,14 +558,14 @@

                      -

                      ◆ has_reads()

                      + +

                      ◆ has_reads()

                      bool FDP::Config::has_outputs bool FairDataPipeline::Config::has_outputs ( ) const
                      - + @@ -577,14 +580,14 @@

                      -

                      ◆ has_writes()

                      + +

                      ◆ has_writes()

                      bool FDP::Config::has_reads bool FairDataPipeline::Config::has_reads ( ) const
                      - + @@ -599,16 +602,16 @@

                      -

                      ◆ link_read()

                      + +

                      ◆ link_read()

                      bool FDP::Config::has_writes bool FairDataPipeline::Config::has_writes ( ) const
                      - + - + @@ -626,16 +629,16 @@

                      -

                      ◆ link_write()

                      + +

                      ◆ link_write()

                      ghc::filesystem::path FDP::Config::link_read ghc::filesystem::path FairDataPipeline::Config::link_read (std::string & const std::string &  data_product)
                      - + - + @@ -653,14 +656,14 @@

                      -

                      ◆ meta_data_()

                      + +

                      ◆ meta_data_()

                      ghc::filesystem::path FDP::Config::link_write ghc::filesystem::path FairDataPipeline::Config::link_write (std::string & const std::string &  data_product)
                      - + @@ -673,8 +676,8 @@

                      -

                      ◆ parse_yaml()

                      + +

                      ◆ parse_yaml()

                      @@ -683,7 +686,7 @@

                      YAML::Node FDP::Config::meta_data_ YAML::Node FairDataPipeline::Config::meta_data_ ( ) const
                      - + diff --git a/class_fair_data_pipeline_1_1_data_pipeline-members.html b/class_fair_data_pipeline_1_1_data_pipeline-members.html new file mode 100644 index 0000000..f8c1029 --- /dev/null +++ b/class_fair_data_pipeline_1_1_data_pipeline-members.html @@ -0,0 +1,88 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                      +
                      +
                      YAML::Node FDP::Config::parse_yaml YAML::Node FairDataPipeline::Config::parse_yaml ( ghc::filesystem::path  yaml_path)
                      + + + + + +
                      +
                      cppDataPipeline 0.3.0 +
                      +
                      C++ Implementation of the FAIR Data Pipeline API
                      +
                      +
                      + + + + + + + + +
                      +
                      + + +
                      + +
                      + +                       +
                      +
                      +
                      FairDataPipeline::DataPipeline Member List
                      +
                      +
                      + +

                      This is the complete list of members for FairDataPipeline::DataPipeline, including all inherited members.

                      + + + + + + + +
                      construct(const std::string &config_file_path, const std::string &script_file_path, std::string token="")FairDataPipeline::DataPipelinestatic
                      finalise()FairDataPipeline::DataPipeline
                      link_read(std::string &data_product)FairDataPipeline::DataPipeline
                      link_write(std::string &data_product)FairDataPipeline::DataPipeline
                      sptr typedef (defined in FairDataPipeline::DataPipeline)FairDataPipeline::DataPipeline
                      ~DataPipeline()FairDataPipeline::DataPipeline
                      + +
                      +Generated by doxygen 1.9.2 +
                      + + diff --git a/class_f_d_p_1_1_data_pipeline.html b/class_fair_data_pipeline_1_1_data_pipeline.html similarity index 54% rename from class_f_d_p_1_1_data_pipeline.html rename to class_fair_data_pipeline_1_1_data_pipeline.html index 6cb32be..db2b443 100644 --- a/class_f_d_p_1_1_data_pipeline.html +++ b/class_fair_data_pipeline_1_1_data_pipeline.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::DataPipeline Class Reference +cppDataPipeline: FairDataPipeline::DataPipeline Class Reference @@ -63,65 +63,64 @@
                    Classes | +Public Types | Public Member Functions | -List of all members
                    -
                    FDP::DataPipeline Class Reference
                    +Static Public Member Functions | +List of all members
                    +
                    FairDataPipeline::DataPipeline Class Reference
                    -

                    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline. - More...

                    +

                    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline. + More...

                    #include <fdp/fdp.hxx>

                    - +

                    Classes

                    class  impl
                    class  impl
                     
                    + + + +

                    +Public Types

                    +typedef std::shared_ptr< DataPipeline > sptr
                     
                    - - - - - - - - - - - - - - - - - - - - - + + + + + + + + - - + + +

                    Public Member Functions

                     DataPipeline (const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
                     Construct a new Data Pipeline (PIMPL) More...
                     
                    +
                     ~DataPipeline ()
                     Destroy the Data Pipeline object.
                     
                    - DataPipeline (DataPipeline &&rhs) noexcept
                     
                    -DataPipeline & operator= (DataPipeline &&rhs) noexcept
                     
                    - DataPipeline (const DataPipeline &rhs)
                     
                    -DataPipeline & operator= (const DataPipeline &rhs)
                     
                    ghc::filesystem::path link_read (std::string &data_product)
                     Return a path to a given data product Whilst recording it's meta data for the code run. More...
                     
                    ghc::filesystem::path link_write (std::string &data_product)
                     Return a path to be used for a given data product whilst recording it's meta data. More...
                     
                    +
                     Destroy the Data Pipeline object.
                     
                    ghc::filesystem::path link_read (std::string &data_product)
                     Return a path to a given data product Whilst recording it's meta data for the code run. More...
                     
                    ghc::filesystem::path link_write (std::string &data_product)
                     Return a path to be used for a given data product whilst recording it's meta data. More...
                     
                    void finalise ()
                     Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
                     
                     Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
                     
                    + + + +

                    +Static Public Member Functions

                    static sptr construct (const std::string &config_file_path, const std::string &script_file_path, std::string token="")
                     Construct a new Data Pipeline (PIMPL) More...
                     

                    Detailed Description

                    -

                    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.

                    -

                    Constructor & Destructor Documentation

                    - -

                    ◆ DataPipeline()

                    +

                    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.

                    +

                    Member Function Documentation

                    + +

                    ◆ construct()

                    @@ -130,7 +129,7 @@

                    - + @@ -145,13 +144,7 @@

                    - - - - - - - + @@ -161,7 +154,7 @@

                    -explicit +static

                    FDP::DataPipeline::DataPipeline DataPipeline::sptr FairDataPipeline::DataPipeline::construct ( const std::string &  config_file_path, std::string token = "",
                    spdlog::level::level_enum log_level = spdlog::level::info token = "" 

                    @@ -172,22 +165,20 @@

                    config_file_path script_file_path token - log_level

                    -

                    Member Function Documentation

                    -                     -

                    ◆ link_read()

                    + +

                    ◆ link_read()

                    - + @@ -207,14 +198,14 @@

                    -

                    ◆ link_write()

                    + +

                    ◆ link_write()

                    ghc::filesystem::path FDP::DataPipeline::link_read ghc::filesystem::path FairDataPipeline::DataPipeline::link_read ( std::string &  data_product)
                    - + diff --git a/class_f_d_p_1_1_data_pipeline_1_1impl-members.html b/class_fair_data_pipeline_1_1_data_pipeline_1_1impl-members.html similarity index 53% rename from class_f_d_p_1_1_data_pipeline_1_1impl-members.html rename to class_fair_data_pipeline_1_1_data_pipeline_1_1impl-members.html index 1e059f0..f358602 100644 --- a/class_f_d_p_1_1_data_pipeline_1_1impl-members.html +++ b/class_fair_data_pipeline_1_1_data_pipeline_1_1impl-members.html @@ -63,23 +63,23 @@
                    -
                    FDP::DataPipeline::impl Member List
                    +
                    FairDataPipeline::DataPipeline::impl Member List
                    -

                    This is the complete list of members for FDP::DataPipeline::impl, including all inherited members.

                    +

                    This is the complete list of members for FairDataPipeline::DataPipeline::impl, including all inherited members.

                    ghc::filesystem::path FDP::DataPipeline::link_write ghc::filesystem::path FairDataPipeline::DataPipeline::link_write ( std::string &  data_product)
                    - - - - - - - + + + + + + +
                    finalise()FDP::DataPipeline::impl
                    get_code_run_uuid() constFDP::DataPipeline::impl
                    impl(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)FDP::DataPipeline::impl
                    link_read(std::string &data_product)FDP::DataPipeline::impl
                    link_write(std::string &data_product)FDP::DataPipeline::impl
                    sptr typedef (defined in FDP::DataPipeline::impl)FDP::DataPipeline::impl
                    ~impl()=defaultFDP::DataPipeline::impl
                    construct(const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, RESTAPI api_location=RESTAPI::LOCAL)FairDataPipeline::DataPipeline::implstatic
                    finalise()FairDataPipeline::DataPipeline::impl
                    get_code_run_uuid() constFairDataPipeline::DataPipeline::impl
                    link_read(std::string &data_product)FairDataPipeline::DataPipeline::impl
                    link_write(std::string &data_product)FairDataPipeline::DataPipeline::impl
                    sptr typedef (defined in FairDataPipeline::DataPipeline::impl)FairDataPipeline::DataPipeline::impl
                    ~impl()=defaultFairDataPipeline::DataPipeline::impl
                    diff --git a/class_f_d_p_1_1_data_pipeline_1_1impl.html b/class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html similarity index 59% rename from class_f_d_p_1_1_data_pipeline_1_1impl.html rename to class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html index c59ced0..d46943c 100644 --- a/class_f_d_p_1_1_data_pipeline_1_1impl.html +++ b/class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::DataPipeline::impl Class Reference +cppDataPipeline: FairDataPipeline::DataPipeline::impl Class Reference @@ -63,56 +63,63 @@
                  Public Types | Public Member Functions | -List of all members
                  -
                  FDP::DataPipeline::impl Class Reference
                  +Static Public Member Functions | +List of all members
                  +
                  FairDataPipeline::DataPipeline::impl Class Reference
                  - - + +

                  Public Types

                  -typedef std::shared_ptr< impl > sptr
                   
                  +typedef std::shared_ptr< impl > sptr
                   
                  - - - - - - - - - - - - - + + + + + + + + - - - - - + + + + + +

                  Public Member Functions

                   impl (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, spdlog::level::level_enum log_level=spdlog::level::info, RESTAPI api_location=RESTAPI::LOCAL)
                   construct a DataPipelineImpl_ instance from configurations and setup More...
                   
                  +
                   ~impl ()=default
                   Default Destructor.
                   
                  ghc::filesystem::path link_read (std::string &data_product)
                   Return a path to a given data product Whilst recording it's meta data for the code run. More...
                   
                  ghc::filesystem::path link_write (std::string &data_product)
                   Return a path to be used for a given data product whilst recording it's meta data. More...
                   
                  +
                   Default Destructor.
                   
                  ghc::filesystem::path link_read (std::string &data_product)
                   Return a path to a given data product Whilst recording it's meta data for the code run. More...
                   
                  ghc::filesystem::path link_write (std::string &data_product)
                   Return a path to be used for a given data product whilst recording it's meta data. More...
                   
                  void finalise ()
                   Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
                   
                  std::string get_code_run_uuid () const
                   Get the code run uuid. More...
                   
                   Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
                   
                  std::string get_code_run_uuid () const
                   Get the code run uuid. More...
                   
                  + + + +

                  +Static Public Member Functions

                  static sptr construct (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, RESTAPI api_location=RESTAPI::LOCAL)
                   construct a DataPipelineImpl_ instance from configurations and setup More...
                   
                  -

                  Constructor & Destructor Documentation

                  - -

                  ◆ impl()

                  +

                  Member Function Documentation

                  + +

                  ◆ construct()

                  + + + @@ -323,8 +323,8 @@

                  -

                  ◆ get_component_object()

                  + +

                  ◆ get_component_object()

                  @@ -333,7 +333,7 @@

                  - + @@ -132,14 +139,8 @@

                  - - - - - - - - + + @@ -147,6 +148,11 @@

                  +static +

                  +
                  FDP::DataPipeline::impl::impl DataPipeline::impl::sptr FairDataPipeline::DataPipeline::impl::construct ( const ghc::filesystem::path &  config_file_path, spdlog::level::level_enum log_level = spdlog::level::info,
                  RESTAPI api_location = RESTAPI::LOCAL RESTAPI api_location = RESTAPI::LOCAL 

                  construct a DataPipelineImpl_ instance from configurations and setup

                  @@ -154,7 +160,7 @@

                  Parameters
                  - +
                  config_file_pathlocation of the local configuration file
                  access_token_fileAPI authorisation token where required
                  access_token_fileAPI authorisation token where required
                  log_levellevel for the output logging statements
                  api_locationwhether to use local/remote RestAPI endpoint
                  @@ -163,15 +169,14 @@

                  Member Function Documentation

                  - -

                  ◆ get_code_run_uuid()

                  + +

                  ◆ get_code_run_uuid()

                  - + @@ -184,14 +189,14 @@

                  -

                  ◆ link_read()

                  + +

                  ◆ link_read()

                  std::string FDP::DataPipeline::impl::get_code_run_uuid std::string FairDataPipeline::DataPipeline::impl::get_code_run_uuid ( ) const
                  - + @@ -211,14 +216,14 @@

                  -

                  ◆ link_write()

                  + +

                  ◆ link_write()

                  ghc::filesystem::path FDP::DataPipeline::impl::link_read ghc::filesystem::path FairDataPipeline::DataPipeline::impl::link_read ( std::string &  data_product)
                  - + diff --git a/class_fair_data_pipeline_1_1_i_o_object-members.html b/class_fair_data_pipeline_1_1_i_o_object-members.html new file mode 100644 index 0000000..49d41b3 --- /dev/null +++ b/class_fair_data_pipeline_1_1_i_o_object-members.html @@ -0,0 +1,98 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                  +
                  +
                  ghc::filesystem::path FDP::DataPipeline::impl::link_write ghc::filesystem::path FairDataPipeline::DataPipeline::impl::link_write ( std::string &  data_product)
                  + + + + + +
                  +
                  cppDataPipeline 0.3.0 +
                  +
                  C++ Implementation of the FAIR Data Pipeline API
                  +
                  +
                  + + + + + + + + +
                  +
                  + + +
                  + +
                  + + +
                  +
                  +
                  FairDataPipeline::IOObject Member List
                  +
                  +
                  + +

                  This is the complete list of members for FairDataPipeline::IOObject, including all inherited members.

                  + + + + + + + + + + + + + + + + + +
                  get_component_description() constFairDataPipeline::IOObjectinline
                  get_component_object() constFairDataPipeline::IOObjectinline
                  get_data_product() constFairDataPipeline::IOObjectinline
                  get_data_product_description() constFairDataPipeline::IOObjectinline
                  get_data_product_object() constFairDataPipeline::IOObjectinline
                  get_path() constFairDataPipeline::IOObjectinline
                  get_use_component() constFairDataPipeline::IOObjectinline
                  get_use_data_product() constFairDataPipeline::IOObjectinline
                  get_use_namespace() constFairDataPipeline::IOObjectinline
                  get_use_version() constFairDataPipeline::IOObjectinline
                  IOObject()=defaultFairDataPipeline::IOObject
                  IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)FairDataPipeline::IOObjectinline
                  IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)FairDataPipeline::IOObjectinline
                  is_public() constFairDataPipeline::IOObjectinline
                  set_component_object(ApiObject &component_obj)FairDataPipeline::IOObjectinline
                  set_data_product_object(ApiObject &data_product_obj)FairDataPipeline::IOObjectinline
                  + +
                  +Generated by doxygen 1.9.2 +
                  + + diff --git a/class_f_d_p_1_1_i_o_object.html b/class_fair_data_pipeline_1_1_i_o_object.html similarity index 57% rename from class_f_d_p_1_1_i_o_object.html rename to class_fair_data_pipeline_1_1_i_o_object.html index 87e83e6..4972a3b 100644 --- a/class_f_d_p_1_1_i_o_object.html +++ b/class_fair_data_pipeline_1_1_i_o_object.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::IOObject Class Reference +cppDataPipeline: FairDataPipeline::IOObject Class Reference @@ -63,79 +63,79 @@

                  Public Member Functions | -List of all members
                  -
                  FDP::IOObject Class Reference
                  +List of all members
                  +
                  FairDataPipeline::IOObject Class Reference
                  -

                  Class for API objects. - More...

                  +

                  Class for API objects. + More...

                  #include <fdp/objects/io_object.hxx>

                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

                  Public Member Functions

                  +
                   IOObject ()=default
                   Construct a new IOObject object (empty constructor)
                   
                   IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
                   Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                   
                   IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                   Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                   
                  const std::string & get_data_product () const
                   Get the data product as a string. More...
                   
                  const std::string & get_use_data_product () const
                   Get the use data product as a string. More...
                   
                  const std::string & get_use_component () const
                   Get the use component as a string. More...
                   
                  const std::string & get_use_version () const
                   Get the use version as a string. More...
                   
                  const std::string & get_use_namespace ()
                   Get the use namespace as a string. More...
                   
                  ghc::filesystem::path get_path () const
                   Get the path of the data product. More...
                   
                  const std::string & get_data_product_description () const
                   Get the data product description as a string. More...
                   
                  const std::string & get_component_description ()
                   Get the component description as a string. More...
                   
                  bool is_public () const
                   Check whether the data product is public. More...
                   
                  ApiObject::sptr get_component_object () const
                   Get the component object object. More...
                   
                  ApiObject::sptr get_data_product_object () const
                   Get the data product object object. More...
                   
                  void set_component_object (ApiObject &component_obj)
                   Set the component object object. More...
                   
                  void set_data_product_object (ApiObject &data_product_obj)
                   Set the data product object object. More...
                   
                   Construct a new IOObject object (empty constructor)
                   
                   IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
                   Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                   
                   IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
                   Construct a new IOObject object Used to store inputs and outputs for in the config. More...
                   
                  const std::string & get_data_product () const
                   Get the data product as a string. More...
                   
                  const std::string & get_use_data_product () const
                   Get the use data product as a string. More...
                   
                  const std::string & get_use_component () const
                   Get the use component as a string. More...
                   
                  const std::string & get_use_version () const
                   Get the use version as a string. More...
                   
                  const std::string & get_use_namespace () const
                   Get the use namespace as a string. More...
                   
                  ghc::filesystem::path get_path () const
                   Get the path of the data product. More...
                   
                  const std::string & get_data_product_description () const
                   Get the data product description as a string. More...
                   
                  const std::string & get_component_description () const
                   Get the component description as a string. More...
                   
                  bool is_public () const
                   Check whether the data product is public. More...
                   
                  ApiObject::sptr get_component_object () const
                   Get the component object object. More...
                   
                  ApiObject::sptr get_data_product_object () const
                   Get the data product object object. More...
                   
                  void set_component_object (ApiObject &component_obj)
                   Set the component object object. More...
                   
                  void set_data_product_object (ApiObject &data_product_obj)
                   Set the data product object object. More...
                   

                  Detailed Description

                  -

                  Class for API objects.

                  +

                  Class for API objects.

                  Constructor & Destructor Documentation

                  - -

                  ◆ IOObject() [1/2]

                  + +

                  ◆ IOObject() [1/2]

                  @@ -144,7 +144,7 @@

                  - + @@ -198,7 +198,7 @@

                  -

                  Construct a new IOObject object Used to store inputs and outputs for in the config.

                  +

                  Construct a new IOObject object Used to store inputs and outputs for in the config.

                  Parameters

                  FDP::IOObject::IOObject FairDataPipeline::IOObject::IOObject ( const std::string &  data_product,
                  @@ -214,8 +214,8 @@

                  -

                  ◆ IOObject() [2/2]

                  + +

                  ◆ IOObject() [2/2]

                  @@ -224,7 +224,7 @@

                  data_productdata_product name as string
                  - + @@ -256,13 +256,13 @@

                  - + - + @@ -278,7 +278,7 @@

                  -

                  Construct a new IOObject object Used to store inputs and outputs for in the config.

                  +

                  Construct a new IOObject object Used to store inputs and outputs for in the config.

                  Parameters

                  FDP::IOObject::IOObject FairDataPipeline::IOObject::IOObject ( const std::string &  data_product, ApiObject & ApiObject &  component_obj,
                  ApiObject & ApiObject &  data_product_obj 
                  @@ -295,8 +295,8 @@

                  Member Function Documentation

                  - -

                  ◆ get_component_description()

                  + +

                  ◆ get_component_description()

                  @@ -305,10 +305,10 @@

                  data_productdata_product name as string
                  - + - +
                  const std::string & FDP::IOObject::get_component_description const std::string & FairDataPipeline::IOObject::get_component_description ( ) const

                  - + @@ -351,8 +351,8 @@

                  -

                  ◆ get_data_product()

                  + +

                  ◆ get_data_product()

                  @@ -361,7 +361,7 @@

                  ApiObject::sptr FDP::IOObject::get_component_object ApiObject::sptr FairDataPipeline::IOObject::get_component_object ( ) const
                  - + @@ -379,8 +379,8 @@

                  -

                  ◆ get_data_product_description()

                  + +

                  ◆ get_data_product_description()

                  @@ -389,7 +389,7 @@

                  const std::string & FDP::IOObject::get_data_product const std::string & FairDataPipeline::IOObject::get_data_product ( ) const
                  - + @@ -407,8 +407,8 @@

                  -

                  ◆ get_data_product_object()

                  + +

                  ◆ get_data_product_object()

                  @@ -417,7 +417,7 @@

                  const std::string & FDP::IOObject::get_data_product_description const std::string & FairDataPipeline::IOObject::get_data_product_description ( ) const
                  - + @@ -435,8 +435,8 @@

                  -

                  ◆ get_path()

                  + +

                  ◆ get_path()

                  @@ -445,7 +445,7 @@

                  ApiObject::sptr FDP::IOObject::get_data_product_object ApiObject::sptr FairDataPipeline::IOObject::get_data_product_object ( ) const
                  - + @@ -463,8 +463,8 @@

                  -

                  ◆ get_use_component()

                  + +

                  ◆ get_use_component()

                  @@ -473,7 +473,7 @@

                  ghc::filesystem::path FDP::IOObject::get_path ghc::filesystem::path FairDataPipeline::IOObject::get_path ( ) const
                  - + @@ -491,8 +491,8 @@

                  -

                  ◆ get_use_data_product()

                  + +

                  ◆ get_use_data_product()

                  @@ -501,7 +501,7 @@

                  const std::string & FDP::IOObject::get_use_component const std::string & FairDataPipeline::IOObject::get_use_component ( ) const
                  - + @@ -519,8 +519,8 @@

                  -

                  ◆ get_use_namespace()

                  + +

                  ◆ get_use_namespace()

                  @@ -529,10 +529,10 @@

                  const std::string & FDP::IOObject::get_use_data_product const std::string & FairDataPipeline::IOObject::get_use_data_product ( ) const
                  - + - +
                  const std::string & FDP::IOObject::get_use_namespace const std::string & FairDataPipeline::IOObject::get_use_namespace ( ) const
                  @@ -547,8 +547,8 @@

                  -

                  ◆ get_use_version()

                  + +

                  ◆ get_use_version()

                  @@ -557,7 +557,7 @@

                  - + @@ -575,8 +575,8 @@

                  -

                  ◆ is_public()

                  + +

                  ◆ is_public()

                  @@ -585,7 +585,7 @@

                  const std::string & FDP::IOObject::get_use_version const std::string & FairDataPipeline::IOObject::get_use_version ( ) const
                   - + @@ -605,8 +605,8 @@

                  -

                  ◆ set_component_object()

                  + +

                  ◆ set_component_object()

                  @@ -615,9 +615,9 @@

                  bool FDP::IOObject::is_public bool FairDataPipeline::IOObject::is_public ( ) const
                  - + - + @@ -639,8 +639,8 @@

                  -

                  ◆ set_data_product_object()

                  + +

                  ◆ set_data_product_object()

                  @@ -649,9 +649,9 @@

                  void FDP::IOObject::set_component_object void FairDataPipeline::IOObject::set_component_object (ApiObject & ApiObject &  component_obj)
                  - + - + diff --git a/class_fair_data_pipeline_1_1_versioning_1_1version-members.html b/class_fair_data_pipeline_1_1_versioning_1_1version-members.html new file mode 100644 index 0000000..a7ad4dd --- /dev/null +++ b/class_fair_data_pipeline_1_1_versioning_1_1version-members.html @@ -0,0 +1,101 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
                  +
                  +
                  void FDP::IOObject::set_data_product_object void FairDataPipeline::IOObject::set_data_product_object (ApiObject & ApiObject &  data_product_obj)
                  + + + + + +
                  +
                  cppDataPipeline 0.3.0 +
                  +
                  C++ Implementation of the FAIR Data Pipeline API
                  +
                  +

                  + + + + + + + + +
                  +
                  + + +
                  + +
                  + +                   +
                  +
                  +
                  FairDataPipeline::Versioning::version Member List
                  +
                  +
                  + +

                  This is the complete list of members for FairDataPipeline::Versioning::version, including all inherited members.

                  + + + + + + + + + + + + + + + + + + + + +
                  alpha() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  beta() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  bump_major() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  bump_minor() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  bump_patch() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  operator!= (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  operator< (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  operator<< (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  operator<= (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  operator== (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  operator> (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  operator>= (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versionfriend
                  prerelease() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  release() (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  to_string() const (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  version()=defaultFairDataPipeline::Versioning::version
                  version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")FairDataPipeline::Versioning::versioninline
                  version(const std::string version_str) (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::version
                  version(const version &v) (defined in FairDataPipeline::Versioning::version)FairDataPipeline::Versioning::versioninline
                  + +
                  +Generated by doxygen 1.9.2 +
                  + + diff --git a/class_f_d_p_1_1_versioning_1_1version.html b/class_fair_data_pipeline_1_1_versioning_1_1version.html similarity index 62% rename from class_f_d_p_1_1_versioning_1_1version.html rename to class_fair_data_pipeline_1_1_versioning_1_1version.html index bd46aed..ba7550c 100644 --- a/class_f_d_p_1_1_versioning_1_1version.html +++ b/class_fair_data_pipeline_1_1_versioning_1_1version.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::Versioning::version Class Reference +cppDataPipeline: FairDataPipeline::Versioning::version Class Reference @@ -63,84 +63,84 @@
                Public Member Functions | Friends | -List of all members
                -
                FDP::Versioning::version Class Reference
                +List of all members
                +
                FairDataPipeline::Versioning::version Class Reference

                class describing the semantic version of an object - More...

                + More...

                #include <fdp/utilities/semver.hxx>

                - - - - - - - + + + + + + - - - - + + + - - + - - + - - + - - + - - + - - + - - + - +

                Public Member Functions

                 version ()=default
                 Construct a new version with the default start value of 0.1.0 More...
                 
                 version (unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
                 Construct a new version from integer representation. More...
                 
                +
                 version ()=default
                 Construct a new version with the default start value of 0.1.0 More...
                 
                 version (unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
                 Construct a new version from integer representation. More...
                 
                 version (const std::string version_str)
                 
                - version (const version &v)
                 
                +
                 
                + version (const version &v)
                 
                void bump_major ()
                 
                +
                 
                void bump_minor ()
                 
                +
                 
                void bump_patch ()
                 
                +
                 
                void alpha ()
                 
                +
                 
                void beta ()
                 
                +
                 
                void prerelease ()
                 
                +
                 
                void release ()
                 
                +
                 
                std::string to_string () const
                 
                 
                +std::ostream &  +bool  +bool  +bool  +bool  +bool  +bool 

                Friends

                -std::ostream & operator<< (std::ostream &os, const version &v)
                operator<< (std::ostream &os, const version &v)
                 
                -bool operator< (const version &v1, const version &v2)
                operator< (const version &v1, const version &v2)
                 
                -bool operator> (const version &v1, const version &v2)
                operator> (const version &v1, const version &v2)
                 
                -bool operator== (const version &v1, const version &v2)
                operator== (const version &v1, const version &v2)
                 
                -bool operator!= (const version &v1, const version &v2)
                operator!= (const version &v1, const version &v2)
                 
                -bool operator<= (const version &v1, const version &v2)
                operator<= (const version &v1, const version &v2)
                 
                -bool operator>= (const version &v1, const version &v2)
                operator>= (const version &v1, const version &v2)
                 

                Detailed Description

                @@ -149,8 +149,8 @@
                Author
                K. Zarebski (UKAEA)

                This class allows the comparison and validation of semantic version numbers and ensures that all data objects handled follow the same protocol

                Constructor & Destructor Documentation

                - -

                ◆ version() [1/2]

                + +

                ◆ version() [1/2]

                @@ -159,7 +159,7 @@

                - + @@ -178,8 +178,8 @@

                -

                ◆ version() [2/2]

                + +

                ◆ version() [2/2]

                @@ -188,7 +188,7 @@

                FDP::Versioning::version::version FairDataPipeline::Versioning::version::version ( )
                - + @@ -208,8 +208,8 @@

                - - + + diff --git a/class_f_d_p_1_1config__parsing__error-members.html b/class_fair_data_pipeline_1_1config__parsing__error-members.html similarity index 80% rename from class_f_d_p_1_1config__parsing__error-members.html rename to class_fair_data_pipeline_1_1config__parsing__error-members.html index 9a61f97..5cc4f10 100644 --- a/class_f_d_p_1_1config__parsing__error-members.html +++ b/class_fair_data_pipeline_1_1config__parsing__error-members.html @@ -63,17 +63,17 @@
                -
                FDP::config_parsing_error Member List
                +
                FairDataPipeline::config_parsing_error Member List
                -

                This is the complete list of members for FDP::config_parsing_error, including all inherited members.

                +

                This is the complete list of members for FairDataPipeline::config_parsing_error, including all inherited members.

                FDP::Versioning::version::version FairDataPipeline::Versioning::version::version ( unsigned int  major, meta_tag tag = meta_tag::RELEASE, meta_tag tag = meta_tag::RELEASE,
                - +
                config_parsing_error(const std::string &message) (defined in FDP::config_parsing_error)FDP::config_parsing_errorinline
                config_parsing_error(const std::string &message) (defined in FairDataPipeline::config_parsing_error)FairDataPipeline::config_parsing_errorinline

                diff --git a/class_f_d_p_1_1config__parsing__error.html b/class_fair_data_pipeline_1_1config__parsing__error.html similarity index 80% rename from class_f_d_p_1_1config__parsing__error.html rename to class_fair_data_pipeline_1_1config__parsing__error.html index 6e17b5a..3ce2290 100644 --- a/class_f_d_p_1_1config__parsing__error.html +++ b/class_fair_data_pipeline_1_1config__parsing__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::config_parsing_error Class Reference +cppDataPipeline: FairDataPipeline::config_parsing_error Class Reference @@ -63,28 +63,28 @@
              Public Member Functions | -List of all members
              -
              FDP::config_parsing_error Class Reference
              +List of all members
              +
              FairDataPipeline::config_parsing_error Class Reference
              -Inheritance diagram for FDP::config_parsing_error:
              +Inheritance diagram for FairDataPipeline::config_parsing_error:
              - +
              - - +

              Public Member Functions

              +
               config_parsing_error (const std::string &message)
               
               
              The documentation for this class was generated from the following file:
              • include/fdp/exceptions.hxx
                • diff --git a/class_fair_data_pipeline_1_1config__parsing__error.png b/class_fair_data_pipeline_1_1config__parsing__error.png new file mode 100644 index 0000000000000000000000000000000000000000..6261c10107c30757d601bbf93a2e374f7602e2fb GIT binary patch literal 763 zcmeAS@N?(olHy`uVBq!ia0vp^FMv3JgBeJwygLaJkO=SzasB`QKS=J)*V6t&6M!r* zK5*awYv&z#AeW;g$S;@ys0akEo(eHyU|{ONZ~_tR>|-lbZRwST9tjNX-(vf`GX%sl5^vDcIT#sQ7%ydUWKE3TID#g!Jn zpDiAj<{j$n6uK#7#aWU%3}z>5bBV>y?a6&>zDS=QcI>Y%EpQ- zOlQ+@0IF{Aky^ko)5L)h=vk(eOAM?hmN0Tn@MIQIn2e_2-?TGl)+z8P?1zbKE%44R zsx}D!7rK3&&by+F&wQpww)Y=(WQ_8CX0YvMSKO6@TmJ;PZCz03_kH6{8{4~Y{{=fN z&$jz&bm7LTo!#@#@36h$`^DtR`-7UYCkzy6f{?!8(!yY2G(T}waOa(z&H zJu|MBp}%Gg<1VY$!8g*B4lv7Be7xSUF8-QjYut>Dd<+#U-dkSG+PVJB525=z7cksk i2MbWIW;0{&wf4DNdpy1sEC(i31_n=8KbLh*2~7Y +
              • FairDataPipeline
              • json_parse_error
              -
              FDP::json_parse_error Member List
              +
              FairDataPipeline::json_parse_error Member List
              -

              This is the complete list of members for FDP::json_parse_error, including all inherited members.

              +

              This is the complete list of members for FairDataPipeline::json_parse_error, including all inherited members.

              - +
              json_parse_error(const std::string &message) (defined in FDP::json_parse_error)FDP::json_parse_errorinline
              json_parse_error(const std::string &message) (defined in FairDataPipeline::json_parse_error)FairDataPipeline::json_parse_errorinline
              diff --git a/class_f_d_p_1_1json__parse__error.html b/class_fair_data_pipeline_1_1json__parse__error.html similarity index 80% rename from class_f_d_p_1_1json__parse__error.html rename to class_fair_data_pipeline_1_1json__parse__error.html index 1182990..eeaeb45 100644 --- a/class_f_d_p_1_1json__parse__error.html +++ b/class_fair_data_pipeline_1_1json__parse__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::json_parse_error Class Reference +cppDataPipeline: FairDataPipeline::json_parse_error Class Reference @@ -63,28 +63,28 @@
            Public Member Functions | -List of all members
            -
            FDP::json_parse_error Class Reference
            +List of all members
            +
            FairDataPipeline::json_parse_error Class Reference
            -Inheritance diagram for FDP::json_parse_error:
            +Inheritance diagram for FairDataPipeline::json_parse_error:
            - +
            - - +

            Public Member Functions

            +
             json_parse_error (const std::string &message)
             
             
            The documentation for this class was generated from the following file:
            • include/fdp/exceptions.hxx
              • diff --git a/class_fair_data_pipeline_1_1json__parse__error.png b/class_fair_data_pipeline_1_1json__parse__error.png new file mode 100644 index 0000000000000000000000000000000000000000..9aa0968e313b885983f41de2560a98dbc421d20a GIT binary patch literal 732 zcmeAS@N?(olHy`uVBq!ia0vp^mw-5cgBeIh+uvRcq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0vOQfKLn;{G&b`@pSb@j2Kfdb!|NiBX zQqmr~mY#~}2+UKzk;5+iT-12;z823Qe<_biQ(~DtCvAGIbII!0O_lQdOOKcFPEv_o zChTD*`~Q>hHru`aYc0+C^}Lgp&OY7}DYp1KC!6Q5i2KSjpPc{ptwMLL_V+eX{{!tu zH+DNtvb(0KvR}ixy63-7*ZI2glObM{?5>|Y@|!L5S9j(28SX|?CoMT&y2@sc#ka>A zTem8+PV)R`;_=bTGtBO!aQ^Cw!tJh#9q&?4Zj{OdR6o|7iM+&|&jrVq6X zr!7(L)$j}|<5lrIwXRXc^Jb~Lk@0IUhU+ibE=>RByzB0+19vk5r>H8#AF@?f}WI)PzRwgO`cnt}tQhs>V60yY+VS z&KL0^rw%=evFM5L)d1^A6hT=2L6}*CU)|C-6!2=J56u?O?RF(Uv<*##T$Q0 zrJkR`c(tSQZCT%`{Ut?*te$6kv zsoM`OFM9LgS^3JJ*Ke%)SbgqBR``9#Rnq%@&pmS6mFwHvwOtRMW#oiDvUTlBP3Lu; zxVQDc?2@dl;+@xBUakm_c&yO!TYLLg<2;dOr+nq9?7N${)aUaFy%$)y%lm87a-saK z(;Va9X19Ly|B`r=yVdB{sd-1^?rxttKV9_v=FLAA{J6%j@5=6AoA=*WzmH^EVktQ7 z1cS`Wi@Xn3u5+o{n%*G)LfwO*(gYT4UuunwUwhW4Dc6;7xSad~Oo|Miu6{1-oD!M< D57b<) literal 0 HcmV?d00001 diff --git a/class_fair_data_pipeline_1_1logger-members.html b/class_fair_data_pipeline_1_1logger-members.html new file mode 100644 index 0000000..40a78bb --- /dev/null +++ b/class_fair_data_pipeline_1_1logger-members.html @@ -0,0 +1,84 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logger Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logger, including all inherited members.

              + + + +
              get_logger() (defined in FairDataPipeline::logger)FairDataPipeline::loggerstatic
              logger_sptr typedef (defined in FairDataPipeline::logger)FairDataPipeline::logger
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logger.html b/class_fair_data_pipeline_1_1logger.html new file mode 100644 index 0000000..ccfbd01 --- /dev/null +++ b/class_fair_data_pipeline_1_1logger.html @@ -0,0 +1,100 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logger Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Public Types | +Static Public Member Functions | +List of all members
              +
              FairDataPipeline::logger Class Reference
              +
              +
              + + + + +

              +Public Types

              +typedef std::shared_ptr< logging::Logger > logger_sptr
               
              + + + +

              +Static Public Member Functions

              +static logger_sptr get_logger ()
               
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_composite_sink-members.html b/class_fair_data_pipeline_1_1logging_1_1_composite_sink-members.html new file mode 100644 index 0000000..da53496 --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_composite_sink-members.html @@ -0,0 +1,93 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logging::CompositeSink Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logging::CompositeSink, including all inherited members.

              + + + + + + + + + + + + +
              add_sink(Sink::sptr sink) (defined in FairDataPipeline::logging::CompositeSink)FairDataPipeline::logging::CompositeSinkinline
              create(enum LOG_LEVEL lvl) (defined in FairDataPipeline::logging::CompositeSink)FairDataPipeline::logging::CompositeSinkinlinestatic
              execute(Logger *logger, enum LOG_LEVEL msg_lvl, const std::string &s) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              log(enum LOG_LEVEL msg_lvl, const std::string &s) (defined in FairDataPipeline::logging::CompositeSink)FairDataPipeline::logging::CompositeSinkvirtual
              log_level() (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              log_level(enum LOG_LEVEL log_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              set_formatter(ISinkFormatter::sptr fmtr) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sinkinline
              should_log(enum LOG_LEVEL msg_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              Sink(enum LOG_LEVEL log_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sinkprotected
              sptr typedef (defined in FairDataPipeline::logging::CompositeSink)FairDataPipeline::logging::CompositeSink
              ~ISink() (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISinkinlinevirtual
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_composite_sink.html b/class_fair_data_pipeline_1_1logging_1_1_composite_sink.html new file mode 100644 index 0000000..bf09fec --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_composite_sink.html @@ -0,0 +1,189 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::CompositeSink Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
              +
              FairDataPipeline::logging::CompositeSink Class Reference
              +
              +
              +
              +Inheritance diagram for FairDataPipeline::logging::CompositeSink:
              +
              +
              + + +FairDataPipeline::logging::Sink +FairDataPipeline::logging::ISink + +
              + + + + + + + + + + +

              +Public Types

              +typedef std::shared_ptr< CompositeSink > sptr
               
              - Public Types inherited from FairDataPipeline::logging::Sink
              +typedef std::shared_ptr< Sink > sptr
               
              - Public Types inherited from FairDataPipeline::logging::ISink
              +typedef std::shared_ptr< ISink > sptr
               
              + + + + + + + + + + + + + + + + +

              +Public Member Functions

              int log (enum LOG_LEVEL msg_lvl, const std::string &s)
               
              +void add_sink (Sink::sptr sink)
               
              - Public Member Functions inherited from FairDataPipeline::logging::Sink
              +enum LOG_LEVEL log_level ()
               
              +void log_level (enum LOG_LEVEL log_lvl)
               
              +bool should_log (enum LOG_LEVEL msg_lvl)
               
              +void set_formatter (ISinkFormatter::sptr fmtr)
               
              +int execute (Logger *logger, enum LOG_LEVEL msg_lvl, const std::string &s)
               
              + + + +

              +Static Public Member Functions

              +static sptr create (enum LOG_LEVEL lvl)
               
              + + + + +

              +Additional Inherited Members

              - Protected Member Functions inherited from FairDataPipeline::logging::Sink
              + Sink (enum LOG_LEVEL log_lvl)
               
              +

              Member Function Documentation

              + +

              ◆ log()

              + +
              +
              + + + + + +
              + + + + + + + + + + + + + + + + + + +
              int FairDataPipeline::logging::CompositeSink::log (enum LOG_LEVEL msg_lvl,
              const std::string & s 
              )
              +               		+virtual
              +
              + +

              Implements FairDataPipeline::logging::ISink.

              + +
              +
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_composite_sink.png b/class_fair_data_pipeline_1_1logging_1_1_composite_sink.png new file mode 100644 index 0000000000000000000000000000000000000000..abb551030ce4fc6746ecbf2781a5972da3b1d9ea GIT binary patch literal 1281 zcmeAS@N?(olHy`uVBq!ia0vp^AAz`ogBeINTKqKvQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;{s+kJDNuIBwCr3>Bbxrco(Z5HRnchx(*>Xgv zU1VF$CY8@JJo;vtYZXu0EbmZVImLMPzMR*$)@<{CzDL(-x=%H8AdU*Za_WrvSc{w3^xc9s-yJYr4)M~e%6nw;$%-?6H`7EqwDXubejzbq{mMw!XFR z=w?-YIrUxIR@HUsr4Q?~ulPP%5>ZngCND7CZSIb`^#0Aeb{sfX=ke$6)YGED@g9?3 zzkRze?0A5A_SUs$w~3f$m97Yhe7Z`U+tccTWRmBu)!q9yzg&~_Y425)na@9WM6;K@ zV^Mt>AzyJ!ap&fpt&Wq{y}o;7(wE3tMss}XyVkw-VEQ3y%g}bI;7I@R zj1z|i?Hk#h<@zhGWi{M0?PUCQO@-}6^kj(z`MyaF`v?lmzX&ujAZhB7Mw3p}l|Vhf z$avl%{#|_bwVd{)!b09MK{q~~oOI^$mgm-6*t|BK_e}ECdU|G={_VYHtKVMpY`<;2 zr`_UMY2p9s<(rT9Kj^RCW&;c?-FFXfpFh7gl*fGDjU|TO-j^1x6P(>DJJ(w|9iUcw?3NU{<2fDL1nZF;Vg7 zUukXJ*uI@dxkO~!?juLDCVdI|zWJ8W_079J>^FVIR~V#uZ^BjfBg+ES*WJJQc#WRk zhK<`h?+5IRG5p$Uvh&`(ciE*qWt+op-^y7XxHzmmX==~fXDuqSFJ(5W+`W4A{>_pw z!=LxE=KI~T+B~^k!;}5j31hyKbI!q>oLI>8r zU^JN0rd(&^<}BCugVRRhQ^k?ZVa#9FdGcJ?u4d?Pf7TI(+H4`_FKY=2{OOsN8rdeq zeZT>(#o^8Ch%M5^Ms_PdcB=Aax@;7^lXhYAS;i=@a^0HE`PPOGn(5oTO{?R6*IUk= z70ock>eJf}3%BR1^Nn|3n{Hdz5_)&Dtm_MnoI?Kl-|V|@ha26gNb1k|es%wit>4d` z*?w2_amdsgCA&p)PQ5vIly#5l`;435eBrIM)irr>-a1)6?O(D=QG1WSoZE4+E6_0i z<2sS}R^9mRW{b^i>|1XoRBIf2nlmAC&7`ZLNy+^Al5RlD-m7dYc)D}1+PQG+bFaKM zyk30Ilc&2f=jo>8(`)P$%zCW~|HjFtmlihm+G_7){kXb1MmaA`FZ^wdqVKxx+kaPO zBwt%`b(@)V^y;v79@BqsXQy{x$u9k%`_p#alfzf#JsW(!PdnjUTetOp(a-4}*_Qe5 z`5mI`C*DYrPndUzVZ!V0os9o_U_t--_3@g>X{ic-nVqI37WO7wQv;S)44$rjF6*2U FngCo5eeVDO literal 0 HcmV?d00001 diff --git a/class_fair_data_pipeline_1_1logging_1_1_logger-members.html b/class_fair_data_pipeline_1_1logging_1_1_logger-members.html new file mode 100644 index 0000000..2bd3604 --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_logger-members.html @@ -0,0 +1,95 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logging::Logger Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logging::Logger, including all inherited members.

              + + + + + + + + + + + + + + +
              create(enum LOG_LEVEL lvl, Sink::sptr sink, std::string name="") (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Loggerstatic
              critical() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              debug() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              error() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              get_level() const (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Loggerinline
              info() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              Logger(enum LOG_LEVEL lvl, Sink::sptr sink, std::string name) (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Loggerprotected
              name() const (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Loggerinline
              set_level(enum LOG_LEVEL lvl) (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Loggerinline
              sink() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Loggerinline
              sptr typedef (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              trace() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              warn() (defined in FairDataPipeline::logging::Logger)FairDataPipeline::logging::Logger
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_logger.html b/class_fair_data_pipeline_1_1logging_1_1_logger.html new file mode 100644 index 0000000..e9a9c89 --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_logger.html @@ -0,0 +1,147 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::Logger Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Classes | +Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +List of all members
              +
              FairDataPipeline::logging::Logger Class Reference
              +
              +
              + + + + +

              +Classes

              class  MsgBuilder
               
              + + + +

              +Public Types

              +typedef std::shared_ptr< Logger > sptr
               
              + + + + + + + + + + + + + + + + + + + + + +

              +Public Member Functions

              +MsgBuilder info ()
               
              +MsgBuilder debug ()
               
              +MsgBuilder trace ()
               
              +MsgBuilder warn ()
               
              +MsgBuilder critical ()
               
              +MsgBuilder error ()
               
              +Sink::sptr sink ()
               
              +const std::string & name () const
               
              +void set_level (enum LOG_LEVEL lvl)
               
              +enum LOG_LEVEL get_level () const
               
              + + + +

              +Static Public Member Functions

              +static sptr create (enum LOG_LEVEL lvl, Sink::sptr sink, std::string name="")
               
              + + + +

              +Protected Member Functions

              + Logger (enum LOG_LEVEL lvl, Sink::sptr sink, std::string name)
               
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder-members.html b/class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder-members.html new file mode 100644 index 0000000..9033a8a --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder-members.html @@ -0,0 +1,86 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logging::Logger::MsgBuilder Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logging::Logger::MsgBuilder, including all inherited members.

              + + + + + +
              Logger (defined in FairDataPipeline::logging::Logger::MsgBuilder)FairDataPipeline::logging::Logger::MsgBuilderfriend
              operator<<(const T &s) (defined in FairDataPipeline::logging::Logger::MsgBuilder)FairDataPipeline::logging::Logger::MsgBuilderinline
              sptr typedef (defined in FairDataPipeline::logging::Logger::MsgBuilder)FairDataPipeline::logging::Logger::MsgBuilder
              ~MsgBuilder() (defined in FairDataPipeline::logging::Logger::MsgBuilder)FairDataPipeline::logging::Logger::MsgBuilder
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder.html b/class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder.html new file mode 100644 index 0000000..1bb3190 --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder.html @@ -0,0 +1,108 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::Logger::MsgBuilder Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Public Types | +Public Member Functions | +Friends | +List of all members
              +
              FairDataPipeline::logging::Logger::MsgBuilder Class Reference
              +
              +
              + + + + +

              +Public Types

              +typedef std::shared_ptr< MsgBuilder > sptr
               
              + + + + +

              +Public Member Functions

              +template<typename T >
              MsgBuilder & operator<< (const T &s)
               
              + + + +

              +Friends

              +class Logger
               
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink-members.html b/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink-members.html new file mode 100644 index 0000000..e5b5439 --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink-members.html @@ -0,0 +1,92 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logging::OStreamSink Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logging::OStreamSink, including all inherited members.

              + + + + + + + + + + + +
              create(enum LOG_LEVEL lvl, std::ostream &os) (defined in FairDataPipeline::logging::OStreamSink)FairDataPipeline::logging::OStreamSinkstatic
              execute(Logger *logger, enum LOG_LEVEL msg_lvl, const std::string &s) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              log(enum LOG_LEVEL msg_lvl, const std::string &s) (defined in FairDataPipeline::logging::OStreamSink)FairDataPipeline::logging::OStreamSinkvirtual
              log_level() (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              log_level(enum LOG_LEVEL log_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              set_formatter(ISinkFormatter::sptr fmtr) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sinkinline
              should_log(enum LOG_LEVEL msg_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              Sink(enum LOG_LEVEL log_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sinkprotected
              sptr typedef (defined in FairDataPipeline::logging::OStreamSink)FairDataPipeline::logging::OStreamSink
              ~ISink() (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISinkinlinevirtual
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.html b/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.html new file mode 100644 index 0000000..4fdccf1 --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.html @@ -0,0 +1,186 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::OStreamSink Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
              +
              FairDataPipeline::logging::OStreamSink Class Reference
              +
              +
              +
              +Inheritance diagram for FairDataPipeline::logging::OStreamSink:
              +
              +
              + + +FairDataPipeline::logging::Sink +FairDataPipeline::logging::ISink + +
              + + + + + + + + + + +

              +Public Types

              +typedef std::shared_ptr< OStreamSink > sptr
               
              - Public Types inherited from FairDataPipeline::logging::Sink
              +typedef std::shared_ptr< Sink > sptr
               
              - Public Types inherited from FairDataPipeline::logging::ISink
              +typedef std::shared_ptr< ISink > sptr
               
              + + + + + + + + + + + + + + +

              +Public Member Functions

              int log (enum LOG_LEVEL msg_lvl, const std::string &s)
               
              - Public Member Functions inherited from FairDataPipeline::logging::Sink
              +enum LOG_LEVEL log_level ()
               
              +void log_level (enum LOG_LEVEL log_lvl)
               
              +bool should_log (enum LOG_LEVEL msg_lvl)
               
              +void set_formatter (ISinkFormatter::sptr fmtr)
               
              +int execute (Logger *logger, enum LOG_LEVEL msg_lvl, const std::string &s)
               
              + + + +

              +Static Public Member Functions

              +static sptr create (enum LOG_LEVEL lvl, std::ostream &os)
               
              + + + + +

              +Additional Inherited Members

              - Protected Member Functions inherited from FairDataPipeline::logging::Sink
              + Sink (enum LOG_LEVEL log_lvl)
               
              +

              Member Function Documentation

              + +

              ◆ log()

              + +
              +
              + + + + + +
              + + + + + + + + + + + + + + + + + + +
              int FairDataPipeline::logging::OStreamSink::log (enum LOG_LEVEL msg_lvl,
              const std::string & s 
              )
              +               		+virtual
              +
              + +

              Implements FairDataPipeline::logging::ISink.

              + +
              +
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.png b/class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.png new file mode 100644 index 0000000000000000000000000000000000000000..5fa9b93a73a784998be1a25af0abf0dda275ca0d GIT binary patch literal 1275 zcmeAS@N?(olHy`uVBq!ia0vp^FMzm%gBeKPY7Q3wQW60^A+G=b{|Cvv`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=Aw?o-U3d6^w7^-k!ABfQNOqbLhYSlg+u0 zO{-}Bv83ODPrkY-A5Ynw|15k&$MbJ?gIAEh)PhM@Cigikf2wb~_9owF;W?_j znmIpHJfGc?jLW$c^|&~|Q)}xC-}r6GxnZ}bI;*SB%*1C^vv1s*|Kf1b z+I-tG5wq`IVZ|AuhkMo4Ha_Yo+c$^Bv|Bfz?DSc6@i(n|WP-NtEc^OwUK4+!S5Jq^ z)~^>Ozb^D?S1wtSvF`oVwjE5V*EJts?U^ULZ{aLK_np;hrK=Yllbdh!KG{9-H)F=e z1uAb}c)g0cQ1wbIZ@XJ8OKIzaWmoPpn)X^{{Iz+vJg?BAw^sbivZO6jjs^(by~z75 zpfosPcIfr6$mm$9P;;^QYb366H>zAMWzq5sFa7lUMY`zZ^=rQ^U9k3g@sE8fnep-8 z+>+VSi@BRs=3dHg^15_A10Fi}7JRlj&o6Mm{yO&q&MK}KufGahTHdhFa=zm)i3@?H zjK3~1u)gqQ7FnRq8_+P%#DTGjpg^5B&`5uQ%_?8lGirI-W`gXpVwpQ_|CKFi)@S?+ zrkO0+@N}~3%+;Ca%QJXwShYNtifw**+HCFFtm@B=^Q)`x^UPXgq5D7jd6K{V#onh; z_p9D$dWpXTc~9E z&z~Duf9ldt4q43wudBBPu5-9qdaA;7@pCUHvkw;K{!8;juiSVX{HzveaJXalRh7)} z=|R_$hMRkkf(G#BKbOP^rJRuU51 zu#c!PM~RjDmrQ&w3m;**u%AuC0hkFGY&DzOE=_rJ?9H*=S#NbRJ(Mff&M-@sHP3&` zdSkUj+I+KshM?}7UsAKLq;1`6IoqbN`|ZPo#!E|WFNjRpU#qxaw(Z{=XYU`rcI{f= zjZ1P1W%p&jKFe!9?}_B5cl#v%v?Y4@9NsZ+=IrKK?@A*#Uw;-Hr4aF{Z`#?dtIfZs z9DXdfc5-$>(jBw)Nq<(QUzxv2WQozXcRga;4^3MiJv&f(UY^?dI~#O#c6z66^m-NM z*lTN-dhdAOp>M?j^8a*C+-&Rn!(ejzqe3b7_UOfRY+2nC>u3AySRJw6=dNtP z&OfeuCDwlV#`jh0%G)^0L$eOXUFCJZEqgbCU-f+3s=(6Rsixb)uJ$fHW;M6o-M9Vo zRoPWpb9_zNcPz{H-eUK_+=6AoOZ&!aLbso49$5P;KL1MXM{nx`dv~#lJh*KNOY!yl gzg{-+{rj4qcW>;m7j{=-fF%`!r>mdKI;Vst01AX literal 0 HcmV?d00001 diff --git a/class_fair_data_pipeline_1_1logging_1_1_sink-members.html b/class_fair_data_pipeline_1_1logging_1_1_sink-members.html new file mode 100644 index 0000000..810ef9f --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_sink-members.html @@ -0,0 +1,91 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logging::Sink Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logging::Sink, including all inherited members.

              + + + + + + + + + + +
              execute(Logger *logger, enum LOG_LEVEL msg_lvl, const std::string &s) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              log(enum LOG_LEVEL msg_lvl, const std::string &msg)=0 (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISinkpure virtual
              log_level() (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              log_level(enum LOG_LEVEL log_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              set_formatter(ISinkFormatter::sptr fmtr) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sinkinline
              should_log(enum LOG_LEVEL msg_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              Sink(enum LOG_LEVEL log_lvl) (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sinkprotected
              sptr typedef (defined in FairDataPipeline::logging::Sink)FairDataPipeline::logging::Sink
              ~ISink() (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISinkinlinevirtual
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_sink.html b/class_fair_data_pipeline_1_1logging_1_1_sink.html new file mode 100644 index 0000000..cf7a2cf --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_sink.html @@ -0,0 +1,138 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::Sink Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Public Types | +Public Member Functions | +Protected Member Functions | +List of all members
              +
              FairDataPipeline::logging::Sink Class Reference
              +
              +
              +
              +Inheritance diagram for FairDataPipeline::logging::Sink:
              +
              +
              + + +FairDataPipeline::logging::ISink +FairDataPipeline::logging::CompositeSink +FairDataPipeline::logging::OStreamSink + +
              + + + + + + + +

              +Public Types

              +typedef std::shared_ptr< Sink > sptr
               
              - Public Types inherited from FairDataPipeline::logging::ISink
              +typedef std::shared_ptr< ISink > sptr
               
              + + + + + + + + + + + + + + +

              +Public Member Functions

              +enum LOG_LEVEL log_level ()
               
              +void log_level (enum LOG_LEVEL log_lvl)
               
              +bool should_log (enum LOG_LEVEL msg_lvl)
               
              +void set_formatter (ISinkFormatter::sptr fmtr)
               
              +int execute (Logger *logger, enum LOG_LEVEL msg_lvl, const std::string &s)
               
              - Public Member Functions inherited from FairDataPipeline::logging::ISink
              +virtual int log (enum LOG_LEVEL msg_lvl, const std::string &msg)=0
               
              + + + +

              +Protected Member Functions

              + Sink (enum LOG_LEVEL log_lvl)
               
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_sink.png b/class_fair_data_pipeline_1_1logging_1_1_sink.png new file mode 100644 index 0000000000000000000000000000000000000000..8036ab3cf6be40af455619d641655d40b734bb36 GIT binary patch literal 1757 zcmb`Ic~Fx_7{XJPd$~K9#<9Ut0iB4@K>D_N72(t_ot$IqIrq@_zWJ^eWaSX<6WHJ+Fw1 zyg4B$j1q5&{>#P7qBu`Arz0m&ZYe}}A3bv{jdn~x%U#8zGoXGPXiNc}J8zdtsCt{a zDRO6N&_EIFJfXX817jeK5&kJ}u%t0y=~W+t32Y_YWY&~C>|{ey5#KH2+YQBk;4je3Gjn^%qCsY0;}e5tb2AyKkrD1(Y*m&a~d{*EL)&9W9tO{I=+I?VilE>4%``e7}|=_8$3% z7#j-iZqR5>K+IOu;{8z6bkDX|hhiURVW#6N@VOfoGYAqo1HK~qx39K@31$>=xR$cc zT~E{4Caf?4?KzA-7q%pYC5*!JKlm5^s)EG`Pr{^?H_q8|9EQ7?lZDa7Li)3W1ZZhG z(Y*&t`N=Skkz6(HuGvbeM`@<5%;CLG73}7aVIf&7LudY>POHTu5LCSJ=NpAJv0>k9 z&@E6XP@4~kkppDT^BKgd&3Bhs&#q-9L_VU!U! zGOiLrMS<5ONBa;RP;;`7>rOZQS0;o(8wgn zX9mp6K?eH%WFRvi>)m z!ER>*VG%hPJ>(u&}t(GK=qBXl?{mue=OMPqzPKOI`CeYp{Xipta{nMF;;F=Bb=e@ zC;3A0xc^3j96t^6$88EL7A-lnU6Gli(l3B~e*J~dN`dEbSycJTYT<`=W??noY~N1y6zY zWlhFnIMBXCSJ`qld}9`Swr%(5rI010tK5M~eQJ-*Btnbd$7j;&S zW9D-Ex3DILB+I%nUCWfhwG~pnJJ&;W8U10%gtt}FQXD{ri-bPhADc_iXV5GXw*v0p zS*h-S@m7xY#B}=1q;%*WBvmvy@Rl0ko$ah`%DuE94c z_C3~iY?Dz9vIQK8A0fROTYs2icmCDG`JRO(+m8m~d~6F5P4bC|uA<^%9YcbJBiCDE z%7-dk5GBH)rP&!l#e>BVgw=9Q@2PgOXtc97u%*Uf(~&H*hW?T_UFBBYyS&Zs2CpWD zo~p&XB+Um+?w7a+*(8Fvl0_FQ?ohc|XK}LqyT)8>27=Cs>q*WWXuaE`9S3^Ma0`qr z@d;sd#|`osm?iN$m>5Py#V&V}RzXY0`Mi&K8SR}Ox0;AuH2(S}z{cDc5d5gk$>CrEx%x4y+;9mrw_Id8T=W;Chcg`$Z AsQ>@~ literal 0 HcmV?d00001 diff --git a/class_fair_data_pipeline_1_1logging_1_1_sink_formatter-members.html b/class_fair_data_pipeline_1_1logging_1_1_sink_formatter-members.html new file mode 100644 index 0000000..1a9f52f --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_sink_formatter-members.html @@ -0,0 +1,87 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              FairDataPipeline::logging::SinkFormatter Member List
              +
              +
              + +

              This is the complete list of members for FairDataPipeline::logging::SinkFormatter, including all inherited members.

              + + + + + + +
              create() (defined in FairDataPipeline::logging::SinkFormatter)FairDataPipeline::logging::SinkFormatterinlinestatic
              header(enum LOG_LEVEL msg_lvl, Logger *logger) (defined in FairDataPipeline::logging::SinkFormatter)FairDataPipeline::logging::SinkFormattervirtual
              sptr typedef (defined in FairDataPipeline::logging::SinkFormatter)FairDataPipeline::logging::SinkFormatter
              ~ISinkFormatter() (defined in FairDataPipeline::logging::ISinkFormatter)FairDataPipeline::logging::ISinkFormatterinlinevirtual
              ~SinkFormatter() (defined in FairDataPipeline::logging::SinkFormatter)FairDataPipeline::logging::SinkFormatterinline
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_sink_formatter.html b/class_fair_data_pipeline_1_1logging_1_1_sink_formatter.html new file mode 100644 index 0000000..795193c --- /dev/null +++ b/class_fair_data_pipeline_1_1logging_1_1_sink_formatter.html @@ -0,0 +1,158 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::SinkFormatter Class Reference + + + + + + + + + +
              +
              + + + + + + +
              +
              cppDataPipeline 0.3.0 +
              +
              C++ Implementation of the FAIR Data Pipeline API
              +
              +
              + + + + + + + + +
              +
              + + +
              + +
              + + +
              +
              +
              +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
              +
              FairDataPipeline::logging::SinkFormatter Class Reference
              +
              +
              +
              +Inheritance diagram for FairDataPipeline::logging::SinkFormatter:
              +
              +
              + + +FairDataPipeline::logging::ISinkFormatter + +
              + + + + + + + +

              +Public Types

              +typedef std::shared_ptr< SinkFormatter > sptr
               
              - Public Types inherited from FairDataPipeline::logging::ISinkFormatter
              +typedef std::shared_ptr< ISinkFormatter > sptr
               
              + + + +

              +Public Member Functions

              std::string header (enum LOG_LEVEL msg_lvl, Logger *logger)
               
              + + + +

              +Static Public Member Functions

              +static sptr create ()
               
              +

              Member Function Documentation

              + +

              ◆ header()

              + +
              +
              + + + + + +
              + + + + + + + + + + + + + + + + + + +
              std::string FairDataPipeline::logging::SinkFormatter::header (enum LOG_LEVEL msg_lvl,
              Logger * logger 
              )
              +               		+virtual
              +
              + +

              Implements FairDataPipeline::logging::ISinkFormatter.

              + +
              +
              +
              The documentation for this class was generated from the following files:
                +
              • include/fdp/utilities/logging.hxx
                • +
              • src/utilities/logging.cxx
                • +
              +
              + +
              +Generated by doxygen 1.9.2 +
              + + diff --git a/class_fair_data_pipeline_1_1logging_1_1_sink_formatter.png b/class_fair_data_pipeline_1_1logging_1_1_sink_formatter.png new file mode 100644 index 0000000000000000000000000000000000000000..7c6f129ca2618fbb4c27d61bc4d4084f7800b164 GIT binary patch literal 944 zcmeAS@N?(olHy`uVBq!ia0vp^AAmT3gBeH)Oy}?eQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;5}_-*p#_oCjU z9$hCF-L%$D=VXlfZRZJp*PRNR)O4#-B*C-m)|s@mU3aXmo`0<5?D@{hsO-4V29?+s zfe(T%rT)&(%KiT&W?T09vN#U2?A7B};Tox#o6c%5?y$Ja zl#(ESMx_3;7e+jpw6wapt`Fxo*)3?t|aN4;)NfET8Re)}Qre?zSzg zdD}}o_HTdfnqaPRE^61^7`wB_8>LOZ9GL5{Tvs+OF4>-So#DDh{ped$Hf~ATw0viH zTV}b}?UiqCt+ieHIcH^CSaHA+&Di5N)Mw1SB)UOm?<)2B_`fR)ewgM@`qE*?awn_e z_M%B&^1rN9pJTn-N}6ZV7r(u%5tHh=)i$W~uHn@2RDLa85qtfs8`F=DeGKoG>}IU5 zz1#C6@4)>%-<9^sewcHKAvv3gxn~V0kHIE2g99gK9bixcQIJzajJ9 zER#@VWR7{k`5@@({G&oio2T1b&V74}d!BgH+9MwKFY`b8_YfFmIiJpL^)`K4sUxE~ zD?~PpH|9^Cq0xr^>3iRY@4c{j=liq#^&4Eyr*^J<*B$LC#kh9y55C`Z8s{!Mt$Y`F zWS4}_l+(XDOJ9dw?Cr^V{E^33{94?s1LC@OSh;36nsbkP-<`X#rqJs;<2TN<bP0l+XkK@=U=* literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1rest__apiquery__error-members.html b/class_fair_data_pipeline_1_1rest__apiquery__error-members.html similarity index 80% rename from class_f_d_p_1_1rest__apiquery__error-members.html rename to class_fair_data_pipeline_1_1rest__apiquery__error-members.html index 72e95a5..daf0475 100644 --- a/class_f_d_p_1_1rest__apiquery__error-members.html +++ b/class_fair_data_pipeline_1_1rest__apiquery__error-members.html @@ -63,17 +63,17 @@
            -
            FDP::rest_apiquery_error Member List
            +
            FairDataPipeline::rest_apiquery_error Member List
            -

            This is the complete list of members for FDP::rest_apiquery_error, including all inherited members.

            +

            This is the complete list of members for FairDataPipeline::rest_apiquery_error, including all inherited members.

            - +
            rest_apiquery_error(const std::string &message) (defined in FDP::rest_apiquery_error)FDP::rest_apiquery_errorinline
            rest_apiquery_error(const std::string &message) (defined in FairDataPipeline::rest_apiquery_error)FairDataPipeline::rest_apiquery_errorinline
            diff --git a/class_f_d_p_1_1rest__apiquery__error.html b/class_fair_data_pipeline_1_1rest__apiquery__error.html similarity index 80% rename from class_f_d_p_1_1rest__apiquery__error.html rename to class_fair_data_pipeline_1_1rest__apiquery__error.html index ba1275c..a6899b0 100644 --- a/class_f_d_p_1_1rest__apiquery__error.html +++ b/class_fair_data_pipeline_1_1rest__apiquery__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::rest_apiquery_error Class Reference +cppDataPipeline: FairDataPipeline::rest_apiquery_error Class Reference @@ -63,28 +63,28 @@
          Public Member Functions | -List of all members
          -
          FDP::rest_apiquery_error Class Reference
          +List of all members
          +
          FairDataPipeline::rest_apiquery_error Class Reference
          -Inheritance diagram for FDP::rest_apiquery_error:
          +Inheritance diagram for FairDataPipeline::rest_apiquery_error:
          - +
          - - +

          Public Member Functions

          +
           rest_apiquery_error (const std::string &message)
           
           
          The documentation for this class was generated from the following file:
          • include/fdp/exceptions.hxx
            • diff --git a/class_fair_data_pipeline_1_1rest__apiquery__error.png b/class_fair_data_pipeline_1_1rest__apiquery__error.png new file mode 100644 index 0000000000000000000000000000000000000000..9f15b80624ee198047f2a356ce33fd96fd56a647 GIT binary patch literal 763 zcmeAS@N?(olHy`uVBq!ia0vp^4}myhg4P45?szJNI_cVFezS{Zy6UeeL@jXRix+ zU0PkrxX`zK^BGxriM6Hj3$EC=>^Dn5>du3;*z23#!YLwUE z-(4);tTOkiYD?WoDaGUUYDbsb#u%k~UdoJ}vNWAz`TiM8X3L+PqUyQ4)N|?2#{qrk zH|ROf_sE!JFPgZgZ_?A{>veRuny}5!@_G}u%p`l|`LEl6riI>j_Wb3ucXq)#ga7}O zJT6T-mwv;Yqh|-(&KLr&N;SRYL1TGlZUa^ zQWX!kSt~lMy(#mntop*NuRbOE9t&n&@K1XcedhD+l<)JMEbLEPPVYM<79OqpPILY1 z)A_HbU$tHG;&Sz-|3bg}E+oe!b#!h&`flcqsBg0D+a6tXUwYZ+^0es^eq|G$ua({` z9d-Y3&Ez{%-#caev|aNrbX%>3_3^8_mTpz|NqigAG_iEXQr|-f`fFn&mM-3Ov|!uZ zm7Cv+9}2iur0UK3Uh&YeWq&6vy(%f!drJDA#;&zCC(T=Rxf{{QDL zvA<888YKGgbL6b-8?#bZ*XoAtJC&&0>uRv6Eh_4iV}$wjOF_BYm?H1qyD|CCdrro4 zuP(j+%-lCW>iyf6;z>UO?VNVZ4be(s@GY%q^IuoSsd(Uc7A$m^>93i2v-d0SPrdfX UT2*|nfGL&1)78&qol`;+03jA{_W%F@ literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1sync__error-members.html b/class_fair_data_pipeline_1_1sync__error-members.html similarity index 82% rename from class_f_d_p_1_1sync__error-members.html rename to class_fair_data_pipeline_1_1sync__error-members.html index 8142277..80165fe 100644 --- a/class_f_d_p_1_1sync__error-members.html +++ b/class_fair_data_pipeline_1_1sync__error-members.html @@ -63,17 +63,17 @@
          -
          FDP::sync_error Member List
          +
          FairDataPipeline::sync_error Member List
          -

          This is the complete list of members for FDP::sync_error, including all inherited members.

          +

          This is the complete list of members for FairDataPipeline::sync_error, including all inherited members.

          - +
          sync_error(const std::string &message) (defined in FDP::sync_error)FDP::sync_errorinline
          sync_error(const std::string &message) (defined in FairDataPipeline::sync_error)FairDataPipeline::sync_errorinline
          diff --git a/class_f_d_p_1_1sync__error.html b/class_fair_data_pipeline_1_1sync__error.html similarity index 81% rename from class_f_d_p_1_1sync__error.html rename to class_fair_data_pipeline_1_1sync__error.html index a9b6f6c..e4c1d98 100644 --- a/class_f_d_p_1_1sync__error.html +++ b/class_fair_data_pipeline_1_1sync__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::sync_error Class Reference +cppDataPipeline: FairDataPipeline::sync_error Class Reference @@ -63,28 +63,28 @@
        Public Member Functions | -List of all members
        -
        FDP::sync_error Class Reference
        +List of all members
        +
        FairDataPipeline::sync_error Class Reference
        -Inheritance diagram for FDP::sync_error:
        +Inheritance diagram for FairDataPipeline::sync_error:
        - +
        - - +

        Public Member Functions

        +
         sync_error (const std::string &message)
         
         
        The documentation for this class was generated from the following file:
        • include/fdp/exceptions.hxx
          • diff --git a/class_fair_data_pipeline_1_1sync__error.png b/class_fair_data_pipeline_1_1sync__error.png new file mode 100644 index 0000000000000000000000000000000000000000..f7202a9d41b0143d3cfaf6c74535bddfe7fc9dd1 GIT binary patch literal 676 zcmeAS@N?(olHy`uVBq!ia0vp^>w!3cgBeIhbX@HQQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;s44^ z*2YCMZQm<%IVdhGJEUJPI@LY?xP|`gjo%8{Ja=8Zy+`fp@+o~u*>}Z5XZ-#2%D}$N z*yB>~ybsr&$T0k{pZv%8o!-nS&r5UXJw5DSF@3&&`{DkSELG3)s-k;&Ol7k7{}~+n zJS${=-}U7iQ{H|)S)=j2**(*5TK>H@p7-rm+oq|$bo*&LZHeD&%j)mvCN0rUtpU36 zq_$_FSDa_pW%2bhZ`v?*T;NVn@;&yu>MW~`H!L zA5GcA0Myc8p{nmNXOg&r-$`zP&!5RrN@TdK0adKE=l9FiW$Agp%)fgjuZ(?^ z6i~@nwKnZ~S=7ahkQZ%V_n2mR-%g9m?%unP>;12s>HsOL=#Q~6{nj#DOCP;`%AhY`fAF3wpdcOPVor2VCAK$feYvX5R+lgI$mOs1kYG~|a?W=#@{ +
        • FairDataPipeline
        • validation_error
        -
        FDP::validation_error Member List
        +
        FairDataPipeline::validation_error Member List
        -

        This is the complete list of members for FDP::validation_error, including all inherited members.

        +

        This is the complete list of members for FairDataPipeline::validation_error, including all inherited members.

        - +
        validation_error(const std::string &message) (defined in FDP::validation_error)FDP::validation_errorinline
        validation_error(const std::string &message) (defined in FairDataPipeline::validation_error)FairDataPipeline::validation_errorinline
        diff --git a/class_f_d_p_1_1validation__error.html b/class_fair_data_pipeline_1_1validation__error.html similarity index 80% rename from class_f_d_p_1_1validation__error.html rename to class_fair_data_pipeline_1_1validation__error.html index 798f7aa..73e62e7 100644 --- a/class_f_d_p_1_1validation__error.html +++ b/class_fair_data_pipeline_1_1validation__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::validation_error Class Reference +cppDataPipeline: FairDataPipeline::validation_error Class Reference @@ -63,28 +63,28 @@
      Public Member Functions | -List of all members
      -
      FDP::validation_error Class Reference
      +List of all members
      +
      FairDataPipeline::validation_error Class Reference
      -Inheritance diagram for FDP::validation_error:
      +Inheritance diagram for FairDataPipeline::validation_error:
      - +
      - - +

      Public Member Functions

      +
       validation_error (const std::string &message)
       
       
      The documentation for this class was generated from the following file:
      • include/fdp/exceptions.hxx
        • diff --git a/class_fair_data_pipeline_1_1validation__error.png b/class_fair_data_pipeline_1_1validation__error.png new file mode 100644 index 0000000000000000000000000000000000000000..9f6342877b4d3401cc4cd58148048055e8042e2a GIT binary patch literal 715 zcmeAS@N?(olHy`uVBq!ia0vp^r+_$sgBeKXyGiW_QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;Nm<^=N8Zr_@ted_FX{Dvpis-N06ClmrCkob&c02-pknB`j@l1PTqCW zKNs=9oLldn3Qn`Wx_tXjoo#xjPkWj6bH<4+{?5tfX|*(4L#;A%>)Kn<;rH5vPu51r z?3Pe@IYn>r4_Apby8mX1oZhiJ<&~=E^DmAKv5qtA4ELGYPg*%$W$xvt+5eMf&!2zF zQ2kH1$mBgT0gt9mT%+&Fye4(Sj#KZNjz3F1VbJ_DV!ihz&8yerCh2AGdv{%Eor-Pn zT%a?9;qGNVdghH7(~sI(#yig69e@7X#e2FoKu)DRai^eHszF1ImPkVm30T<3cz3%& zgY}94hD|F$c;On)18)!B`TE`{KK-L!es2Hw*UR?q+1kfca3zN?*ZRiA73J59?ri6` zXw%qtJ@|Igy!&dq?WIn|Oq-m|%Rc-3#h6_64R!ppp5Iu=-*NTftG(tu0lz$DRP`<~ zCvJTsJ?|#lx;@%$(=+bBcaDfMmU-tTzp+kO#{9~kbvBVnUoNjryO5vqIzMUqq92b| z%dy-LP`weITb{J`VZ!Tl=`YeZ%QOtn?rGgr{8{M$-||mu!soo5yFhxr*YrHSg)-0X zFW$39ynRdhgQvMuJ~N7yuV+1xm0!8cdTJn>bjs?t6U^Cn^O*g9$yR!MgX)@Z9BuP| z-TL3a-M~LpKDDp=9W%2*z+5f|Gf^n^jaN0^Z2dw$%c8RJ%&e6Sz?8?}>FVdQ&MBb@ E0B9dSoB#j- literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1write__error-members.html b/class_fair_data_pipeline_1_1write__error-members.html similarity index 82% rename from class_f_d_p_1_1write__error-members.html rename to class_fair_data_pipeline_1_1write__error-members.html index 9385cde..3d2be0a 100644 --- a/class_f_d_p_1_1write__error-members.html +++ b/class_fair_data_pipeline_1_1write__error-members.html @@ -63,17 +63,17 @@
      -
      FDP::write_error Member List
      +
      FairDataPipeline::write_error Member List
      -

      This is the complete list of members for FDP::write_error, including all inherited members.

      +

      This is the complete list of members for FairDataPipeline::write_error, including all inherited members.

      - +
      write_error(const std::string &message) (defined in FDP::write_error)FDP::write_errorinline
      write_error(const std::string &message) (defined in FairDataPipeline::write_error)FairDataPipeline::write_errorinline
      diff --git a/class_f_d_p_1_1write__error.html b/class_fair_data_pipeline_1_1write__error.html similarity index 81% rename from class_f_d_p_1_1write__error.html rename to class_fair_data_pipeline_1_1write__error.html index 7ff950c..e8d2bc5 100644 --- a/class_f_d_p_1_1write__error.html +++ b/class_fair_data_pipeline_1_1write__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::write_error Class Reference +cppDataPipeline: FairDataPipeline::write_error Class Reference @@ -63,28 +63,28 @@
    Public Member Functions | -List of all members
    -
    FDP::write_error Class Reference
    +List of all members
    +
    FairDataPipeline::write_error Class Reference
    -Inheritance diagram for FDP::write_error:
    +Inheritance diagram for FairDataPipeline::write_error:
    - +
    - - +

    Public Member Functions

    +
     write_error (const std::string &message)
     
     
    The documentation for this class was generated from the following file:
    • include/fdp/exceptions.hxx
      • diff --git a/class_fair_data_pipeline_1_1write__error.png b/class_fair_data_pipeline_1_1write__error.png new file mode 100644 index 0000000000000000000000000000000000000000..803fddf8a581f3345c62d458b17fc9fc7bf18279 GIT binary patch literal 673 zcmeAS@N?(olHy`uVBq!ia0vp^>w!3cgBeIhbX@HQQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;dw0X!`YqnH<%YF1#kjFM|e&O5=AKZlEPv0%dd2w55 z{cqFmZ?krtiRbbCcWvfV=bz@Sv!3UFUcd3^zt9=yEBf{OuAOYx%il2lmg2Xi3peh4 zxORKxog>>T_zQQQXjj{p9+$ewO1CdsFDN14rCEMCt8%`6z4gxvJwKM#bU139-g^7H z?(6SoUj7v5o4T1}kEQ%6Wr=;I`~N-?{n`H^Z~N=s!hffKF#VaNrtdHhgr_aOcP2;T aFT;<-jEPDPiN}EHiNVv=&t;ucLK6T1K1`4R literal 0 HcmV?d00001 diff --git a/classes.html b/classes.html index e6fe1e6..55e9f69 100644 --- a/classes.html +++ b/classes.html @@ -66,38 +66,44 @@
      Class Index
      -
      A | C | D | I | J | L | R | S | V | W
      +
      A | C | D | I | J | L | M | O | R | S | V | W
      A
      -
      API (FDP)
      ApiObject (FDP)
      +
      API (FairDataPipeline)
      ApiObject (FairDataPipeline)
      C
      -
      Config (FDP)
      config_parsing_error (FDP)
      +
      CompositeSink (FairDataPipeline::logging)
      Config (FairDataPipeline)
      config_parsing_error (FairDataPipeline)
      D
      -
      DataPipeline (FDP)
      DataPipelineImpl_
      +
      DataPipeline (FairDataPipeline)
      DataPipelineImpl_
      I
      -
      DataPipeline::impl (FDP)
      IOObject (FDP)
      +
      DataPipeline::impl (FairDataPipeline)
      IOObject (FairDataPipeline)
      ISink (FairDataPipeline::logging)
      ISinkFormatter (FairDataPipeline::logging)
      J
      -
      json_parse_error (FDP)
      +
      json_parse_error (FairDataPipeline)
      L
      -
      logger (FDP)
      +
      logger (FairDataPipeline)
      Logger (FairDataPipeline::logging)
      +
      +
      M
      +
      Logger::MsgBuilder (FairDataPipeline::logging)
      +
      +
      O
      +
      OStreamSink (FairDataPipeline::logging)
      R
      -
      rest_apiquery_error (FDP)
      +
      rest_apiquery_error (FairDataPipeline)
      S
      -
      sync_error (FDP)
      +
      Sink (FairDataPipeline::logging)
      SinkFormatter (FairDataPipeline::logging)
      sync_error (FairDataPipeline)
      V
      -
      validation_error (FDP)
      version (FDP::Versioning)
      +
      validation_error (FairDataPipeline)
      version (FairDataPipeline::Versioning)
      W
      -
      write_error (FDP)
      +
      write_error (FairDataPipeline)
      diff --git a/config_8hxx.html b/config_8hxx.html index a545175..16a931f 100644 --- a/config_8hxx.html +++ b/config_8hxx.html @@ -78,8 +78,8 @@ #include <regex>
      #include <map>
      #include <stdio.h>
      -#include "fdp/objects/metadata.hxx"
      -#include "fdp/registry/api.hxx"
      +#include "fdp/objects/metadata.hxx"
      +#include "fdp/registry/api.hxx"
      #include "fdp/objects/api_object.hxx"
      #include "fdp/objects/io_object.hxx"
      @@ -87,8 +87,8 @@ - - + +

      Classes

      class  FDP::Config
       class for interacting with confifurations More...
      class  FairDataPipeline::Config
       class for interacting with confifurations More...
       

      Detailed Description

      diff --git a/config_8hxx_source.html b/config_8hxx_source.html index bdf8674..9f58097 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -82,142 +82,143 @@
      20#include <ghc/filesystem.hpp>
      21#include <stdio.h>
      22
      -
      23#include "fdp/objects/metadata.hxx"
      -
      24#include "fdp/registry/api.hxx"
      +
      23#include "fdp/objects/metadata.hxx"
      +
      24#include "fdp/registry/api.hxx"
      25#include "fdp/objects/api_object.hxx"
      26#include "fdp/objects/io_object.hxx"
      27
      -
      28namespace FDP {
      -
      33 class Config {
      -
      34 private:
      -
      35 const ghc::filesystem::path config_file_path_;
      -
      36 const ghc::filesystem::path config_dir_;
      -
      37 const ghc::filesystem::path script_file_path_;
      -
      38 YAML::Node config_data_;
      -
      39 std::string api_url_;
      -
      40 std::string token_;
      -
      41 API::sptr api_;
      -
      42
      -
      43 ApiObject::sptr user_;
      -
      44 ApiObject::sptr author_;
      -
      45
      -
      46 ApiObject::sptr config_storage_root_;
      -
      47 ApiObject::sptr config_storage_location_;
      -
      48 ApiObject::sptr config_file_type_;
      -
      49 ApiObject::sptr config_obj_;
      +
      28namespace FairDataPipeline {
      +
      33 class Config {
      +
      34 public:
      +
      35 typedef std::shared_ptr< Config > sptr;
      +
      36
      +
      37 typedef std::map< std::string, IOObject > map_type;
      +
      38
      +
      39 private:
      +
      40 const ghc::filesystem::path config_file_path_;
      +
      41 const ghc::filesystem::path config_dir_;
      +
      42 const ghc::filesystem::path script_file_path_;
      +
      43 YAML::Node config_data_;
      +
      44 std::string api_url_;
      +
      45 std::string token_;
      +
      46 API::sptr api_;
      +
      47
      +
      48 ApiObject::sptr user_;
      +
      49 ApiObject::sptr author_;
      50
      -
      51 ApiObject::sptr script_storage_root_;
      -
      52 ApiObject::sptr script_storage_location_;
      -
      53 ApiObject::sptr script_file_type_;
      -
      54 ApiObject::sptr script_obj_;
      +
      51 ApiObject::sptr config_storage_root_;
      +
      52 ApiObject::sptr config_storage_location_;
      +
      53 ApiObject::sptr config_file_type_;
      +
      54 ApiObject::sptr config_obj_;
      55
      -
      56 ApiObject::sptr code_repo_storage_root_;
      -
      57 ApiObject::sptr code_repo_storage_location_;
      -
      58 ApiObject::sptr code_repo_obj_;
      -
      59
      -
      60 ApiObject::sptr code_run_;
      -
      61
      -
      62 std::map<std::string, IOObject> writes_;
      -
      63 std::map<std::string, IOObject> reads_;
      +
      56 ApiObject::sptr script_storage_root_;
      +
      57 ApiObject::sptr script_storage_location_;
      +
      58 ApiObject::sptr script_file_type_;
      +
      59 ApiObject::sptr script_obj_;
      +
      60
      +
      61 ApiObject::sptr code_repo_storage_root_;
      +
      62 ApiObject::sptr code_repo_storage_location_;
      +
      63 ApiObject::sptr code_repo_obj_;
      64
      -
      65 std::map<std::string, IOObject> outputs_;
      -
      66 std::map<std::string, IOObject> inputs_;
      -
      67
      -
      68 RESTAPI rest_api_location_ = RESTAPI::LOCAL;
      +
      65 ApiObject::sptr code_run_;
      +
      66
      +
      67 map_type writes_;
      +
      68 map_type reads_;
      69
      -
      70 bool config_has_writes() const;
      -
      71 bool config_has_reads() const;
      -
      72
      -
      73 void initialise(RESTAPI api_location);
      -
      74 void validate_config(ghc::filesystem::path yaml_path, RESTAPI api_location);
      -
      83 Config(const ghc::filesystem::path &config_file_path,
      -
      84 const ghc::filesystem::path &script_file_path,
      -
      85 const std::string &token,
      -
      86 RESTAPI api_location);
      -
      87
      -
      88
      -
      89 public:
      -
      90 typedef std::shared_ptr< Config > sptr;
      -
      91
      -
      92 static Config::sptr construct(const ghc::filesystem::path &config_file_path,
      -
      93 const ghc::filesystem::path &script_file_path,
      -
      94 const std::string &token,
      -
      95 RESTAPI api_location);
      -
      96
      -
      97
      -
      102 ~Config();
      -
      103
      -
      109 YAML::Node meta_data_() const;
      -
      115 YAML::Node config_writes_() const;
      -
      116
      -
      122 YAML::Node config_reads_() const;
      -
      123
      -
      130 bool has_reads() const;
      -
      137 bool has_writes() const;
      -
      144 bool has_outputs() const;
      -
      151 bool has_inputs() const;
      -
      152
      -
      159 ghc::filesystem::path get_config_file_path() const {return config_file_path_;}
      -
      171 ghc::filesystem::path get_script_file_path() const {return script_file_path_;}
      -
      172
      -
      178 std::string get_token() const {return token_;}
      -
      179
      -
      185 std::string get_api_url() const {return api_url_;}
      -
      191 ghc::filesystem::path get_data_store() const;
      -
      192
      -
      198 std::string get_default_input_namespace() const;
      -
      199
      -
      205 std::string get_default_output_namespace() const;
      -
      206
      -
      212 std::string get_config_directory() const;
      -
      213
      -
      219 std::string get_code_run_uuid() const;
      -
      220
      -
      228 ghc::filesystem::path link_write(std::string &data_product);
      -
      229
      -
      236 ghc::filesystem::path link_read(std::string &data_product);
      -
      237
      -
      244 void finalise();
      -
      245
      -
      252 static YAML::Node parse_yaml(ghc::filesystem::path yaml_path);
      -
      253
      -
      259 YAML::Node get_config_data() const {return config_data_;}
      -
      260
      -
      266 API::sptr get_api() const {return api_;}
      -
      267
      -
      273 RESTAPI get_rest_api_location() const {return rest_api_location_;}
      -
      274
      -
      275 };
      -
      276};
      -
      277#endif
      -
      api.hxx
      File containing classes and methods for connecting to the RestAPI.
      -
      FDP::RESTAPI
      RESTAPI
      selection of either local or remote pipeline running
      Definition: api.hxx:37
      -
      FDP::Config
      class for interacting with confifurations
      Definition: config.hxx:33
      -
      FDP::Config::config_writes_
      YAML::Node config_writes_() const
      Returns the writes Yaml Node from the config.
      Definition: config.cxx:43
      -
      FDP::Config::parse_yaml
      static YAML::Node parse_yaml(ghc::filesystem::path yaml_path)
      Read a given yaml file into a Yaml Node.
      Definition: config.cxx:33
      -
      FDP::Config::get_token
      std::string get_token() const
      Get the token as a string.
      Definition: config.hxx:178
      -
      FDP::Config::has_inputs
      bool has_inputs() const
      Check whether any inputs have been added.
      Definition: config.cxx:73
      -
      FDP::Config::get_default_input_namespace
      std::string get_default_input_namespace() const
      Get the default input namespace.
      Definition: config.cxx:86
      -
      FDP::Config::get_data_store
      ghc::filesystem::path get_data_store() const
      Get the data store path.
      Definition: config.cxx:81
      -
      FDP::Config::has_reads
      bool has_reads() const
      Check whether the config has reads.
      Definition: config.cxx:69
      -
      FDP::Config::~Config
      ~Config()
      Destroy the Config object.
      Definition: config.cxx:29
      -
      FDP::Config::get_script_file_path
      ghc::filesystem::path get_script_file_path() const
      Get the script file path object.
      Definition: config.hxx:171
      -
      FDP::Config::meta_data_
      YAML::Node meta_data_() const
      Returns the meta_data Yaml Node from the config.
      Definition: config.cxx:39
      -
      FDP::Config::link_read
      ghc::filesystem::path link_read(std::string &data_product)
      Return the filepath to a given data product.
      Definition: config.cxx:432
      -
      FDP::Config::finalise
      void finalise()
      Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
      Definition: config.cxx:551
      -
      FDP::Config::get_rest_api_location
      RESTAPI get_rest_api_location() const
      Get the rest api location (local / remote)
      Definition: config.hxx:273
      -
      FDP::Config::get_config_file_path
      ghc::filesystem::path get_config_file_path() const
      Get the config file path object.
      Definition: config.hxx:159
      -
      FDP::Config::get_api
      API::sptr get_api() const
      Get the api object (used to interact with the pipeline directly)
      Definition: config.hxx:266
      -
      FDP::Config::get_code_run_uuid
      std::string get_code_run_uuid() const
      Get the code run uuid.
      Definition: config.cxx:350
      -
      FDP::Config::has_writes
      bool has_writes() const
      Check whether the config has writes.
      Definition: config.cxx:65
      -
      FDP::Config::has_outputs
      bool has_outputs() const
      Check whether any outputs have been added.
      Definition: config.cxx:77
      -
      FDP::Config::get_config_data
      YAML::Node get_config_data() const
      Get the config data as a Yaml Node.
      Definition: config.hxx:259
      -
      FDP::Config::link_write
      ghc::filesystem::path link_write(std::string &data_product)
      Provide a tempory file path for a given data product to be written whilst recording metadata.
      Definition: config.cxx:355
      -
      FDP::Config::get_default_output_namespace
      std::string get_default_output_namespace() const
      Get the default output namespace.
      Definition: config.cxx:90
      -
      FDP::Config::get_api_url
      std::string get_api_url() const
      Get the api url.
      Definition: config.hxx:185
      -
      FDP::Config::get_config_directory
      std::string get_config_directory() const
      Get the config directory path as a string.
      Definition: config.cxx:346
      -
      FDP::Config::config_reads_
      YAML::Node config_reads_() const
      Returns the reads Yaml Node from the config.
      Definition: config.cxx:47
      -
      metadata.hxx
      File containing methods for handling of metadata.
      +
      70 map_type outputs_;
      +
      71 map_type inputs_;
      +
      72
      +
      73 RESTAPI rest_api_location_ = RESTAPI::LOCAL;
      +
      74
      +
      75 bool config_has_writes() const;
      +
      76 bool config_has_reads() const;
      +
      77
      +
      78 void initialise(RESTAPI api_location);
      +
      79 void validate_config(ghc::filesystem::path yaml_path, RESTAPI api_location);
      +
      88 Config(const ghc::filesystem::path &config_file_path,
      +
      89 const ghc::filesystem::path &script_file_path,
      +
      90 const std::string &token,
      +
      91 RESTAPI api_location);
      +
      92
      +
      93
      +
      94 public:
      +
      95
      +
      96 static Config::sptr construct(const ghc::filesystem::path &config_file_path,
      +
      97 const ghc::filesystem::path &script_file_path,
      +
      98 const std::string &token,
      +
      99 RESTAPI api_location);
      +
      100
      +
      101
      +
      106 ~Config();
      +
      107
      +
      113 YAML::Node meta_data_() const;
      +
      119 YAML::Node config_writes_() const;
      +
      120
      +
      126 YAML::Node config_reads_() const;
      +
      127
      +
      134 bool has_reads() const;
      +
      141 bool has_writes() const;
      +
      148 bool has_outputs() const;
      +
      155 bool has_inputs() const;
      +
      156
      +
      163 ghc::filesystem::path get_config_file_path() const {return config_file_path_;}
      +
      175 ghc::filesystem::path get_script_file_path() const {return script_file_path_;}
      +
      176
      +
      182 std::string get_token() const {return token_;}
      +
      183
      +
      189 std::string get_api_url() const {return api_url_;}
      +
      195 ghc::filesystem::path get_data_store() const;
      +
      196
      +
      202 std::string get_default_input_namespace() const;
      +
      203
      +
      209 std::string get_default_output_namespace() const;
      +
      210
      +
      216 std::string get_config_directory() const;
      +
      217
      +
      223 std::string get_code_run_uuid() const;
      +
      224
      +
      232 ghc::filesystem::path link_write( const std::string &data_product);
      +
      233
      +
      240 ghc::filesystem::path link_read(const std::string& data_product);
      +
      241
      +
      248 void finalise();
      +
      249
      +
      256 static YAML::Node parse_yaml(ghc::filesystem::path yaml_path);
      +
      257
      +
      263 YAML::Node get_config_data() const {return config_data_;}
      +
      264
      +
      270 API::sptr get_api() const {return api_;}
      +
      271
      +
      277 RESTAPI get_rest_api_location() const {return rest_api_location_;}
      +
      278
      +
      279 };
      +
      280};
      +
      281#endif
      +
      FairDataPipeline::Config
      class for interacting with confifurations
      Definition: config.hxx:33
      +
      FairDataPipeline::Config::meta_data_
      YAML::Node meta_data_() const
      Returns the meta_data Yaml Node from the config.
      Definition: config.cxx:40
      +
      FairDataPipeline::Config::link_read
      ghc::filesystem::path link_read(const std::string &data_product)
      Return the filepath to a given data product.
      Definition: config.cxx:471
      +
      FairDataPipeline::Config::get_config_data
      YAML::Node get_config_data() const
      Get the config data as a Yaml Node.
      Definition: config.hxx:263
      +
      FairDataPipeline::Config::get_config_file_path
      ghc::filesystem::path get_config_file_path() const
      Get the config file path object.
      Definition: config.hxx:163
      +
      FairDataPipeline::Config::get_default_output_namespace
      std::string get_default_output_namespace() const
      Get the default output namespace.
      Definition: config.cxx:91
      +
      FairDataPipeline::Config::get_data_store
      ghc::filesystem::path get_data_store() const
      Get the data store path.
      Definition: config.cxx:82
      +
      FairDataPipeline::Config::parse_yaml
      static YAML::Node parse_yaml(ghc::filesystem::path yaml_path)
      Read a given yaml file into a Yaml Node.
      Definition: config.cxx:34
      +
      FairDataPipeline::Config::get_api_url
      std::string get_api_url() const
      Get the api url.
      Definition: config.hxx:189
      +
      FairDataPipeline::Config::has_writes
      bool has_writes() const
      Check whether the config has writes.
      Definition: config.cxx:66
      +
      FairDataPipeline::Config::has_outputs
      bool has_outputs() const
      Check whether any outputs have been added.
      Definition: config.cxx:78
      +
      FairDataPipeline::Config::get_token
      std::string get_token() const
      Get the token as a string.
      Definition: config.hxx:182
      +
      FairDataPipeline::Config::finalise
      void finalise()
      Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
      Definition: config.cxx:614
      +
      FairDataPipeline::Config::get_script_file_path
      ghc::filesystem::path get_script_file_path() const
      Get the script file path object.
      Definition: config.hxx:175
      +
      FairDataPipeline::Config::get_api
      API::sptr get_api() const
      Get the api object (used to interact with the pipeline directly)
      Definition: config.hxx:270
      +
      FairDataPipeline::Config::link_write
      ghc::filesystem::path link_write(const std::string &data_product)
      Provide a tempory file path for a given data product to be written whilst recording metadata.
      Definition: config.cxx:378
      +
      FairDataPipeline::Config::has_inputs
      bool has_inputs() const
      Check whether any inputs have been added.
      Definition: config.cxx:74
      +
      FairDataPipeline::Config::config_writes_
      YAML::Node config_writes_() const
      Returns the writes Yaml Node from the config.
      Definition: config.cxx:44
      +
      FairDataPipeline::Config::get_rest_api_location
      RESTAPI get_rest_api_location() const
      Get the rest api location (local / remote)
      Definition: config.hxx:277
      +
      FairDataPipeline::Config::config_reads_
      YAML::Node config_reads_() const
      Returns the reads Yaml Node from the config.
      Definition: config.cxx:48
      +
      FairDataPipeline::Config::~Config
      ~Config()
      Destroy the Config object.
      Definition: config.cxx:31
      +
      FairDataPipeline::Config::get_default_input_namespace
      std::string get_default_input_namespace() const
      Get the default input namespace.
      Definition: config.cxx:87
      +
      FairDataPipeline::Config::get_config_directory
      std::string get_config_directory() const
      Get the config directory path as a string.
      Definition: config.cxx:369
      +
      FairDataPipeline::Config::get_code_run_uuid
      std::string get_code_run_uuid() const
      Get the code run uuid.
      Definition: config.cxx:373
      +
      FairDataPipeline::Config::has_reads
      bool has_reads() const
      Check whether the config has reads.
      Definition: config.cxx:70
      diff --git a/data__io_8hxx_source.html b/data__io_8hxx_source.html index 765b5b5..bb87b70 100644 --- a/data__io_8hxx_source.html +++ b/data__io_8hxx_source.html @@ -86,11 +86,11 @@
      23#include <iostream>
      24
      25#include "fdp/objects/config.hxx"
      -
      26#include "fdp/objects/metadata.hxx"
      -
      27#include "fdp/utilities/logging.hxx"
      -
      28#include "fdp/utilities/semver.hxx"
      +
      26#include "fdp/objects/metadata.hxx"
      +
      27#include "fdp/utilities/logging.hxx"
      +
      28#include "fdp/utilities/semver.hxx"
      29
      -
      30namespace FDP {
      +
      30namespace FairDataPipeline {
      31
      47double read_point_estimate_from_toml(const ghc::filesystem::path var_address);
      48
      @@ -125,22 +125,20 @@
      87
      88 toml_out_.close();
      89
      -
      90 APILogger->debug("FileSystem:CreateEstimate: Wrote point estimate to '{0}'",
      -
      91 output_filename_.string());
      -
      92
      -
      93 return output_filename_;
      -
      94}
      -
      95
      -
      102std::string get_first_key_(const toml::value data_table);
      -
      103
      -
      104}; // namespace FDP
      +
      90
      +
      91 auto the_logger = logger::get_logger();
      +
      92 the_logger->debug()
      +
      93 << "FileSystem:CreateEstimate: Wrote point estimate to '" << output_filename_.string() << "'";
      +
      94
      +
      95 return output_filename_;
      +
      96}
      +
      97
      +
      104std::string get_first_key_(const toml::value data_table);
      105
      -
      106#endif
      +
      106}; // namespace FairDataPipeline
      +
      107
      +
      108#endif
      -
      logging.hxx
      File contains pointers for creating global logger during session.
      -
      FDP::APILogger
      const logger::sptr APILogger
      Global logger used across all FDP scripts.
      Definition: logging.cxx:19
      -
      metadata.hxx
      File containing methods for handling of metadata.
      -
      semver.hxx
      File contains classes and types for validating semantic versioning.
      diff --git a/class_f_d_p_1_1logger-members.html b/dir_8c20949084a9f35c1e6bd2c48f358243.html similarity index 79% rename from class_f_d_p_1_1logger-members.html rename to dir_8c20949084a9f35c1e6bd2c48f358243.html index 9ad5c15..27961ec 100644 --- a/class_f_d_p_1_1logger-members.html +++ b/dir_8c20949084a9f35c1e6bd2c48f358243.html @@ -5,7 +5,7 @@ -cppDataPipeline: Member List +cppDataPipeline: include/windows_sys Directory Reference @@ -63,18 +63,14 @@
    -
    FDP::logger Member List
    +
    windows_sys Directory Reference
    - -

    This is the complete list of members for FDP::logger, including all inherited members.

    - - -
    sptr typedef (defined in FDP::logger)FDP::logger
    +
    Generated by doxygen 1.9.2 diff --git a/dir_ac6c6686346e4bb6ee59787dd26cbe81.html b/dir_ac6c6686346e4bb6ee59787dd26cbe81.html index cf86882..1aeb6f3 100644 --- a/dir_ac6c6686346e4bb6ee59787dd26cbe81.html +++ b/dir_ac6c6686346e4bb6ee59787dd26cbe81.html @@ -70,19 +70,6 @@
    utilities Directory Reference
    - - - - - - - - - - - -

    -Files

    file  json.hxx [code]
     File contains methods relating to handling of JSON based data.
     
    file  logging.hxx [code]
     File contains pointers for creating global logger during session.
     
    file  semver.hxx [code]
     File contains classes and types for validating semantic versioning.
     
    diff --git a/dir_d98af0b859cb0744225e11c767d17cdb.html b/dir_d98af0b859cb0744225e11c767d17cdb.html index a2add24..46a9b4c 100644 --- a/dir_d98af0b859cb0744225e11c767d17cdb.html +++ b/dir_d98af0b859cb0744225e11c767d17cdb.html @@ -70,13 +70,6 @@
    registry Directory Reference
    - - - - - -

    -Files

    file  api.hxx [code]
     File containing classes and methods for connecting to the RestAPI.
     
    diff --git a/dir_f537a5f098b413116eae11cd84c41a43.html b/dir_f537a5f098b413116eae11cd84c41a43.html index 92eca82..393696d 100644 --- a/dir_f537a5f098b413116eae11cd84c41a43.html +++ b/dir_f537a5f098b413116eae11cd84c41a43.html @@ -75,9 +75,6 @@ Files

    file  config.hxx [code]   -file  metadata.hxx [code] - File containing methods for handling of metadata.
    -  diff --git a/exceptions_8hxx_source.html b/exceptions_8hxx_source.html index 06533f0..71a334b 100644 --- a/exceptions_8hxx_source.html +++ b/exceptions_8hxx_source.html @@ -76,48 +76,48 @@
    4#include <stdexcept>
    5#include <string>
    6
    -
    7namespace FDP {
    -
    8class config_parsing_error : public std::runtime_error {
    +
    7namespace FairDataPipeline {
    +
    8class config_parsing_error : public std::runtime_error {
    9public:
    -
    10 config_parsing_error(const std::string& message)
    +
    10 config_parsing_error(const std::string& message)
    11 : std::runtime_error(message) {}
    12};
    13
    -
    14class rest_apiquery_error : public std::runtime_error {
    +
    14class rest_apiquery_error : public std::runtime_error {
    15public:
    -
    16 rest_apiquery_error(const std::string& message)
    +
    16 rest_apiquery_error(const std::string& message)
    17 : std::runtime_error(message) {}
    18};
    19
    -
    20class json_parse_error : public std::runtime_error {
    +
    20class json_parse_error : public std::runtime_error {
    21public:
    -
    22 json_parse_error(const std::string& message) : std::runtime_error(message) {}
    +
    22 json_parse_error(const std::string& message) : std::runtime_error(message) {}
    23};
    24
    -
    25class validation_error : public std::runtime_error {
    +
    25class validation_error : public std::runtime_error {
    26public:
    -
    27 validation_error(const std::string& message) : std::runtime_error(message) {}
    +
    27 validation_error(const std::string& message) : std::runtime_error(message) {}
    28};
    29
    -
    30class sync_error : public std::runtime_error {
    +
    30class sync_error : public std::runtime_error {
    31public:
    -
    32 sync_error(const std::string& message) : std::runtime_error(message) {}
    +
    32 sync_error(const std::string& message) : std::runtime_error(message) {}
    33};
    34
    -
    35class write_error : public std::runtime_error {
    +
    35class write_error : public std::runtime_error {
    36public:
    -
    37 write_error(const std::string& message) : std::runtime_error(message) {}
    +
    37 write_error(const std::string& message) : std::runtime_error(message) {}
    38};
    39
    -
    40}; // namespace FDP
    +
    40}; // namespace FairDataPipeline
    41
    42#endif
    -
    FDP::config_parsing_error
    Definition: exceptions.hxx:8
    -
    FDP::json_parse_error
    Definition: exceptions.hxx:20
    -
    FDP::rest_apiquery_error
    Definition: exceptions.hxx:14
    -
    FDP::sync_error
    Definition: exceptions.hxx:30
    -
    FDP::validation_error
    Definition: exceptions.hxx:25
    -
    FDP::write_error
    Definition: exceptions.hxx:35
    +
    FairDataPipeline::config_parsing_error
    Definition: exceptions.hxx:8
    +
    FairDataPipeline::json_parse_error
    Definition: exceptions.hxx:20
    +
    FairDataPipeline::rest_apiquery_error
    Definition: exceptions.hxx:14
    +
    FairDataPipeline::sync_error
    Definition: exceptions.hxx:30
    +
    FairDataPipeline::validation_error
    Definition: exceptions.hxx:25
    +
    FairDataPipeline::write_error
    Definition: exceptions.hxx:35
    diff --git a/fdp_8hxx_source.html b/fdp_8hxx_source.html index dc3cf6d..d502568 100644 --- a/fdp_8hxx_source.html +++ b/fdp_8hxx_source.html @@ -73,50 +73,57 @@
    1#ifndef __FDP__
    2#define __FDP__
    3
    -
    4#include "spdlog/spdlog.h"
    -
    5#include <ghc/filesystem.hpp>
    -
    6
    -
    7//#include "fdp/registry/datapipeline.hxx"
    -
    8
    -
    9namespace FDP {
    -
    15 class DataPipeline {
    -
    16
    -
    17 public:
    -
    26 explicit DataPipeline(
    -
    27 const std::string &config_file_path,
    -
    28 const std::string &script_file_path,
    -
    29 std::string token = "",
    -
    30 spdlog::level::level_enum log_level = spdlog::level::info);
    -
    31
    -
    36 ~DataPipeline();
    -
    37
    -
    38 DataPipeline(DataPipeline &&rhs) noexcept;
    -
    39 DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    +
    4#include "utilities/logging.hxx"
    +
    5
    +
    6#include <ghc/filesystem.hpp>
    +
    7
    +
    8namespace FairDataPipeline {
    +
    14 class DataPipeline {
    +
    15
    +
    16 public:
    +
    17 typedef std::shared_ptr< DataPipeline > sptr;
    +
    25 static sptr construct(
    +
    26 const std::string &config_file_path,
    +
    27 const std::string &script_file_path,
    +
    28 std::string token = "" );
    +
    29
    +
    30
    +
    35 ~DataPipeline();
    +
    36
    +
    37 //DataPipeline(DataPipeline &&rhs) noexcept;
    +
    38 //DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    +
    39
    40
    -
    41 DataPipeline(const DataPipeline &rhs);
    -
    42 DataPipeline &operator=(const DataPipeline &rhs);
    -
    43
    -
    51 ghc::filesystem::path link_read(std::string &data_product);
    -
    52
    -
    60 ghc::filesystem::path link_write(std::string &data_product);
    -
    61
    -
    68 void finalise();
    -
    69
    -
    70 private:
    -
    71 class impl;
    -
    72
    -
    73 std::shared_ptr< DataPipeline::impl > pimpl_;
    -
    74 };
    -
    75}; // namespace FDP
    -
    76
    -
    77#endif
    -
    FDP::DataPipeline::impl
    Definition: fdp.cxx:30
    -
    FDP::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:15
    -
    FDP::DataPipeline::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:185
    -
    FDP::DataPipeline::~DataPipeline
    ~DataPipeline()
    Destroy the Data Pipeline object.
    -
    FDP::DataPipeline::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:181
    -
    FDP::DataPipeline::DataPipeline
    DataPipeline(const std::string &config_file_path, const std::string &script_file_path, std::string token="", spdlog::level::level_enum log_level=spdlog::level::info)
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.cxx:162
    -
    FDP::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:189
    +
    48 ghc::filesystem::path link_read(std::string &data_product);
    +
    49
    +
    57 ghc::filesystem::path link_write(std::string &data_product);
    +
    58
    +
    65 void finalise();
    +
    66
    +
    67 private:
    +
    68 explicit DataPipeline(
    +
    69 const std::string &config_file_path,
    +
    70 const std::string &script_file_path,
    +
    71 std::string token = ""
    +
    72 );
    +
    73
    +
    74 DataPipeline(const DataPipeline &rhs) = delete;
    +
    75
    +
    76 DataPipeline &operator=(const DataPipeline &rhs) = delete;
    +
    77
    +
    78 class impl;
    +
    79
    +
    80 std::shared_ptr< DataPipeline::impl > pimpl_;
    +
    81 };
    +
    82}; // namespace FairDataPipeline
    +
    83#endif
    + +
    FairDataPipeline::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:14
    +
    FairDataPipeline::DataPipeline::construct
    static sptr construct(const std::string &config_file_path, const std::string &script_file_path, std::string token="")
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.cxx:153
    +
    FairDataPipeline::DataPipeline::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:179
    +
    FairDataPipeline::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:183
    +
    FairDataPipeline::DataPipeline::~DataPipeline
    ~DataPipeline()
    Destroy the Data Pipeline object.
    +
    FairDataPipeline::DataPipeline::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:175
    diff --git a/files.html b/files.html index 671d3aa..95e9edb 100644 --- a/files.html +++ b/files.html @@ -74,16 +74,19 @@  api_object.hxx  config.hxx  io_object.hxx - metadata.hxxFile containing methods for handling of metadata + metadata.hxx  ▼ registry - api.hxxFile containing classes and methods for connecting to the RestAPI + api.hxx  data_io.hxx  ▼ utilities - json.hxxFile contains methods relating to handling of JSON based data - logging.hxxFile contains pointers for creating global logger during session - semver.hxxFile contains classes and types for validating semantic versioning + json.hxx + logging.hxx + semver.hxx  exceptions.hxx  fdp.hxx + ▼ windows_sys + time.h + times.h diff --git a/functions.html b/functions.html index 37f9ea3..fc3f3d6 100644 --- a/functions.html +++ b/functions.html @@ -66,127 +66,120 @@
    Here is a list of all documented class members with links to the class documentation for each member:

    - a -

    - c -

    - - -

    - d -

    - e -

    - f -

    - g -

    - h -

    - i -

    - j -

    - l -

    - m -

    - p -

    - r -

    - s -

    - v -

    - ~ -

    diff --git a/functions_func.html b/functions_func.html index 3459360..3f882e7 100644 --- a/functions_func.html +++ b/functions_func.html @@ -66,127 +66,120 @@  

    - a -

    - c -

    - - -

    - d -

    - e -

    - f -

    - g -

    - h -

    - i -

    - j -

    - l -

    - m -

    - p -

    - r -

    - s -

    - v -

    - ~ -

    diff --git a/hierarchy.html b/hierarchy.html index 78d0e04..74cdaac 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -67,23 +67,31 @@
    This inheritance list is sorted roughly, but not completely, alphabetically:
    -
    [detail level 12]
    - - - - +
    [detail level 123]
     CFDP::APIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CFDP::ApiObjectClass for API objects
     CFDP::ConfigClass for interacting with confifurations
     CFDP::DataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
    + + + + - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
     CFairDataPipeline::APIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CFairDataPipeline::ApiObjectClass for API objects
     CFairDataPipeline::ConfigClass for interacting with confifurations
     CFairDataPipeline::DataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
     CFDP::DataPipeline::impl
     CFDP::IOObjectClass for API objects
     CFDP::logger
     ▼Cstd::runtime_error
     CFDP::config_parsing_error
     CFDP::json_parse_error
     CFDP::rest_apiquery_error
     CFDP::sync_error
     CFDP::validation_error
     CFDP::write_error
     CFDP::Versioning::versionClass describing the semantic version of an object
     CFairDataPipeline::DataPipeline::impl
     CFairDataPipeline::IOObjectClass for API objects
     ▼CFairDataPipeline::logging::ISink
     ▼CFairDataPipeline::logging::Sink
     CFairDataPipeline::logging::CompositeSink
     CFairDataPipeline::logging::OStreamSink
     ▼CFairDataPipeline::logging::ISinkFormatter
     CFairDataPipeline::logging::SinkFormatter
     CFairDataPipeline::logger
     CFairDataPipeline::logging::Logger
     CFairDataPipeline::logging::Logger::MsgBuilder
     ▼Cstd::runtime_error
     CFairDataPipeline::config_parsing_error
     CFairDataPipeline::json_parse_error
     CFairDataPipeline::rest_apiquery_error
     CFairDataPipeline::sync_error
     CFairDataPipeline::validation_error
     CFairDataPipeline::write_error
     CFairDataPipeline::Versioning::versionClass describing the semantic version of an object
    diff --git a/index.html b/index.html index df0dcd3..0337cb4 100644 --- a/index.html +++ b/index.html @@ -88,14 +88,17 @@

    Outline

    The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

    -

    +

    +Logging

    +

    The environment variable FDP_LOG_LEVEL=[TRACE:DEBUG:INFO:WARN:ERROR:CRITICAL:OFF] can be set to specify the logging output level.

    +

    Unit Tests

    The unit tests use the local registry, this needs to be running prior to running the tests see: the CLI documentation

    Tests can be lauched using the following command:

    -

    +

    Unix

    $ ./build/bin/fdpapi-tests
    -

    +

    Windows

    $ build\bin\Release\fdpapi-tests.exe
    diff --git a/io__object_8hxx_source.html b/io__object_8hxx_source.html index 57072d1..e58a5cd 100644 --- a/io__object_8hxx_source.html +++ b/io__object_8hxx_source.html @@ -77,11 +77,11 @@
    5#include <cstddef>
    6#include <json/value.h>
    7
    -
    8#include "fdp/utilities/logging.hxx"
    +
    8#include "fdp/utilities/logging.hxx"
    9#include "fdp/objects/api_object.hxx"
    10
    -
    11namespace FDP {
    -
    16 class IOObject {
    +
    11namespace FairDataPipeline {
    +
    16 class IOObject {
    17 private:
    18 std::string data_product_;
    19 std::string use_data_product_;
    @@ -97,8 +97,8 @@
    29 ApiObject::sptr data_product_obj_;
    30
    31 public:
    -
    36 IOObject() = default;
    -
    49 IOObject (const std::string& data_product,
    +
    36 IOObject() = default;
    +
    49 IOObject (const std::string& data_product,
    50 const std::string& use_data_product,
    51 const std::string& use_version,
    52 const std::string& use_namespace,
    @@ -114,71 +114,70 @@
    62 data_product_description_(data_product_description),
    63 public_(isPublic){};
    64
    -
    77 IOObject( const std::string& data_product,
    +
    77 IOObject( const std::string& data_product,
    78 const std::string& use_data_product,
    79 const std::string& use_version,
    80 const std::string& use_namespace,
    81 ghc::filesystem::path path,
    -
    82 ApiObject &component_obj,
    -
    83 ApiObject &data_product_obj)
    +
    82 ApiObject &component_obj,
    +
    83 ApiObject &data_product_obj)
    84 :
    85 data_product_(data_product),
    86 use_data_product_(use_data_product),
    87 use_version_(use_version),
    88 use_namespace_(use_namespace),
    89 path_(path),
    -
    90 component_obj_(std::make_shared<ApiObject>(component_obj)),
    -
    91 data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
    +
    90 component_obj_(std::make_shared<ApiObject>(component_obj)),
    +
    91 data_product_obj_(std::make_shared<ApiObject>(data_product_obj)){};
    92
    -
    98 const std::string& get_data_product() const {return data_product_;}
    +
    98 const std::string& get_data_product() const {return data_product_;}
    99
    -
    105 const std::string& get_use_data_product() const {return use_data_product_;}
    +
    105 const std::string& get_use_data_product() const {return use_data_product_;}
    106
    -
    112 const std::string& get_use_component() const {return use_component_;}
    +
    112 const std::string& get_use_component() const {return use_component_;}
    113
    -
    119 const std::string& get_use_version() const {return use_version_;}
    +
    119 const std::string& get_use_version() const {return use_version_;}
    120
    -
    126 const std::string& get_use_namespace() {return use_namespace_;}
    +
    126 const std::string& get_use_namespace() const {return use_namespace_;}
    127
    -
    133 ghc::filesystem::path get_path() const {return path_;}
    +
    133 ghc::filesystem::path get_path() const {return path_;}
    134
    -
    140 const std::string& get_data_product_description() const {return data_product_description_;}
    +
    140 const std::string& get_data_product_description() const {return data_product_description_;}
    141
    -
    147 const std::string& get_component_description() {return component_description_;}
    +
    147 const std::string& get_component_description() const {return component_description_;}
    148
    -
    155 bool is_public() const {return public_;}
    +
    155 bool is_public() const {return public_;}
    156
    -
    162 ApiObject::sptr get_component_object() const {return component_obj_;}
    +
    162 ApiObject::sptr get_component_object() const {return component_obj_;}
    163
    164
    -
    170 ApiObject::sptr get_data_product_object() const {return data_product_obj_;}
    +
    170 ApiObject::sptr get_data_product_object() const {return data_product_obj_;}
    171
    -
    177 void set_component_object(ApiObject& component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
    +
    177 void set_component_object(ApiObject& component_obj){component_obj_ = std::make_shared<ApiObject>(component_obj);}
    178
    -
    184 void set_data_product_object(ApiObject &data_product_obj){data_product_obj_ = std::make_shared<ApiObject>(data_product_obj);}
    +
    184 void set_data_product_object(ApiObject &data_product_obj){data_product_obj_ = std::make_shared<ApiObject>(data_product_obj);}
    185 };
    186};
    187
    188#endif
    -
    FDP::ApiObject
    Class for API objects.
    Definition: api_object.hxx:15
    -
    FDP::IOObject
    Class for API objects.
    Definition: io_object.hxx:16
    -
    FDP::IOObject::get_use_data_product
    const std::string & get_use_data_product() const
    Get the use data product as a string.
    Definition: io_object.hxx:105
    -
    FDP::IOObject::IOObject
    IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
    Construct a new IOObject object Used to store inputs and outputs for in the config.
    Definition: io_object.hxx:77
    -
    FDP::IOObject::get_use_component
    const std::string & get_use_component() const
    Get the use component as a string.
    Definition: io_object.hxx:112
    -
    FDP::IOObject::set_data_product_object
    void set_data_product_object(ApiObject &data_product_obj)
    Set the data product object object.
    Definition: io_object.hxx:184
    -
    FDP::IOObject::get_use_version
    const std::string & get_use_version() const
    Get the use version as a string.
    Definition: io_object.hxx:119
    -
    FDP::IOObject::get_data_product
    const std::string & get_data_product() const
    Get the data product as a string.
    Definition: io_object.hxx:98
    -
    FDP::IOObject::is_public
    bool is_public() const
    Check whether the data product is public.
    Definition: io_object.hxx:155
    -
    FDP::IOObject::IOObject
    IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
    Construct a new IOObject object Used to store inputs and outputs for in the config.
    Definition: io_object.hxx:49
    -
    FDP::IOObject::IOObject
    IOObject()=default
    Construct a new IOObject object (empty constructor)
    -
    FDP::IOObject::get_path
    ghc::filesystem::path get_path() const
    Get the path of the data product.
    Definition: io_object.hxx:133
    -
    FDP::IOObject::get_component_description
    const std::string & get_component_description()
    Get the component description as a string.
    Definition: io_object.hxx:147
    -
    FDP::IOObject::set_component_object
    void set_component_object(ApiObject &component_obj)
    Set the component object object.
    Definition: io_object.hxx:177
    -
    FDP::IOObject::get_data_product_description
    const std::string & get_data_product_description() const
    Get the data product description as a string.
    Definition: io_object.hxx:140
    -
    FDP::IOObject::get_use_namespace
    const std::string & get_use_namespace()
    Get the use namespace as a string.
    Definition: io_object.hxx:126
    -
    FDP::IOObject::get_component_object
    ApiObject::sptr get_component_object() const
    Get the component object object.
    Definition: io_object.hxx:162
    -
    FDP::IOObject::get_data_product_object
    ApiObject::sptr get_data_product_object() const
    Get the data product object object.
    Definition: io_object.hxx:170
    -
    logging.hxx
    File contains pointers for creating global logger during session.
    +
    FairDataPipeline::ApiObject
    Class for API objects.
    Definition: api_object.hxx:15
    +
    FairDataPipeline::IOObject
    Class for API objects.
    Definition: io_object.hxx:16
    +
    FairDataPipeline::IOObject::IOObject
    IOObject()=default
    Construct a new IOObject object (empty constructor)
    +
    FairDataPipeline::IOObject::get_path
    ghc::filesystem::path get_path() const
    Get the path of the data product.
    Definition: io_object.hxx:133
    +
    FairDataPipeline::IOObject::get_component_description
    const std::string & get_component_description() const
    Get the component description as a string.
    Definition: io_object.hxx:147
    +
    FairDataPipeline::IOObject::get_use_component
    const std::string & get_use_component() const
    Get the use component as a string.
    Definition: io_object.hxx:112
    +
    FairDataPipeline::IOObject::get_component_object
    ApiObject::sptr get_component_object() const
    Get the component object object.
    Definition: io_object.hxx:162
    +
    FairDataPipeline::IOObject::get_data_product_description
    const std::string & get_data_product_description() const
    Get the data product description as a string.
    Definition: io_object.hxx:140
    +
    FairDataPipeline::IOObject::set_component_object
    void set_component_object(ApiObject &component_obj)
    Set the component object object.
    Definition: io_object.hxx:177
    +
    FairDataPipeline::IOObject::set_data_product_object
    void set_data_product_object(ApiObject &data_product_obj)
    Set the data product object object.
    Definition: io_object.hxx:184
    +
    FairDataPipeline::IOObject::get_data_product_object
    ApiObject::sptr get_data_product_object() const
    Get the data product object object.
    Definition: io_object.hxx:170
    +
    FairDataPipeline::IOObject::get_use_namespace
    const std::string & get_use_namespace() const
    Get the use namespace as a string.
    Definition: io_object.hxx:126
    +
    FairDataPipeline::IOObject::IOObject
    IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
    Construct a new IOObject object Used to store inputs and outputs for in the config.
    Definition: io_object.hxx:49
    +
    FairDataPipeline::IOObject::get_use_version
    const std::string & get_use_version() const
    Get the use version as a string.
    Definition: io_object.hxx:119
    +
    FairDataPipeline::IOObject::IOObject
    IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
    Construct a new IOObject object Used to store inputs and outputs for in the config.
    Definition: io_object.hxx:77
    +
    FairDataPipeline::IOObject::get_use_data_product
    const std::string & get_use_data_product() const
    Get the use data product as a string.
    Definition: io_object.hxx:105
    +
    FairDataPipeline::IOObject::get_data_product
    const std::string & get_data_product() const
    Get the data product as a string.
    Definition: io_object.hxx:98
    +
    FairDataPipeline::IOObject::is_public
    bool is_public() const
    Check whether the data product is public.
    Definition: io_object.hxx:155
    diff --git a/json_8hxx.html b/json_8hxx.html deleted file mode 100644 index 247bd5b..0000000 --- a/json_8hxx.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - -cppDataPipeline: include/fdp/utilities/json.hxx File Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    -Functions
    -
    json.hxx File Reference
    -
    -
    - -

    File contains methods relating to handling of JSON based data. -More...

    -
    #include <json/writer.h>
    -
    -

    Go to the source code of this file.

    - - - - - -

    -Functions

    std::string FDP::json_to_string (Json::Value &json_data)
     convert a JSON object to string form More...
     
    -

    Detailed Description

    -

    File contains methods relating to handling of JSON based data.

    -
    -
    Author
    K. Zarebski (UKAEA)
    -
    Date
    2021-05-06
    -

    This file contains methods which modify/change the form of data which is held as a JSON string

    -

    Function Documentation

    - -

    ◆ json_to_string()

    - -
    -
    - - - - - - - - -
    std::string FDP::json_to_string (Json::Value & json_data)
    -
    - -

    convert a JSON object to string form

    -
    -
    Author
    K. Zarebski (UKAEA)
    -
    Parameters
    - - -
    json_dataJSON data held in a Json::Value object
    -
    -
    -
    Returns
    the data as a JSON string
    -

    -Test Case

    -

    test/test_utilities.cxx: TestJSONString

    -

    This unit test checks that the JSON string constructed from a Json::Value object matches expectation

    -
    -
    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/json_8hxx_source.html b/json_8hxx_source.html index dbc6377..18e83d8 100644 --- a/json_8hxx_source.html +++ b/json_8hxx_source.html @@ -70,18 +70,17 @@
    json.hxx
    -Go to the documentation of this file.
    1
    +
    1
    10#ifndef __FDP_JSON_HXX__
    11#define __FDP_JSON_HXX__
    12
    13#include <json/writer.h>
    14
    -
    15namespace FDP {
    -
    31std::string json_to_string(Json::Value &json_data);
    -
    32}; // namespace FDP
    +
    15namespace FairDataPipeline {
    +
    31std::string json_to_string(Json::Value &json_data);
    +
    32}; // namespace FairDataPipeline
    33
    34#endif
    -
    FDP::json_to_string
    std::string json_to_string(Json::Value &json_data)
    convert a JSON object to string form
    Definition: json.cxx:4
    diff --git a/logging_8hxx.html b/logging_8hxx.html deleted file mode 100644 index 8a56784..0000000 --- a/logging_8hxx.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - -cppDataPipeline: include/fdp/utilities/logging.hxx File Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    -Classes | -Variables
    -
    logging.hxx File Reference
    -
    -
    - -

    File contains pointers for creating global logger during session. -More...

    -
    #include "spdlog/sinks/stdout_color_sinks.h"
    -#include "spdlog/spdlog.h"
    -
    -

    Go to the source code of this file.

    - - - - -

    -Classes

    class  FDP::logger
     
    - - - - -

    -Variables

    const logger::sptr FDP::APILogger = create_logger()
     Global logger used across all FDP scripts. More...
     
    -

    Detailed Description

    -

    File contains pointers for creating global logger during session.

    -
    -
    Author
    K. Zarebski (UKAEA)
    -
    Date
    2021-05-06
    -

    This file should be included in all FDP header files as it allows all debug/error information to be output to the same logger and hence the same terminal session. It uses the SPDLog library.

    -

    Variable Documentation

    - -

    ◆ APILogger

    - -
    -
    - - - - -
    const logger::sptr FDP::APILogger = create_logger()
    -
    - -

    Global logger used across all FDP scripts.

    -
    Author
    K. Zarebski (UKAEA)
    - -
    -
    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/logging_8hxx_source.html b/logging_8hxx_source.html index c15ec63..5267e21 100644 --- a/logging_8hxx_source.html +++ b/logging_8hxx_source.html @@ -70,30 +70,211 @@
    logging.hxx
    -Go to the documentation of this file.
    1
    +
    1
    11#ifndef __FDP_LOGGING_HXX__
    12#define __FDP_LOGGING_HXX__
    -
    13
    -
    14#include "spdlog/sinks/stdout_color_sinks.h"
    -
    15#include "spdlog/spdlog.h"
    -
    16
    -
    17namespace FDP {
    +
    13#include <memory>
    +
    14#include <iostream>
    +
    15#include <sstream>
    +
    16#include <string>
    +
    17#include <vector>
    18
    -
    19 class logger
    -
    20 {
    -
    21 public:
    -
    22 typedef std::shared_ptr<spdlog::logger> sptr;
    -
    23 private:
    -
    24 };
    -
    25
    -
    31 extern const logger::sptr APILogger;
    -
    32} // namespace FDP
    -
    33
    +
    19namespace FairDataPipeline {
    +
    20 namespace logging {
    +
    21
    +
    22 enum LOG_LEVEL
    +
    23 {
    +
    24 TRACE = 0,
    +
    25 DEBUG = 1,
    +
    26 INFO = 2,
    +
    27 WARN = 3,
    +
    28 ERROR = 4,
    +
    29 CRITICAL = 5,
    +
    30 OFF = 6
    +
    31 };
    +
    32
    +
    33 const std::string& to_string( enum LOG_LEVEL lvl );
    34
    -
    35
    -
    36#endif
    -
    FDP::logger
    Definition: logging.hxx:20
    -
    FDP::APILogger
    const logger::sptr APILogger
    Global logger used across all FDP scripts.
    Definition: logging.cxx:19
    +
    35 struct ISink
    +
    36 {
    +
    37 typedef std::shared_ptr< ISink > sptr;
    +
    38 virtual int log( enum LOG_LEVEL msg_lvl, const std::string& msg ) = 0;
    +
    39 virtual ~ISink(){};
    +
    40 };
    +
    41
    +
    42 class Logger;
    +
    43
    +
    44 class SinkFormatter;
    +
    45 typedef std::shared_ptr< SinkFormatter > SinkFormatterPtr;
    +
    46
    +
    47 struct ISinkFormatter
    +
    48 {
    +
    49 typedef std::shared_ptr< ISinkFormatter > sptr;
    +
    50 virtual std::string header(enum LOG_LEVEL msg_lvl, Logger* logger )= 0;
    +
    51 virtual ~ISinkFormatter(){;}
    +
    52 };
    +
    53
    +
    54
    +
    55 class Sink : public ISink
    +
    56 {
    +
    57 public:
    +
    58 typedef std::shared_ptr< Sink > sptr;
    +
    59
    +
    60
    +
    61 enum LOG_LEVEL log_level();
    +
    62 void log_level( enum LOG_LEVEL log_lvl );
    +
    63
    +
    64 bool should_log( enum LOG_LEVEL msg_lvl );
    +
    65
    +
    66 void set_formatter( ISinkFormatter::sptr fmtr ){_fmtr = fmtr;}
    +
    67
    +
    68 int execute( Logger* logger, enum LOG_LEVEL msg_lvl, const std::string& s );
    +
    69
    +
    70 protected:
    +
    71 Sink( enum LOG_LEVEL log_lvl );
    +
    72
    +
    73 private:
    +
    74
    +
    75
    +
    76 enum LOG_LEVEL _log_lvl;
    +
    77 ISinkFormatter::sptr _fmtr;
    +
    78 };
    +
    79
    +
    80
    +
    81 class OStreamSink : public Sink
    +
    82 {
    +
    83 public:
    +
    84 typedef std::shared_ptr< OStreamSink > sptr;
    +
    85
    +
    86 static sptr create( enum LOG_LEVEL lvl, std::ostream& os );
    +
    87
    +
    88 int log( enum LOG_LEVEL msg_lvl, const std::string& s);
    +
    89
    +
    90 private:
    +
    91
    +
    92 OStreamSink(enum LOG_LEVEL log_lvl, std::ostream& os);
    +
    93
    +
    94 std::ostream& _os;
    +
    95 };
    +
    96
    +
    97 class CompositeSink : public Sink
    +
    98 {
    +
    99 public:
    +
    100 typedef std::shared_ptr< CompositeSink > sptr;
    +
    101
    +
    102
    +
    103 static sptr create( enum LOG_LEVEL lvl ){ return sptr( new CompositeSink( lvl ) ); }
    +
    104
    +
    105
    +
    106 int log( enum LOG_LEVEL msg_lvl, const std::string& s);
    +
    107 void add_sink( Sink::sptr sink ){ _sinks.push_back( sink ); }
    +
    108
    +
    109 private:
    +
    110 std::vector< Sink::sptr > _sinks;
    +
    111
    +
    112 CompositeSink(enum LOG_LEVEL log_lvl) : Sink(log_lvl){ ;}
    +
    113 };
    +
    114
    +
    115
    +
    116 class SinkFormatter : public ISinkFormatter
    +
    117 {
    +
    118 public:
    +
    119 typedef std::shared_ptr< SinkFormatter > sptr;
    +
    120
    +
    121 static sptr create(){ return sptr( new SinkFormatter() ); }
    +
    122
    +
    123 ~SinkFormatter()
    +
    124 {
    +
    125 }
    +
    126
    +
    127 std::string header( enum LOG_LEVEL msg_lvl, Logger* logger );
    +
    128
    +
    129 private:
    +
    130 SinkFormatter(){}
    +
    131 };
    +
    132
    +
    133 class Logger
    +
    134 {
    +
    135 public:
    +
    136 typedef std::shared_ptr< Logger > sptr;
    +
    137 class MsgBuilder
    +
    138 {
    +
    139 public:
    +
    140 friend class Logger;
    +
    141 typedef std::shared_ptr< MsgBuilder > sptr;
    +
    142
    +
    143 ~MsgBuilder();
    +
    144
    +
    145 template< typename T >
    +
    146 MsgBuilder& operator<<( const T& s)
    +
    147 {
    +
    148 if( _logger->sink()->should_log( _msg_lvl ) )
    +
    149 {
    +
    150 _oss << s;
    +
    151 }
    +
    152 return *this;
    +
    153 }
    +
    154
    +
    155 private:
    +
    156 MsgBuilder( enum LOG_LEVEL msg_lvl, Logger* logger );
    +
    157 MsgBuilder( const MsgBuilder& rhs );
    +
    158
    +
    159 Logger* _logger;
    +
    160 enum LOG_LEVEL _msg_lvl;
    +
    161
    +
    162 std::ostringstream _oss;
    +
    163 };
    +
    164
    +
    165 static sptr create( enum LOG_LEVEL lvl, Sink::sptr sink, std::string name="" );
    +
    166
    +
    167 MsgBuilder info();
    +
    168 MsgBuilder debug();
    +
    169 MsgBuilder trace();
    +
    170 MsgBuilder warn();
    +
    171 MsgBuilder critical();
    +
    172 MsgBuilder error();
    +
    173
    +
    174 Sink::sptr sink(){ return _sink; }
    +
    175 const std::string& name() const { return _name;}
    +
    176
    +
    177 void set_level( enum LOG_LEVEL lvl){ _log_lvl = lvl;}
    +
    178 enum LOG_LEVEL get_level() const { return _log_lvl;}
    +
    179
    +
    180 protected:
    +
    181 Logger( enum LOG_LEVEL lvl, Sink::sptr sink, std::string name ) ;
    +
    182
    +
    183 private:
    +
    184
    +
    185 enum LOG_LEVEL _log_lvl;
    +
    186 Sink::sptr _sink;
    +
    187 std::string _name;
    +
    188 };
    +
    189 }
    +
    190
    +
    191 class logger
    +
    192 {
    +
    193 public:
    +
    194 typedef std::shared_ptr< logging::Logger > logger_sptr;
    +
    195
    +
    196 static logger_sptr get_logger();
    +
    197 private:
    +
    198 static logger_sptr _instance;
    +
    199 };
    +
    200
    +
    201} // namespace FairDataPipeline
    +
    202
    +
    203
    +
    204
    +
    205#endif
    +
    FairDataPipeline::logger
    Definition: logging.hxx:192
    + + +
    FairDataPipeline::logging::Logger
    Definition: logging.hxx:134
    +
    FairDataPipeline::logging::OStreamSink
    Definition: logging.hxx:82
    +
    FairDataPipeline::logging::SinkFormatter
    Definition: logging.hxx:117
    +
    FairDataPipeline::logging::Sink
    Definition: logging.hxx:56
    + +
    FairDataPipeline::logging::ISink
    Definition: logging.hxx:36
    diff --git a/menudata.js b/menudata.js index bf9dfed..a842bfa 100644 --- a/menudata.js +++ b/menudata.js @@ -37,7 +37,6 @@ var menudata={children:[ {text:"All",url:"functions.html",children:[ {text:"a",url:"functions.html#index_a"}, {text:"c",url:"functions.html#index_c"}, -{text:"d",url:"functions.html#index_d"}, {text:"e",url:"functions.html#index_e"}, {text:"f",url:"functions.html#index_f"}, {text:"g",url:"functions.html#index_g"}, @@ -54,7 +53,6 @@ var menudata={children:[ {text:"Functions",url:"functions_func.html",children:[ {text:"a",url:"functions_func.html#index_a"}, {text:"c",url:"functions_func.html#index_c"}, -{text:"d",url:"functions_func.html#index_d"}, {text:"e",url:"functions_func.html#index_e"}, {text:"f",url:"functions_func.html#index_f"}, {text:"g",url:"functions_func.html#index_g"}, diff --git a/metadata_8hxx.html b/metadata_8hxx.html deleted file mode 100644 index ec1ae73..0000000 --- a/metadata_8hxx.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - - - -cppDataPipeline: include/fdp/objects/metadata.hxx File Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    -Functions
    -
    metadata.hxx File Reference
    -
    -
    - -

    File containing methods for handling of metadata. -More...

    -
    #include <ctime>
    -#include <ghc/filesystem.hpp>
    -#include <fstream>
    -#include <iomanip>
    -#include <iostream>
    -#include <sstream>
    -#include <random>
    -#include <chrono>
    -#include <regex>
    -#include "digestpp.hpp"
    -#include <unistd.h>
    -
    -

    Go to the source code of this file.

    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    -Functions

    std::string FDP::calculate_hash_from_file (const ghc::filesystem::path &)
     calculates a hash from a given input file via SHA1 More...
     
    std::string FDP::calculate_hash_from_string (const std::string &input)
     calculates a hash from a given string via SHA1 More...
     
    std::string FDP::generate_random_hash ()
     Generate a random hash. More...
     
    std::string FDP::current_time_stamp (bool file_name=false)
     returns the current time as a timestamp More...
     
    std::string FDP::remove_local_from_root (const std::string &root)
     remove the file:// from a given root More...
     
    std::string FDP::remove_backslash_from_path (const std::string &path)
     replace backslashes with forward slashes in a given path More...
     
    bool FDP::file_exists (const std::string &Filename)
     check whether a given file exists More...
     
    std::string FDP::read_token (const ghc::filesystem::path &token_path)
     read a token from a given file More...
     
    -

    Detailed Description

    -

    File containing methods for handling of metadata.

    -
    -
    Author
    K. Zarebski (UKAEA)
    -
    Date
    2021-05-05
    -

    The functions contained within this file process or create metadata related to the versioning of objects and runs.

    -

    Function Documentation

    - -

    ◆ calculate_hash_from_file()

    - -
    -
    - - - - - - - - -
    std::string FDP::calculate_hash_from_file (const ghc::filesystem::path & file_path)
    -
    - -

    calculates a hash from a given input file via SHA1

    -
    -
    Returns
    the hash obtained from the file contents
    - -
    -
    - -

    ◆ calculate_hash_from_string()

    - -
    -
    - - - - - - - - -
    std::string FDP::calculate_hash_from_string (const std::string & input)
    -
    - -

    calculates a hash from a given string via SHA1

    -
    -
    Parameters
    - - -
    inputstring to be hashed
    -
    -
    -
    Returns
    the hash obtained from the string contents
    - -
    -
    - -

    ◆ current_time_stamp()

    - -
    -
    - - - - - - - - -
    std::string FDP::current_time_stamp (bool file_name = false)
    -
    - -

    returns the current time as a timestamp

    -
    -
    Author
    K. Zarebski (UKAEA)
    -
    Parameters
    - - -
    file_nameif true, format the timestamp to be filename friendly
    -
    -
    -
    Returns
    timestamp for the current time
    - -
    -
    - -

    ◆ file_exists()

    - -
    -
    - - - - - - - - -
    bool FDP::file_exists (const std::string & Filename)
    -
    - -

    check whether a given file exists

    -
    Parameters
    - - -
    Filename
    -
    -
    -
    Returns
    true file exists
    -
    -false file does not exist
    - -
    -
    - -

    ◆ generate_random_hash()

    - -
    -
    - - - - - - - -
    std::string FDP::generate_random_hash ()
    -
    - -

    Generate a random hash.

    -
    Returns
    std::string a random hash
    - -
    -
    - -

    ◆ read_token()

    - -
    -
    - - - - - - - - -
    std::string FDP::read_token (const ghc::filesystem::path & token_path)
    -
    - -

    read a token from a given file

    -
    Parameters
    - - -
    token_path
    -
    -
    -
    Returns
    std::string
    - -
    -
    - -

    ◆ remove_backslash_from_path()

    - -
    -
    - - - - - - - - -
    std::string FDP::remove_backslash_from_path (const std::string & path)
    -
    - -

    replace backslashes with forward slashes in a given path

    -
    Parameters
    - - -
    path
    -
    -
    -
    Returns
    std::string
    - -
    -
    - -

    ◆ remove_local_from_root()

    - -
    -
    - - - - - - - - -
    std::string FDP::remove_local_from_root (const std::string & root)
    -
    - -

    remove the file:// from a given root

    -
    Parameters
    - - -
    root
    -
    -
    -
    Returns
    std::string
    - -
    -
    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/metadata_8hxx_source.html b/metadata_8hxx_source.html index d77f4da..247b692 100644 --- a/metadata_8hxx_source.html +++ b/metadata_8hxx_source.html @@ -70,7 +70,7 @@
    metadata.hxx
    -Go to the documentation of this file.
    1
    +
    1
    10#ifndef __FDP_METADATA_HXX__
    11#define __FDP_METADATA_HXX__
    12
    @@ -93,34 +93,26 @@
    29 #include <unistd.h>
    30#endif
    31
    -
    32namespace FDP {
    -
    38std::string calculate_hash_from_file(const ghc::filesystem::path &);
    +
    32namespace FairDataPipeline {
    +
    38std::string calculate_hash_from_file(const ghc::filesystem::path &);
    39
    -
    46std::string calculate_hash_from_string(const std::string &input);
    +
    46std::string calculate_hash_from_string(const std::string &input);
    47
    -
    53std::string generate_random_hash();
    +
    53std::string generate_random_hash();
    54
    -
    62std::string current_time_stamp(bool file_name = false);
    +
    62std::string current_time_stamp(bool file_name = false);
    63
    -
    70std::string remove_local_from_root(const std::string &root);
    +
    70std::string remove_local_from_root(const std::string &root);
    71
    -
    78std::string remove_backslash_from_path(const std::string &path);
    +
    78std::string remove_backslash_from_path(const std::string &path);
    79
    -
    87bool file_exists( const std::string &Filename );
    +
    87bool file_exists( const std::string &Filename );
    88
    -
    95std::string read_token(const ghc::filesystem::path &token_path);
    +
    95std::string read_token(const ghc::filesystem::path &token_path);
    96
    -
    97}; // namespace FDP
    +
    97}; // namespace FairDataPipeline
    98
    99#endif
    -
    FDP::current_time_stamp
    std::string current_time_stamp(bool file_name=false)
    returns the current time as a timestamp
    Definition: metadata.cxx:52
    -
    FDP::remove_local_from_root
    std::string remove_local_from_root(const std::string &root)
    remove the file:// from a given root
    Definition: metadata.cxx:67
    -
    FDP::remove_backslash_from_path
    std::string remove_backslash_from_path(const std::string &path)
    replace backslashes with forward slashes in a given path
    Definition: metadata.cxx:71
    -
    FDP::read_token
    std::string read_token(const ghc::filesystem::path &token_path)
    read a token from a given file
    Definition: metadata.cxx:80
    -
    FDP::file_exists
    bool file_exists(const std::string &Filename)
    check whether a given file exists
    Definition: metadata.cxx:75
    -
    FDP::generate_random_hash
    std::string generate_random_hash()
    Generate a random hash.
    Definition: metadata.cxx:22
    -
    FDP::calculate_hash_from_string
    std::string calculate_hash_from_string(const std::string &input)
    calculates a hash from a given string via SHA1
    Definition: metadata.cxx:18
    -
    FDP::calculate_hash_from_file
    std::string calculate_hash_from_file(const ghc::filesystem::path &)
    calculates a hash from a given input file via SHA1
    Definition: metadata.cxx:4
    diff --git a/namespace_f_d_p_1_1_versioning.html b/namespace_fair_data_pipeline_1_1_versioning.html similarity index 66% rename from namespace_f_d_p_1_1_versioning.html rename to namespace_fair_data_pipeline_1_1_versioning.html index 8082e77..e63c78d 100644 --- a/namespace_f_d_p_1_1_versioning.html +++ b/namespace_fair_data_pipeline_1_1_versioning.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::Versioning Namespace Reference +cppDataPipeline: FairDataPipeline::Versioning Namespace Reference @@ -63,43 +63,43 @@
    Classes | Enumerations
    -
    FDP::Versioning Namespace Reference
    +
    FairDataPipeline::Versioning Namespace Reference

    namespace containing all semantic versioning types and classes -More...

    +More...

    - - + +

    Classes

    class  version
     class describing the semantic version of an object More...
    class  version
     class describing the semantic version of an object More...
     
    - - - + +

    Enumerations

    enum class  meta_tag { ALPHA -, BETA -, RELEASE_CANDIDATE -, RELEASE +
    enum class  meta_tag { ALPHA +, BETA +, RELEASE_CANDIDATE +, RELEASE }
     the allowed tags for versions describing version state More...
     
     the allowed tags for versions describing version state More...
     

    Detailed Description

    namespace containing all semantic versioning types and classes

    Author
    K. Zarebski (UKAEA)

    Enumeration Type Documentation

    - -

    ◆ meta_tag

    + +

    ◆ meta_tag

    @@ -108,7 +108,7 @@

    - +
    enum class FDP::Versioning::meta_tagenum class FairDataPipeline::Versioning::meta_tag
    @@ -123,13 +123,13 @@

    Author
    K. Zarebski (UKAEA)

    This enum class contains all permitted release state classifiers which describe whether the code/data object is a full release or still under review by the authors

    - - - -
    Enumerator
    ALPHA 

    Release is an Alpha release

    +
    Enumerator
    ALPHA 

    Release is an Alpha release

    BETA 

    Release is an Beta release

    +
    BETA 

    Release is an Beta release

    RELEASE_CANDIDATE 

    Release is a candidate for full release

    +
    RELEASE_CANDIDATE 

    Release is a candidate for full release

    RELEASE 

    Release is a full release

    +
    RELEASE 

    Release is a full release

    diff --git a/namespacemembers.html b/namespacemembers.html index eaef37e..a4e1dfc 100644 --- a/namespacemembers.html +++ b/namespacemembers.html @@ -64,7 +64,7 @@
    Here is a list of all documented namespace members with links to the namespaces they belong to:
    diff --git a/namespacemembers_enum.html b/namespacemembers_enum.html index 25cb595..b5e81c2 100644 --- a/namespacemembers_enum.html +++ b/namespacemembers_enum.html @@ -64,7 +64,7 @@
     
    diff --git a/namespaces.html b/namespaces.html index 56c9c90..4416c1b 100644 --- a/namespaces.html +++ b/namespaces.html @@ -67,23 +67,32 @@

    Here is a list of all documented namespaces with brief descriptions:
    -
    [detail level 123]
    - - - - - - - - - - - - - - - - +
    [detail level 1234]
     ▼NFDP
     ▼NVersioningNamespace containing all semantic versioning types and classes
     CversionClass describing the semantic version of an object
     CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CApiObjectClass for API objects
     CConfigClass for interacting with confifurations
     Cconfig_parsing_error
     ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     Cimpl
     CIOObjectClass for API objects
     Cjson_parse_error
     Clogger
     Crest_apiquery_error
     Csync_error
     Cvalidation_error
     Cwrite_error
    + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼NFairDataPipeline
     ▼Nlogging
     CCompositeSink
     CISink
     CISinkFormatter
     ▼CLogger
     CMsgBuilder
     COStreamSink
     CSink
     CSinkFormatter
     ▼NVersioningNamespace containing all semantic versioning types and classes
     CversionClass describing the semantic version of an object
     CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CApiObjectClass for API objects
     CConfigClass for interacting with confifurations
     Cconfig_parsing_error
     ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     Cimpl
     CIOObjectClass for API objects
     Cjson_parse_error
     Clogger
     Crest_apiquery_error
     Csync_error
     Cvalidation_error
     Cwrite_error
    diff --git a/search/all_0.js b/search/all_0.js index e3da8b7..3d2aa2a 100644 --- a/search/all_0.js +++ b/search/all_0.js @@ -1,9 +1,7 @@ var searchData= [ - ['alpha_0',['ALPHA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a002101f8725e5c78d9f30d87f3fa4c87',1,'FDP::Versioning']]], - ['api_1',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API::API()'],['../class_f_d_p_1_1_a_p_i.html',1,'FDP::API']]], - ['api_2ehxx_2',['api.hxx',['../api_8hxx.html',1,'']]], - ['apilogger_3',['APILogger',['../logging_8hxx.html#a88c65a4f48c8dde03f5d414f29ac4b7a',1,'FDP']]], - ['apiobject_4',['ApiObject',['../class_f_d_p_1_1_api_object.html',1,'FDP']]], - ['append_5fwith_5fforward_5fslash_5',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] + ['alpha_0',['ALPHA',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a002101f8725e5c78d9f30d87f3fa4c87',1,'FairDataPipeline::Versioning']]], + ['api_1',['API',['../class_fair_data_pipeline_1_1_a_p_i.html',1,'FairDataPipeline']]], + ['apiobject_2',['ApiObject',['../class_fair_data_pipeline_1_1_api_object.html',1,'FairDataPipeline']]], + ['append_5fwith_5fforward_5fslash_3',['append_with_forward_slash',['../class_fair_data_pipeline_1_1_a_p_i.html#a77c8f0b7fb9b65b6d56951088f48ca03',1,'FairDataPipeline::API']]] ]; diff --git a/search/all_1.js b/search/all_1.js index ccd8dc2..2b88f9d 100644 --- a/search/all_1.js +++ b/search/all_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['beta_0',['BETA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a36b84f8e3fba5bf993e3ba352d62d146',1,'FDP::Versioning']]] + ['beta_0',['BETA',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a36b84f8e3fba5bf993e3ba352d62d146',1,'FairDataPipeline::Versioning']]] ]; diff --git a/search/all_10.js b/search/all_10.js index 9bd96a8..3cc76f9 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -1,5 +1,5 @@ var searchData= [ - ['write_5ferror_0',['write_error',['../class_f_d_p_1_1write__error.html',1,'FDP']]], - ['write_5ffunc_5f_1',['write_func_',['../api_8hxx.html#aafe123714129a23215ddd6799c699af6',1,'FDP']]] + ['validation_5ferror_0',['validation_error',['../class_fair_data_pipeline_1_1validation__error.html',1,'FairDataPipeline']]], + ['version_1',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html',1,'FairDataPipeline::Versioning::version'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a487e9e19f8dc597c02c0d2caf9483984',1,'FairDataPipeline::Versioning::version::version()=default'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a82cda27e083c9b3ef3d38c6ca52fc820',1,'FairDataPipeline::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] ]; diff --git a/search/all_11.js b/search/all_11.js index cf3da40..d07245a 100644 --- a/search/all_11.js +++ b/search/all_11.js @@ -1,6 +1,4 @@ var searchData= [ - ['_7econfig_0',['~Config',['../class_f_d_p_1_1_config.html#a5078af487531c263fef8fbe08a4191df',1,'FDP::Config']]], - ['_7edatapipeline_1',['~DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#a67f8a0f07ef29d1c4661e74bdd79ce38',1,'FDP::DataPipeline']]], - ['_7eimpl_2',['~impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a1c68d7867deda1530cbed05069b05b09',1,'FDP::DataPipeline::impl']]] + ['write_5ferror_0',['write_error',['../class_fair_data_pipeline_1_1write__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/enums_1.html b/search/all_12.html similarity index 95% rename from search/enums_1.html rename to search/all_12.html index 4b930ac..3235d84 100644 --- a/search/enums_1.html +++ b/search/all_12.html @@ -4,7 +4,7 @@ - + diff --git a/search/all_12.js b/search/all_12.js new file mode 100644 index 0000000..0f5adfa --- /dev/null +++ b/search/all_12.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['_7econfig_0',['~Config',['../class_fair_data_pipeline_1_1_config.html#ab73735ce5c3376bd09d9b44a92745604',1,'FairDataPipeline::Config']]], + ['_7edatapipeline_1',['~DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html#aa78325ee158faa93be203ec59e5e075f',1,'FairDataPipeline::DataPipeline']]], + ['_7eimpl_2',['~impl',['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a95b04cf2f78c7bdfba26f2ebd99dc0e6',1,'FairDataPipeline::DataPipeline::impl']]] +]; diff --git a/search/all_2.js b/search/all_2.js index 28f7c4c..6f32db9 100644 --- a/search/all_2.js +++ b/search/all_2.js @@ -1,12 +1,10 @@ var searchData= [ - ['calculate_5fhash_5ffrom_5ffile_0',['calculate_hash_from_file',['../metadata_8hxx.html#aef5b5dab5a6743bed9e9d0842ec8e0b9',1,'FDP']]], - ['calculate_5fhash_5ffrom_5fstring_1',['calculate_hash_from_string',['../metadata_8hxx.html#add1040168fb281b0753ca26cd445d8ee',1,'FDP']]], - ['config_2',['Config',['../class_f_d_p_1_1_config.html',1,'FDP']]], - ['config_2ehxx_3',['config.hxx',['../config_8hxx.html',1,'']]], - ['config_5fparsing_5ferror_4',['config_parsing_error',['../class_f_d_p_1_1config__parsing__error.html',1,'FDP']]], - ['config_5freads_5f_5',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], - ['config_5fwrites_5f_6',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], - ['construct_7',['construct',['../class_f_d_p_1_1_api_object.html#a52db6cca9c94d6bed3b00166c3c04b9c',1,'FDP::ApiObject']]], - ['current_5ftime_5fstamp_8',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] + ['compositesink_0',['CompositeSink',['../class_fair_data_pipeline_1_1logging_1_1_composite_sink.html',1,'FairDataPipeline::logging']]], + ['config_1',['Config',['../class_fair_data_pipeline_1_1_config.html',1,'FairDataPipeline']]], + ['config_2ehxx_2',['config.hxx',['../config_8hxx.html',1,'']]], + ['config_5fparsing_5ferror_3',['config_parsing_error',['../class_fair_data_pipeline_1_1config__parsing__error.html',1,'FairDataPipeline']]], + ['config_5freads_5f_4',['config_reads_',['../class_fair_data_pipeline_1_1_config.html#aabc4e10c3abc199eb2d981ccc405c3f3',1,'FairDataPipeline::Config']]], + ['config_5fwrites_5f_5',['config_writes_',['../class_fair_data_pipeline_1_1_config.html#aa4191219e1e366891673d7b9a038657f',1,'FairDataPipeline::Config']]], + ['construct_6',['construct',['../class_fair_data_pipeline_1_1_data_pipeline.html#a681b53aa30d6b0ca68e3988c7288e4c1',1,'FairDataPipeline::DataPipeline::construct()'],['../class_fair_data_pipeline_1_1_api_object.html#a0381e1bad290b6cd65ce9ea2c19a80cb',1,'FairDataPipeline::ApiObject::construct()'],['../class_fair_data_pipeline_1_1_a_p_i.html#a50c23587bd6426fa07a669da6ff845a6',1,'FairDataPipeline::API::construct()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#aade68609c67d22ee027fdd53da1dece8',1,'FairDataPipeline::DataPipeline::impl::construct()']]] ]; diff --git a/search/all_3.js b/search/all_3.js index 07c400f..f315710 100644 --- a/search/all_3.js +++ b/search/all_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline::DataPipeline()'],['../class_f_d_p_1_1_data_pipeline.html',1,'FDP::DataPipeline']]], + ['datapipeline_0',['DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html',1,'FairDataPipeline']]], ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]] ]; diff --git a/search/all_4.js b/search/all_4.js index 41a0804..9ccb208 100644 --- a/search/all_4.js +++ b/search/all_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['escape_5fspace_0',['escape_space',['../class_f_d_p_1_1_a_p_i.html#a98101859c913eea13166a115a97b9e64',1,'FDP::API']]] + ['escape_5fspace_0',['escape_space',['../class_fair_data_pipeline_1_1_a_p_i.html#a9bd47ef694c9c5a53ebd4f8d11881dd2',1,'FairDataPipeline::API']]] ]; diff --git a/search/all_5.js b/search/all_5.js index 2da5634..a286d3f 100644 --- a/search/all_5.js +++ b/search/all_5.js @@ -1,7 +1,6 @@ var searchData= [ ['fair_20data_20pipeline_20c_2b_2b_20api_0',['FAIR Data Pipeline C++ API',['../index.html',1,'']]], - ['file_5fexists_1',['file_exists',['../metadata_8hxx.html#a7d885b9af9988c944d23eedbff430272',1,'FDP']]], - ['finalise_2',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aa8df96d2a875997a793d684f23b990db',1,'FDP::DataPipeline::impl::finalise()']]], - ['versioning_3',['Versioning',['../namespace_f_d_p_1_1_versioning.html',1,'FDP']]] + ['finalise_1',['finalise',['../class_fair_data_pipeline_1_1_data_pipeline.html#a92c0472680d46d0017ebd85b1575d02d',1,'FairDataPipeline::DataPipeline::finalise()'],['../class_fair_data_pipeline_1_1_config.html#a47f7446d7511bb3ff5a68bf1c25814a4',1,'FairDataPipeline::Config::finalise()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a88bc798cecc1b1de65b37667ae89f481',1,'FairDataPipeline::DataPipeline::impl::finalise()']]], + ['versioning_2',['Versioning',['../namespace_fair_data_pipeline_1_1_versioning.html',1,'FairDataPipeline']]] ]; diff --git a/search/all_6.js b/search/all_6.js index 3ff3585..46b6465 100644 --- a/search/all_6.js +++ b/search/all_6.js @@ -1,36 +1,35 @@ var searchData= [ - ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], - ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a94caee3afb761dae494814264972c0b5',1,'FDP::Config']]], - ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], - ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], - ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad61c43afc5485c9fcfbef5174a68d78f',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], - ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#ac3145f3de8a58010d8a33e57fee67ec2',1,'FDP::IOObject']]], - ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#ad8d3ed9b24f406d20575ef45469ee8a0',1,'FDP::IOObject']]], - ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], - ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], - ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], - ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#a7c7acd56d99c4eda4618fdc6e8a236d1',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#ac76df715690e2af929a66470e9ca938f',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af927b241ff0f6f83fe646d24ac7cefa0',1,'FDP::IOObject']]], - ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], - ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], - ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], - ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], - ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], - ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], - ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ab8bf366173b74a96e0f37b38c884536f',1,'FDP::IOObject']]], - ['get_5frequest_20',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], - ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a7ddbba3e1add1f60e68780871cc72b5e',1,'FDP::Config']]], - ['get_5fscript_5ffile_5fpath_22',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], - ['get_5ftoken_23',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], - ['get_5ftype_24',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], - ['get_5furi_25',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], - ['get_5furl_5froot_26',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], - ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a4439875ff61e85bf04f00004eb35ccc2',1,'FDP::IOObject']]], - ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a08e05013423139691db36810344cd5c0',1,'FDP::IOObject']]], - ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#acd94303a44a3d221a5aa369688faf05a',1,'FDP::IOObject']]], - ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#a6a1ab929bcc0d31a3af114bf9fe3a449',1,'FDP::IOObject']]], - ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#acbac01d71e5f888734b306115123bc20',1,'FDP::ApiObject']]], - ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a6acd61ea72aa94c5494689581f3fe0bc',1,'FDP::ApiObject']]] + ['get_5fapi_0',['get_api',['../class_fair_data_pipeline_1_1_config.html#a6cc0a787c24e1d33f11308a5da7e1290',1,'FairDataPipeline::Config']]], + ['get_5fapi_5furl_1',['get_api_url',['../class_fair_data_pipeline_1_1_config.html#a4052397551021c6c027909d481cfa6dc',1,'FairDataPipeline::Config']]], + ['get_5fby_5fid_2',['get_by_id',['../class_fair_data_pipeline_1_1_a_p_i.html#af64b8d337919cf682ba79dbe0a78de80',1,'FairDataPipeline::API']]], + ['get_5fcode_5frun_5fuuid_3',['get_code_run_uuid',['../class_fair_data_pipeline_1_1_config.html#af6d7f4c607670c21c080013ad194305c',1,'FairDataPipeline::Config::get_code_run_uuid()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a96e28706b3d0a1809787e0afff0f0a88',1,'FairDataPipeline::DataPipeline::impl::get_code_run_uuid()']]], + ['get_5fcomponent_5fdescription_4',['get_component_description',['../class_fair_data_pipeline_1_1_i_o_object.html#a3cfc22da4295b989440eb0197ff09288',1,'FairDataPipeline::IOObject']]], + ['get_5fcomponent_5fobject_5',['get_component_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a4c7fa781dc836558cdc4c7a4a3843c26',1,'FairDataPipeline::IOObject']]], + ['get_5fconfig_5fdata_6',['get_config_data',['../class_fair_data_pipeline_1_1_config.html#a0ac997802676d72ed05ea95500865211',1,'FairDataPipeline::Config']]], + ['get_5fconfig_5fdirectory_7',['get_config_directory',['../class_fair_data_pipeline_1_1_config.html#ad9fc2b5ca3cb098a5cb7466cef50a9a8',1,'FairDataPipeline::Config']]], + ['get_5fconfig_5ffile_5fpath_8',['get_config_file_path',['../class_fair_data_pipeline_1_1_config.html#a0ad1d6842ea860dcb14c0d608924608c',1,'FairDataPipeline::Config']]], + ['get_5fdata_5fproduct_9',['get_data_product',['../class_fair_data_pipeline_1_1_i_o_object.html#af1c43a40eedf7a639e6ae6174f44a6c7',1,'FairDataPipeline::IOObject']]], + ['get_5fdata_5fproduct_5fdescription_10',['get_data_product_description',['../class_fair_data_pipeline_1_1_i_o_object.html#a5f48c463ac62335b479f0987f8446021',1,'FairDataPipeline::IOObject']]], + ['get_5fdata_5fproduct_5fobject_11',['get_data_product_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a714e482615a8d5ab6da5b5cbbe396956',1,'FairDataPipeline::IOObject']]], + ['get_5fdata_5fstore_12',['get_data_store',['../class_fair_data_pipeline_1_1_config.html#a0db92abe9690edff27768dd55cdc3b57',1,'FairDataPipeline::Config']]], + ['get_5fdefault_5finput_5fnamespace_13',['get_default_input_namespace',['../class_fair_data_pipeline_1_1_config.html#ac348baa7909b2468cc90c8284736d59d',1,'FairDataPipeline::Config']]], + ['get_5fdefault_5foutput_5fnamespace_14',['get_default_output_namespace',['../class_fair_data_pipeline_1_1_config.html#a0b0676eb5387f8cf7976ee289f53de22',1,'FairDataPipeline::Config']]], + ['get_5ffirst_5fcomponent_15',['get_first_component',['../class_fair_data_pipeline_1_1_api_object.html#adc461dac7bd62791694b448f248285b9',1,'FairDataPipeline::ApiObject']]], + ['get_5fid_16',['get_id',['../class_fair_data_pipeline_1_1_api_object.html#aaa059f4d3987b084a26e4a549da33f17',1,'FairDataPipeline::ApiObject']]], + ['get_5fid_5ffrom_5fstring_17',['get_id_from_string',['../class_fair_data_pipeline_1_1_api_object.html#add02fcf7053cb65579b95238a4d680f1',1,'FairDataPipeline::ApiObject']]], + ['get_5fpath_18',['get_path',['../class_fair_data_pipeline_1_1_i_o_object.html#a0747d6a9ca266ab82caf55b0b31cfbee',1,'FairDataPipeline::IOObject']]], + ['get_5frequest_19',['get_request',['../class_fair_data_pipeline_1_1_a_p_i.html#a83e58d8969eeec9be2504c11826d7112',1,'FairDataPipeline::API']]], + ['get_5frest_5fapi_5flocation_20',['get_rest_api_location',['../class_fair_data_pipeline_1_1_config.html#aa42386544e7c435c9668b3501665c73f',1,'FairDataPipeline::Config']]], + ['get_5fscript_5ffile_5fpath_21',['get_script_file_path',['../class_fair_data_pipeline_1_1_config.html#a6b8c535f166ad505efc886658bc4343b',1,'FairDataPipeline::Config']]], + ['get_5ftoken_22',['get_token',['../class_fair_data_pipeline_1_1_config.html#a458fa564b7b8f80f9a672114f763a311',1,'FairDataPipeline::Config']]], + ['get_5ftype_23',['get_type',['../class_fair_data_pipeline_1_1_api_object.html#afa001cc0d830f37a7a5c0f08f5ba33a1',1,'FairDataPipeline::ApiObject']]], + ['get_5furi_24',['get_uri',['../class_fair_data_pipeline_1_1_api_object.html#acb91f5e8c3311b239527ab3a3bd45051',1,'FairDataPipeline::ApiObject']]], + ['get_5furl_5froot_25',['get_url_root',['../class_fair_data_pipeline_1_1_a_p_i.html#aab2c9e803376ab69f4f43de2742e9de7',1,'FairDataPipeline::API']]], + ['get_5fuse_5fcomponent_26',['get_use_component',['../class_fair_data_pipeline_1_1_i_o_object.html#a42e444653e2f769bd9481bfce6e66c8e',1,'FairDataPipeline::IOObject']]], + ['get_5fuse_5fdata_5fproduct_27',['get_use_data_product',['../class_fair_data_pipeline_1_1_i_o_object.html#acace8d1db43d6844d4de441814bb42dd',1,'FairDataPipeline::IOObject']]], + ['get_5fuse_5fnamespace_28',['get_use_namespace',['../class_fair_data_pipeline_1_1_i_o_object.html#a73bc664d4eb616bab1fc4e37661e08c3',1,'FairDataPipeline::IOObject']]], + ['get_5fuse_5fversion_29',['get_use_version',['../class_fair_data_pipeline_1_1_i_o_object.html#a8ab831de6cd7a18c7a216102f2f0bbba',1,'FairDataPipeline::IOObject']]], + ['get_5fvalue_5fas_5fint_30',['get_value_as_int',['../class_fair_data_pipeline_1_1_api_object.html#a8566bce9f37b5de3d6643fcd37b4a829',1,'FairDataPipeline::ApiObject']]], + ['get_5fvalue_5fas_5fstring_31',['get_value_as_string',['../class_fair_data_pipeline_1_1_api_object.html#a9c6f48fd620933be0e2ec224bd1ecd8e',1,'FairDataPipeline::ApiObject']]] ]; diff --git a/search/all_7.js b/search/all_7.js index 54d93b0..d14787e 100644 --- a/search/all_7.js +++ b/search/all_7.js @@ -1,7 +1,7 @@ var searchData= [ - ['has_5finputs_0',['has_inputs',['../class_f_d_p_1_1_config.html#a3575ed8e0f6a51f99b4428bd575bfc24',1,'FDP::Config']]], - ['has_5foutputs_1',['has_outputs',['../class_f_d_p_1_1_config.html#ab3424fed4132fd1adda88f1566293de4',1,'FDP::Config']]], - ['has_5freads_2',['has_reads',['../class_f_d_p_1_1_config.html#a4d652212cbb50a0e92afc41ea64815de',1,'FDP::Config']]], - ['has_5fwrites_3',['has_writes',['../class_f_d_p_1_1_config.html#ab2c81212fdb00aeda1f7881df61e60a7',1,'FDP::Config']]] + ['has_5finputs_0',['has_inputs',['../class_fair_data_pipeline_1_1_config.html#aa17707c6271ce1f17a781195d1c83814',1,'FairDataPipeline::Config']]], + ['has_5foutputs_1',['has_outputs',['../class_fair_data_pipeline_1_1_config.html#a4583d8193e3bc8ad66b60ff4d7f60131',1,'FairDataPipeline::Config']]], + ['has_5freads_2',['has_reads',['../class_fair_data_pipeline_1_1_config.html#af7973ce8257cbef71d0d860168253f0f',1,'FairDataPipeline::Config']]], + ['has_5fwrites_3',['has_writes',['../class_fair_data_pipeline_1_1_config.html#a4555122fc22ed19c7163f8aaad3b1735',1,'FairDataPipeline::Config']]] ]; diff --git a/search/all_8.js b/search/all_8.js index a19c30f..25ae71e 100644 --- a/search/all_8.js +++ b/search/all_8.js @@ -1,7 +1,9 @@ var searchData= [ - ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html',1,'FDP::DataPipeline::impl'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ac3b1ebeb2fbf90a729d8ef5784324445',1,'FDP::DataPipeline::impl::impl()']]], - ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP::IOObject'],['../class_f_d_p_1_1_i_o_object.html#ab02b513c6e8a608e11128a7790abc056',1,'FDP::IOObject::IOObject()=default'],['../class_f_d_p_1_1_i_o_object.html#aaf0df6076993057837e2727ec71f8e68',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#a1b252f1e63196516b77ff2737761c87a',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], - ['is_5fempty_2',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], - ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#a8252f827930e78fa41ef284472e44ffe',1,'FDP::IOObject']]] + ['impl_0',['impl',['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html',1,'FairDataPipeline::DataPipeline']]], + ['ioobject_1',['IOObject',['../class_fair_data_pipeline_1_1_i_o_object.html',1,'FairDataPipeline::IOObject'],['../class_fair_data_pipeline_1_1_i_o_object.html#a012b2b04413800d2a09418d2ed97459c',1,'FairDataPipeline::IOObject::IOObject()=default'],['../class_fair_data_pipeline_1_1_i_o_object.html#a7d5c6cd8d1c53a4f4c800670115f6542',1,'FairDataPipeline::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)'],['../class_fair_data_pipeline_1_1_i_o_object.html#aa8d07d60ec85809caddb8bf1614c81a4',1,'FairDataPipeline::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['is_5fempty_2',['is_empty',['../class_fair_data_pipeline_1_1_api_object.html#ada37bdbca0c405920f446efce7f1a802',1,'FairDataPipeline::ApiObject']]], + ['is_5fpublic_3',['is_public',['../class_fair_data_pipeline_1_1_i_o_object.html#afca56fb44355d2fb120a8f83b0dc5f32',1,'FairDataPipeline::IOObject']]], + ['isink_4',['ISink',['../struct_fair_data_pipeline_1_1logging_1_1_i_sink.html',1,'FairDataPipeline::logging']]], + ['isinkformatter_5',['ISinkFormatter',['../struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/all_9.js b/search/all_9.js index ee3fc51..bbccd08 100644 --- a/search/all_9.js +++ b/search/all_9.js @@ -1,7 +1,5 @@ var searchData= [ - ['json_2ehxx_0',['json.hxx',['../json_8hxx.html',1,'']]], - ['json_5fparse_5ferror_1',['json_parse_error',['../class_f_d_p_1_1json__parse__error.html',1,'FDP']]], - ['json_5fto_5fquery_5fstring_2',['json_to_query_string',['../class_f_d_p_1_1_a_p_i.html#ad91263a71029cccc94e9e49cd4a37568',1,'FDP::API']]], - ['json_5fto_5fstring_3',['json_to_string',['../json_8hxx.html#a77f24139171b28c1fc719b55846938f1',1,'FDP']]] + ['json_5fparse_5ferror_0',['json_parse_error',['../class_fair_data_pipeline_1_1json__parse__error.html',1,'FairDataPipeline']]], + ['json_5fto_5fquery_5fstring_1',['json_to_query_string',['../class_fair_data_pipeline_1_1_a_p_i.html#a04550b2a3747f77273c0a5aa11cb37f8',1,'FairDataPipeline::API']]] ]; diff --git a/search/all_a.js b/search/all_a.js index 7f82bef..3513464 100644 --- a/search/all_a.js +++ b/search/all_a.js @@ -1,8 +1,7 @@ var searchData= [ - ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ae8e7f7f1e7bbdbe93094d59c367210ad',1,'FDP::DataPipeline::impl::link_read()']]], - ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a43686ff0e1cf0733770058808b7bd322',1,'FDP::DataPipeline::impl::link_write()']]], - ['local_2',['LOCAL',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa54b4c4075463b2e02cd69f5cd139b5b2',1,'FDP']]], - ['logger_3',['logger',['../class_f_d_p_1_1logger.html',1,'FDP']]], - ['logging_2ehxx_4',['logging.hxx',['../logging_8hxx.html',1,'']]] + ['link_5fread_0',['link_read',['../class_fair_data_pipeline_1_1_data_pipeline.html#af0eafc06e593cf671dfe5cf3fdc425cd',1,'FairDataPipeline::DataPipeline::link_read()'],['../class_fair_data_pipeline_1_1_config.html#a0a80b73790d5cc86c1e0feac40384e4c',1,'FairDataPipeline::Config::link_read()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#ad6c57457ffe8f703f88bbb49bec34702',1,'FairDataPipeline::DataPipeline::impl::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_fair_data_pipeline_1_1_data_pipeline.html#a850325eb103977cd6c1a9ca9ad6c32aa',1,'FairDataPipeline::DataPipeline::link_write()'],['../class_fair_data_pipeline_1_1_config.html#a79878583ed56f0c4a4d10f11154a54ef',1,'FairDataPipeline::Config::link_write()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#afe198537ecdb0e45363b7edd84c4ae01',1,'FairDataPipeline::DataPipeline::impl::link_write()']]], + ['logger_2',['logger',['../class_fair_data_pipeline_1_1logger.html',1,'FairDataPipeline']]], + ['logger_3',['Logger',['../class_fair_data_pipeline_1_1logging_1_1_logger.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/all_b.js b/search/all_b.js index f1322a6..43117cb 100644 --- a/search/all_b.js +++ b/search/all_b.js @@ -1,6 +1,6 @@ var searchData= [ - ['meta_5fdata_5f_0',['meta_data_',['../class_f_d_p_1_1_config.html#a6202b2d39b4dbd977340b90f5382a4fb',1,'FDP::Config']]], - ['meta_5ftag_1',['meta_tag',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08',1,'FDP::Versioning']]], - ['metadata_2ehxx_2',['metadata.hxx',['../metadata_8hxx.html',1,'']]] + ['meta_5fdata_5f_0',['meta_data_',['../class_fair_data_pipeline_1_1_config.html#a007b9d59446d41aa345a62d903051d6b',1,'FairDataPipeline::Config']]], + ['meta_5ftag_1',['meta_tag',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62',1,'FairDataPipeline::Versioning']]], + ['msgbuilder_2',['MsgBuilder',['../class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder.html',1,'FairDataPipeline::logging::Logger']]] ]; diff --git a/search/all_c.js b/search/all_c.js index dd59b81..c342a14 100644 --- a/search/all_c.js +++ b/search/all_c.js @@ -1,5 +1,4 @@ var searchData= [ - ['parse_5fyaml_0',['parse_yaml',['../class_f_d_p_1_1_config.html#a12c5d3bb7298854078dfb5bf70e31443',1,'FDP::Config']]], - ['post_1',['post',['../class_f_d_p_1_1_a_p_i.html#a2479874abf32bcaaeb269972b3aaef90',1,'FDP::API']]] + ['ostreamsink_0',['OStreamSink',['../class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/all_d.js b/search/all_d.js index 9a228a2..471f904 100644 --- a/search/all_d.js +++ b/search/all_d.js @@ -1,12 +1,5 @@ var searchData= [ - ['read_5ftoken_0',['read_token',['../metadata_8hxx.html#a5dbd216ab20d3b4329231ba5965b34e3',1,'FDP']]], - ['release_1',['RELEASE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a7d649ef069df9885e382417c79f3d5cd',1,'FDP::Versioning']]], - ['release_5fcandidate_2',['RELEASE_CANDIDATE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a29fa7e21ab006777c5d8f86d893bfa53',1,'FDP::Versioning']]], - ['remote_3',['REMOTE',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa62f728a9642195060871a70b9b60c937',1,'FDP']]], - ['remove_5fbackslash_5ffrom_5fpath_4',['remove_backslash_from_path',['../metadata_8hxx.html#a45be90ccf712b64441d38e0a1ed324f4',1,'FDP']]], - ['remove_5fleading_5fforward_5fslash_5',['remove_leading_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a69448057f09381a313980bec41b3d4cd',1,'FDP::API']]], - ['remove_5flocal_5ffrom_5froot_6',['remove_local_from_root',['../metadata_8hxx.html#a1f7e1d16c6056d8117113a16d806e75d',1,'FDP']]], - ['rest_5fapiquery_5ferror_7',['rest_apiquery_error',['../class_f_d_p_1_1rest__apiquery__error.html',1,'FDP']]], - ['restapi_8',['RESTAPI',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45f',1,'FDP']]] + ['parse_5fyaml_0',['parse_yaml',['../class_fair_data_pipeline_1_1_config.html#a29487b05d1a71932b5ce20d8c0faca7d',1,'FairDataPipeline::Config']]], + ['post_1',['post',['../class_fair_data_pipeline_1_1_a_p_i.html#ac80ad050a49bfb010d26655592a1c8a1',1,'FairDataPipeline::API']]] ]; diff --git a/search/all_e.js b/search/all_e.js index 26a767b..ba56fd7 100644 --- a/search/all_e.js +++ b/search/all_e.js @@ -1,7 +1,7 @@ var searchData= [ - ['semver_2ehxx_0',['semver.hxx',['../semver_8hxx.html',1,'']]], - ['set_5fcomponent_5fobject_1',['set_component_object',['../class_f_d_p_1_1_i_o_object.html#ac4ec3246d12c759041bb2ca099afffac',1,'FDP::IOObject']]], - ['set_5fdata_5fproduct_5fobject_2',['set_data_product_object',['../class_f_d_p_1_1_i_o_object.html#a4a3cd1518aa9138c15c52cf925f3f1e3',1,'FDP::IOObject']]], - ['sync_5ferror_3',['sync_error',['../class_f_d_p_1_1sync__error.html',1,'FDP']]] + ['release_0',['RELEASE',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a7d649ef069df9885e382417c79f3d5cd',1,'FairDataPipeline::Versioning']]], + ['release_5fcandidate_1',['RELEASE_CANDIDATE',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a29fa7e21ab006777c5d8f86d893bfa53',1,'FairDataPipeline::Versioning']]], + ['remove_5fleading_5fforward_5fslash_2',['remove_leading_forward_slash',['../class_fair_data_pipeline_1_1_a_p_i.html#a2643a2cf82f253c2756d4ebdb8ce6650',1,'FairDataPipeline::API']]], + ['rest_5fapiquery_5ferror_3',['rest_apiquery_error',['../class_fair_data_pipeline_1_1rest__apiquery__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/all_f.js b/search/all_f.js index 202a0d3..f68378b 100644 --- a/search/all_f.js +++ b/search/all_f.js @@ -1,5 +1,8 @@ var searchData= [ - ['validation_5ferror_0',['validation_error',['../class_f_d_p_1_1validation__error.html',1,'FDP']]], - ['version_1',['version',['../class_f_d_p_1_1_versioning_1_1version.html',1,'FDP::Versioning::version'],['../class_f_d_p_1_1_versioning_1_1version.html#aa9be4a03ccee8827e226ea4154781bc6',1,'FDP::Versioning::version::version()=default'],['../class_f_d_p_1_1_versioning_1_1version.html#ac46f9e049c31b63fb6552409d7d2d7b1',1,'FDP::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] + ['set_5fcomponent_5fobject_0',['set_component_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a6889e85849addfa22d01c7c1b63f342f',1,'FairDataPipeline::IOObject']]], + ['set_5fdata_5fproduct_5fobject_1',['set_data_product_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a6b5ffe80335b332786cf86eb489f96f2',1,'FairDataPipeline::IOObject']]], + ['sink_2',['Sink',['../class_fair_data_pipeline_1_1logging_1_1_sink.html',1,'FairDataPipeline::logging']]], + ['sinkformatter_3',['SinkFormatter',['../class_fair_data_pipeline_1_1logging_1_1_sink_formatter.html',1,'FairDataPipeline::logging']]], + ['sync_5ferror_4',['sync_error',['../class_fair_data_pipeline_1_1sync__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_0.js b/search/classes_0.js index fc23376..5bed2e7 100644 --- a/search/classes_0.js +++ b/search/classes_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['api_0',['API',['../class_f_d_p_1_1_a_p_i.html',1,'FDP']]], - ['apiobject_1',['ApiObject',['../class_f_d_p_1_1_api_object.html',1,'FDP']]] + ['api_0',['API',['../class_fair_data_pipeline_1_1_a_p_i.html',1,'FairDataPipeline']]], + ['apiobject_1',['ApiObject',['../class_fair_data_pipeline_1_1_api_object.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_1.js b/search/classes_1.js index 543cc44..01d857f 100644 --- a/search/classes_1.js +++ b/search/classes_1.js @@ -1,5 +1,6 @@ var searchData= [ - ['config_0',['Config',['../class_f_d_p_1_1_config.html',1,'FDP']]], - ['config_5fparsing_5ferror_1',['config_parsing_error',['../class_f_d_p_1_1config__parsing__error.html',1,'FDP']]] + ['compositesink_0',['CompositeSink',['../class_fair_data_pipeline_1_1logging_1_1_composite_sink.html',1,'FairDataPipeline::logging']]], + ['config_1',['Config',['../class_fair_data_pipeline_1_1_config.html',1,'FairDataPipeline']]], + ['config_5fparsing_5ferror_2',['config_parsing_error',['../class_fair_data_pipeline_1_1config__parsing__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_2.js b/search/classes_2.js index 0fec80b..f315710 100644 --- a/search/classes_2.js +++ b/search/classes_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html',1,'FDP']]], + ['datapipeline_0',['DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html',1,'FairDataPipeline']]], ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]] ]; diff --git a/search/classes_3.js b/search/classes_3.js index 0024224..596baea 100644 --- a/search/classes_3.js +++ b/search/classes_3.js @@ -1,5 +1,7 @@ var searchData= [ - ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html',1,'FDP::DataPipeline']]], - ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html',1,'FDP']]] + ['impl_0',['impl',['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html',1,'FairDataPipeline::DataPipeline']]], + ['ioobject_1',['IOObject',['../class_fair_data_pipeline_1_1_i_o_object.html',1,'FairDataPipeline']]], + ['isink_2',['ISink',['../struct_fair_data_pipeline_1_1logging_1_1_i_sink.html',1,'FairDataPipeline::logging']]], + ['isinkformatter_3',['ISinkFormatter',['../struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/classes_4.js b/search/classes_4.js index ee83dc0..8a208d9 100644 --- a/search/classes_4.js +++ b/search/classes_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['json_5fparse_5ferror_0',['json_parse_error',['../class_f_d_p_1_1json__parse__error.html',1,'FDP']]] + ['json_5fparse_5ferror_0',['json_parse_error',['../class_fair_data_pipeline_1_1json__parse__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_5.js b/search/classes_5.js index c8ad9bd..6779d44 100644 --- a/search/classes_5.js +++ b/search/classes_5.js @@ -1,4 +1,5 @@ var searchData= [ - ['logger_0',['logger',['../class_f_d_p_1_1logger.html',1,'FDP']]] + ['logger_0',['logger',['../class_fair_data_pipeline_1_1logger.html',1,'FairDataPipeline']]], + ['logger_1',['Logger',['../class_fair_data_pipeline_1_1logging_1_1_logger.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/classes_6.js b/search/classes_6.js index 5d19101..4c6b2cd 100644 --- a/search/classes_6.js +++ b/search/classes_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['rest_5fapiquery_5ferror_0',['rest_apiquery_error',['../class_f_d_p_1_1rest__apiquery__error.html',1,'FDP']]] + ['msgbuilder_0',['MsgBuilder',['../class_fair_data_pipeline_1_1logging_1_1_logger_1_1_msg_builder.html',1,'FairDataPipeline::logging::Logger']]] ]; diff --git a/search/classes_7.js b/search/classes_7.js index 0a01a4d..c342a14 100644 --- a/search/classes_7.js +++ b/search/classes_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['sync_5ferror_0',['sync_error',['../class_f_d_p_1_1sync__error.html',1,'FDP']]] + ['ostreamsink_0',['OStreamSink',['../class_fair_data_pipeline_1_1logging_1_1_o_stream_sink.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/classes_8.js b/search/classes_8.js index a751baa..844f1dc 100644 --- a/search/classes_8.js +++ b/search/classes_8.js @@ -1,5 +1,4 @@ var searchData= [ - ['validation_5ferror_0',['validation_error',['../class_f_d_p_1_1validation__error.html',1,'FDP']]], - ['version_1',['version',['../class_f_d_p_1_1_versioning_1_1version.html',1,'FDP::Versioning']]] + ['rest_5fapiquery_5ferror_0',['rest_apiquery_error',['../class_fair_data_pipeline_1_1rest__apiquery__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_9.js b/search/classes_9.js index be6390b..1cf4c57 100644 --- a/search/classes_9.js +++ b/search/classes_9.js @@ -1,4 +1,6 @@ var searchData= [ - ['write_5ferror_0',['write_error',['../class_f_d_p_1_1write__error.html',1,'FDP']]] + ['sink_0',['Sink',['../class_fair_data_pipeline_1_1logging_1_1_sink.html',1,'FairDataPipeline::logging']]], + ['sinkformatter_1',['SinkFormatter',['../class_fair_data_pipeline_1_1logging_1_1_sink_formatter.html',1,'FairDataPipeline::logging']]], + ['sync_5ferror_2',['sync_error',['../class_fair_data_pipeline_1_1sync__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/files_3.html b/search/classes_a.html similarity index 95% rename from search/files_3.html rename to search/classes_a.html index 418f304..5dd0c5a 100644 --- a/search/files_3.html +++ b/search/classes_a.html @@ -4,7 +4,7 @@ - + diff --git a/search/classes_a.js b/search/classes_a.js new file mode 100644 index 0000000..ca729e2 --- /dev/null +++ b/search/classes_a.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['validation_5ferror_0',['validation_error',['../class_fair_data_pipeline_1_1validation__error.html',1,'FairDataPipeline']]], + ['version_1',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html',1,'FairDataPipeline::Versioning']]] +]; diff --git a/search/files_1.html b/search/classes_b.html similarity index 95% rename from search/files_1.html rename to search/classes_b.html index 2e6e1e1..ff9cd7e 100644 --- a/search/files_1.html +++ b/search/classes_b.html @@ -4,7 +4,7 @@ - + diff --git a/search/classes_b.js b/search/classes_b.js new file mode 100644 index 0000000..d07245a --- /dev/null +++ b/search/classes_b.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5ferror_0',['write_error',['../class_fair_data_pipeline_1_1write__error.html',1,'FairDataPipeline']]] +]; diff --git a/search/enums_0.js b/search/enums_0.js index 416e3bc..b492a8a 100644 --- a/search/enums_0.js +++ b/search/enums_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['meta_5ftag_0',['meta_tag',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08',1,'FDP::Versioning']]] + ['meta_5ftag_0',['meta_tag',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62',1,'FairDataPipeline::Versioning']]] ]; diff --git a/search/enums_1.js b/search/enums_1.js deleted file mode 100644 index f61498a..0000000 --- a/search/enums_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['restapi_0',['RESTAPI',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45f',1,'FDP']]] -]; diff --git a/search/enumvalues_0.js b/search/enumvalues_0.js index 80cdc28..5511751 100644 --- a/search/enumvalues_0.js +++ b/search/enumvalues_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['alpha_0',['ALPHA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a002101f8725e5c78d9f30d87f3fa4c87',1,'FDP::Versioning']]] + ['alpha_0',['ALPHA',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a002101f8725e5c78d9f30d87f3fa4c87',1,'FairDataPipeline::Versioning']]] ]; diff --git a/search/enumvalues_1.js b/search/enumvalues_1.js index ccd8dc2..2b88f9d 100644 --- a/search/enumvalues_1.js +++ b/search/enumvalues_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['beta_0',['BETA',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a36b84f8e3fba5bf993e3ba352d62d146',1,'FDP::Versioning']]] + ['beta_0',['BETA',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a36b84f8e3fba5bf993e3ba352d62d146',1,'FairDataPipeline::Versioning']]] ]; diff --git a/search/enumvalues_2.js b/search/enumvalues_2.js index a30f4a9..aeeff40 100644 --- a/search/enumvalues_2.js +++ b/search/enumvalues_2.js @@ -1,4 +1,5 @@ var searchData= [ - ['local_0',['LOCAL',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa54b4c4075463b2e02cd69f5cd139b5b2',1,'FDP']]] + ['release_0',['RELEASE',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a7d649ef069df9885e382417c79f3d5cd',1,'FairDataPipeline::Versioning']]], + ['release_5fcandidate_1',['RELEASE_CANDIDATE',['../namespace_fair_data_pipeline_1_1_versioning.html#a42c8c9e5838425e5fe43e3f542f7bd62a29fa7e21ab006777c5d8f86d893bfa53',1,'FairDataPipeline::Versioning']]] ]; diff --git a/search/enumvalues_3.html b/search/enumvalues_3.html deleted file mode 100644 index 08a159b..0000000 --- a/search/enumvalues_3.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/enumvalues_3.js b/search/enumvalues_3.js deleted file mode 100644 index c3ed804..0000000 --- a/search/enumvalues_3.js +++ /dev/null @@ -1,6 +0,0 @@ -var searchData= -[ - ['release_0',['RELEASE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a7d649ef069df9885e382417c79f3d5cd',1,'FDP::Versioning']]], - ['release_5fcandidate_1',['RELEASE_CANDIDATE',['../namespace_f_d_p_1_1_versioning.html#ae96112f76df26e6f7382845a1badfb08a29fa7e21ab006777c5d8f86d893bfa53',1,'FDP::Versioning']]], - ['remote_2',['REMOTE',['../api_8hxx.html#ab547adecdcdf31fbb64fd808caa0a45fa62f728a9642195060871a70b9b60c937',1,'FDP']]] -]; diff --git a/search/files_0.js b/search/files_0.js index a9561d0..09bcd02 100644 --- a/search/files_0.js +++ b/search/files_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['api_2ehxx_0',['api.hxx',['../api_8hxx.html',1,'']]] + ['config_2ehxx_0',['config.hxx',['../config_8hxx.html',1,'']]] ]; diff --git a/search/files_1.js b/search/files_1.js deleted file mode 100644 index 09bcd02..0000000 --- a/search/files_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['config_2ehxx_0',['config.hxx',['../config_8hxx.html',1,'']]] -]; diff --git a/search/files_2.html b/search/files_2.html deleted file mode 100644 index 7a0a2e1..0000000 --- a/search/files_2.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/files_2.js b/search/files_2.js deleted file mode 100644 index 4ddb543..0000000 --- a/search/files_2.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['json_2ehxx_0',['json.hxx',['../json_8hxx.html',1,'']]] -]; diff --git a/search/files_3.js b/search/files_3.js deleted file mode 100644 index 2965f28..0000000 --- a/search/files_3.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['logging_2ehxx_0',['logging.hxx',['../logging_8hxx.html',1,'']]] -]; diff --git a/search/files_4.html b/search/files_4.html deleted file mode 100644 index d5e4577..0000000 --- a/search/files_4.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/files_4.js b/search/files_4.js deleted file mode 100644 index f5067bf..0000000 --- a/search/files_4.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['metadata_2ehxx_0',['metadata.hxx',['../metadata_8hxx.html',1,'']]] -]; diff --git a/search/files_5.html b/search/files_5.html deleted file mode 100644 index c1ae5d6..0000000 --- a/search/files_5.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/files_5.js b/search/files_5.js deleted file mode 100644 index 6050d04..0000000 --- a/search/files_5.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['semver_2ehxx_0',['semver.hxx',['../semver_8hxx.html',1,'']]] -]; diff --git a/search/functions_0.js b/search/functions_0.js index 9c4efce..5159187 100644 --- a/search/functions_0.js +++ b/search/functions_0.js @@ -1,5 +1,4 @@ var searchData= [ - ['api_0',['API',['../class_f_d_p_1_1_a_p_i.html#ac194b91d3e48a28447b57415256dee09',1,'FDP::API']]], - ['append_5fwith_5fforward_5fslash_1',['append_with_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a3ad431714e79510c6b4268ffeba7109c',1,'FDP::API']]] + ['append_5fwith_5fforward_5fslash_0',['append_with_forward_slash',['../class_fair_data_pipeline_1_1_a_p_i.html#a77c8f0b7fb9b65b6d56951088f48ca03',1,'FairDataPipeline::API']]] ]; diff --git a/search/functions_1.js b/search/functions_1.js index d62f6cf..976520c 100644 --- a/search/functions_1.js +++ b/search/functions_1.js @@ -1,9 +1,6 @@ var searchData= [ - ['calculate_5fhash_5ffrom_5ffile_0',['calculate_hash_from_file',['../metadata_8hxx.html#aef5b5dab5a6743bed9e9d0842ec8e0b9',1,'FDP']]], - ['calculate_5fhash_5ffrom_5fstring_1',['calculate_hash_from_string',['../metadata_8hxx.html#add1040168fb281b0753ca26cd445d8ee',1,'FDP']]], - ['config_5freads_5f_2',['config_reads_',['../class_f_d_p_1_1_config.html#ae6d8d51e4e85cf56bf6073176a7a9aad',1,'FDP::Config']]], - ['config_5fwrites_5f_3',['config_writes_',['../class_f_d_p_1_1_config.html#a11e0003de1809e4d2acbcc86a75c1236',1,'FDP::Config']]], - ['construct_4',['construct',['../class_f_d_p_1_1_api_object.html#a52db6cca9c94d6bed3b00166c3c04b9c',1,'FDP::ApiObject']]], - ['current_5ftime_5fstamp_5',['current_time_stamp',['../metadata_8hxx.html#a0f9f5711fdb2e85d991b5a6c606f9b1e',1,'FDP']]] + ['config_5freads_5f_0',['config_reads_',['../class_fair_data_pipeline_1_1_config.html#aabc4e10c3abc199eb2d981ccc405c3f3',1,'FairDataPipeline::Config']]], + ['config_5fwrites_5f_1',['config_writes_',['../class_fair_data_pipeline_1_1_config.html#aa4191219e1e366891673d7b9a038657f',1,'FairDataPipeline::Config']]], + ['construct_2',['construct',['../class_fair_data_pipeline_1_1_data_pipeline.html#a681b53aa30d6b0ca68e3988c7288e4c1',1,'FairDataPipeline::DataPipeline::construct()'],['../class_fair_data_pipeline_1_1_api_object.html#a0381e1bad290b6cd65ce9ea2c19a80cb',1,'FairDataPipeline::ApiObject::construct()'],['../class_fair_data_pipeline_1_1_a_p_i.html#a50c23587bd6426fa07a669da6ff845a6',1,'FairDataPipeline::API::construct()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#aade68609c67d22ee027fdd53da1dece8',1,'FairDataPipeline::DataPipeline::impl::construct()']]] ]; diff --git a/search/functions_10.html b/search/functions_10.html deleted file mode 100644 index 0a62f42..0000000 --- a/search/functions_10.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/functions_10.js b/search/functions_10.js deleted file mode 100644 index cf3da40..0000000 --- a/search/functions_10.js +++ /dev/null @@ -1,6 +0,0 @@ -var searchData= -[ - ['_7econfig_0',['~Config',['../class_f_d_p_1_1_config.html#a5078af487531c263fef8fbe08a4191df',1,'FDP::Config']]], - ['_7edatapipeline_1',['~DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#a67f8a0f07ef29d1c4661e74bdd79ce38',1,'FDP::DataPipeline']]], - ['_7eimpl_2',['~impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a1c68d7867deda1530cbed05069b05b09',1,'FDP::DataPipeline::impl']]] -]; diff --git a/search/functions_2.js b/search/functions_2.js index 9ec1d93..9ccb208 100644 --- a/search/functions_2.js +++ b/search/functions_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['datapipeline_0',['DataPipeline',['../class_f_d_p_1_1_data_pipeline.html#aa59a3657d69452a0c54d7b09aa8ce5fd',1,'FDP::DataPipeline']]] + ['escape_5fspace_0',['escape_space',['../class_fair_data_pipeline_1_1_a_p_i.html#a9bd47ef694c9c5a53ebd4f8d11881dd2',1,'FairDataPipeline::API']]] ]; diff --git a/search/functions_3.js b/search/functions_3.js index 41a0804..716ebbf 100644 --- a/search/functions_3.js +++ b/search/functions_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['escape_5fspace_0',['escape_space',['../class_f_d_p_1_1_a_p_i.html#a98101859c913eea13166a115a97b9e64',1,'FDP::API']]] + ['finalise_0',['finalise',['../class_fair_data_pipeline_1_1_data_pipeline.html#a92c0472680d46d0017ebd85b1575d02d',1,'FairDataPipeline::DataPipeline::finalise()'],['../class_fair_data_pipeline_1_1_config.html#a47f7446d7511bb3ff5a68bf1c25814a4',1,'FairDataPipeline::Config::finalise()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a88bc798cecc1b1de65b37667ae89f481',1,'FairDataPipeline::DataPipeline::impl::finalise()']]] ]; diff --git a/search/functions_4.js b/search/functions_4.js index 03312d9..46b6465 100644 --- a/search/functions_4.js +++ b/search/functions_4.js @@ -1,5 +1,35 @@ var searchData= [ - ['file_5fexists_0',['file_exists',['../metadata_8hxx.html#a7d885b9af9988c944d23eedbff430272',1,'FDP']]], - ['finalise_1',['finalise',['../class_f_d_p_1_1_data_pipeline.html#ab2f0647e00ca35e2e7ab68b17cb52916',1,'FDP::DataPipeline::finalise()'],['../class_f_d_p_1_1_config.html#a7a48b2a8da35c03e4f621b3a70aac705',1,'FDP::Config::finalise()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#aa8df96d2a875997a793d684f23b990db',1,'FDP::DataPipeline::impl::finalise()']]] + ['get_5fapi_0',['get_api',['../class_fair_data_pipeline_1_1_config.html#a6cc0a787c24e1d33f11308a5da7e1290',1,'FairDataPipeline::Config']]], + ['get_5fapi_5furl_1',['get_api_url',['../class_fair_data_pipeline_1_1_config.html#a4052397551021c6c027909d481cfa6dc',1,'FairDataPipeline::Config']]], + ['get_5fby_5fid_2',['get_by_id',['../class_fair_data_pipeline_1_1_a_p_i.html#af64b8d337919cf682ba79dbe0a78de80',1,'FairDataPipeline::API']]], + ['get_5fcode_5frun_5fuuid_3',['get_code_run_uuid',['../class_fair_data_pipeline_1_1_config.html#af6d7f4c607670c21c080013ad194305c',1,'FairDataPipeline::Config::get_code_run_uuid()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a96e28706b3d0a1809787e0afff0f0a88',1,'FairDataPipeline::DataPipeline::impl::get_code_run_uuid()']]], + ['get_5fcomponent_5fdescription_4',['get_component_description',['../class_fair_data_pipeline_1_1_i_o_object.html#a3cfc22da4295b989440eb0197ff09288',1,'FairDataPipeline::IOObject']]], + ['get_5fcomponent_5fobject_5',['get_component_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a4c7fa781dc836558cdc4c7a4a3843c26',1,'FairDataPipeline::IOObject']]], + ['get_5fconfig_5fdata_6',['get_config_data',['../class_fair_data_pipeline_1_1_config.html#a0ac997802676d72ed05ea95500865211',1,'FairDataPipeline::Config']]], + ['get_5fconfig_5fdirectory_7',['get_config_directory',['../class_fair_data_pipeline_1_1_config.html#ad9fc2b5ca3cb098a5cb7466cef50a9a8',1,'FairDataPipeline::Config']]], + ['get_5fconfig_5ffile_5fpath_8',['get_config_file_path',['../class_fair_data_pipeline_1_1_config.html#a0ad1d6842ea860dcb14c0d608924608c',1,'FairDataPipeline::Config']]], + ['get_5fdata_5fproduct_9',['get_data_product',['../class_fair_data_pipeline_1_1_i_o_object.html#af1c43a40eedf7a639e6ae6174f44a6c7',1,'FairDataPipeline::IOObject']]], + ['get_5fdata_5fproduct_5fdescription_10',['get_data_product_description',['../class_fair_data_pipeline_1_1_i_o_object.html#a5f48c463ac62335b479f0987f8446021',1,'FairDataPipeline::IOObject']]], + ['get_5fdata_5fproduct_5fobject_11',['get_data_product_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a714e482615a8d5ab6da5b5cbbe396956',1,'FairDataPipeline::IOObject']]], + ['get_5fdata_5fstore_12',['get_data_store',['../class_fair_data_pipeline_1_1_config.html#a0db92abe9690edff27768dd55cdc3b57',1,'FairDataPipeline::Config']]], + ['get_5fdefault_5finput_5fnamespace_13',['get_default_input_namespace',['../class_fair_data_pipeline_1_1_config.html#ac348baa7909b2468cc90c8284736d59d',1,'FairDataPipeline::Config']]], + ['get_5fdefault_5foutput_5fnamespace_14',['get_default_output_namespace',['../class_fair_data_pipeline_1_1_config.html#a0b0676eb5387f8cf7976ee289f53de22',1,'FairDataPipeline::Config']]], + ['get_5ffirst_5fcomponent_15',['get_first_component',['../class_fair_data_pipeline_1_1_api_object.html#adc461dac7bd62791694b448f248285b9',1,'FairDataPipeline::ApiObject']]], + ['get_5fid_16',['get_id',['../class_fair_data_pipeline_1_1_api_object.html#aaa059f4d3987b084a26e4a549da33f17',1,'FairDataPipeline::ApiObject']]], + ['get_5fid_5ffrom_5fstring_17',['get_id_from_string',['../class_fair_data_pipeline_1_1_api_object.html#add02fcf7053cb65579b95238a4d680f1',1,'FairDataPipeline::ApiObject']]], + ['get_5fpath_18',['get_path',['../class_fair_data_pipeline_1_1_i_o_object.html#a0747d6a9ca266ab82caf55b0b31cfbee',1,'FairDataPipeline::IOObject']]], + ['get_5frequest_19',['get_request',['../class_fair_data_pipeline_1_1_a_p_i.html#a83e58d8969eeec9be2504c11826d7112',1,'FairDataPipeline::API']]], + ['get_5frest_5fapi_5flocation_20',['get_rest_api_location',['../class_fair_data_pipeline_1_1_config.html#aa42386544e7c435c9668b3501665c73f',1,'FairDataPipeline::Config']]], + ['get_5fscript_5ffile_5fpath_21',['get_script_file_path',['../class_fair_data_pipeline_1_1_config.html#a6b8c535f166ad505efc886658bc4343b',1,'FairDataPipeline::Config']]], + ['get_5ftoken_22',['get_token',['../class_fair_data_pipeline_1_1_config.html#a458fa564b7b8f80f9a672114f763a311',1,'FairDataPipeline::Config']]], + ['get_5ftype_23',['get_type',['../class_fair_data_pipeline_1_1_api_object.html#afa001cc0d830f37a7a5c0f08f5ba33a1',1,'FairDataPipeline::ApiObject']]], + ['get_5furi_24',['get_uri',['../class_fair_data_pipeline_1_1_api_object.html#acb91f5e8c3311b239527ab3a3bd45051',1,'FairDataPipeline::ApiObject']]], + ['get_5furl_5froot_25',['get_url_root',['../class_fair_data_pipeline_1_1_a_p_i.html#aab2c9e803376ab69f4f43de2742e9de7',1,'FairDataPipeline::API']]], + ['get_5fuse_5fcomponent_26',['get_use_component',['../class_fair_data_pipeline_1_1_i_o_object.html#a42e444653e2f769bd9481bfce6e66c8e',1,'FairDataPipeline::IOObject']]], + ['get_5fuse_5fdata_5fproduct_27',['get_use_data_product',['../class_fair_data_pipeline_1_1_i_o_object.html#acace8d1db43d6844d4de441814bb42dd',1,'FairDataPipeline::IOObject']]], + ['get_5fuse_5fnamespace_28',['get_use_namespace',['../class_fair_data_pipeline_1_1_i_o_object.html#a73bc664d4eb616bab1fc4e37661e08c3',1,'FairDataPipeline::IOObject']]], + ['get_5fuse_5fversion_29',['get_use_version',['../class_fair_data_pipeline_1_1_i_o_object.html#a8ab831de6cd7a18c7a216102f2f0bbba',1,'FairDataPipeline::IOObject']]], + ['get_5fvalue_5fas_5fint_30',['get_value_as_int',['../class_fair_data_pipeline_1_1_api_object.html#a8566bce9f37b5de3d6643fcd37b4a829',1,'FairDataPipeline::ApiObject']]], + ['get_5fvalue_5fas_5fstring_31',['get_value_as_string',['../class_fair_data_pipeline_1_1_api_object.html#a9c6f48fd620933be0e2ec224bd1ecd8e',1,'FairDataPipeline::ApiObject']]] ]; diff --git a/search/functions_5.js b/search/functions_5.js index 3ff3585..d14787e 100644 --- a/search/functions_5.js +++ b/search/functions_5.js @@ -1,36 +1,7 @@ var searchData= [ - ['generate_5frandom_5fhash_0',['generate_random_hash',['../metadata_8hxx.html#ab79af90fa92ae81a67367f00e8c2a99a',1,'FDP']]], - ['get_5fapi_1',['get_api',['../class_f_d_p_1_1_config.html#a94caee3afb761dae494814264972c0b5',1,'FDP::Config']]], - ['get_5fapi_5furl_2',['get_api_url',['../class_f_d_p_1_1_config.html#acd762b031412ed42b87088773b90b4ea',1,'FDP::Config']]], - ['get_5fby_5fid_3',['get_by_id',['../class_f_d_p_1_1_a_p_i.html#ae112e2f7491f0eea80fa050f4351453e',1,'FDP::API']]], - ['get_5fcode_5frun_5fuuid_4',['get_code_run_uuid',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ad61c43afc5485c9fcfbef5174a68d78f',1,'FDP::DataPipeline::impl::get_code_run_uuid()'],['../class_f_d_p_1_1_config.html#a9e0b8f3d9b007fd973786f4aad510e11',1,'FDP::Config::get_code_run_uuid()']]], - ['get_5fcomponent_5fdescription_5',['get_component_description',['../class_f_d_p_1_1_i_o_object.html#ac3145f3de8a58010d8a33e57fee67ec2',1,'FDP::IOObject']]], - ['get_5fcomponent_5fobject_6',['get_component_object',['../class_f_d_p_1_1_i_o_object.html#ad8d3ed9b24f406d20575ef45469ee8a0',1,'FDP::IOObject']]], - ['get_5fconfig_5fdata_7',['get_config_data',['../class_f_d_p_1_1_config.html#abb5f291d556dcc6bdf46eb58e41eec09',1,'FDP::Config']]], - ['get_5fconfig_5fdirectory_8',['get_config_directory',['../class_f_d_p_1_1_config.html#aceec2d117c285882497b09ef2baf5640',1,'FDP::Config']]], - ['get_5fconfig_5ffile_5fpath_9',['get_config_file_path',['../class_f_d_p_1_1_config.html#a7f353dbe62d7ffadae9e4bacceb6c014',1,'FDP::Config']]], - ['get_5fdata_5fproduct_10',['get_data_product',['../class_f_d_p_1_1_i_o_object.html#a7c7acd56d99c4eda4618fdc6e8a236d1',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fdescription_11',['get_data_product_description',['../class_f_d_p_1_1_i_o_object.html#ac76df715690e2af929a66470e9ca938f',1,'FDP::IOObject']]], - ['get_5fdata_5fproduct_5fobject_12',['get_data_product_object',['../class_f_d_p_1_1_i_o_object.html#af927b241ff0f6f83fe646d24ac7cefa0',1,'FDP::IOObject']]], - ['get_5fdata_5fstore_13',['get_data_store',['../class_f_d_p_1_1_config.html#a4315879e9ce125e0a3d260cec4afde8e',1,'FDP::Config']]], - ['get_5fdefault_5finput_5fnamespace_14',['get_default_input_namespace',['../class_f_d_p_1_1_config.html#a3d4b349053235b6d5455fec3e516bb69',1,'FDP::Config']]], - ['get_5fdefault_5foutput_5fnamespace_15',['get_default_output_namespace',['../class_f_d_p_1_1_config.html#aca9815afe0d7413bb66c4fadc83521a5',1,'FDP::Config']]], - ['get_5ffirst_5fcomponent_16',['get_first_component',['../class_f_d_p_1_1_api_object.html#a4c964c90d680e483acd361ea99a010d0',1,'FDP::ApiObject']]], - ['get_5fid_17',['get_id',['../class_f_d_p_1_1_api_object.html#a25f83ee236824640178369c4679becad',1,'FDP::ApiObject']]], - ['get_5fid_5ffrom_5fstring_18',['get_id_from_string',['../class_f_d_p_1_1_api_object.html#a2f34316403d1e24821031897216a4604',1,'FDP::ApiObject']]], - ['get_5fpath_19',['get_path',['../class_f_d_p_1_1_i_o_object.html#ab8bf366173b74a96e0f37b38c884536f',1,'FDP::IOObject']]], - ['get_5frequest_20',['get_request',['../class_f_d_p_1_1_a_p_i.html#a2a81d9b793ec9e352dfe5567fc4867dd',1,'FDP::API']]], - ['get_5frest_5fapi_5flocation_21',['get_rest_api_location',['../class_f_d_p_1_1_config.html#a7ddbba3e1add1f60e68780871cc72b5e',1,'FDP::Config']]], - ['get_5fscript_5ffile_5fpath_22',['get_script_file_path',['../class_f_d_p_1_1_config.html#a5c077dca02f9d4edf4c34fbe7ec65177',1,'FDP::Config']]], - ['get_5ftoken_23',['get_token',['../class_f_d_p_1_1_config.html#a13ec01cb682c8a3e1cea9a4d4f74c9fc',1,'FDP::Config']]], - ['get_5ftype_24',['get_type',['../class_f_d_p_1_1_api_object.html#a7ad9de3d81707b9df7c13cf263c30625',1,'FDP::ApiObject']]], - ['get_5furi_25',['get_uri',['../class_f_d_p_1_1_api_object.html#a2fb1cd09b99bb3d854f21167d3d48dc9',1,'FDP::ApiObject']]], - ['get_5furl_5froot_26',['get_url_root',['../class_f_d_p_1_1_a_p_i.html#aa7876cac606b8a3e45f35eaf4f318abe',1,'FDP::API']]], - ['get_5fuse_5fcomponent_27',['get_use_component',['../class_f_d_p_1_1_i_o_object.html#a4439875ff61e85bf04f00004eb35ccc2',1,'FDP::IOObject']]], - ['get_5fuse_5fdata_5fproduct_28',['get_use_data_product',['../class_f_d_p_1_1_i_o_object.html#a08e05013423139691db36810344cd5c0',1,'FDP::IOObject']]], - ['get_5fuse_5fnamespace_29',['get_use_namespace',['../class_f_d_p_1_1_i_o_object.html#acd94303a44a3d221a5aa369688faf05a',1,'FDP::IOObject']]], - ['get_5fuse_5fversion_30',['get_use_version',['../class_f_d_p_1_1_i_o_object.html#a6a1ab929bcc0d31a3af114bf9fe3a449',1,'FDP::IOObject']]], - ['get_5fvalue_5fas_5fint_31',['get_value_as_int',['../class_f_d_p_1_1_api_object.html#acbac01d71e5f888734b306115123bc20',1,'FDP::ApiObject']]], - ['get_5fvalue_5fas_5fstring_32',['get_value_as_string',['../class_f_d_p_1_1_api_object.html#a6acd61ea72aa94c5494689581f3fe0bc',1,'FDP::ApiObject']]] + ['has_5finputs_0',['has_inputs',['../class_fair_data_pipeline_1_1_config.html#aa17707c6271ce1f17a781195d1c83814',1,'FairDataPipeline::Config']]], + ['has_5foutputs_1',['has_outputs',['../class_fair_data_pipeline_1_1_config.html#a4583d8193e3bc8ad66b60ff4d7f60131',1,'FairDataPipeline::Config']]], + ['has_5freads_2',['has_reads',['../class_fair_data_pipeline_1_1_config.html#af7973ce8257cbef71d0d860168253f0f',1,'FairDataPipeline::Config']]], + ['has_5fwrites_3',['has_writes',['../class_fair_data_pipeline_1_1_config.html#a4555122fc22ed19c7163f8aaad3b1735',1,'FairDataPipeline::Config']]] ]; diff --git a/search/functions_6.js b/search/functions_6.js index 54d93b0..5d13661 100644 --- a/search/functions_6.js +++ b/search/functions_6.js @@ -1,7 +1,6 @@ var searchData= [ - ['has_5finputs_0',['has_inputs',['../class_f_d_p_1_1_config.html#a3575ed8e0f6a51f99b4428bd575bfc24',1,'FDP::Config']]], - ['has_5foutputs_1',['has_outputs',['../class_f_d_p_1_1_config.html#ab3424fed4132fd1adda88f1566293de4',1,'FDP::Config']]], - ['has_5freads_2',['has_reads',['../class_f_d_p_1_1_config.html#a4d652212cbb50a0e92afc41ea64815de',1,'FDP::Config']]], - ['has_5fwrites_3',['has_writes',['../class_f_d_p_1_1_config.html#ab2c81212fdb00aeda1f7881df61e60a7',1,'FDP::Config']]] + ['ioobject_0',['IOObject',['../class_fair_data_pipeline_1_1_i_o_object.html#a012b2b04413800d2a09418d2ed97459c',1,'FairDataPipeline::IOObject::IOObject()=default'],['../class_fair_data_pipeline_1_1_i_o_object.html#a7d5c6cd8d1c53a4f4c800670115f6542',1,'FairDataPipeline::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)'],['../class_fair_data_pipeline_1_1_i_o_object.html#aa8d07d60ec85809caddb8bf1614c81a4',1,'FairDataPipeline::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], + ['is_5fempty_1',['is_empty',['../class_fair_data_pipeline_1_1_api_object.html#ada37bdbca0c405920f446efce7f1a802',1,'FairDataPipeline::ApiObject']]], + ['is_5fpublic_2',['is_public',['../class_fair_data_pipeline_1_1_i_o_object.html#afca56fb44355d2fb120a8f83b0dc5f32',1,'FairDataPipeline::IOObject']]] ]; diff --git a/search/functions_7.js b/search/functions_7.js index b87c845..647401d 100644 --- a/search/functions_7.js +++ b/search/functions_7.js @@ -1,7 +1,4 @@ var searchData= [ - ['impl_0',['impl',['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ac3b1ebeb2fbf90a729d8ef5784324445',1,'FDP::DataPipeline::impl']]], - ['ioobject_1',['IOObject',['../class_f_d_p_1_1_i_o_object.html#ab02b513c6e8a608e11128a7790abc056',1,'FDP::IOObject::IOObject()=default'],['../class_f_d_p_1_1_i_o_object.html#aaf0df6076993057837e2727ec71f8e68',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)'],['../class_f_d_p_1_1_i_o_object.html#a1b252f1e63196516b77ff2737761c87a',1,'FDP::IOObject::IOObject(const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)']]], - ['is_5fempty_2',['is_empty',['../class_f_d_p_1_1_api_object.html#a25498e83fc1b483fb786e81aa4576a01',1,'FDP::ApiObject']]], - ['is_5fpublic_3',['is_public',['../class_f_d_p_1_1_i_o_object.html#a8252f827930e78fa41ef284472e44ffe',1,'FDP::IOObject']]] + ['json_5fto_5fquery_5fstring_0',['json_to_query_string',['../class_fair_data_pipeline_1_1_a_p_i.html#a04550b2a3747f77273c0a5aa11cb37f8',1,'FairDataPipeline::API']]] ]; diff --git a/search/functions_8.js b/search/functions_8.js index e1738cd..50087dd 100644 --- a/search/functions_8.js +++ b/search/functions_8.js @@ -1,5 +1,5 @@ var searchData= [ - ['json_5fto_5fquery_5fstring_0',['json_to_query_string',['../class_f_d_p_1_1_a_p_i.html#ad91263a71029cccc94e9e49cd4a37568',1,'FDP::API']]], - ['json_5fto_5fstring_1',['json_to_string',['../json_8hxx.html#a77f24139171b28c1fc719b55846938f1',1,'FDP']]] + ['link_5fread_0',['link_read',['../class_fair_data_pipeline_1_1_data_pipeline.html#af0eafc06e593cf671dfe5cf3fdc425cd',1,'FairDataPipeline::DataPipeline::link_read()'],['../class_fair_data_pipeline_1_1_config.html#a0a80b73790d5cc86c1e0feac40384e4c',1,'FairDataPipeline::Config::link_read()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#ad6c57457ffe8f703f88bbb49bec34702',1,'FairDataPipeline::DataPipeline::impl::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_fair_data_pipeline_1_1_data_pipeline.html#a850325eb103977cd6c1a9ca9ad6c32aa',1,'FairDataPipeline::DataPipeline::link_write()'],['../class_fair_data_pipeline_1_1_config.html#a79878583ed56f0c4a4d10f11154a54ef',1,'FairDataPipeline::Config::link_write()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#afe198537ecdb0e45363b7edd84c4ae01',1,'FairDataPipeline::DataPipeline::impl::link_write()']]] ]; diff --git a/search/functions_9.js b/search/functions_9.js index 0f20d38..cec6db9 100644 --- a/search/functions_9.js +++ b/search/functions_9.js @@ -1,5 +1,4 @@ var searchData= [ - ['link_5fread_0',['link_read',['../class_f_d_p_1_1_data_pipeline.html#a77b0e4cf1ecedefc4f98d71050a7d6c5',1,'FDP::DataPipeline::link_read()'],['../class_f_d_p_1_1_config.html#a794593eb3a2ad1d6fdf8659a5853e66c',1,'FDP::Config::link_read()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#ae8e7f7f1e7bbdbe93094d59c367210ad',1,'FDP::DataPipeline::impl::link_read()']]], - ['link_5fwrite_1',['link_write',['../class_f_d_p_1_1_data_pipeline.html#a2b51a4f59e452e5ea242d7dcf3905555',1,'FDP::DataPipeline::link_write()'],['../class_f_d_p_1_1_config.html#aca288df67576372a7295f67f39776f68',1,'FDP::Config::link_write()'],['../class_f_d_p_1_1_data_pipeline_1_1impl.html#a43686ff0e1cf0733770058808b7bd322',1,'FDP::DataPipeline::impl::link_write()']]] + ['meta_5fdata_5f_0',['meta_data_',['../class_fair_data_pipeline_1_1_config.html#a007b9d59446d41aa345a62d903051d6b',1,'FairDataPipeline::Config']]] ]; diff --git a/search/functions_a.js b/search/functions_a.js index 84407a8..471f904 100644 --- a/search/functions_a.js +++ b/search/functions_a.js @@ -1,4 +1,5 @@ var searchData= [ - ['meta_5fdata_5f_0',['meta_data_',['../class_f_d_p_1_1_config.html#a6202b2d39b4dbd977340b90f5382a4fb',1,'FDP::Config']]] + ['parse_5fyaml_0',['parse_yaml',['../class_fair_data_pipeline_1_1_config.html#a29487b05d1a71932b5ce20d8c0faca7d',1,'FairDataPipeline::Config']]], + ['post_1',['post',['../class_fair_data_pipeline_1_1_a_p_i.html#ac80ad050a49bfb010d26655592a1c8a1',1,'FairDataPipeline::API']]] ]; diff --git a/search/functions_b.js b/search/functions_b.js index dd59b81..6281117 100644 --- a/search/functions_b.js +++ b/search/functions_b.js @@ -1,5 +1,4 @@ var searchData= [ - ['parse_5fyaml_0',['parse_yaml',['../class_f_d_p_1_1_config.html#a12c5d3bb7298854078dfb5bf70e31443',1,'FDP::Config']]], - ['post_1',['post',['../class_f_d_p_1_1_a_p_i.html#a2479874abf32bcaaeb269972b3aaef90',1,'FDP::API']]] + ['remove_5fleading_5fforward_5fslash_0',['remove_leading_forward_slash',['../class_fair_data_pipeline_1_1_a_p_i.html#a2643a2cf82f253c2756d4ebdb8ce6650',1,'FairDataPipeline::API']]] ]; diff --git a/search/functions_c.js b/search/functions_c.js index 7d93398..84ddb1b 100644 --- a/search/functions_c.js +++ b/search/functions_c.js @@ -1,7 +1,5 @@ var searchData= [ - ['read_5ftoken_0',['read_token',['../metadata_8hxx.html#a5dbd216ab20d3b4329231ba5965b34e3',1,'FDP']]], - ['remove_5fbackslash_5ffrom_5fpath_1',['remove_backslash_from_path',['../metadata_8hxx.html#a45be90ccf712b64441d38e0a1ed324f4',1,'FDP']]], - ['remove_5fleading_5fforward_5fslash_2',['remove_leading_forward_slash',['../class_f_d_p_1_1_a_p_i.html#a69448057f09381a313980bec41b3d4cd',1,'FDP::API']]], - ['remove_5flocal_5ffrom_5froot_3',['remove_local_from_root',['../metadata_8hxx.html#a1f7e1d16c6056d8117113a16d806e75d',1,'FDP']]] + ['set_5fcomponent_5fobject_0',['set_component_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a6889e85849addfa22d01c7c1b63f342f',1,'FairDataPipeline::IOObject']]], + ['set_5fdata_5fproduct_5fobject_1',['set_data_product_object',['../class_fair_data_pipeline_1_1_i_o_object.html#a6b5ffe80335b332786cf86eb489f96f2',1,'FairDataPipeline::IOObject']]] ]; diff --git a/search/functions_d.js b/search/functions_d.js index 681bae3..7034011 100644 --- a/search/functions_d.js +++ b/search/functions_d.js @@ -1,5 +1,4 @@ var searchData= [ - ['set_5fcomponent_5fobject_0',['set_component_object',['../class_f_d_p_1_1_i_o_object.html#ac4ec3246d12c759041bb2ca099afffac',1,'FDP::IOObject']]], - ['set_5fdata_5fproduct_5fobject_1',['set_data_product_object',['../class_f_d_p_1_1_i_o_object.html#a4a3cd1518aa9138c15c52cf925f3f1e3',1,'FDP::IOObject']]] + ['version_0',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a487e9e19f8dc597c02c0d2caf9483984',1,'FairDataPipeline::Versioning::version::version()=default'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a82cda27e083c9b3ef3d38c6ca52fc820',1,'FairDataPipeline::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] ]; diff --git a/search/functions_e.js b/search/functions_e.js index 8f39951..0f5adfa 100644 --- a/search/functions_e.js +++ b/search/functions_e.js @@ -1,4 +1,6 @@ var searchData= [ - ['version_0',['version',['../class_f_d_p_1_1_versioning_1_1version.html#aa9be4a03ccee8827e226ea4154781bc6',1,'FDP::Versioning::version::version()=default'],['../class_f_d_p_1_1_versioning_1_1version.html#ac46f9e049c31b63fb6552409d7d2d7b1',1,'FDP::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] + ['_7econfig_0',['~Config',['../class_fair_data_pipeline_1_1_config.html#ab73735ce5c3376bd09d9b44a92745604',1,'FairDataPipeline::Config']]], + ['_7edatapipeline_1',['~DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html#aa78325ee158faa93be203ec59e5e075f',1,'FairDataPipeline::DataPipeline']]], + ['_7eimpl_2',['~impl',['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a95b04cf2f78c7bdfba26f2ebd99dc0e6',1,'FairDataPipeline::DataPipeline::impl']]] ]; diff --git a/search/functions_f.html b/search/functions_f.html deleted file mode 100644 index 555578c..0000000 --- a/search/functions_f.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/functions_f.js b/search/functions_f.js deleted file mode 100644 index 86e8349..0000000 --- a/search/functions_f.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['write_5ffunc_5f_0',['write_func_',['../api_8hxx.html#aafe123714129a23215ddd6799c699af6',1,'FDP']]] -]; diff --git a/search/namespaces_0.js b/search/namespaces_0.js index fe3cecd..606e968 100644 --- a/search/namespaces_0.js +++ b/search/namespaces_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['versioning_0',['Versioning',['../namespace_f_d_p_1_1_versioning.html',1,'FDP']]] + ['versioning_0',['Versioning',['../namespace_fair_data_pipeline_1_1_versioning.html',1,'FairDataPipeline']]] ]; diff --git a/search/searchdata.js b/search/searchdata.js index 063ab19..226abaf 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,14 +1,13 @@ var indexSectionsWithContent = { - 0: "abcdefghijlmprsvw~", - 1: "acdijlrsvw", + 0: "abcdefghijlmoprsvw~", + 1: "acdijlmorsvw", 2: "f", - 3: "acjlms", - 4: "acdefghijlmprsvw~", - 5: "a", - 6: "mr", - 7: "ablr", - 8: "f" + 3: "c", + 4: "acefghijlmprsv~", + 5: "m", + 6: "abr", + 7: "f" }; var indexSectionNames = @@ -18,10 +17,9 @@ var indexSectionNames = 2: "namespaces", 3: "files", 4: "functions", - 5: "variables", - 6: "enums", - 7: "enumvalues", - 8: "pages" + 5: "enums", + 6: "enumvalues", + 7: "pages" }; var indexSectionLabels = @@ -31,9 +29,8 @@ var indexSectionLabels = 2: "Namespaces", 3: "Files", 4: "Functions", - 5: "Variables", - 6: "Enumerations", - 7: "Enumerator", - 8: "Pages" + 5: "Enumerations", + 6: "Enumerator", + 7: "Pages" }; diff --git a/search/variables_0.html b/search/variables_0.html deleted file mode 100644 index 7778cf0..0000000 --- a/search/variables_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/search/variables_0.js b/search/variables_0.js deleted file mode 100644 index 3254fe5..0000000 --- a/search/variables_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['apilogger_0',['APILogger',['../logging_8hxx.html#a88c65a4f48c8dde03f5d414f29ac4b7a',1,'FDP']]] -]; diff --git a/semver_8hxx.html b/semver_8hxx.html deleted file mode 100644 index 87af2bb..0000000 --- a/semver_8hxx.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - -cppDataPipeline: include/fdp/utilities/semver.hxx File Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    -Classes | -Namespaces | -Enumerations
    -
    semver.hxx File Reference
    -
    -
    - -

    File contains classes and types for validating semantic versioning. -More...

    -
    #include <ostream>
    -#include <string>
    -#include <vector>
    -
    -

    Go to the source code of this file.

    - - - - - -

    -Classes

    class  FDP::Versioning::version
     class describing the semantic version of an object More...
     
    - - - - -

    -Namespaces

    namespace  FDP::Versioning
     namespace containing all semantic versioning types and classes
     
    - - - - -

    -Enumerations

    enum class  FDP::Versioning::meta_tag { FDP::Versioning::ALPHA -, FDP::Versioning::BETA -, FDP::Versioning::RELEASE_CANDIDATE -, FDP::Versioning::RELEASE - }
     the allowed tags for versions describing version state More...
     
    -

    Detailed Description

    -

    File contains classes and types for validating semantic versioning.

    -
    -
    Author
    K. Zarebski (UKAEA)
    -
    Date
    2021-05-06
    -

    This file contains all classes and types required to ensure that data objects follow strict semantic versioning. This is important for tracking which values are used during code runs.

    -
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/semver_8hxx_source.html b/semver_8hxx_source.html index c5b09b9..7f062ba 100644 --- a/semver_8hxx_source.html +++ b/semver_8hxx_source.html @@ -70,7 +70,7 @@
    semver.hxx
    -Go to the documentation of this file.
    1
    +
    1
    12#ifndef __FDP_SEMVER_HXX__
    13#define __FDP_SEMVER_HXX__
    14
    @@ -78,29 +78,29 @@
    16#include <string>
    17#include <vector>
    18
    -
    19namespace FDP {
    +
    19namespace FairDataPipeline {
    26namespace Versioning {
    27
    -
    38enum class meta_tag {
    -
    39 ALPHA,
    -
    40 BETA,
    -
    41 RELEASE_CANDIDATE,
    -
    42 RELEASE
    +
    38enum class meta_tag {
    +
    39 ALPHA,
    +
    40 BETA,
    +
    41 RELEASE_CANDIDATE,
    +
    42 RELEASE
    43};
    44
    -
    53class version {
    +
    53class version {
    54public:
    -
    60 version() = default;
    +
    60 version() = default;
    61
    -
    80 version(unsigned int major, unsigned int minor, unsigned int patch,
    -
    81 meta_tag tag = meta_tag::RELEASE, unsigned int tag_v = 1E9,
    +
    80 version(unsigned int major, unsigned int minor, unsigned int patch,
    +
    81 meta_tag tag = meta_tag::RELEASE, unsigned int tag_v = 1E9,
    82 std::string meta_data = "")
    83 : major_(major), minor_(minor), patch_(patch), meta_tag_(tag),
    84 tag_v_(tag_v), meta_data_(meta_data) {}
    85
    -
    86 version(const std::string version_str);
    +
    86 version(const std::string version_str);
    87
    -
    88 version(const version &v)
    +
    88 version(const version &v)
    89 : major_(v.major_), minor_(v.minor_), patch_(v.patch_),
    90 meta_tag_(v.meta_tag_), tag_v_(v.tag_v_), meta_data_(v.meta_data_) {}
    91
    @@ -109,23 +109,23 @@
    94 void bump_patch() { patch_ += 1; }
    95
    96 void alpha() {
    -
    97 tag_v_ = (meta_tag_ == meta_tag::ALPHA) ? tag_v_ + 1 : 0;
    -
    98 meta_tag_ = meta_tag::ALPHA;
    +
    97 tag_v_ = (meta_tag_ == meta_tag::ALPHA) ? tag_v_ + 1 : 0;
    +
    98 meta_tag_ = meta_tag::ALPHA;
    99 }
    100
    101 void beta() {
    -
    102 tag_v_ = (meta_tag_ == meta_tag::BETA) ? tag_v_ + 1 : 0;
    -
    103 meta_tag_ = meta_tag::BETA;
    +
    102 tag_v_ = (meta_tag_ == meta_tag::BETA) ? tag_v_ + 1 : 0;
    +
    103 meta_tag_ = meta_tag::BETA;
    104 }
    105
    106 void prerelease() {
    -
    107 tag_v_ = (meta_tag_ == meta_tag::RELEASE_CANDIDATE) ? tag_v_ + 1 : 0;
    -
    108 meta_tag_ = meta_tag::RELEASE_CANDIDATE;
    +
    107 tag_v_ = (meta_tag_ == meta_tag::RELEASE_CANDIDATE) ? tag_v_ + 1 : 0;
    +
    108 meta_tag_ = meta_tag::RELEASE_CANDIDATE;
    109 }
    110
    111 void release() {
    112 tag_v_ = 1E9;
    -
    113 meta_tag_ = meta_tag::RELEASE;
    +
    113 meta_tag_ = meta_tag::RELEASE;
    114 }
    115
    116 std::string to_string() const {
    @@ -135,7 +135,7 @@
    120 out_str_ += std::to_string(minor_) + ".";
    121 out_str_ += std::to_string(patch_);
    122
    -
    123 if (meta_tag_ != meta_tag::RELEASE) {
    +
    123 if (meta_tag_ != meta_tag::RELEASE) {
    124 out_str_ += "-" + get_tag_str();
    125
    126 if (tag_v_ != 1E9) {
    @@ -149,12 +149,12 @@
    134 return out_str_;
    135 }
    136
    -
    137 friend std::ostream &operator<<(std::ostream &os, const version &v) {
    +
    137 friend std::ostream &operator<<(std::ostream &os, const version &v) {
    138 os << v.to_string();
    139 return os;
    140 }
    141
    -
    142 friend bool operator<(const version &v1, const version &v2) {
    +
    142 friend bool operator<(const version &v1, const version &v2) {
    143 if (v1.major_ < v2.major_)
    144 return true;
    145 else if (v2.major_ < v1.major_)
    @@ -178,11 +178,11 @@
    163 return false;
    164 }
    165
    -
    166 friend bool operator>(const version &v1, const version &v2) {
    +
    166 friend bool operator>(const version &v1, const version &v2) {
    167 return v2 < v1;
    168 }
    169
    -
    170 friend bool operator==(const version &v1, const version &v2) {
    +
    170 friend bool operator==(const version &v1, const version &v2) {
    171 bool same_ = v1.major_ == v2.major_;
    172 same_ = same_ && (v1.minor_ == v2.minor_);
    173 same_ = same_ && (v1.patch_ == v2.patch_);
    @@ -192,15 +192,15 @@
    177 return same_;
    178 }
    179
    -
    180 friend bool operator!=(const version &v1, const version &v2) {
    +
    180 friend bool operator!=(const version &v1, const version &v2) {
    181 return !(v1 == v2);
    182 }
    183
    -
    184 friend bool operator<=(const version &v1, const version &v2) {
    +
    184 friend bool operator<=(const version &v1, const version &v2) {
    185 return (v1 == v2) || v1 < v2;
    186 }
    187
    -
    188 friend bool operator>=(const version &v1, const version &v2) {
    +
    188 friend bool operator>=(const version &v1, const version &v2) {
    189 return (v1 == v2) || v1 > v2;
    190 }
    191
    @@ -208,23 +208,23 @@
    193 unsigned int major_ = 0;
    194 unsigned int minor_ = 1;
    195 unsigned int patch_ = 0;
    -
    196 meta_tag meta_tag_ = meta_tag::RELEASE;
    +
    196 meta_tag meta_tag_ = meta_tag::RELEASE;
    197 unsigned int tag_v_ = 1E9;
    198 std::string meta_data_ = "";
    199 std::string get_tag_str() const;
    200};
    201}; // namespace Versioning
    -
    202}; // namespace FDP
    +
    202}; // namespace FairDataPipeline
    203
    204#endif
    -
    FDP::Versioning::version
    class describing the semantic version of an object
    Definition: semver.hxx:53
    -
    FDP::Versioning::version::version
    version()=default
    Construct a new version with the default start value of 0.1.0
    -
    FDP::Versioning::version::version
    version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
    Construct a new version from integer representation.
    Definition: semver.hxx:80
    -
    FDP::Versioning::meta_tag
    meta_tag
    the allowed tags for versions describing version state
    Definition: semver.hxx:38
    - - - - +
    FairDataPipeline::Versioning::version
    class describing the semantic version of an object
    Definition: semver.hxx:53
    +
    FairDataPipeline::Versioning::version::version
    version()=default
    Construct a new version with the default start value of 0.1.0
    +
    FairDataPipeline::Versioning::version::version
    version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
    Construct a new version from integer representation.
    Definition: semver.hxx:80
    +
    FairDataPipeline::Versioning::meta_tag
    meta_tag
    the allowed tags for versions describing version state
    Definition: semver.hxx:38
    + + + +
    diff --git a/struct_fair_data_pipeline_1_1logging_1_1_i_sink-members.html b/struct_fair_data_pipeline_1_1logging_1_1_i_sink-members.html new file mode 100644 index 0000000..8d22305 --- /dev/null +++ b/struct_fair_data_pipeline_1_1logging_1_1_i_sink-members.html @@ -0,0 +1,85 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FairDataPipeline::logging::ISink Member List
    +
    +
    + +

    This is the complete list of members for FairDataPipeline::logging::ISink, including all inherited members.

    + + + + +
    log(enum LOG_LEVEL msg_lvl, const std::string &msg)=0 (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISinkpure virtual
    sptr typedef (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISink
    ~ISink() (defined in FairDataPipeline::logging::ISink)FairDataPipeline::logging::ISinkinlinevirtual
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/struct_fair_data_pipeline_1_1logging_1_1_i_sink.html b/struct_fair_data_pipeline_1_1logging_1_1_i_sink.html new file mode 100644 index 0000000..f61ee12 --- /dev/null +++ b/struct_fair_data_pipeline_1_1logging_1_1_i_sink.html @@ -0,0 +1,110 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::ISink Struct Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +List of all members
    +
    FairDataPipeline::logging::ISink Struct Referenceabstract
    +
    +
    +
    +Inheritance diagram for FairDataPipeline::logging::ISink:
    +
    +
    + + +FairDataPipeline::logging::Sink +FairDataPipeline::logging::CompositeSink +FairDataPipeline::logging::OStreamSink + +
    + + + + +

    +Public Types

    +typedef std::shared_ptr< ISink > sptr
     
    + + + +

    +Public Member Functions

    +virtual int log (enum LOG_LEVEL msg_lvl, const std::string &msg)=0
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/struct_fair_data_pipeline_1_1logging_1_1_i_sink.png b/struct_fair_data_pipeline_1_1logging_1_1_i_sink.png new file mode 100644 index 0000000000000000000000000000000000000000..ea637988c2db3f458ac03c850180825d0456ec5e GIT binary patch literal 1759 zcmbuAc~p{F6u>_sDJ!#Mi~BN#ZIN`?&GmL|$Juh8-?d@`dcPCXMJy|9UT^QmauFNoc- z+l}r%wq#`I-4g{UNKSs#i^JR9^tKpVXj61@77AheF5#ieZuar|t~wbxzh&5mrfb0( zZybwzRcrXc<_1M)+lOZVs>E{xbv4g%JMM>{KUF5(V*HN0A;R4IM1iK!=$d&=))({v z&4oLJVDAL&hmpQx+j0ZKRcmCNqY{7Na^3hf#^%#~C5PfG)NG{Vf!j&EGR&Y!=V4Xl zf_KZo{oyg9th`4odhnA6%BprJEY5Yv*)BB`JLa2od^E>X2s6+VCWj;`8)T^}!~!}f9@!{HKO4 zW{+P`56qZ20?-j9P6B*a)g5JQp#_#a6Cq~ng*S-9I^MxN#UMY(z z=LB$Y6FG0OkV1o_*>Fof%W{)8Wh)X49LWhU&=A`Uh%E!gWlgVWgxj%{Rm7t+E)DnY z(2_yt(9<6`9C6+;*%OLer^_)Sf%%GEET_@FZ8N;kTQY%wf!#^z;9-tq1qOp(#QkSF z?RD)4C2QliBB^uBR}?8!K9NkOZEP5^l)G1?zn3{sJ00Ace4WeFBggB4F)e-Hm%2~e zs^$<{I7OtFuiLI_5&aJe;@fd1bo z2#FBf04cDPo6Q-HyjZ>=O`=wR;aqntOvonTT_dC{OZg@AbMflO`HF-D#Au0qmIHfB zm50w8?4CslQKvXX4lRT1ZZ8XD2pD+UO41OGTqe6WMQ#{96iZPvS)Nv(`6X6J{jXNU zCkg$Fyl1@yvK1>K=PjI9+or8Gc_>>*IBpP~5>xC(|6Yw%hYs|os4{C^@x>0OtH>fx7zVpm`LHMr&4W(v(6OywUmcr{p` zFVLtaRdk}+sLZRD<8T7oUuby+x2jl>LtAvuGrBKvWzZZCPZjg}MZL?&7 zCSldC6E(T{L8gu0!0&%N8Iy$fMhPQnJattYKe!Vr5lC%XG}GA{0g3c&=EGw`N#Y%X zDegf(rdW8e&E+MW%Nk5&6P|G^ua#Cu2Wsb@b5jXQ(qE<;rY&!W4wLY=5-^F!E5=P> zUF#FaS$}e*E-QNd8@%&~XPWY7Vv5p#>`uNqMJ|>rDwbfRxaww3MWk3N8f8C59DH)Z z0pqLaid7QB#wsp`$u`1$s#DfZOejb`JimT>J6|Uv{eb{qTNpj}+-y>Sq$M>I4cQ{I zd^J-(5yl_#aMnrw;j`M-tYS#a6zL6CPWee*uOg~Nfzp2AWF!p}Ygigwj_j~`ITa`Q zl~x>`p2=b0T4Gkex9RQ?CB?Q5m(=;nQY1=0o>fh;X4_z#A*MGQZKIk*6*f3m)Vc}X zm_M1BwlmA+2QId@&~GZs{Rz)T_CFU_n>wnBrqs5xadM^n^3skYbe&`43@r(HeDi0K z1(J07ZEn%0p(mr(!YX)OvwtZ9i5OikQ9C|dnM1pZK}@&4rqZa%;%3IcSz{{AhL?`l z?4Kf!>!o|J;cBB + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FairDataPipeline::logging::ISinkFormatter Member List
    +
    +
    + +

    This is the complete list of members for FairDataPipeline::logging::ISinkFormatter, including all inherited members.

    + + + + +
    header(enum LOG_LEVEL msg_lvl, Logger *logger)=0 (defined in FairDataPipeline::logging::ISinkFormatter)FairDataPipeline::logging::ISinkFormatterpure virtual
    sptr typedef (defined in FairDataPipeline::logging::ISinkFormatter)FairDataPipeline::logging::ISinkFormatter
    ~ISinkFormatter() (defined in FairDataPipeline::logging::ISinkFormatter)FairDataPipeline::logging::ISinkFormatterinlinevirtual
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.html b/struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.html new file mode 100644 index 0000000..631f8df --- /dev/null +++ b/struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.html @@ -0,0 +1,108 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::logging::ISinkFormatter Struct Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +List of all members
    +
    FairDataPipeline::logging::ISinkFormatter Struct Referenceabstract
    +
    +
    +
    +Inheritance diagram for FairDataPipeline::logging::ISinkFormatter:
    +
    +
    + + +FairDataPipeline::logging::SinkFormatter + +
    + + + + +

    +Public Types

    +typedef std::shared_ptr< ISinkFormatter > sptr
     
    + + + +

    +Public Member Functions

    +virtual std::string header (enum LOG_LEVEL msg_lvl, Logger *logger)=0
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.png b/struct_fair_data_pipeline_1_1logging_1_1_i_sink_formatter.png new file mode 100644 index 0000000000000000000000000000000000000000..8977aa1dda2a6c15825c38116f22ebba1eb5f654 GIT binary patch literal 947 zcmeAS@N?(olHy`uVBq!ia0vp^AAmT3gBeH)Oy}?eQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;X ziz=!l*f0BD#%uIA)6n5WpW)xrn{-Z3J;GEV>zmLp(X^4#EsV`icg>C7ol*1MGu2ey zD3v*D=eKgy@b~~79KeIvdn>P9l!C( z`!&Z@eWOe7|5@dx*|tSBUCnK`f1YOMoJ`rB+R6f!8^B4`TN|Ka~C}{T{=-i_;sTS@XR`9^8Ks?Qapj?Y1-z z!~84m4UBc&Y6b^R%sRlJ{Q7!D^KFs|db!0m8yjZD( z99Vc?V_}ns6qZOxAtdmiJ|p(}SLt1AU+=1OTr;Tz7-ODNk-`y^+`<^+w(Ykm?8(aB zI9<}ZT8GnYf8?Z{yUOYh*%dAH3JTEYVAk;roPG1m&co5We=W4(2ns4aDlD`?#r6XC z0oB!~zt#KX0b}hjFxDOdW9^jW%YXlN-fw-XCL~?+bQhQD(Mlf~#aRKy?%X?m+&y>V zz}L!~zw3T>&Re@HzwWB^>6ezehF5BfygeT~yw=!vxYSnUdFG;&?;eZ%+r*}x{?%Fe zI&EW?WZuJ%Jiek;`o0g?RqwKxeX}VN0orwsmG7R^(HDDfC^+4=*3aa=qxVvvF8`|a zfzas|+AqseuNv-Sx#N+{d&lzimL-QzXTPaU=>I73W9B5YnL4U7->m#Pb>H>3m$qq# zi(Y?sY3JS_uXtW|$KI0PP;PL0sqzMuy{pCR<6p-ney+Z!@{+Tbd&l*~NtY)r;eVA4 zjkrl)9BbJkCe?MSZBXf5!>Qw`{F-miy4O{Te;I9pjC4cU=Jx_~7=x#)pUXO@geCyg CU%Vy& literal 0 HcmV?d00001 diff --git a/class_f_d_p_1_1logger.html b/time_8h_source.html similarity index 69% rename from class_f_d_p_1_1logger.html rename to time_8h_source.html index 6299b90..10c48e4 100644 --- a/class_f_d_p_1_1logger.html +++ b/time_8h_source.html @@ -5,7 +5,7 @@ -cppDataPipeline: FDP::logger Class Reference +cppDataPipeline: include/windows_sys/time.h Source File @@ -63,27 +63,21 @@
    -
    -Public Types | -List of all members
    -
    FDP::logger Class Reference
    +
    time.h
    - - - - -

    -Public Types

    -typedef std::shared_ptr< spdlog::logger > sptr
     
    -
    The documentation for this class was generated from the following file: -
    +
    1#pragma once
    +
    2
    +
    3#ifndef _TIMES_H
    +
    4
    +
    5#include "windows_sys/times.h"
    +
    6
    +
    7#endif
    +
    Generated by doxygen 1.9.2 diff --git a/times_8h_source.html b/times_8h_source.html new file mode 100644 index 0000000..207221d --- /dev/null +++ b/times_8h_source.html @@ -0,0 +1,117 @@ + + + + + + + +cppDataPipeline: include/windows_sys/times.h Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    times.h
    +
    +
    +
    1#ifndef _TIMES_H
    +
    2#define _TIMES_H
    +
    3
    +
    4#ifdef _WIN32
    +
    5#include <sys/timeb.h>
    +
    6#include <sys/types.h>
    +
    7#include <winsock2.h>
    +
    8
    +
    9int gettimeofday(struct timeval* t,void* timezone);
    +
    10
    +
    11// from linux's sys/times.h
    +
    12
    +
    13//#include <features.h>
    +
    14
    +
    15#define __need_clock_t
    +
    16#include <time.h>
    +
    17
    +
    18
    +
    19/* Structure describing CPU time used by a process and its children. */
    +
    20struct tms
    +
    21 {
    +
    22 clock_t tms_utime; /* User CPU time. */
    +
    23 clock_t tms_stime; /* System CPU time. */
    +
    24
    +
    25 clock_t tms_cutime; /* User CPU time of dead children. */
    +
    26 clock_t tms_cstime; /* System CPU time of dead children. */
    +
    27 };
    +
    28
    +
    29/* Store the CPU time used by this process and all its
    +
    30 dead children (and their dead children) in BUFFER.
    +
    31 Return the elapsed real time, or (clock_t) -1 for errors.
    +
    32 All times are in CLK_TCKths of a second. */
    +
    33clock_t times (struct tms *__buffer);
    +
    34
    +
    35typedef long long suseconds_t ;
    +
    36
    +
    37#endif
    +
    38#endif
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + From 7b1af85f4754dcb67441609be3838ee53bc9f088 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Fri, 29 Apr 2022 05:42:33 +0000 Subject: [PATCH 10/19] deploy: a89d1fe276e58dd5451c0debb6cf8a60517f98a5 --- data__io_8hxx_source.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data__io_8hxx_source.html b/data__io_8hxx_source.html index bb87b70..c5c6f3a 100644 --- a/data__io_8hxx_source.html +++ b/data__io_8hxx_source.html @@ -115,7 +115,7 @@
    77 ghc::filesystem::create_directories(output_filename_.parent_path());
    78 }
    79
    -
    80 toml_out_.open(output_filename_);
    +
    80 toml_out_.open(output_filename_.string());
    81
    82 if (!toml_out_) {
    83 throw std::runtime_error("Failed to open TOML file for writing");
    From bf3318bb8886c4838472b612d2ac7ff444a8bd6a Mon Sep 17 00:00:00 2001 From: RyanJField Date: Mon, 16 May 2022 12:20:19 +0000 Subject: [PATCH 11/19] deploy: 25ce127988b7d9c08dcead36e652670b210b3dbd --- api_8hxx_source.html | 2 +- config_8hxx.html | 2 +- config_8hxx_source.html | 2 +- metadata_8hxx_source.html | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api_8hxx_source.html b/api_8hxx_source.html index 16ca504..5c05f25 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -81,7 +81,7 @@
    18#include <iterator>
    19#include <json/reader.h>
    20#include <map>
    -
    21#include <regex>
    +
    21#include <boost/regex.hpp>
    22#include <string>
    23#include <vector>
    24
    diff --git a/config_8hxx.html b/config_8hxx.html index 16a931f..6770ac8 100644 --- a/config_8hxx.html +++ b/config_8hxx.html @@ -75,7 +75,7 @@
    #include <string>
    #include <ghc/filesystem.hpp>
    #include <yaml-cpp/yaml.h>
    -#include <regex>
    +#include <boost/regex.hpp>
    #include <map>
    #include <stdio.h>
    #include "fdp/objects/metadata.hxx"
    diff --git a/config_8hxx_source.html b/config_8hxx_source.html index 9f58097..5157c42 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -77,7 +77,7 @@
    15#include <string>
    16#include <ghc/filesystem.hpp>
    17#include <yaml-cpp/yaml.h>
    -
    18#include <regex>
    +
    18#include <boost/regex.hpp>
    19#include <map>
    20#include <ghc/filesystem.hpp>
    21#include <stdio.h>
    diff --git a/metadata_8hxx_source.html b/metadata_8hxx_source.html index 247b692..b6f6921 100644 --- a/metadata_8hxx_source.html +++ b/metadata_8hxx_source.html @@ -82,7 +82,7 @@
    18#include <sstream>
    19#include <random>
    20#include <chrono>
    -
    21#include <regex>
    +
    21#include <boost/regex.hpp>
    22
    23#include "digestpp.hpp"
    24
    From 3ce6cc1f0475fedd822e4705a8daec95097de6cf Mon Sep 17 00:00:00 2001 From: RyanJField Date: Thu, 19 May 2022 14:32:23 +0000 Subject: [PATCH 12/19] deploy: d4a3ee76d021e2a9d876ba02c427edcf0617ee71 --- semver_8hxx_source.html | 287 ++++++++++++++++++++-------------------- 1 file changed, 144 insertions(+), 143 deletions(-) diff --git a/semver_8hxx_source.html b/semver_8hxx_source.html index 7f062ba..d00e0f5 100644 --- a/semver_8hxx_source.html +++ b/semver_8hxx_source.html @@ -77,150 +77,151 @@
    15#include <ostream>
    16#include <string>
    17#include <vector>
    -
    18
    -
    19namespace FairDataPipeline {
    -
    26namespace Versioning {
    -
    27
    -
    38enum class meta_tag {
    -
    39 ALPHA,
    -
    40 BETA,
    -
    41 RELEASE_CANDIDATE,
    -
    42 RELEASE
    -
    43};
    -
    44
    -
    53class version {
    -
    54public:
    -
    60 version() = default;
    -
    61
    -
    80 version(unsigned int major, unsigned int minor, unsigned int patch,
    -
    81 meta_tag tag = meta_tag::RELEASE, unsigned int tag_v = 1E9,
    -
    82 std::string meta_data = "")
    -
    83 : major_(major), minor_(minor), patch_(patch), meta_tag_(tag),
    -
    84 tag_v_(tag_v), meta_data_(meta_data) {}
    -
    85
    -
    86 version(const std::string version_str);
    -
    87
    -
    88 version(const version &v)
    -
    89 : major_(v.major_), minor_(v.minor_), patch_(v.patch_),
    -
    90 meta_tag_(v.meta_tag_), tag_v_(v.tag_v_), meta_data_(v.meta_data_) {}
    -
    91
    -
    92 void bump_major() { major_ += 1; }
    -
    93 void bump_minor() { minor_ += 1; }
    -
    94 void bump_patch() { patch_ += 1; }
    -
    95
    -
    96 void alpha() {
    -
    97 tag_v_ = (meta_tag_ == meta_tag::ALPHA) ? tag_v_ + 1 : 0;
    -
    98 meta_tag_ = meta_tag::ALPHA;
    -
    99 }
    -
    100
    -
    101 void beta() {
    -
    102 tag_v_ = (meta_tag_ == meta_tag::BETA) ? tag_v_ + 1 : 0;
    -
    103 meta_tag_ = meta_tag::BETA;
    -
    104 }
    -
    105
    -
    106 void prerelease() {
    -
    107 tag_v_ = (meta_tag_ == meta_tag::RELEASE_CANDIDATE) ? tag_v_ + 1 : 0;
    -
    108 meta_tag_ = meta_tag::RELEASE_CANDIDATE;
    -
    109 }
    -
    110
    -
    111 void release() {
    -
    112 tag_v_ = 1E9;
    -
    113 meta_tag_ = meta_tag::RELEASE;
    -
    114 }
    -
    115
    -
    116 std::string to_string() const {
    -
    117 std::string out_str_;
    -
    118
    -
    119 out_str_ += std::to_string(major_) + ".";
    -
    120 out_str_ += std::to_string(minor_) + ".";
    -
    121 out_str_ += std::to_string(patch_);
    -
    122
    -
    123 if (meta_tag_ != meta_tag::RELEASE) {
    -
    124 out_str_ += "-" + get_tag_str();
    -
    125
    -
    126 if (tag_v_ != 1E9) {
    -
    127 out_str_ += std::to_string(tag_v_);
    -
    128 }
    -
    129 }
    -
    130 if (!meta_data_.empty()) {
    -
    131 out_str_ += "+" + meta_data_;
    -
    132 }
    -
    133
    -
    134 return out_str_;
    -
    135 }
    -
    136
    -
    137 friend std::ostream &operator<<(std::ostream &os, const version &v) {
    -
    138 os << v.to_string();
    -
    139 return os;
    -
    140 }
    -
    141
    -
    142 friend bool operator<(const version &v1, const version &v2) {
    -
    143 if (v1.major_ < v2.major_)
    -
    144 return true;
    -
    145 else if (v2.major_ < v1.major_)
    -
    146 return false;
    -
    147 if (v1.minor_ < v2.minor_)
    -
    148 return true;
    -
    149 else if (v2.minor_ < v1.minor_)
    -
    150 return false;
    -
    151 if (v1.patch_ < v2.patch_)
    -
    152 return true;
    -
    153 else if (v2.patch_ < v1.patch_)
    -
    154 return false;
    -
    155 if (v1.meta_tag_ < v2.meta_tag_)
    -
    156 return true;
    -
    157 else if (v2.meta_tag_ < v1.meta_tag_)
    -
    158 return false;
    -
    159 if (v1.tag_v_ < v2.tag_v_)
    -
    160 return true;
    -
    161 else if (v2.tag_v_ < v1.tag_v_)
    -
    162 return false;
    -
    163 return false;
    -
    164 }
    -
    165
    -
    166 friend bool operator>(const version &v1, const version &v2) {
    -
    167 return v2 < v1;
    -
    168 }
    -
    169
    -
    170 friend bool operator==(const version &v1, const version &v2) {
    -
    171 bool same_ = v1.major_ == v2.major_;
    -
    172 same_ = same_ && (v1.minor_ == v2.minor_);
    -
    173 same_ = same_ && (v1.patch_ == v2.patch_);
    -
    174 same_ = same_ && (v1.meta_tag_ == v2.meta_tag_);
    -
    175 same_ = same_ && (v1.tag_v_ == v2.tag_v_);
    -
    176 same_ = same_ && (v1.meta_data_ == v2.meta_data_);
    -
    177 return same_;
    -
    178 }
    -
    179
    -
    180 friend bool operator!=(const version &v1, const version &v2) {
    -
    181 return !(v1 == v2);
    -
    182 }
    -
    183
    -
    184 friend bool operator<=(const version &v1, const version &v2) {
    -
    185 return (v1 == v2) || v1 < v2;
    -
    186 }
    -
    187
    -
    188 friend bool operator>=(const version &v1, const version &v2) {
    -
    189 return (v1 == v2) || v1 > v2;
    -
    190 }
    -
    191
    -
    192private:
    -
    193 unsigned int major_ = 0;
    -
    194 unsigned int minor_ = 1;
    -
    195 unsigned int patch_ = 0;
    -
    196 meta_tag meta_tag_ = meta_tag::RELEASE;
    -
    197 unsigned int tag_v_ = 1E9;
    -
    198 std::string meta_data_ = "";
    -
    199 std::string get_tag_str() const;
    -
    200};
    -
    201}; // namespace Versioning
    -
    202}; // namespace FairDataPipeline
    -
    203
    -
    204#endif
    -
    FairDataPipeline::Versioning::version
    class describing the semantic version of an object
    Definition: semver.hxx:53
    +
    18#include <stdexcept>
    +
    19
    +
    20namespace FairDataPipeline {
    +
    27namespace Versioning {
    +
    28
    +
    39enum class meta_tag {
    +
    40 ALPHA,
    +
    41 BETA,
    +
    42 RELEASE_CANDIDATE,
    +
    43 RELEASE
    +
    44};
    +
    45
    +
    54class version {
    +
    55public:
    +
    61 version() = default;
    +
    62
    +
    81 version(unsigned int major, unsigned int minor, unsigned int patch,
    +
    82 meta_tag tag = meta_tag::RELEASE, unsigned int tag_v = 1E9,
    +
    83 std::string meta_data = "")
    +
    84 : major_(major), minor_(minor), patch_(patch), meta_tag_(tag),
    +
    85 tag_v_(tag_v), meta_data_(meta_data) {}
    +
    86
    +
    87 version(const std::string version_str);
    +
    88
    +
    89 version(const version &v)
    +
    90 : major_(v.major_), minor_(v.minor_), patch_(v.patch_),
    +
    91 meta_tag_(v.meta_tag_), tag_v_(v.tag_v_), meta_data_(v.meta_data_) {}
    +
    92
    +
    93 void bump_major() { major_ += 1; }
    +
    94 void bump_minor() { minor_ += 1; }
    +
    95 void bump_patch() { patch_ += 1; }
    +
    96
    +
    97 void alpha() {
    +
    98 tag_v_ = (meta_tag_ == meta_tag::ALPHA) ? tag_v_ + 1 : 0;
    +
    99 meta_tag_ = meta_tag::ALPHA;
    +
    100 }
    +
    101
    +
    102 void beta() {
    +
    103 tag_v_ = (meta_tag_ == meta_tag::BETA) ? tag_v_ + 1 : 0;
    +
    104 meta_tag_ = meta_tag::BETA;
    +
    105 }
    +
    106
    +
    107 void prerelease() {
    +
    108 tag_v_ = (meta_tag_ == meta_tag::RELEASE_CANDIDATE) ? tag_v_ + 1 : 0;
    +
    109 meta_tag_ = meta_tag::RELEASE_CANDIDATE;
    +
    110 }
    +
    111
    +
    112 void release() {
    +
    113 tag_v_ = 1E9;
    +
    114 meta_tag_ = meta_tag::RELEASE;
    +
    115 }
    +
    116
    +
    117 std::string to_string() const {
    +
    118 std::string out_str_;
    +
    119
    +
    120 out_str_ += std::to_string(major_) + ".";
    +
    121 out_str_ += std::to_string(minor_) + ".";
    +
    122 out_str_ += std::to_string(patch_);
    +
    123
    +
    124 if (meta_tag_ != meta_tag::RELEASE) {
    +
    125 out_str_ += "-" + get_tag_str();
    +
    126
    +
    127 if (tag_v_ != 1E9) {
    +
    128 out_str_ += std::to_string(tag_v_);
    +
    129 }
    +
    130 }
    +
    131 if (!meta_data_.empty()) {
    +
    132 out_str_ += "+" + meta_data_;
    +
    133 }
    +
    134
    +
    135 return out_str_;
    +
    136 }
    +
    137
    +
    138 friend std::ostream &operator<<(std::ostream &os, const version &v) {
    +
    139 os << v.to_string();
    +
    140 return os;
    +
    141 }
    +
    142
    +
    143 friend bool operator<(const version &v1, const version &v2) {
    +
    144 if (v1.major_ < v2.major_)
    +
    145 return true;
    +
    146 else if (v2.major_ < v1.major_)
    +
    147 return false;
    +
    148 if (v1.minor_ < v2.minor_)
    +
    149 return true;
    +
    150 else if (v2.minor_ < v1.minor_)
    +
    151 return false;
    +
    152 if (v1.patch_ < v2.patch_)
    +
    153 return true;
    +
    154 else if (v2.patch_ < v1.patch_)
    +
    155 return false;
    +
    156 if (v1.meta_tag_ < v2.meta_tag_)
    +
    157 return true;
    +
    158 else if (v2.meta_tag_ < v1.meta_tag_)
    +
    159 return false;
    +
    160 if (v1.tag_v_ < v2.tag_v_)
    +
    161 return true;
    +
    162 else if (v2.tag_v_ < v1.tag_v_)
    +
    163 return false;
    +
    164 return false;
    +
    165 }
    +
    166
    +
    167 friend bool operator>(const version &v1, const version &v2) {
    +
    168 return v2 < v1;
    +
    169 }
    +
    170
    +
    171 friend bool operator==(const version &v1, const version &v2) {
    +
    172 bool same_ = v1.major_ == v2.major_;
    +
    173 same_ = same_ && (v1.minor_ == v2.minor_);
    +
    174 same_ = same_ && (v1.patch_ == v2.patch_);
    +
    175 same_ = same_ && (v1.meta_tag_ == v2.meta_tag_);
    +
    176 same_ = same_ && (v1.tag_v_ == v2.tag_v_);
    +
    177 same_ = same_ && (v1.meta_data_ == v2.meta_data_);
    +
    178 return same_;
    +
    179 }
    +
    180
    +
    181 friend bool operator!=(const version &v1, const version &v2) {
    +
    182 return !(v1 == v2);
    +
    183 }
    +
    184
    +
    185 friend bool operator<=(const version &v1, const version &v2) {
    +
    186 return (v1 == v2) || v1 < v2;
    +
    187 }
    +
    188
    +
    189 friend bool operator>=(const version &v1, const version &v2) {
    +
    190 return (v1 == v2) || v1 > v2;
    +
    191 }
    +
    192
    +
    193private:
    +
    194 unsigned int major_ = 0;
    +
    195 unsigned int minor_ = 1;
    +
    196 unsigned int patch_ = 0;
    +
    197 meta_tag meta_tag_ = meta_tag::RELEASE;
    +
    198 unsigned int tag_v_ = 1E9;
    +
    199 std::string meta_data_ = "";
    +
    200 std::string get_tag_str() const;
    +
    201};
    +
    202}; // namespace Versioning
    +
    203}; // namespace FairDataPipeline
    +
    204
    +
    205#endif
    +
    FairDataPipeline::Versioning::version
    class describing the semantic version of an object
    Definition: semver.hxx:54
    FairDataPipeline::Versioning::version::version
    version()=default
    Construct a new version with the default start value of 0.1.0
    -
    FairDataPipeline::Versioning::version::version
    version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
    Construct a new version from integer representation.
    Definition: semver.hxx:80
    -
    FairDataPipeline::Versioning::meta_tag
    meta_tag
    the allowed tags for versions describing version state
    Definition: semver.hxx:38
    +
    FairDataPipeline::Versioning::version::version
    version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")
    Construct a new version from integer representation.
    Definition: semver.hxx:81
    +
    FairDataPipeline::Versioning::meta_tag
    meta_tag
    the allowed tags for versions describing version state
    Definition: semver.hxx:39
    From 1d44b1510a755c7aded639a660e79e80e928e199 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Sat, 18 Jun 2022 04:47:44 +0000 Subject: [PATCH 13/19] deploy: f3b12da9ebb79d936b80993ceca6f52327d89215 --- ...ta_pipeline_1_1_data_pipeline-members.html | 4 +-- ..._fair_data_pipeline_1_1_data_pipeline.html | 28 +++++++++---------- fdp_8hxx_source.html | 8 +++--- functions.html | 4 +-- functions_func.html | 4 +-- search/all_a.js | 4 +-- search/functions_8.js | 4 +-- 7 files changed, 28 insertions(+), 28 deletions(-) diff --git a/class_fair_data_pipeline_1_1_data_pipeline-members.html b/class_fair_data_pipeline_1_1_data_pipeline-members.html index f8c1029..369db45 100644 --- a/class_fair_data_pipeline_1_1_data_pipeline-members.html +++ b/class_fair_data_pipeline_1_1_data_pipeline-members.html @@ -75,8 +75,8 @@ - - + +
    construct(const std::string &config_file_path, const std::string &script_file_path, std::string token="")FairDataPipeline::DataPipelinestatic
    finalise()FairDataPipeline::DataPipeline
    link_read(std::string &data_product)FairDataPipeline::DataPipeline
    link_write(std::string &data_product)FairDataPipeline::DataPipeline
    link_read(std::string &data_product)FairDataPipeline::DataPipeline
    link_write(std::string &data_product)FairDataPipeline::DataPipeline
    sptr typedef (defined in FairDataPipeline::DataPipeline)FairDataPipeline::DataPipeline
    ~DataPipeline()FairDataPipeline::DataPipeline
    diff --git a/class_fair_data_pipeline_1_1_data_pipeline.html b/class_fair_data_pipeline_1_1_data_pipeline.html index db2b443..1a6bf30 100644 --- a/class_fair_data_pipeline_1_1_data_pipeline.html +++ b/class_fair_data_pipeline_1_1_data_pipeline.html @@ -99,12 +99,12 @@  ~DataPipeline ()  Destroy the Data Pipeline object.
      -ghc::filesystem::path link_read (std::string &data_product) - Return a path to a given data product Whilst recording it's meta data for the code run. More...
    -  -ghc::filesystem::path link_write (std::string &data_product) - Return a path to be used for a given data product whilst recording it's meta data. More...
    -  +std::string link_read (std::string &data_product) + Return a path to a given data product Whilst recording it's meta data for the code run. More...
    +  +std::string link_write (std::string &data_product) + Return a path to be used for a given data product whilst recording it's meta data. More...
    +  void finalise ()  Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.
    @@ -171,14 +171,14 @@

    -

    ◆ link_read()

    + +

    ◆ link_read()

    - + @@ -194,18 +194,18 @@

    Returns
    ghc::filesystem::path
    +
    Returns
    std::string
    -     -

    ◆ link_write()

    + +

    ◆ link_write()

    ghc::filesystem::path FairDataPipeline::DataPipeline::link_read std::string FairDataPipeline::DataPipeline::link_read ( std::string &  data_product)
    - + @@ -221,7 +221,7 @@

    Returns
    ghc::filesystem::path
    +
    Returns
    std::string
    diff --git a/fdp_8hxx_source.html b/fdp_8hxx_source.html index d502568..522fd9c 100644 --- a/fdp_8hxx_source.html +++ b/fdp_8hxx_source.html @@ -94,9 +94,9 @@
    38 //DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    39
    40
    -
    48 ghc::filesystem::path link_read(std::string &data_product);
    +
    48 std::string link_read(std::string &data_product);
    49
    -
    57 ghc::filesystem::path link_write(std::string &data_product);
    +
    57 std::string link_write(std::string &data_product);
    58
    65 void finalise();
    66
    @@ -120,10 +120,10 @@
    FairDataPipeline::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:14
    FairDataPipeline::DataPipeline::construct
    static sptr construct(const std::string &config_file_path, const std::string &script_file_path, std::string token="")
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.cxx:153
    -
    FairDataPipeline::DataPipeline::link_write
    ghc::filesystem::path link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:179
    FairDataPipeline::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:183
    FairDataPipeline::DataPipeline::~DataPipeline
    ~DataPipeline()
    Destroy the Data Pipeline object.
    -
    FairDataPipeline::DataPipeline::link_read
    ghc::filesystem::path link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:175
    +
    FairDataPipeline::DataPipeline::link_write
    std::string link_write(std::string &data_product)
    Return a path to be used for a given data product whilst recording it's meta data.
    Definition: fdp.cxx:179
    +
    FairDataPipeline::DataPipeline::link_read
    std::string link_read(std::string &data_product)
    Return a path to a given data product Whilst recording it's meta data for the code run.
    Definition: fdp.cxx:175
    diff --git a/functions.html b/functions.html index fc3f3d6..34dd2ff 100644 --- a/functions.html +++ b/functions.html @@ -144,8 +144,8 @@

    - j -

      - l -

      diff --git a/functions_func.html b/functions_func.html index 3f882e7..cdafe73 100644 --- a/functions_func.html +++ b/functions_func.html @@ -144,8 +144,8 @@

      - j -

        - l -

        diff --git a/search/all_a.js b/search/all_a.js index 3513464..d96d6a5 100644 --- a/search/all_a.js +++ b/search/all_a.js @@ -1,7 +1,7 @@ var searchData= [ - ['link_5fread_0',['link_read',['../class_fair_data_pipeline_1_1_data_pipeline.html#af0eafc06e593cf671dfe5cf3fdc425cd',1,'FairDataPipeline::DataPipeline::link_read()'],['../class_fair_data_pipeline_1_1_config.html#a0a80b73790d5cc86c1e0feac40384e4c',1,'FairDataPipeline::Config::link_read()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#ad6c57457ffe8f703f88bbb49bec34702',1,'FairDataPipeline::DataPipeline::impl::link_read()']]], - ['link_5fwrite_1',['link_write',['../class_fair_data_pipeline_1_1_data_pipeline.html#a850325eb103977cd6c1a9ca9ad6c32aa',1,'FairDataPipeline::DataPipeline::link_write()'],['../class_fair_data_pipeline_1_1_config.html#a79878583ed56f0c4a4d10f11154a54ef',1,'FairDataPipeline::Config::link_write()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#afe198537ecdb0e45363b7edd84c4ae01',1,'FairDataPipeline::DataPipeline::impl::link_write()']]], + ['link_5fread_0',['link_read',['../class_fair_data_pipeline_1_1_data_pipeline.html#ac19e140328b80be63bc40c88ca9b1ec8',1,'FairDataPipeline::DataPipeline::link_read()'],['../class_fair_data_pipeline_1_1_config.html#a0a80b73790d5cc86c1e0feac40384e4c',1,'FairDataPipeline::Config::link_read()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#ad6c57457ffe8f703f88bbb49bec34702',1,'FairDataPipeline::DataPipeline::impl::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_fair_data_pipeline_1_1_data_pipeline.html#abe4a1a7d6fdc099e43f50642eeefe56c',1,'FairDataPipeline::DataPipeline::link_write()'],['../class_fair_data_pipeline_1_1_config.html#a79878583ed56f0c4a4d10f11154a54ef',1,'FairDataPipeline::Config::link_write()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#afe198537ecdb0e45363b7edd84c4ae01',1,'FairDataPipeline::DataPipeline::impl::link_write()']]], ['logger_2',['logger',['../class_fair_data_pipeline_1_1logger.html',1,'FairDataPipeline']]], ['logger_3',['Logger',['../class_fair_data_pipeline_1_1logging_1_1_logger.html',1,'FairDataPipeline::logging']]] ]; diff --git a/search/functions_8.js b/search/functions_8.js index 50087dd..6076adc 100644 --- a/search/functions_8.js +++ b/search/functions_8.js @@ -1,5 +1,5 @@ var searchData= [ - ['link_5fread_0',['link_read',['../class_fair_data_pipeline_1_1_data_pipeline.html#af0eafc06e593cf671dfe5cf3fdc425cd',1,'FairDataPipeline::DataPipeline::link_read()'],['../class_fair_data_pipeline_1_1_config.html#a0a80b73790d5cc86c1e0feac40384e4c',1,'FairDataPipeline::Config::link_read()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#ad6c57457ffe8f703f88bbb49bec34702',1,'FairDataPipeline::DataPipeline::impl::link_read()']]], - ['link_5fwrite_1',['link_write',['../class_fair_data_pipeline_1_1_data_pipeline.html#a850325eb103977cd6c1a9ca9ad6c32aa',1,'FairDataPipeline::DataPipeline::link_write()'],['../class_fair_data_pipeline_1_1_config.html#a79878583ed56f0c4a4d10f11154a54ef',1,'FairDataPipeline::Config::link_write()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#afe198537ecdb0e45363b7edd84c4ae01',1,'FairDataPipeline::DataPipeline::impl::link_write()']]] + ['link_5fread_0',['link_read',['../class_fair_data_pipeline_1_1_data_pipeline.html#ac19e140328b80be63bc40c88ca9b1ec8',1,'FairDataPipeline::DataPipeline::link_read()'],['../class_fair_data_pipeline_1_1_config.html#a0a80b73790d5cc86c1e0feac40384e4c',1,'FairDataPipeline::Config::link_read()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#ad6c57457ffe8f703f88bbb49bec34702',1,'FairDataPipeline::DataPipeline::impl::link_read()']]], + ['link_5fwrite_1',['link_write',['../class_fair_data_pipeline_1_1_data_pipeline.html#abe4a1a7d6fdc099e43f50642eeefe56c',1,'FairDataPipeline::DataPipeline::link_write()'],['../class_fair_data_pipeline_1_1_config.html#a79878583ed56f0c4a4d10f11154a54ef',1,'FairDataPipeline::Config::link_write()'],['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#afe198537ecdb0e45363b7edd84c4ae01',1,'FairDataPipeline::DataPipeline::impl::link_write()']]] ]; From 9ffad23caf6cd8c65dbeedbe8085c6dab6a8381c Mon Sep 17 00:00:00 2001 From: RyanJField Date: Tue, 2 Aug 2022 15:31:49 +0000 Subject: [PATCH 14/19] deploy: 4df97283226c3bb2309f2ed93a31ad34c3c8b539 --- annotated.html | 16 +- ...ata_pipeline_1_1_distribution-members.html | 96 ++++++++++++ ...s_fair_data_pipeline_1_1_distribution.html | 144 ++++++++++++++++++ ...ine_1_1config__parsing__error-members.html | 83 ---------- ...ta_pipeline_1_1config__parsing__error.html | 10 -- ...ipeline_1_1json__parse__error-members.html | 83 ---------- ...r_data_pipeline_1_1json__parse__error.html | 10 -- ...line_1_1rest__apiquery__error-members.html | 83 ---------- ...ata_pipeline_1_1rest__apiquery__error.html | 10 -- class_fair_data_pipeline_1_1sync__error.html | 10 -- ...ass_fair_data_pipeline_1_1toml__error.html | 21 ++- class_fair_data_pipeline_1_1toml__error.png | Bin 0 -> 660 bytes ...pipeline_1_1validation__error-members.html | 83 ---------- ...ir_data_pipeline_1_1validation__error.html | 10 -- ...data_pipeline_1_1write__error-members.html | 83 ---------- class_fair_data_pipeline_1_1write__error.html | 10 -- classes.html | 9 +- data__io_8hxx_source.html | 98 ++++++------ distribution_8hxx_source.html | 128 ++++++++++++++++ exceptions_8hxx_source.html | 80 +++++----- files.html | 27 ++-- hierarchy.html | 40 ++--- logging_8hxx_source.html | 2 +- namespaces.html | 16 +- search/all_10.js | 3 +- search/all_11.js | 3 +- search/all_12.js | 4 +- search/all_13.html | 37 +++++ search/all_13.js | 6 + search/all_3.js | 3 +- search/classes_2.js | 3 +- search/classes_a.js | 3 +- search/classes_b.js | 3 +- search/classes_c.html | 37 +++++ search/classes_c.js | 4 + search/searchdata.js | 4 +- 36 files changed, 628 insertions(+), 634 deletions(-) create mode 100644 class_fair_data_pipeline_1_1_distribution-members.html create mode 100644 class_fair_data_pipeline_1_1_distribution.html delete mode 100644 class_fair_data_pipeline_1_1config__parsing__error-members.html delete mode 100644 class_fair_data_pipeline_1_1json__parse__error-members.html delete mode 100644 class_fair_data_pipeline_1_1rest__apiquery__error-members.html rename class_fair_data_pipeline_1_1sync__error-members.html => class_fair_data_pipeline_1_1toml__error.html (78%) create mode 100644 class_fair_data_pipeline_1_1toml__error.png delete mode 100644 class_fair_data_pipeline_1_1validation__error-members.html delete mode 100644 class_fair_data_pipeline_1_1write__error-members.html create mode 100644 distribution_8hxx_source.html create mode 100644 search/all_13.html create mode 100644 search/all_13.js create mode 100644 search/classes_c.html create mode 100644 search/classes_c.js diff --git a/annotated.html b/annotated.html index b9e35ce..ffd7862 100644 --- a/annotated.html +++ b/annotated.html @@ -86,13 +86,15 @@

    - - - - - - - + + + + + + + + +
    ghc::filesystem::path FairDataPipeline::DataPipeline::link_write std::string FairDataPipeline::DataPipeline::link_write ( std::string &  data_product)
     Cconfig_parsing_error
     ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     Cimpl
     CIOObjectClass for API objects
     Cjson_parse_error
     Clogger
     Crest_apiquery_error
     Csync_error
     Cvalidation_error
     Cwrite_error
     CDistributionClass for API objects
     CIOObjectClass for API objects
     Cjson_parse_error
     Clogger
     Crest_apiquery_error
     Csync_error
     Ctoml_error
     Cvalidation_error
     Cwrite_error
     CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
    diff --git a/class_fair_data_pipeline_1_1_distribution-members.html b/class_fair_data_pipeline_1_1_distribution-members.html new file mode 100644 index 0000000..dee5930 --- /dev/null +++ b/class_fair_data_pipeline_1_1_distribution-members.html @@ -0,0 +1,96 @@ + + + + + + + +cppDataPipeline: Member List + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    FairDataPipeline::Distribution Member List
    +
    +
    + +

    This is the complete list of members for FairDataPipeline::Distribution, including all inherited members.

    + + + + + + + + + + + + + + + +
    Distribution(const std::string &name, double mu, double sigma) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributioninline
    Distribution(const std::string &name, double mu, double sigma, const std::string &component) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributioninline
    Distribution(const std::string &file_name) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributionexplicit
    Distribution(const std::string &file_name, const std::string &component) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distribution
    get_component() const (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributioninline
    get_mu() const (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributioninline
    get_name() const (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributioninline
    get_sigma() const (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributioninline
    isEqual(const Distribution &dist) const (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributionprotectedvirtual
    operator== (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributionfriend
    read_from_toml(const ghc::filesystem::path &file_path, const std::string &component) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributionprotected
    write_to_toml(std::string &file_name) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distribution
    write_to_toml(std::string &component, std::string &file_name) (defined in FairDataPipeline::Distribution)FairDataPipeline::Distribution
    ~Distribution()=default (defined in FairDataPipeline::Distribution)FairDataPipeline::Distributionvirtual
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_fair_data_pipeline_1_1_distribution.html b/class_fair_data_pipeline_1_1_distribution.html new file mode 100644 index 0000000..1a8ac95 --- /dev/null +++ b/class_fair_data_pipeline_1_1_distribution.html @@ -0,0 +1,144 @@ + + + + + + + +cppDataPipeline: FairDataPipeline::Distribution Class Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Protected Member Functions | +Friends | +List of all members
    +
    FairDataPipeline::Distribution Class Reference
    +
    +
    + +

    Class for API objects. + More...

    + +

    #include <fdp/objects/distribution.hxx>

    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Distribution (const std::string &name, double mu, double sigma)
     
    + Distribution (const std::string &name, double mu, double sigma, const std::string &component)
     
    + Distribution (const std::string &file_name)
     
    + Distribution (const std::string &file_name, const std::string &component)
     
    +std::string get_name () const
     
    +double get_mu () const
     
    +double get_sigma () const
     
    +std::string get_component () const
     
    +std::string write_to_toml (std::string &file_name)
     
    +std::string write_to_toml (std::string &component, std::string &file_name)
     
    + + + + + +

    +Protected Member Functions

    +void read_from_toml (const ghc::filesystem::path &file_path, const std::string &component)
     
    +virtual bool isEqual (const Distribution &dist) const
     
    + + + +

    +Friends

    +bool operator== (const Distribution &lhs, const Distribution &rhs)
     
    +

    Detailed Description

    +

    Class for API objects.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/class_fair_data_pipeline_1_1config__parsing__error-members.html b/class_fair_data_pipeline_1_1config__parsing__error-members.html deleted file mode 100644 index 5cc4f10..0000000 --- a/class_fair_data_pipeline_1_1config__parsing__error-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    FairDataPipeline::config_parsing_error Member List
    -
    -
    - -

    This is the complete list of members for FairDataPipeline::config_parsing_error, including all inherited members.

    - - -
    config_parsing_error(const std::string &message) (defined in FairDataPipeline::config_parsing_error)FairDataPipeline::config_parsing_errorinline
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/class_fair_data_pipeline_1_1config__parsing__error.html b/class_fair_data_pipeline_1_1config__parsing__error.html index 3ce2290..056876b 100644 --- a/class_fair_data_pipeline_1_1config__parsing__error.html +++ b/class_fair_data_pipeline_1_1config__parsing__error.html @@ -67,9 +67,6 @@
    -
    -Public Member Functions | -List of all members
    FairDataPipeline::config_parsing_error Class Reference
    @@ -79,13 +76,6 @@
    - - - - -

    -Public Member Functions

    - config_parsing_error (const std::string &message)
     
    The documentation for this class was generated from the following file: diff --git a/class_fair_data_pipeline_1_1json__parse__error-members.html b/class_fair_data_pipeline_1_1json__parse__error-members.html deleted file mode 100644 index 2772cb2..0000000 --- a/class_fair_data_pipeline_1_1json__parse__error-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    FairDataPipeline::json_parse_error Member List
    -
    -
    - -

    This is the complete list of members for FairDataPipeline::json_parse_error, including all inherited members.

    - - -
    json_parse_error(const std::string &message) (defined in FairDataPipeline::json_parse_error)FairDataPipeline::json_parse_errorinline
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/class_fair_data_pipeline_1_1json__parse__error.html b/class_fair_data_pipeline_1_1json__parse__error.html index eeaeb45..2477019 100644 --- a/class_fair_data_pipeline_1_1json__parse__error.html +++ b/class_fair_data_pipeline_1_1json__parse__error.html @@ -67,9 +67,6 @@
    -
    -Public Member Functions | -List of all members
    FairDataPipeline::json_parse_error Class Reference
    @@ -79,13 +76,6 @@
    - - - - -

    -Public Member Functions

    - json_parse_error (const std::string &message)
     
    The documentation for this class was generated from the following file: diff --git a/class_fair_data_pipeline_1_1rest__apiquery__error-members.html b/class_fair_data_pipeline_1_1rest__apiquery__error-members.html deleted file mode 100644 index daf0475..0000000 --- a/class_fair_data_pipeline_1_1rest__apiquery__error-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    FairDataPipeline::rest_apiquery_error Member List
    -
    -
    - -

    This is the complete list of members for FairDataPipeline::rest_apiquery_error, including all inherited members.

    - - -
    rest_apiquery_error(const std::string &message) (defined in FairDataPipeline::rest_apiquery_error)FairDataPipeline::rest_apiquery_errorinline
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/class_fair_data_pipeline_1_1rest__apiquery__error.html b/class_fair_data_pipeline_1_1rest__apiquery__error.html index a6899b0..902e4ef 100644 --- a/class_fair_data_pipeline_1_1rest__apiquery__error.html +++ b/class_fair_data_pipeline_1_1rest__apiquery__error.html @@ -67,9 +67,6 @@
    -
    -Public Member Functions | -List of all members
    FairDataPipeline::rest_apiquery_error Class Reference
    @@ -79,13 +76,6 @@
    - - - - -

    -Public Member Functions

    - rest_apiquery_error (const std::string &message)
     
    The documentation for this class was generated from the following file: diff --git a/class_fair_data_pipeline_1_1sync__error.html b/class_fair_data_pipeline_1_1sync__error.html index e4c1d98..6324f74 100644 --- a/class_fair_data_pipeline_1_1sync__error.html +++ b/class_fair_data_pipeline_1_1sync__error.html @@ -67,9 +67,6 @@
    -
    -Public Member Functions | -List of all members
    FairDataPipeline::sync_error Class Reference
    @@ -79,13 +76,6 @@
    - - - - -

    -Public Member Functions

    - sync_error (const std::string &message)
     
    The documentation for this class was generated from the following file: diff --git a/class_fair_data_pipeline_1_1sync__error-members.html b/class_fair_data_pipeline_1_1toml__error.html similarity index 78% rename from class_fair_data_pipeline_1_1sync__error-members.html rename to class_fair_data_pipeline_1_1toml__error.html index 80165fe..86c2d96 100644 --- a/class_fair_data_pipeline_1_1sync__error-members.html +++ b/class_fair_data_pipeline_1_1toml__error.html @@ -5,7 +5,7 @@ -cppDataPipeline: Member List +cppDataPipeline: FairDataPipeline::toml_error Class Reference @@ -63,18 +63,23 @@
    -
    FairDataPipeline::sync_error Member List
    +
    FairDataPipeline::toml_error Class Reference
    - -

    This is the complete list of members for FairDataPipeline::sync_error, including all inherited members.

    - - -
    sync_error(const std::string &message) (defined in FairDataPipeline::sync_error)FairDataPipeline::sync_errorinline
    +
    +Inheritance diagram for FairDataPipeline::toml_error:
    +
    +
    + +
    +
    The documentation for this class was generated from the following file: +
    Generated by doxygen 1.9.2 diff --git a/class_fair_data_pipeline_1_1toml__error.png b/class_fair_data_pipeline_1_1toml__error.png new file mode 100644 index 0000000000000000000000000000000000000000..8e063ab99549d966857fcfdec6c97775aec833d3 GIT binary patch literal 660 zcmeAS@N?(olHy`uVBq!ia0vp^tAIFwgBeKfTPSxPNJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?y~DSNs&hEy=VoqMq8umX?Ee7&3h|35xv z=6LAXy32vL6201e6B$2GVBMFLX4YolDdi{}I%$(>psHr{`vub`h6~TDmA_qOw@Rhf z#XK;V^ZGa8f@!}lMJ4}~+GNW0)k@ta)wtHjK;>o7_W<8dLD}oGUQhcQa%YF}e6iYmBp1ZC|bAAxM@>GA{|LesnV1c*EUwvnsTU=#REbnT1 z@-(CAvNb8WKNqvCFn3sz!58r6-m;Q>hWW2cJ$GICv%%}rCb{L+;*(V7X1c)~3UcvR z7gJ+tCx)L@3_S}A1LXS?BaS=PPU<^kCGctwBf}@tKt`aah{Ips2cA81On}XxNlnXP z8whJ#c?P+h^We^ZDxLK-)0y`)TXf9{oPQ zYu7a0Pg@^9_>~+3QWR$f*{i-KJG5_TAVO=GrUpZ<>_ZFY`?0vVybE?#W9VMoG zJ8z}Uet&DbaMrxl?e*;W|L>&T;48gfu*#3AB(OO?d-vDu;|F&)OZC6hy%KA(&$Gcf zl2<12rIP5Z+3 ze?IuT`pR45%EyBLbyqRWzwW|%;u;7SRnMN;yFmY~V`|C59aW;hB*ft9>gTe~DWM4f DwAwHM literal 0 HcmV?d00001 diff --git a/class_fair_data_pipeline_1_1validation__error-members.html b/class_fair_data_pipeline_1_1validation__error-members.html deleted file mode 100644 index 4ca2948..0000000 --- a/class_fair_data_pipeline_1_1validation__error-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    FairDataPipeline::validation_error Member List
    -
    -
    - -

    This is the complete list of members for FairDataPipeline::validation_error, including all inherited members.

    - - -
    validation_error(const std::string &message) (defined in FairDataPipeline::validation_error)FairDataPipeline::validation_errorinline
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/class_fair_data_pipeline_1_1validation__error.html b/class_fair_data_pipeline_1_1validation__error.html index 73e62e7..b5c37e0 100644 --- a/class_fair_data_pipeline_1_1validation__error.html +++ b/class_fair_data_pipeline_1_1validation__error.html @@ -67,9 +67,6 @@
    -
    -Public Member Functions | -List of all members
    FairDataPipeline::validation_error Class Reference
    @@ -79,13 +76,6 @@
    - - - - -

    -Public Member Functions

    - validation_error (const std::string &message)
     
    The documentation for this class was generated from the following file: diff --git a/class_fair_data_pipeline_1_1write__error-members.html b/class_fair_data_pipeline_1_1write__error-members.html deleted file mode 100644 index 3d2be0a..0000000 --- a/class_fair_data_pipeline_1_1write__error-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -cppDataPipeline: Member List - - - - - - - - - -
    -
    - - - - - - -
    -
    cppDataPipeline 0.3.0 -
    -
    C++ Implementation of the FAIR Data Pipeline API
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    FairDataPipeline::write_error Member List
    -
    -
    - -

    This is the complete list of members for FairDataPipeline::write_error, including all inherited members.

    - - -
    write_error(const std::string &message) (defined in FairDataPipeline::write_error)FairDataPipeline::write_errorinline
    - -
    -Generated by doxygen 1.9.2 -
    - - diff --git a/class_fair_data_pipeline_1_1write__error.html b/class_fair_data_pipeline_1_1write__error.html index e8d2bc5..501e91e 100644 --- a/class_fair_data_pipeline_1_1write__error.html +++ b/class_fair_data_pipeline_1_1write__error.html @@ -67,9 +67,6 @@
    -
    -Public Member Functions | -List of all members
    FairDataPipeline::write_error Class Reference
    @@ -79,13 +76,6 @@
    - - - - -

    -Public Member Functions

    - write_error (const std::string &message)
     
    The documentation for this class was generated from the following file: diff --git a/classes.html b/classes.html index 55e9f69..7ce3ed1 100644 --- a/classes.html +++ b/classes.html @@ -66,7 +66,7 @@
    Class Index
    -
    A | C | D | I | J | L | M | O | R | S | V | W
    +
    A | C | D | I | J | L | M | O | R | S | T | V | W
    A
    @@ -76,7 +76,7 @@
    CompositeSink (FairDataPipeline::logging)
    Config (FairDataPipeline)
    config_parsing_error (FairDataPipeline)
    D
    -
    DataPipeline (FairDataPipeline)
    DataPipelineImpl_
    +
    DataPipeline (FairDataPipeline)
    DataPipelineImpl_
    Distribution (FairDataPipeline)
    I
    DataPipeline::impl (FairDataPipeline)
    IOObject (FairDataPipeline)
    ISink (FairDataPipeline::logging)
    ISinkFormatter (FairDataPipeline::logging)
    @@ -99,9 +99,12 @@
    S
    Sink (FairDataPipeline::logging)
    SinkFormatter (FairDataPipeline::logging)
    sync_error (FairDataPipeline)
    +
    T
    +
    toml_error (FairDataPipeline)
    +
    V
    validation_error (FairDataPipeline)
    version (FairDataPipeline::Versioning)
    -
    +
    W
    write_error (FairDataPipeline)
    diff --git a/data__io_8hxx_source.html b/data__io_8hxx_source.html index c5c6f3a..74fb04c 100644 --- a/data__io_8hxx_source.html +++ b/data__io_8hxx_source.html @@ -5,7 +5,7 @@ -cppDataPipeline: include/fdp/registry/data_io.hxx Source File +cppDataPipeline: include/fdp/utilities/data_io.hxx Source File @@ -63,7 +63,7 @@
    @@ -89,55 +89,53 @@
    26#include "fdp/objects/metadata.hxx"
    27#include "fdp/utilities/logging.hxx"
    28#include "fdp/utilities/semver.hxx"
    -
    29
    -
    30namespace FairDataPipeline {
    -
    31
    -
    47double read_point_estimate_from_toml(const ghc::filesystem::path var_address);
    -
    48
    -
    59template <typename T>
    -
    60ghc::filesystem::path create_estimate(T &value,
    -
    61 const ghc::filesystem::path &data_product,
    -
    62 const Versioning::version &version_num,
    -
    63 const Config *config
    -
    64 ) {
    -
    65 const std::string param_name_ = data_product.stem().string();
    -
    66 const std::string namespace_ = config->get_default_output_namespace();
    -
    67 const ghc::filesystem::path data_store_ = config->get_data_store();
    -
    68 const toml::value data_{
    -
    69 {param_name_, {{"type", "point-estimate"}, {"value", value}}}};
    -
    70
    -
    71 const ghc::filesystem::path output_filename_ =
    -
    72 data_store_ / namespace_ / data_product.parent_path() /
    -
    73 std::string(version_num.to_string() + ".toml");
    -
    74 std::ofstream toml_out_;
    -
    75
    -
    76 if (!ghc::filesystem::exists(output_filename_.parent_path())) {
    -
    77 ghc::filesystem::create_directories(output_filename_.parent_path());
    -
    78 }
    -
    79
    -
    80 toml_out_.open(output_filename_.string());
    -
    81
    -
    82 if (!toml_out_) {
    -
    83 throw std::runtime_error("Failed to open TOML file for writing");
    -
    84 }
    -
    85
    -
    86 toml_out_ << toml::format(data_);
    -
    87
    -
    88 toml_out_.close();
    -
    89
    -
    90
    -
    91 auto the_logger = logger::get_logger();
    -
    92 the_logger->debug()
    -
    93 << "FileSystem:CreateEstimate: Wrote point estimate to '" << output_filename_.string() << "'";
    -
    94
    -
    95 return output_filename_;
    -
    96}
    +
    29#include "fdp/exceptions.hxx"
    +
    30
    +
    31namespace FairDataPipeline {
    +
    32
    +
    48double read_point_estimate_from_toml(const ghc::filesystem::path file_path);
    +
    49double read_point_estimate_from_toml(const ghc::filesystem::path file_path, const std::string &component);
    +
    50toml::value read_parameter_from_toml(const ghc::filesystem::path file_path,
    +
    51 const std::string &parameter);
    +
    52toml::value read_parameter_from_toml(const ghc::filesystem::path file_path,
    +
    53 const std::string &parameter,
    +
    54 const std::string &component);
    +
    55toml::value read_data_from_toml(const ghc::filesystem::path file_path);
    +
    56toml::value read_component_from_toml(const ghc::filesystem::path file_path, const std::string &component);
    +
    57
    +
    58ghc::filesystem::path write_toml_data(ghc::filesystem::path file_path,
    +
    59 const std::string &component,
    +
    60 const toml::value &data);
    +
    61
    +
    70template <typename T>
    +
    71ghc::filesystem::path write_toml_parameter(T &value,
    +
    72 const std::string &parameter,
    +
    73 const std::string &component,
    +
    74 const ghc::filesystem::path file_path
    +
    75 ) {
    +
    76
    +
    77 const toml::value data_{
    +
    78 {component, {{"type", parameter}, {"value", value}}}};
    +
    79 return write_toml_data(file_path, component, data_);
    +
    80
    +
    81}
    +
    82
    +
    83
    +
    84template <typename T>
    +
    85ghc::filesystem::path
    +
    86write_point_estimate(T &value, const std::string &component,
    +
    87 const ghc::filesystem::path file_path) {
    +
    88 return write_toml_parameter(value, "point-estimate",
    +
    89 component, file_path);
    +
    90}
    +
    91
    +
    92std::string get_first_component(const ghc::filesystem::path &file_path);
    +
    93
    +
    94bool component_exists(const ghc::filesystem::path &file_path, const std::string &component);
    +
    95
    +
    96}; // namespace FairDataPipeline
    97
    -
    104std::string get_first_key_(const toml::value data_table);
    -
    105
    -
    106}; // namespace FairDataPipeline
    -
    107
    -
    108#endif
    +
    98#endif
    diff --git a/distribution_8hxx_source.html b/distribution_8hxx_source.html new file mode 100644 index 0000000..02f99fa --- /dev/null +++ b/distribution_8hxx_source.html @@ -0,0 +1,128 @@ + + + + + + + +cppDataPipeline: include/fdp/objects/distribution.hxx Source File + + + + + + + + + +
    +
    + + + + + + +
    +
    cppDataPipeline 0.3.0 +
    +
    C++ Implementation of the FAIR Data Pipeline API
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    distribution.hxx
    +
    +
    +
    1#ifndef __FDP_DISTRIBUTION_HXX__
    +
    2#define __FDP_DISTRIBUTION_HXX__
    +
    3
    +
    4#include <string>
    +
    5#include <ghc/filesystem.hpp>
    +
    6
    +
    7namespace FairDataPipeline {
    +
    12 class Distribution {
    +
    13
    +
    14 public:
    +
    15 Distribution(const std::string &name, double mu, double sigma):
    +
    16 _name(name),
    +
    17 _mu(mu),
    +
    18 _sigma(sigma),
    +
    19 _component("0"){};
    +
    20 Distribution(const std::string &name, double mu, double sigma, const std::string &component):
    +
    21 _name(name),
    +
    22 _mu(mu),
    +
    23 _sigma(sigma),
    +
    24 _component(component){};
    +
    25 explicit Distribution(const std::string &file_name);
    +
    26 Distribution(const std::string &file_name, const std::string &component);
    +
    27 virtual ~Distribution() = default;
    +
    28 std::string get_name() const {return _name;}
    +
    29 double get_mu() const {return _mu;}
    +
    30 double get_sigma() const {return _sigma;}
    +
    31 std::string get_component() const {return _component;}
    +
    32
    +
    33 std::string write_to_toml(std::string &file_name);
    +
    34 std::string write_to_toml(std::string &component, std::string &file_name);
    +
    35
    +
    36 private:
    +
    37 std::string _name;
    +
    38 double _mu;
    +
    39 double _sigma;
    +
    40 std::string _component;
    +
    41
    +
    42 protected:
    +
    43 void read_from_toml(const ghc::filesystem::path &file_path, const std::string &component);
    +
    44 virtual bool isEqual(const Distribution& dist) const;
    +
    45 friend bool operator==(const Distribution& lhs, const Distribution& rhs){
    +
    46 return typeid(lhs) == typeid(rhs) && lhs.isEqual(rhs);
    +
    47 }
    +
    48 };
    +
    49
    +
    50}; // namespace FairDataPipeline
    +
    51
    +
    52#endif
    +
    FairDataPipeline::Distribution
    Class for API objects.
    Definition: distribution.hxx:12
    +
    + +
    +Generated by doxygen 1.9.2 +
    + + diff --git a/exceptions_8hxx_source.html b/exceptions_8hxx_source.html index 71a334b..87baf76 100644 --- a/exceptions_8hxx_source.html +++ b/exceptions_8hxx_source.html @@ -79,45 +79,49 @@
    7namespace FairDataPipeline {
    8class config_parsing_error : public std::runtime_error {
    9public:
    -
    10 config_parsing_error(const std::string& message)
    -
    11 : std::runtime_error(message) {}
    -
    12};
    -
    13
    -
    14class rest_apiquery_error : public std::runtime_error {
    -
    15public:
    -
    16 rest_apiquery_error(const std::string& message)
    -
    17 : std::runtime_error(message) {}
    -
    18};
    -
    19
    -
    20class json_parse_error : public std::runtime_error {
    -
    21public:
    -
    22 json_parse_error(const std::string& message) : std::runtime_error(message) {}
    -
    23};
    -
    24
    -
    25class validation_error : public std::runtime_error {
    -
    26public:
    -
    27 validation_error(const std::string& message) : std::runtime_error(message) {}
    -
    28};
    -
    29
    -
    30class sync_error : public std::runtime_error {
    -
    31public:
    -
    32 sync_error(const std::string& message) : std::runtime_error(message) {}
    -
    33};
    -
    34
    -
    35class write_error : public std::runtime_error {
    -
    36public:
    -
    37 write_error(const std::string& message) : std::runtime_error(message) {}
    -
    38};
    -
    39
    -
    40}; // namespace FairDataPipeline
    -
    41
    -
    42#endif
    +
    10 using std::runtime_error::runtime_error;
    +
    11};
    +
    12
    +
    13class rest_apiquery_error : public std::runtime_error {
    +
    14public:
    +
    15 using std::runtime_error::runtime_error;
    +
    16};
    +
    17
    +
    18class json_parse_error : public std::runtime_error {
    +
    19public:
    +
    20 using std::runtime_error::runtime_error;
    +
    21};
    +
    22
    +
    23class validation_error : public std::runtime_error {
    +
    24public:
    +
    25 using std::runtime_error::runtime_error;
    +
    26};
    +
    27
    +
    28class sync_error : public std::runtime_error {
    +
    29public:
    +
    30 using std::runtime_error::runtime_error;
    +
    31};
    +
    32
    +
    33class write_error : public std::runtime_error {
    +
    34public:
    +
    35 using std::runtime_error::runtime_error;
    +
    36};
    +
    37
    +
    38class toml_error : public std::runtime_error {
    +
    39public:
    +
    40 using std::runtime_error::runtime_error;
    +
    41};
    +
    42
    +
    43}; // namespace FairDataPipeline
    +
    44
    +
    45#endif
    FairDataPipeline::config_parsing_error
    Definition: exceptions.hxx:8
    -
    FairDataPipeline::json_parse_error
    Definition: exceptions.hxx:20
    -
    FairDataPipeline::rest_apiquery_error
    Definition: exceptions.hxx:14
    -
    FairDataPipeline::sync_error
    Definition: exceptions.hxx:30
    -
    FairDataPipeline::validation_error
    Definition: exceptions.hxx:25
    -
    FairDataPipeline::write_error
    Definition: exceptions.hxx:35
    +
    FairDataPipeline::json_parse_error
    Definition: exceptions.hxx:18
    +
    FairDataPipeline::rest_apiquery_error
    Definition: exceptions.hxx:13
    +
    FairDataPipeline::sync_error
    Definition: exceptions.hxx:28
    +
    FairDataPipeline::toml_error
    Definition: exceptions.hxx:38
    +
    FairDataPipeline::validation_error
    Definition: exceptions.hxx:23
    +
    FairDataPipeline::write_error
    Definition: exceptions.hxx:33
    diff --git a/files.html b/files.html index 95e9edb..6ea5685 100644 --- a/files.html +++ b/files.html @@ -73,20 +73,21 @@  ▼ objects  api_object.hxx  config.hxx - io_object.hxx - metadata.hxx - ▼ registry - api.hxx - data_io.hxx + distribution.hxx + io_object.hxx + metadata.hxx + ▼ registry + api.hxx  ▼ utilities - json.hxx - logging.hxx - semver.hxx - exceptions.hxx - fdp.hxx - ▼ windows_sys - time.h - times.h + data_io.hxx + json.hxx + logging.hxx + semver.hxx + exceptions.hxx + fdp.hxx + ▼ windows_sys + time.h + times.h diff --git a/hierarchy.html b/hierarchy.html index 74cdaac..64f17c0 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -73,25 +73,27 @@  CFairDataPipeline::ConfigClass for interacting with confifurations  CFairDataPipeline::DataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline  CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods - CFairDataPipeline::DataPipeline::impl - CFairDataPipeline::IOObjectClass for API objects - ▼CFairDataPipeline::logging::ISink - ▼CFairDataPipeline::logging::Sink - CFairDataPipeline::logging::CompositeSink - CFairDataPipeline::logging::OStreamSink - ▼CFairDataPipeline::logging::ISinkFormatter - CFairDataPipeline::logging::SinkFormatter - CFairDataPipeline::logger - CFairDataPipeline::logging::Logger - CFairDataPipeline::logging::Logger::MsgBuilder - ▼Cstd::runtime_error - CFairDataPipeline::config_parsing_error - CFairDataPipeline::json_parse_error - CFairDataPipeline::rest_apiquery_error - CFairDataPipeline::sync_error - CFairDataPipeline::validation_error - CFairDataPipeline::write_error - CFairDataPipeline::Versioning::versionClass describing the semantic version of an object + CFairDataPipeline::DistributionClass for API objects + CFairDataPipeline::DataPipeline::impl + CFairDataPipeline::IOObjectClass for API objects + ▼CFairDataPipeline::logging::ISink + ▼CFairDataPipeline::logging::Sink + CFairDataPipeline::logging::CompositeSink + CFairDataPipeline::logging::OStreamSink + ▼CFairDataPipeline::logging::ISinkFormatter + CFairDataPipeline::logging::SinkFormatter + CFairDataPipeline::logger + CFairDataPipeline::logging::Logger + CFairDataPipeline::logging::Logger::MsgBuilder + ▼Cstd::runtime_error + CFairDataPipeline::config_parsing_error + CFairDataPipeline::json_parse_error + CFairDataPipeline::rest_apiquery_error + CFairDataPipeline::sync_error + CFairDataPipeline::toml_error + CFairDataPipeline::validation_error + CFairDataPipeline::write_error + CFairDataPipeline::Versioning::versionClass describing the semantic version of an object diff --git a/logging_8hxx_source.html b/logging_8hxx_source.html index 5267e21..30cb873 100644 --- a/logging_8hxx_source.html +++ b/logging_8hxx_source.html @@ -222,7 +222,7 @@
    159 Logger* _logger;
    160 enum LOG_LEVEL _msg_lvl;
    161
    -
    162 std::ostringstream _oss;
    +
    162 std::ostringstream _oss{""};
    163 };
    164
    165 static sptr create( enum LOG_LEVEL lvl, Sink::sptr sink, std::string name="" );
    diff --git a/namespaces.html b/namespaces.html index 4416c1b..432f539 100644 --- a/namespaces.html +++ b/namespaces.html @@ -86,13 +86,15 @@  Cconfig_parsing_error  ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline  Cimpl - CIOObjectClass for API objects - Cjson_parse_error - Clogger - Crest_apiquery_error - Csync_error - Cvalidation_error - Cwrite_error + CDistributionClass for API objects + CIOObjectClass for API objects + Cjson_parse_error + Clogger + Crest_apiquery_error + Csync_error + Ctoml_error + Cvalidation_error + Cwrite_error diff --git a/search/all_10.js b/search/all_10.js index 3cc76f9..4ad6fb5 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -1,5 +1,4 @@ var searchData= [ - ['validation_5ferror_0',['validation_error',['../class_fair_data_pipeline_1_1validation__error.html',1,'FairDataPipeline']]], - ['version_1',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html',1,'FairDataPipeline::Versioning::version'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a487e9e19f8dc597c02c0d2caf9483984',1,'FairDataPipeline::Versioning::version::version()=default'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a82cda27e083c9b3ef3d38c6ca52fc820',1,'FairDataPipeline::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] + ['toml_5ferror_0',['toml_error',['../class_fair_data_pipeline_1_1toml__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/all_11.js b/search/all_11.js index d07245a..3cc76f9 100644 --- a/search/all_11.js +++ b/search/all_11.js @@ -1,4 +1,5 @@ var searchData= [ - ['write_5ferror_0',['write_error',['../class_fair_data_pipeline_1_1write__error.html',1,'FairDataPipeline']]] + ['validation_5ferror_0',['validation_error',['../class_fair_data_pipeline_1_1validation__error.html',1,'FairDataPipeline']]], + ['version_1',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html',1,'FairDataPipeline::Versioning::version'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a487e9e19f8dc597c02c0d2caf9483984',1,'FairDataPipeline::Versioning::version::version()=default'],['../class_fair_data_pipeline_1_1_versioning_1_1version.html#a82cda27e083c9b3ef3d38c6ca52fc820',1,'FairDataPipeline::Versioning::version::version(unsigned int major, unsigned int minor, unsigned int patch, meta_tag tag=meta_tag::RELEASE, unsigned int tag_v=1E9, std::string meta_data="")']]] ]; diff --git a/search/all_12.js b/search/all_12.js index 0f5adfa..d07245a 100644 --- a/search/all_12.js +++ b/search/all_12.js @@ -1,6 +1,4 @@ var searchData= [ - ['_7econfig_0',['~Config',['../class_fair_data_pipeline_1_1_config.html#ab73735ce5c3376bd09d9b44a92745604',1,'FairDataPipeline::Config']]], - ['_7edatapipeline_1',['~DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html#aa78325ee158faa93be203ec59e5e075f',1,'FairDataPipeline::DataPipeline']]], - ['_7eimpl_2',['~impl',['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a95b04cf2f78c7bdfba26f2ebd99dc0e6',1,'FairDataPipeline::DataPipeline::impl']]] + ['write_5ferror_0',['write_error',['../class_fair_data_pipeline_1_1write__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/all_13.html b/search/all_13.html new file mode 100644 index 0000000..882aef9 --- /dev/null +++ b/search/all_13.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/all_13.js b/search/all_13.js new file mode 100644 index 0000000..0f5adfa --- /dev/null +++ b/search/all_13.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['_7econfig_0',['~Config',['../class_fair_data_pipeline_1_1_config.html#ab73735ce5c3376bd09d9b44a92745604',1,'FairDataPipeline::Config']]], + ['_7edatapipeline_1',['~DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html#aa78325ee158faa93be203ec59e5e075f',1,'FairDataPipeline::DataPipeline']]], + ['_7eimpl_2',['~impl',['../class_fair_data_pipeline_1_1_data_pipeline_1_1impl.html#a95b04cf2f78c7bdfba26f2ebd99dc0e6',1,'FairDataPipeline::DataPipeline::impl']]] +]; diff --git a/search/all_3.js b/search/all_3.js index f315710..ac27dd0 100644 --- a/search/all_3.js +++ b/search/all_3.js @@ -1,5 +1,6 @@ var searchData= [ ['datapipeline_0',['DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html',1,'FairDataPipeline']]], - ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]] + ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]], + ['distribution_2',['Distribution',['../class_fair_data_pipeline_1_1_distribution.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_2.js b/search/classes_2.js index f315710..ac27dd0 100644 --- a/search/classes_2.js +++ b/search/classes_2.js @@ -1,5 +1,6 @@ var searchData= [ ['datapipeline_0',['DataPipeline',['../class_fair_data_pipeline_1_1_data_pipeline.html',1,'FairDataPipeline']]], - ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]] + ['datapipelineimpl_5f_1',['DataPipelineImpl_',['../class_data_pipeline_impl__.html',1,'']]], + ['distribution_2',['Distribution',['../class_fair_data_pipeline_1_1_distribution.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_a.js b/search/classes_a.js index ca729e2..4ad6fb5 100644 --- a/search/classes_a.js +++ b/search/classes_a.js @@ -1,5 +1,4 @@ var searchData= [ - ['validation_5ferror_0',['validation_error',['../class_fair_data_pipeline_1_1validation__error.html',1,'FairDataPipeline']]], - ['version_1',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html',1,'FairDataPipeline::Versioning']]] + ['toml_5ferror_0',['toml_error',['../class_fair_data_pipeline_1_1toml__error.html',1,'FairDataPipeline']]] ]; diff --git a/search/classes_b.js b/search/classes_b.js index d07245a..ca729e2 100644 --- a/search/classes_b.js +++ b/search/classes_b.js @@ -1,4 +1,5 @@ var searchData= [ - ['write_5ferror_0',['write_error',['../class_fair_data_pipeline_1_1write__error.html',1,'FairDataPipeline']]] + ['validation_5ferror_0',['validation_error',['../class_fair_data_pipeline_1_1validation__error.html',1,'FairDataPipeline']]], + ['version_1',['version',['../class_fair_data_pipeline_1_1_versioning_1_1version.html',1,'FairDataPipeline::Versioning']]] ]; diff --git a/search/classes_c.html b/search/classes_c.html new file mode 100644 index 0000000..3611906 --- /dev/null +++ b/search/classes_c.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/search/classes_c.js b/search/classes_c.js new file mode 100644 index 0000000..d07245a --- /dev/null +++ b/search/classes_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['write_5ferror_0',['write_error',['../class_fair_data_pipeline_1_1write__error.html',1,'FairDataPipeline']]] +]; diff --git a/search/searchdata.js b/search/searchdata.js index 226abaf..8700a86 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,7 +1,7 @@ var indexSectionsWithContent = { - 0: "abcdefghijlmoprsvw~", - 1: "acdijlmorsvw", + 0: "abcdefghijlmoprstvw~", + 1: "acdijlmorstvw", 2: "f", 3: "c", 4: "acefghijlmprsv~", From da026dc1e4539ad1c693d5c8f2b25e37ebe87454 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Fri, 26 Aug 2022 18:10:24 +0000 Subject: [PATCH 15/19] deploy: b2d2d394208fc83c0c19d757baeeed54c2bdb619 --- api_8hxx_source.html | 92 ++++++++++--------- ..._fair_data_pipeline_1_1_a_p_i-members.html | 7 +- class_fair_data_pipeline_1_1_a_p_i.html | 3 + 3 files changed, 54 insertions(+), 48 deletions(-) diff --git a/api_8hxx_source.html b/api_8hxx_source.html index 5c05f25..4a6e1a3 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -117,58 +117,60 @@
    104
    105 Json::Value post_storage_root(Json::Value &post_data, const std::string &token);
    106
    -
    107 Json::Value get_by_json_query(const std::string &addr_path,
    -
    108 Json::Value &query_data,
    -
    109 long expected_response = 200,
    -
    110 std::string token = "");
    -
    111
    -
    120 Json::Value get_by_id(const std::string &table, int const &id,
    -
    121 long expected_response = 200, std::string token = "");
    -
    122
    -
    129 std::string get_url_root() const { return url_root_; }
    -
    130
    -
    139 std::string json_to_query_string(Json::Value &json_value);
    -
    140
    -
    149 std::string escape_space(std::string &str);
    -
    150
    -
    158 static std::string append_with_forward_slash(std::string string);
    -
    159
    -
    166 static std::string remove_leading_forward_slash(std::string str);
    -
    167
    -
    168private:
    -
    169 API( const std::string& url_root)
    -
    170 : url_root_(API::append_with_forward_slash(url_root)) {}
    -
    171
    -
    172 std::string url_root_;
    -
    173 CURL *setup_json_session_(std::string &addr_path, std::string *response,
    -
    174 long &http_code, std::string token = "");
    -
    175 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
    -
    176 FILE *file);
    -
    177
    -
    178 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
    -
    179 const std::string &token, long expected_response, bool PATCH = false);
    -
    180
    -
    181 // Legacy Method
    -
    182 Json::Value get_request(const ghc::filesystem::path &addr_path,
    -
    183 long expected_response = 200, std::string token = "");
    -
    184
    -
    185 void download_file(const ghc::filesystem::path &url,
    -
    186 ghc::filesystem::path out_path);
    -
    187};
    -
    188
    -
    189std::string url_encode(const std::string& url);
    +
    107 Json::Value post_file_type(Json::Value &post_data, const std::string &token);
    +
    108
    +
    109 Json::Value get_by_json_query(const std::string &addr_path,
    +
    110 Json::Value &query_data,
    +
    111 long expected_response = 200,
    +
    112 std::string token = "");
    +
    113
    +
    122 Json::Value get_by_id(const std::string &table, int const &id,
    +
    123 long expected_response = 200, std::string token = "");
    +
    124
    +
    131 std::string get_url_root() const { return url_root_; }
    +
    132
    +
    141 std::string json_to_query_string(Json::Value &json_value);
    +
    142
    +
    151 std::string escape_space(std::string &str);
    +
    152
    +
    160 static std::string append_with_forward_slash(std::string string);
    +
    161
    +
    168 static std::string remove_leading_forward_slash(std::string str);
    +
    169
    +
    170private:
    +
    171 API( const std::string& url_root)
    +
    172 : url_root_(API::append_with_forward_slash(url_root)) {}
    +
    173
    +
    174 std::string url_root_;
    +
    175 CURL *setup_json_session_(std::string &addr_path, std::string *response,
    +
    176 long &http_code, std::string token = "");
    +
    177 CURL *setup_download_session_(const ghc::filesystem::path &addr_path,
    +
    178 FILE *file);
    +
    179
    +
    180 Json::Value post_patch_request(const std::string addr_path, Json::Value &post_data,
    +
    181 const std::string &token, long expected_response, bool PATCH = false);
    +
    182
    +
    183 // Legacy Method
    +
    184 Json::Value get_request(const ghc::filesystem::path &addr_path,
    +
    185 long expected_response = 200, std::string token = "");
    +
    186
    +
    187 void download_file(const ghc::filesystem::path &url,
    +
    188 ghc::filesystem::path out_path);
    +
    189};
    190
    -
    191}; // namespace FairDataPipeline
    +
    191std::string url_encode(const std::string& url);
    192
    -
    193#endif
    +
    193}; // namespace FairDataPipeline
    +
    194
    +
    195#endif
    FairDataPipeline::API
    a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
    Definition: api.hxx:65
    FairDataPipeline::API::json_to_query_string
    std::string json_to_query_string(Json::Value &json_value)
    Formats a json object into a string representation which can be used as a url endpoint query.
    Definition: api.cxx:165
    -
    FairDataPipeline::API::remove_leading_forward_slash
    static std::string remove_leading_forward_slash(std::string str)
    Remove the leading forward slash from a given string.
    Definition: api.cxx:332
    +
    FairDataPipeline::API::remove_leading_forward_slash
    static std::string remove_leading_forward_slash(std::string str)
    Remove the leading forward slash from a given string.
    Definition: api.cxx:347
    FairDataPipeline::API::construct
    static sptr construct(const std::string &url_root)
    construct an API object using the given URL as the root
    Definition: api.cxx:16
    -
    FairDataPipeline::API::append_with_forward_slash
    static std::string append_with_forward_slash(std::string string)
    Static function to append a given string with a "/" unless the string is empty or already ends with a...
    Definition: api.cxx:319
    +
    FairDataPipeline::API::append_with_forward_slash
    static std::string append_with_forward_slash(std::string string)
    Static function to append a given string with a "/" unless the string is empty or already ends with a...
    Definition: api.cxx:334
    FairDataPipeline::API::get_request
    Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
    sends the given 'packet' of information to the RestAPI
    Definition: api.cxx:102
    FairDataPipeline::API::escape_space
    std::string escape_space(std::string &str)
    escapes space " " characters within a string with it's html character code (%20)
    Definition: api.cxx:201
    -
    FairDataPipeline::API::get_url_root
    std::string get_url_root() const
    returns the root URL for the RestAPI used by the API instance
    Definition: api.hxx:129
    +
    FairDataPipeline::API::get_url_root
    std::string get_url_root() const
    returns the root URL for the RestAPI used by the API instance
    Definition: api.hxx:131
    FairDataPipeline::API::post
    Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
    post information from a JSON value object to the RestAPI
    Definition: api.cxx:206
    FairDataPipeline::API::get_by_id
    Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
    get an object from the api by it's id
    Definition: api.cxx:158
    diff --git a/class_fair_data_pipeline_1_1_a_p_i-members.html b/class_fair_data_pipeline_1_1_a_p_i-members.html index 293273a..d72c8be 100644 --- a/class_fair_data_pipeline_1_1_a_p_i-members.html +++ b/class_fair_data_pipeline_1_1_a_p_i-members.html @@ -83,9 +83,10 @@ json_to_query_string(Json::Value &json_value)FairDataPipeline::API patch(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=200) (defined in FairDataPipeline::API)FairDataPipeline::API post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)FairDataPipeline::API - post_storage_root(Json::Value &post_data, const std::string &token) (defined in FairDataPipeline::API)FairDataPipeline::API - remove_leading_forward_slash(std::string str)FairDataPipeline::APIstatic - sptr typedef (defined in FairDataPipeline::API)FairDataPipeline::API + post_file_type(Json::Value &post_data, const std::string &token) (defined in FairDataPipeline::API)FairDataPipeline::API + post_storage_root(Json::Value &post_data, const std::string &token) (defined in FairDataPipeline::API)FairDataPipeline::API + remove_leading_forward_slash(std::string str)FairDataPipeline::APIstatic + sptr typedef (defined in FairDataPipeline::API)FairDataPipeline::API
    diff --git a/class_fair_data_pipeline_1_1_a_p_i.html b/class_fair_data_pipeline_1_1_a_p_i.html index c09bffa..f47c317 100644 --- a/class_fair_data_pipeline_1_1_a_p_i.html +++ b/class_fair_data_pipeline_1_1_a_p_i.html @@ -101,6 +101,9 @@ Json::Value post_storage_root (Json::Value &post_data, const std::string &token)   + +Json::Value post_file_type (Json::Value &post_data, const std::string &token) +  Json::Value get_by_json_query (const std::string &addr_path, Json::Value &query_data, long expected_response=200, std::string token="")   From 84fbb055e3ebe755a6ca819a77158d73ecb5f71a Mon Sep 17 00:00:00 2001 From: RyanJField Date: Tue, 13 Dec 2022 13:10:46 +0000 Subject: [PATCH 16/19] deploy: 7aab433b751734c62f04dad0b23d12d7c072df20 --- config_8hxx_source.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/config_8hxx_source.html b/config_8hxx_source.html index 5157c42..7741ef0 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -196,7 +196,7 @@
    281#endif
    FairDataPipeline::Config
    class for interacting with confifurations
    Definition: config.hxx:33
    FairDataPipeline::Config::meta_data_
    YAML::Node meta_data_() const
    Returns the meta_data Yaml Node from the config.
    Definition: config.cxx:40
    -
    FairDataPipeline::Config::link_read
    ghc::filesystem::path link_read(const std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:471
    +
    FairDataPipeline::Config::link_read
    ghc::filesystem::path link_read(const std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:470
    FairDataPipeline::Config::get_config_data
    YAML::Node get_config_data() const
    Get the config data as a Yaml Node.
    Definition: config.hxx:263
    FairDataPipeline::Config::get_config_file_path
    ghc::filesystem::path get_config_file_path() const
    Get the config file path object.
    Definition: config.hxx:163
    FairDataPipeline::Config::get_default_output_namespace
    std::string get_default_output_namespace() const
    Get the default output namespace.
    Definition: config.cxx:91
    @@ -206,18 +206,18 @@
    FairDataPipeline::Config::has_writes
    bool has_writes() const
    Check whether the config has writes.
    Definition: config.cxx:66
    FairDataPipeline::Config::has_outputs
    bool has_outputs() const
    Check whether any outputs have been added.
    Definition: config.cxx:78
    FairDataPipeline::Config::get_token
    std::string get_token() const
    Get the token as a string.
    Definition: config.hxx:182
    -
    FairDataPipeline::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:614
    +
    FairDataPipeline::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:613
    FairDataPipeline::Config::get_script_file_path
    ghc::filesystem::path get_script_file_path() const
    Get the script file path object.
    Definition: config.hxx:175
    FairDataPipeline::Config::get_api
    API::sptr get_api() const
    Get the api object (used to interact with the pipeline directly)
    Definition: config.hxx:270
    -
    FairDataPipeline::Config::link_write
    ghc::filesystem::path link_write(const std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:378
    +
    FairDataPipeline::Config::link_write
    ghc::filesystem::path link_write(const std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:377
    FairDataPipeline::Config::has_inputs
    bool has_inputs() const
    Check whether any inputs have been added.
    Definition: config.cxx:74
    FairDataPipeline::Config::config_writes_
    YAML::Node config_writes_() const
    Returns the writes Yaml Node from the config.
    Definition: config.cxx:44
    FairDataPipeline::Config::get_rest_api_location
    RESTAPI get_rest_api_location() const
    Get the rest api location (local / remote)
    Definition: config.hxx:277
    FairDataPipeline::Config::config_reads_
    YAML::Node config_reads_() const
    Returns the reads Yaml Node from the config.
    Definition: config.cxx:48
    FairDataPipeline::Config::~Config
    ~Config()
    Destroy the Config object.
    Definition: config.cxx:31
    FairDataPipeline::Config::get_default_input_namespace
    std::string get_default_input_namespace() const
    Get the default input namespace.
    Definition: config.cxx:87
    -
    FairDataPipeline::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:369
    -
    FairDataPipeline::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:373
    +
    FairDataPipeline::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:368
    +
    FairDataPipeline::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:372
    FairDataPipeline::Config::has_reads
    bool has_reads() const
    Check whether the config has reads.
    Definition: config.cxx:70
    From bf0135773dc19f7c09beaed0fc4acf907efd2d23 Mon Sep 17 00:00:00 2001 From: RyanJField Date: Thu, 9 Feb 2023 14:24:16 +0000 Subject: [PATCH 17/19] deploy: f9ac6f62114e87de79193d877e2b7499232d8b3f --- api_8hxx_source.html | 16 ++++---- config_8hxx.html | 2 +- config_8hxx_source.html | 12 +++--- fdp_8hxx_source.html | 78 +++++++++++++++++++-------------------- index.html | 9 ++++- metadata_8hxx_source.html | 4 +- 6 files changed, 63 insertions(+), 58 deletions(-) diff --git a/api_8hxx_source.html b/api_8hxx_source.html index 4a6e1a3..5d947aa 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -81,7 +81,7 @@
    18#include <iterator>
    19#include <json/reader.h>
    20#include <map>
    -
    21#include <boost/regex.hpp>
    +
    21#include <re2/re2.h>
    22#include <string>
    23#include <vector>
    24
    @@ -164,15 +164,15 @@
    194
    195#endif
    FairDataPipeline::API
    a class which handles the fetching and posting of information to the FDP data pipeline RestAPI
    Definition: api.hxx:65
    -
    FairDataPipeline::API::json_to_query_string
    std::string json_to_query_string(Json::Value &json_value)
    Formats a json object into a string representation which can be used as a url endpoint query.
    Definition: api.cxx:165
    -
    FairDataPipeline::API::remove_leading_forward_slash
    static std::string remove_leading_forward_slash(std::string str)
    Remove the leading forward slash from a given string.
    Definition: api.cxx:347
    +
    FairDataPipeline::API::json_to_query_string
    std::string json_to_query_string(Json::Value &json_value)
    Formats a json object into a string representation which can be used as a url endpoint query.
    Definition: api.cxx:166
    +
    FairDataPipeline::API::remove_leading_forward_slash
    static std::string remove_leading_forward_slash(std::string str)
    Remove the leading forward slash from a given string.
    Definition: api.cxx:356
    FairDataPipeline::API::construct
    static sptr construct(const std::string &url_root)
    construct an API object using the given URL as the root
    Definition: api.cxx:16
    -
    FairDataPipeline::API::append_with_forward_slash
    static std::string append_with_forward_slash(std::string string)
    Static function to append a given string with a "/" unless the string is empty or already ends with a...
    Definition: api.cxx:334
    -
    FairDataPipeline::API::get_request
    Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
    sends the given 'packet' of information to the RestAPI
    Definition: api.cxx:102
    -
    FairDataPipeline::API::escape_space
    std::string escape_space(std::string &str)
    escapes space " " characters within a string with it's html character code (%20)
    Definition: api.cxx:201
    +
    FairDataPipeline::API::append_with_forward_slash
    static std::string append_with_forward_slash(std::string string)
    Static function to append a given string with a "/" unless the string is empty or already ends with a...
    Definition: api.cxx:343
    +
    FairDataPipeline::API::get_request
    Json::Value get_request(const std::string &addr_path, long expected_response=200, std::string token="")
    sends the given 'packet' of information to the RestAPI
    Definition: api.cxx:103
    +
    FairDataPipeline::API::escape_space
    std::string escape_space(std::string &str)
    escapes space " " characters within a string with it's html character code (%20)
    Definition: api.cxx:206
    FairDataPipeline::API::get_url_root
    std::string get_url_root() const
    returns the root URL for the RestAPI used by the API instance
    Definition: api.hxx:131
    -
    FairDataPipeline::API::post
    Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
    post information from a JSON value object to the RestAPI
    Definition: api.cxx:206
    -
    FairDataPipeline::API::get_by_id
    Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
    get an object from the api by it's id
    Definition: api.cxx:158
    +
    FairDataPipeline::API::post
    Json::Value post(const std::string addr_path, Json::Value &post_data, const std::string &token, long expected_response=201)
    post information from a JSON value object to the RestAPI
    Definition: api.cxx:213
    +
    FairDataPipeline::API::get_by_id
    Json::Value get_by_id(const std::string &table, int const &id, long expected_response=200, std::string token="")
    get an object from the api by it's id
    Definition: api.cxx:159
    diff --git a/config_8hxx.html b/config_8hxx.html index 6770ac8..8f6ea54 100644 --- a/config_8hxx.html +++ b/config_8hxx.html @@ -75,7 +75,7 @@
    #include <string>
    #include <ghc/filesystem.hpp>
    #include <yaml-cpp/yaml.h>
    -#include <boost/regex.hpp>
    +#include <re2/re2.h>
    #include <map>
    #include <stdio.h>
    #include "fdp/objects/metadata.hxx"
    diff --git a/config_8hxx_source.html b/config_8hxx_source.html index 7741ef0..c61572f 100644 --- a/config_8hxx_source.html +++ b/config_8hxx_source.html @@ -77,7 +77,7 @@
    15#include <string>
    16#include <ghc/filesystem.hpp>
    17#include <yaml-cpp/yaml.h>
    -
    18#include <boost/regex.hpp>
    +
    18#include <re2/re2.h>
    19#include <map>
    20#include <ghc/filesystem.hpp>
    21#include <stdio.h>
    @@ -196,7 +196,7 @@
    281#endif
    FairDataPipeline::Config
    class for interacting with confifurations
    Definition: config.hxx:33
    FairDataPipeline::Config::meta_data_
    YAML::Node meta_data_() const
    Returns the meta_data Yaml Node from the config.
    Definition: config.cxx:40
    -
    FairDataPipeline::Config::link_read
    ghc::filesystem::path link_read(const std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:470
    +
    FairDataPipeline::Config::link_read
    ghc::filesystem::path link_read(const std::string &data_product)
    Return the filepath to a given data product.
    Definition: config.cxx:471
    FairDataPipeline::Config::get_config_data
    YAML::Node get_config_data() const
    Get the config data as a Yaml Node.
    Definition: config.hxx:263
    FairDataPipeline::Config::get_config_file_path
    ghc::filesystem::path get_config_file_path() const
    Get the config file path object.
    Definition: config.hxx:163
    FairDataPipeline::Config::get_default_output_namespace
    std::string get_default_output_namespace() const
    Get the default output namespace.
    Definition: config.cxx:91
    @@ -206,18 +206,18 @@
    FairDataPipeline::Config::has_writes
    bool has_writes() const
    Check whether the config has writes.
    Definition: config.cxx:66
    FairDataPipeline::Config::has_outputs
    bool has_outputs() const
    Check whether any outputs have been added.
    Definition: config.cxx:78
    FairDataPipeline::Config::get_token
    std::string get_token() const
    Get the token as a string.
    Definition: config.hxx:182
    -
    FairDataPipeline::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:613
    +
    FairDataPipeline::Config::finalise
    void finalise()
    Finalise the pipeline Write any pending metadata to the registry Rename any pending writes to their n...
    Definition: config.cxx:614
    FairDataPipeline::Config::get_script_file_path
    ghc::filesystem::path get_script_file_path() const
    Get the script file path object.
    Definition: config.hxx:175
    FairDataPipeline::Config::get_api
    API::sptr get_api() const
    Get the api object (used to interact with the pipeline directly)
    Definition: config.hxx:270
    -
    FairDataPipeline::Config::link_write
    ghc::filesystem::path link_write(const std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:377
    +
    FairDataPipeline::Config::link_write
    ghc::filesystem::path link_write(const std::string &data_product)
    Provide a tempory file path for a given data product to be written whilst recording metadata.
    Definition: config.cxx:378
    FairDataPipeline::Config::has_inputs
    bool has_inputs() const
    Check whether any inputs have been added.
    Definition: config.cxx:74
    FairDataPipeline::Config::config_writes_
    YAML::Node config_writes_() const
    Returns the writes Yaml Node from the config.
    Definition: config.cxx:44
    FairDataPipeline::Config::get_rest_api_location
    RESTAPI get_rest_api_location() const
    Get the rest api location (local / remote)
    Definition: config.hxx:277
    FairDataPipeline::Config::config_reads_
    YAML::Node config_reads_() const
    Returns the reads Yaml Node from the config.
    Definition: config.cxx:48
    FairDataPipeline::Config::~Config
    ~Config()
    Destroy the Config object.
    Definition: config.cxx:31
    FairDataPipeline::Config::get_default_input_namespace
    std::string get_default_input_namespace() const
    Get the default input namespace.
    Definition: config.cxx:87
    -
    FairDataPipeline::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:368
    -
    FairDataPipeline::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:372
    +
    FairDataPipeline::Config::get_config_directory
    std::string get_config_directory() const
    Get the config directory path as a string.
    Definition: config.cxx:369
    +
    FairDataPipeline::Config::get_code_run_uuid
    std::string get_code_run_uuid() const
    Get the code run uuid.
    Definition: config.cxx:373
    FairDataPipeline::Config::has_reads
    bool has_reads() const
    Check whether the config has reads.
    Definition: config.cxx:70
    diff --git a/fdp_8hxx_source.html b/fdp_8hxx_source.html index 522fd9c..87ccf39 100644 --- a/fdp_8hxx_source.html +++ b/fdp_8hxx_source.html @@ -75,50 +75,48 @@
    3
    4#include "utilities/logging.hxx"
    5
    -
    6#include <ghc/filesystem.hpp>
    -
    7
    -
    8namespace FairDataPipeline {
    -
    14 class DataPipeline {
    -
    15
    -
    16 public:
    -
    17 typedef std::shared_ptr< DataPipeline > sptr;
    -
    25 static sptr construct(
    -
    26 const std::string &config_file_path,
    -
    27 const std::string &script_file_path,
    -
    28 std::string token = "" );
    -
    29
    -
    30
    -
    35 ~DataPipeline();
    -
    36
    -
    37 //DataPipeline(DataPipeline &&rhs) noexcept;
    -
    38 //DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    -
    39
    -
    40
    -
    48 std::string link_read(std::string &data_product);
    -
    49
    -
    57 std::string link_write(std::string &data_product);
    -
    58
    -
    65 void finalise();
    -
    66
    -
    67 private:
    -
    68 explicit DataPipeline(
    -
    69 const std::string &config_file_path,
    -
    70 const std::string &script_file_path,
    -
    71 std::string token = ""
    -
    72 );
    +
    6namespace FairDataPipeline {
    +
    12 class DataPipeline {
    +
    13
    +
    14 public:
    +
    15 typedef std::shared_ptr< DataPipeline > sptr;
    +
    23 static sptr construct(
    +
    24 const std::string &config_file_path,
    +
    25 const std::string &script_file_path,
    +
    26 std::string token = "" );
    +
    27
    +
    28
    +
    33 ~DataPipeline();
    +
    34
    +
    35 //DataPipeline(DataPipeline &&rhs) noexcept;
    +
    36 //DataPipeline &operator=(DataPipeline &&rhs) noexcept;
    +
    37
    +
    38
    +
    46 std::string link_read(std::string &data_product);
    +
    47
    +
    55 std::string link_write(std::string &data_product);
    +
    56
    +
    63 void finalise();
    +
    64
    +
    65 private:
    +
    66 explicit DataPipeline(
    +
    67 const std::string &config_file_path,
    +
    68 const std::string &script_file_path,
    +
    69 std::string token = ""
    +
    70 );
    +
    71
    +
    72 DataPipeline(const DataPipeline &rhs) = delete;
    73
    -
    74 DataPipeline(const DataPipeline &rhs) = delete;
    +
    74 DataPipeline &operator=(const DataPipeline &rhs) = delete;
    75
    -
    76 DataPipeline &operator=(const DataPipeline &rhs) = delete;
    +
    76 class impl;
    77
    -
    78 class impl;
    -
    79
    -
    80 std::shared_ptr< DataPipeline::impl > pimpl_;
    -
    81 };
    -
    82}; // namespace FairDataPipeline
    -
    83#endif
    +
    78 std::shared_ptr< DataPipeline::impl > pimpl_;
    +
    79 };
    +
    80}; // namespace FairDataPipeline
    +
    81#endif
    -
    FairDataPipeline::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:14
    +
    FairDataPipeline::DataPipeline
    DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.
    Definition: fdp.hxx:12
    FairDataPipeline::DataPipeline::construct
    static sptr construct(const std::string &config_file_path, const std::string &script_file_path, std::string token="")
    Construct a new Data Pipeline (PIMPL)
    Definition: fdp.cxx:153
    FairDataPipeline::DataPipeline::finalise
    void finalise()
    Finalise the pipeline Record all data products and meta data to the registry update the code run with...
    Definition: fdp.cxx:183
    FairDataPipeline::DataPipeline::~DataPipeline
    ~DataPipeline()
    Destroy the Data Pipeline object.
    diff --git a/index.html b/index.html index 0337cb4..f5d74c7 100644 --- a/index.html +++ b/index.html @@ -80,11 +80,18 @@

    It is recomended that you install CURL prior to installation of this API

    -

    compile the library and tests by running:

    +

    Compile the library and tests by running:

    $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
    $ cmake --build build

    Important For multi-config compilers such as Visual Studio xcode or ninja the config type needs to be set to Release otherwise the API will not build for example:

    $ cmake -Bbuild -DFDPAPI_BUILD_TESTS=ON
    $ cmake --build build --config=Release
    +

    The library can be installed system-wide using:

    +
    $ cmake --build build --target install
    +

    Note that this will require Boost to be installed to your system, or you may need to build a shared library:

    +
    $ cmake -B build -DFDPAPI_BUILD_TESTS=ON -DBUILD_SHARED_LIBS=ON
    +

    After doing so, the library can be discovered and utilised in other CMake projects using:

    +
    find_package(fdpapi)
    +
    target_link_libraries(my_project PRIVATE fdpapi::fdpapi)

    Outline

    The main class the user will interact with is DataPipeline which has only the required methods such as link_read etc. This class has a member which is a pointer to an underlying DataPipelineImpl_ class which performs the various procedures required to handle the data. A logger has been used to give as much feedback to the user as possible, the verbosity being handled by a log level argument.

    diff --git a/metadata_8hxx_source.html b/metadata_8hxx_source.html index b6f6921..6428225 100644 --- a/metadata_8hxx_source.html +++ b/metadata_8hxx_source.html @@ -82,9 +82,9 @@
    18#include <sstream>
    19#include <random>
    20#include <chrono>
    -
    21#include <boost/regex.hpp>
    +
    21#include <re2/re2.h>
    22
    -
    23#include "digestpp.hpp"
    +
    23#include "digestpp/digestpp.hpp"
    24
    25#ifdef _WIN32
    26 #include <io.h>
    From efb82b29fc60f11a00af6e3a1a4c971b1bdc8fee Mon Sep 17 00:00:00 2001 From: RyanJField Date: Wed, 19 Apr 2023 08:49:37 +0000 Subject: [PATCH 18/19] deploy: ba4cf72a123f83e5d5ca05207ca8e7fb83ad77a8 --- annotated.html | 55 +- api_8hxx_source.html | 27 +- api__object_8hxx_source.html | 27 +- bc_sd.png | Bin 0 -> 635 bytes class_data_pipeline_impl__.html | 27 +- ..._fair_data_pipeline_1_1_a_p_i-members.html | 27 +- class_fair_data_pipeline_1_1_a_p_i.html | 45 +- ..._data_pipeline_1_1_api_object-members.html | 27 +- class_fair_data_pipeline_1_1_api_object.html | 50 +- ...fair_data_pipeline_1_1_config-members.html | 27 +- class_fair_data_pipeline_1_1_config.html | 98 +- ...ta_pipeline_1_1_data_pipeline-members.html | 27 +- ..._fair_data_pipeline_1_1_data_pipeline.html | 92 +- ...ine_1_1_data_pipeline_1_1impl-members.html | 27 +- ...ta_pipeline_1_1_data_pipeline_1_1impl.html | 94 +- ...ata_pipeline_1_1_distribution-members.html | 27 +- ...s_fair_data_pipeline_1_1_distribution.html | 27 +- ..._data_pipeline_1_1_i_o_object-members.html | 27 +- class_fair_data_pipeline_1_1_i_o_object.html | 89 +- ...ine_1_1_versioning_1_1version-members.html | 27 +- ...ta_pipeline_1_1_versioning_1_1version.html | 33 +- ...ta_pipeline_1_1config__parsing__error.html | 27 +- ...ata_pipeline_1_1config__parsing__error.png | Bin 763 -> 782 bytes ...r_data_pipeline_1_1json__parse__error.html | 27 +- ...ir_data_pipeline_1_1json__parse__error.png | Bin 732 -> 750 bytes ..._fair_data_pipeline_1_1logger-members.html | 27 +- class_fair_data_pipeline_1_1logger.html | 27 +- ...1_1logging_1_1_composite_sink-members.html | 27 +- ...ipeline_1_1logging_1_1_composite_sink.html | 32 +- ...pipeline_1_1logging_1_1_composite_sink.png | Bin 1281 -> 1304 bytes ...ipeline_1_1logging_1_1_logger-members.html | 27 +- ...r_data_pipeline_1_1logging_1_1_logger.html | 27 +- ...ng_1_1_logger_1_1_msg_builder-members.html | 27 +- ...1_1logging_1_1_logger_1_1_msg_builder.html | 27 +- ..._1_1logging_1_1_o_stream_sink-members.html | 27 +- ...pipeline_1_1logging_1_1_o_stream_sink.html | 32 +- ..._pipeline_1_1logging_1_1_o_stream_sink.png | Bin 1275 -> 1299 bytes ..._pipeline_1_1logging_1_1_sink-members.html | 27 +- ...air_data_pipeline_1_1logging_1_1_sink.html | 27 +- ...fair_data_pipeline_1_1logging_1_1_sink.png | Bin 1757 -> 1806 bytes ...1_1logging_1_1_sink_formatter-members.html | 27 +- ...ipeline_1_1logging_1_1_sink_formatter.html | 32 +- ...pipeline_1_1logging_1_1_sink_formatter.png | Bin 944 -> 964 bytes ...ata_pipeline_1_1rest__apiquery__error.html | 27 +- ...data_pipeline_1_1rest__apiquery__error.png | Bin 763 -> 785 bytes class_fair_data_pipeline_1_1sync__error.html | 27 +- class_fair_data_pipeline_1_1sync__error.png | Bin 676 -> 689 bytes class_fair_data_pipeline_1_1toml__error.html | 27 +- class_fair_data_pipeline_1_1toml__error.png | Bin 660 -> 674 bytes ...ir_data_pipeline_1_1validation__error.html | 27 +- ...air_data_pipeline_1_1validation__error.png | Bin 715 -> 731 bytes class_fair_data_pipeline_1_1write__error.html | 27 +- class_fair_data_pipeline_1_1write__error.png | Bin 673 -> 683 bytes classes.html | 27 +- config_8hxx.html | 29 +- config_8hxx_source.html | 27 +- data__io_8hxx_source.html | 27 +- dir_39f1df2935b9bcc0c6b792c5d1359e85.html | 40 +- dir_68267d1309a1af8e8297ef4c3efbcdba.html | 33 +- dir_7b5d38f1875f1b693f62ca6a108a1129.html | 27 +- dir_8c20949084a9f35c1e6bd2c48f358243.html | 35 +- dir_a7fa5847c07dc92c5227f8a150238560.html | 27 +- dir_ac6c6686346e4bb6ee59787dd26cbe81.html | 39 +- dir_cb3c39cc4ab347a95dfc53ab4ca55b3c.html | 27 +- dir_d44c64559bbebec7f509842c48db8b23.html | 31 +- dir_d98af0b859cb0744225e11c767d17cdb.html | 33 +- dir_f537a5f098b413116eae11cd84c41a43.html | 35 +- distribution_8hxx_source.html | 27 +- docd.png | Bin 0 -> 756 bytes doxygen.css | 962 ++++++++++-------- dynsections.js | 2 + exceptions_8hxx_source.html | 41 +- fdp_8hxx_source.html | 27 +- files.html | 47 +- functions.html | 27 +- functions_func.html | 27 +- hierarchy.html | 53 +- index.html | 33 +- io__object_8hxx_source.html | 27 +- jquery.js | 7 +- json_8hxx_source.html | 27 +- logging_8hxx_source.html | 27 +- menu.js | 43 +- metadata_8hxx_source.html | 27 +- ...ace_fair_data_pipeline_1_1_versioning.html | 29 +- namespacemembers.html | 27 +- namespacemembers_enum.html | 27 +- namespaces.html | 56 +- nav_fd.png | Bin 0 -> 169 bytes nav_hd.png | Bin 0 -> 114 bytes search/all_0.html | 37 - search/all_1.html | 37 - search/all_10.html | 37 - search/all_11.html | 37 - search/all_12.html | 37 - search/all_13.html | 37 - search/all_2.html | 37 - search/all_2.js | 2 +- search/all_3.html | 37 - search/all_4.html | 37 - search/all_5.html | 37 - search/all_5.js | 2 +- search/all_6.html | 37 - search/all_6.js | 2 +- search/all_7.html | 37 - search/all_8.html | 37 - search/all_9.html | 37 - search/all_a.html | 37 - search/all_a.js | 4 +- search/all_b.html | 37 - search/all_c.html | 37 - search/all_d.html | 37 - search/all_e.html | 37 - search/all_f.html | 37 - search/classes_0.html | 37 - search/classes_1.html | 37 - search/classes_2.html | 37 - search/classes_3.html | 37 - search/classes_4.html | 37 - search/classes_5.html | 37 - search/classes_6.html | 37 - search/classes_7.html | 37 - search/classes_8.html | 37 - search/classes_9.html | 37 - search/classes_a.html | 37 - search/classes_b.html | 37 - search/classes_c.html | 37 - search/enums_0.html | 37 - search/enumvalues_0.html | 37 - search/enumvalues_1.html | 37 - search/enumvalues_2.html | 37 - search/files_0.html | 37 - search/functions_0.html | 37 - search/functions_1.html | 37 - search/functions_1.js | 2 +- search/functions_2.html | 37 - search/functions_3.html | 37 - search/functions_3.js | 2 +- search/functions_4.html | 37 - search/functions_4.js | 2 +- search/functions_5.html | 37 - search/functions_6.html | 37 - search/functions_7.html | 37 - search/functions_8.html | 37 - search/functions_8.js | 4 +- search/functions_9.html | 37 - search/functions_a.html | 37 - search/functions_b.html | 37 - search/functions_c.html | 37 - search/functions_d.html | 37 - search/functions_e.html | 37 - search/mag.svg | 37 + search/mag_d.svg | 37 + search/mag_seld.svg | 74 ++ search/namespaces_0.html | 37 - search/nomatches.html | 13 - search/pages_0.html | 37 - search/search.css | 110 +- search/search.js | 124 ++- search/search_l.png | Bin 567 -> 0 bytes search/search_m.png | Bin 158 -> 0 bytes search/search_r.png | Bin 553 -> 0 bytes semver_8hxx_source.html | 27 +- splitbard.png | Bin 0 -> 282 bytes ...ipeline_1_1logging_1_1_i_sink-members.html | 27 +- ...r_data_pipeline_1_1logging_1_1_i_sink.html | 27 +- ...ir_data_pipeline_1_1logging_1_1_i_sink.png | Bin 1759 -> 1807 bytes ...1logging_1_1_i_sink_formatter-members.html | 27 +- ...eline_1_1logging_1_1_i_sink_formatter.html | 27 +- ...peline_1_1logging_1_1_i_sink_formatter.png | Bin 947 -> 963 bytes tab_ad.png | Bin 0 -> 135 bytes tab_bd.png | Bin 0 -> 173 bytes tab_hd.png | Bin 0 -> 180 bytes tab_sd.png | Bin 0 -> 188 bytes tabs.css | 2 +- time_8h_source.html | 27 +- times_8h_source.html | 27 +- 177 files changed, 2553 insertions(+), 3530 deletions(-) create mode 100644 bc_sd.png create mode 100644 docd.png create mode 100644 nav_fd.png create mode 100644 nav_hd.png delete mode 100644 search/all_0.html delete mode 100644 search/all_1.html delete mode 100644 search/all_10.html delete mode 100644 search/all_11.html delete mode 100644 search/all_12.html delete mode 100644 search/all_13.html delete mode 100644 search/all_2.html delete mode 100644 search/all_3.html delete mode 100644 search/all_4.html delete mode 100644 search/all_5.html delete mode 100644 search/all_6.html delete mode 100644 search/all_7.html delete mode 100644 search/all_8.html delete mode 100644 search/all_9.html delete mode 100644 search/all_a.html delete mode 100644 search/all_b.html delete mode 100644 search/all_c.html delete mode 100644 search/all_d.html delete mode 100644 search/all_e.html delete mode 100644 search/all_f.html delete mode 100644 search/classes_0.html delete mode 100644 search/classes_1.html delete mode 100644 search/classes_2.html delete mode 100644 search/classes_3.html delete mode 100644 search/classes_4.html delete mode 100644 search/classes_5.html delete mode 100644 search/classes_6.html delete mode 100644 search/classes_7.html delete mode 100644 search/classes_8.html delete mode 100644 search/classes_9.html delete mode 100644 search/classes_a.html delete mode 100644 search/classes_b.html delete mode 100644 search/classes_c.html delete mode 100644 search/enums_0.html delete mode 100644 search/enumvalues_0.html delete mode 100644 search/enumvalues_1.html delete mode 100644 search/enumvalues_2.html delete mode 100644 search/files_0.html delete mode 100644 search/functions_0.html delete mode 100644 search/functions_1.html delete mode 100644 search/functions_2.html delete mode 100644 search/functions_3.html delete mode 100644 search/functions_4.html delete mode 100644 search/functions_5.html delete mode 100644 search/functions_6.html delete mode 100644 search/functions_7.html delete mode 100644 search/functions_8.html delete mode 100644 search/functions_9.html delete mode 100644 search/functions_a.html delete mode 100644 search/functions_b.html delete mode 100644 search/functions_c.html delete mode 100644 search/functions_d.html delete mode 100644 search/functions_e.html create mode 100644 search/mag.svg create mode 100644 search/mag_d.svg create mode 100644 search/mag_seld.svg delete mode 100644 search/namespaces_0.html delete mode 100644 search/nomatches.html delete mode 100644 search/pages_0.html delete mode 100644 search/search_l.png delete mode 100644 search/search_m.png delete mode 100644 search/search_r.png create mode 100644 splitbard.png create mode 100644 tab_ad.png create mode 100644 tab_bd.png create mode 100644 tab_hd.png create mode 100644 tab_sd.png diff --git a/annotated.html b/annotated.html index ffd7862..57593aa 100644 --- a/annotated.html +++ b/annotated.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: Class List @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -57,9 +57,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -69,39 +76,39 @@
    Here are the classes, structs, unions and interfaces with brief descriptions:
    [detail level 1234]
    - + - + - + - + - + - + - + - + - + - + - + - + - + - +
     ▼NFairDataPipeline
     ▼Nlogging
     ▼Nlogging
     CCompositeSink
     CISink
     CISink
     CISinkFormatter
     ▼CLogger
     ▼CLogger
     CMsgBuilder
     COStreamSink
     COStreamSink
     CSink
     CSinkFormatter
     CSinkFormatter
     ▼NVersioningNamespace containing all semantic versioning types and classes
     CversionClass describing the semantic version of an object
     CversionClass describing the semantic version of an object
     CAPIClass which handles the fetching and posting of information to the FDP data pipeline RestAPI
     CApiObjectClass for API objects
     CApiObjectClass for API objects
     CConfigClass for interacting with confifurations
     Cconfig_parsing_error
     Cconfig_parsing_error
     ▼CDataPipelineDataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline
     Cimpl
     Cimpl
     CDistributionClass for API objects
     CIOObjectClass for API objects
     CIOObjectClass for API objects
     Cjson_parse_error
     Clogger
     Clogger
     Crest_apiquery_error
     Csync_error
     Csync_error
     Ctoml_error
     Cvalidation_error
     Cvalidation_error
     Cwrite_error
     CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
     CDataPipelineImpl_Private pointer-to-implementation class containing all backend methods
    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/api_8hxx_source.html b/api_8hxx_source.html index 5d947aa..3583baf 100644 --- a/api_8hxx_source.html +++ b/api_8hxx_source.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: include/fdp/registry/api.hxx Source File @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/api__object_8hxx_source.html b/api__object_8hxx_source.html index 1c81851..9506ce4 100644 --- a/api__object_8hxx_source.html +++ b/api__object_8hxx_source.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: include/fdp/objects/api_object.hxx Source File @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/bc_sd.png b/bc_sd.png new file mode 100644 index 0000000000000000000000000000000000000000..31ca888dc71049713b35c351933a8d0f36180bf1 GIT binary patch literal 635 zcmV->0)+jEP)Jwi0r1~gdSq#w{Bu1q z`craw(p2!hu$4C_$Oc3X(sI6e=9QSTwPt{G) z=htT&^~&c~L2~e{r5_5SYe7#Is-$ln>~Kd%$F#tC65?{LvQ}8O`A~RBB0N~`2M+waajO;5>3B&-viHGJeEK2TQOiPRa zfDKyqwMc4wfaEh4jt>H`nW_Zidwk@Bowp`}(VUaj-pSI(-1L>FJVsX}Yl9~JsqgsZ zUD9(rMwf23Gez6KPa|wwInZodP-2}9@fK0Ga_9{8SOjU&4l`pH4@qlQp83>>HT$xW zER^U>)MyV%t(Lu=`d=Y?{k1@}&r7ZGkFQ%z%N+sE9BtYjovzxyxCPxN6&@wLK{soQ zSmkj$aLI}miuE^p@~4}mg9OjDfGEkgY4~^XzLRUBB*O{+&vq<3v(E%+k_i%=`~j%{ Vj14gnt9}3g002ovPDHLkV1n!oC4m3{ literal 0 HcmV?d00001 diff --git a/class_data_pipeline_impl__.html b/class_data_pipeline_impl__.html index 96c471e..f0fa860 100644 --- a/class_data_pipeline_impl__.html +++ b/class_data_pipeline_impl__.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: DataPipelineImpl_ Class Reference @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -80,7 +87,7 @@
    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/class_fair_data_pipeline_1_1_a_p_i-members.html b/class_fair_data_pipeline_1_1_a_p_i-members.html index d72c8be..1b866dc 100644 --- a/class_fair_data_pipeline_1_1_a_p_i-members.html +++ b/class_fair_data_pipeline_1_1_a_p_i-members.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: Member List @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/class_fair_data_pipeline_1_1_a_p_i.html b/class_fair_data_pipeline_1_1_a_p_i.html index f47c317..7738fcf 100644 --- a/class_fair_data_pipeline_1_1_a_p_i.html +++ b/class_fair_data_pipeline_1_1_a_p_i.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: FairDataPipeline::API Class Reference @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +

    Member Function Documentation

    -

    ◆ append_with_forward_slash()

    +

    ◆ append_with_forward_slash()

    @@ -174,7 +181,7 @@

    -

    ◆ construct()

    +

    ◆ construct()

    @@ -210,7 +217,7 @@

    -

    ◆ escape_space()

    +

    ◆ escape_space()

    @@ -237,7 +244,7 @@

    -

    ◆ get_by_id()

    +

    ◆ get_by_id()

    @@ -288,7 +295,7 @@

    -

    ◆ get_request()

    +

    ◆ get_request()

    @@ -333,7 +340,7 @@

    -

    ◆ get_url_root()

    +

    ◆ get_url_root()

    @@ -363,7 +370,7 @@

    -

    ◆ json_to_query_string()

    +

    ◆ json_to_query_string()

    @@ -390,7 +397,7 @@

    -

    ◆ post()

    +

    ◆ post()

    @@ -444,7 +451,7 @@

    -

    ◆ remove_leading_forward_slash()

    +

    ◆ remove_leading_forward_slash()

    @@ -485,7 +492,7 @@

    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/class_fair_data_pipeline_1_1_api_object-members.html b/class_fair_data_pipeline_1_1_api_object-members.html index f1431ab..37e9245 100644 --- a/class_fair_data_pipeline_1_1_api_object-members.html +++ b/class_fair_data_pipeline_1_1_api_object-members.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: Member List @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    -Generated by doxygen 1.9.2 +Generated by doxygen 1.9.5
    diff --git a/class_fair_data_pipeline_1_1_api_object.html b/class_fair_data_pipeline_1_1_api_object.html index eef6d96..3404fcd 100644 --- a/class_fair_data_pipeline_1_1_api_object.html +++ b/class_fair_data_pipeline_1_1_api_object.html @@ -1,9 +1,9 @@ - + - + cppDataPipeline: FairDataPipeline::ApiObject Class Reference @@ -19,8 +19,8 @@
    - - +
    +
    cppDataPipeline 0.3.0
    C++ Implementation of the FAIR Data Pipeline API
    @@ -30,10 +30,10 @@
    - + @@ -56,9 +56,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +