diff options
1 files changed, 444 insertions, 0 deletions
| -rw-r--r-- | Year 1/Object-oriented Programming/Project 2/docs/html/classString.html | 444 |
diff --git a/Year 1/Object-oriented Programming/Project 2/docs/html/classString.html b/Year 1/Object-oriented Programming/Project 2/docs/html/classString.html new file mode 100644 index 0000000..13b7008 --- /dev/null +++ b/Year 1/Object-oriented Programming/Project 2/docs/html/classString.html @@ -0,0 +1,444 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>FMI Table: String Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr id="projectrow"> + <td id="projectalign"> + <div id="projectname">FMI Table + </div> + <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 2 | Project Topic 7 |</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.3 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */ +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#friends">Friends</a> | +<a href="classString-members.html">List of all members</a> </div> + <div class="headertitle"><div class="title">String Class Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>A dynamically-allocated C-style string with extra features. + <a href="classString.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="String_8h_source.html">String.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ad3d65397e27bb3c4db1295208cfb1559"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#ad3d65397e27bb3c4db1295208cfb1559">String</a> (unsigned length)</td></tr> +<tr class="memdesc:ad3d65397e27bb3c4db1295208cfb1559"><td class="mdescLeft"> </td><td class="mdescRight">The underlying array is allocated with length (+ 1) size. <a href="classString.html#ad3d65397e27bb3c4db1295208cfb1559">More...</a><br /></td></tr> +<tr class="separator:ad3d65397e27bb3c4db1295208cfb1559"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3fba40cf6cb11735ffddc355a5ff68f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a3fba40cf6cb11735ffddc355a5ff68f4">String</a> (const char *str)</td></tr> +<tr class="memdesc:a3fba40cf6cb11735ffddc355a5ff68f4"><td class="mdescLeft"> </td><td class="mdescRight">Copies str. <a href="classString.html#a3fba40cf6cb11735ffddc355a5ff68f4">More...</a><br /></td></tr> +<tr class="separator:a3fba40cf6cb11735ffddc355a5ff68f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3d7f953737f3d4dca72d1cc4836f7dcc"><td class="memItemLeft" align="right" valign="top"><a id="a3d7f953737f3d4dca72d1cc4836f7dcc" name="a3d7f953737f3d4dca72d1cc4836f7dcc"></a> +const char * </td><td class="memItemRight" valign="bottom"><b>get_cstr</b> () const</td></tr> +<tr class="memdesc:a3d7f953737f3d4dca72d1cc4836f7dcc"><td class="mdescLeft"> </td><td class="mdescRight">Returns internal C-style string. <br /></td></tr> +<tr class="separator:a3d7f953737f3d4dca72d1cc4836f7dcc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7793a7e9a7601d4c724dcc85566259bf"><td class="memItemLeft" align="right" valign="top"><a id="a7793a7e9a7601d4c724dcc85566259bf" name="a7793a7e9a7601d4c724dcc85566259bf"></a> +unsigned </td><td class="memItemRight" valign="bottom"><b>get_length</b> () const</td></tr> +<tr class="memdesc:a7793a7e9a7601d4c724dcc85566259bf"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of characters in string. <br /></td></tr> +<tr class="separator:a7793a7e9a7601d4c724dcc85566259bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5d3b77a51619a8580a373d2cd1092a54"><td class="memItemLeft" align="right" valign="top"><a id="a5d3b77a51619a8580a373d2cd1092a54" name="a5d3b77a51619a8580a373d2cd1092a54"></a> +char & </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (unsigned index)</td></tr> +<tr class="memdesc:a5d3b77a51619a8580a373d2cd1092a54"><td class="mdescLeft"> </td><td class="mdescRight">Returns a character reference (from the underlying C-style string) at the given index. <br /></td></tr> +<tr class="separator:a5d3b77a51619a8580a373d2cd1092a54"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a64de9ab1af5df9397f8fbd8c79d5f4b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">operator+=</a> (const char *str)</td></tr> +<tr class="memdesc:a64de9ab1af5df9397f8fbd8c79d5f4b6"><td class="mdescLeft"> </td><td class="mdescRight">Appends a C-style string. <a href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">More...</a><br /></td></tr> +<tr class="separator:a64de9ab1af5df9397f8fbd8c79d5f4b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0a96f034ca01cc9fbb27e17330c66ca1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a0a96f034ca01cc9fbb27e17330c66ca1">operator+=</a> (int number)</td></tr> +<tr class="memdesc:a0a96f034ca01cc9fbb27e17330c66ca1"><td class="mdescLeft"> </td><td class="mdescRight">Appends a number. <a href="classString.html#a0a96f034ca01cc9fbb27e17330c66ca1">More...</a><br /></td></tr> +<tr class="separator:a0a96f034ca01cc9fbb27e17330c66ca1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed8480111703abc1f281148c778b0445"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#aed8480111703abc1f281148c778b0445">operator+=</a> (unsigned number)</td></tr> +<tr class="memdesc:aed8480111703abc1f281148c778b0445"><td class="mdescLeft"> </td><td class="mdescRight">Appends a number. <a href="classString.html#aed8480111703abc1f281148c778b0445">More...</a><br /></td></tr> +<tr class="separator:aed8480111703abc1f281148c778b0445"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2e4c8591498da08d8ffe206fc45f62a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a2e4c8591498da08d8ffe206fc45f62a5">operator+=</a> (double number)</td></tr> +<tr class="memdesc:a2e4c8591498da08d8ffe206fc45f62a5"><td class="mdescLeft"> </td><td class="mdescRight">Appends a number. <a href="classString.html#a2e4c8591498da08d8ffe206fc45f62a5">More...</a><br /></td></tr> +<tr class="separator:a2e4c8591498da08d8ffe206fc45f62a5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afc158dffcdf56e601bd640cbacdfcd3c"><td class="memItemLeft" align="right" valign="top"><a id="afc158dffcdf56e601bd640cbacdfcd3c" name="afc158dffcdf56e601bd640cbacdfcd3c"></a> + </td><td class="memItemRight" valign="bottom"><b>String</b> (const <a class="el" href="classString.html">String</a> &other)</td></tr> +<tr class="separator:afc158dffcdf56e601bd640cbacdfcd3c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a734f34a0b7a42bcad30c368d6e8c5469"><td class="memItemLeft" align="right" valign="top"><a id="a734f34a0b7a42bcad30c368d6e8c5469" name="a734f34a0b7a42bcad30c368d6e8c5469"></a> +<a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classString.html">String</a> &other)</td></tr> +<tr class="separator:a734f34a0b7a42bcad30c368d6e8c5469"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a553fcc11563b3d0f5c020309e8b68843"><td class="memItemLeft" align="right" valign="top"><a id="a553fcc11563b3d0f5c020309e8b68843" name="a553fcc11563b3d0f5c020309e8b68843"></a> + </td><td class="memItemRight" valign="bottom"><b>String</b> (<a class="el" href="classString.html">String</a> &&other)</td></tr> +<tr class="separator:a553fcc11563b3d0f5c020309e8b68843"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3c0ede83ee25c89959a0c4369166d98a"><td class="memItemLeft" align="right" valign="top"><a id="a3c0ede83ee25c89959a0c4369166d98a" name="a3c0ede83ee25c89959a0c4369166d98a"></a> +<a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classString.html">String</a> &&other)</td></tr> +<tr class="separator:a3c0ede83ee25c89959a0c4369166d98a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad76bb9eca15651c67332808cdaad6344"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#ad76bb9eca15651c67332808cdaad6344">read</a> (std::istream &istr)</td></tr> +<tr class="memdesc:ad76bb9eca15651c67332808cdaad6344"><td class="mdescLeft"> </td><td class="mdescRight">Reads <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> from stream. <a href="classString.html#ad76bb9eca15651c67332808cdaad6344">More...</a><br /></td></tr> +<tr class="separator:ad76bb9eca15651c67332808cdaad6344"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7b0ea809587c21bc1d2b87bfee53e628"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a7b0ea809587c21bc1d2b87bfee53e628">write</a> (std::ostream &ostr) const</td></tr> +<tr class="memdesc:a7b0ea809587c21bc1d2b87bfee53e628"><td class="mdescLeft"> </td><td class="mdescRight">Writes <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> to stream. <a href="classString.html#a7b0ea809587c21bc1d2b87bfee53e628">More...</a><br /></td></tr> +<tr class="separator:a7b0ea809587c21bc1d2b87bfee53e628"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3f420d69fbe3de91711dc69148d23cc7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a3f420d69fbe3de91711dc69148d23cc7">compare</a> (const <a class="el" href="classString.html">String</a> &other) const</td></tr> +<tr class="memdesc:a3f420d69fbe3de91711dc69148d23cc7"><td class="mdescLeft"> </td><td class="mdescRight">Compares two strings. <a href="classString.html#a3f420d69fbe3de91711dc69148d23cc7">More...</a><br /></td></tr> +<tr class="separator:a3f420d69fbe3de91711dc69148d23cc7"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:a145347940875a9da605f74c2138be157"><td class="memItemLeft" align="right" valign="top">std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#a145347940875a9da605f74c2138be157">operator>></a> (std::istream &istr, <a class="el" href="classString.html">String</a> &str)</td></tr> +<tr class="memdesc:a145347940875a9da605f74c2138be157"><td class="mdescLeft"> </td><td class="mdescRight">Reads <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> from stream with >> operator. <a href="classString.html#a145347940875a9da605f74c2138be157">More...</a><br /></td></tr> +<tr class="separator:a145347940875a9da605f74c2138be157"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaf68eeb5ffc0983ecc68d49085e33102"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classString.html#aaf68eeb5ffc0983ecc68d49085e33102">operator<<</a> (std::ostream &ostr, const <a class="el" href="classString.html">String</a> &str)</td></tr> +<tr class="memdesc:aaf68eeb5ffc0983ecc68d49085e33102"><td class="mdescLeft"> </td><td class="mdescRight">Writes <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> to stream with << operator. <a href="classString.html#aaf68eeb5ffc0983ecc68d49085e33102">More...</a><br /></td></tr> +<tr class="separator:aaf68eeb5ffc0983ecc68d49085e33102"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p >A dynamically-allocated C-style string with extra features. </p> +<dl class="section remark"><dt>Remarks</dt><dd>There is no buffer allocation, meaning each <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> takes only the amount of memory it needs and every append operation juggles around memory. </dd></dl> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ad3d65397e27bb3c4db1295208cfb1559" name="ad3d65397e27bb3c4db1295208cfb1559"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad3d65397e27bb3c4db1295208cfb1559">◆ </a></span>String() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">String::String </td> + <td>(</td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>length</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The underlying array is allocated with length (+ 1) size. </p> +<p >Allocated with length + 1 size, so there is a terminating zero at the end. </p> + +</div> +</div> +<a id="a3fba40cf6cb11735ffddc355a5ff68f4" name="a3fba40cf6cb11735ffddc355a5ff68f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3fba40cf6cb11735ffddc355a5ff68f4">◆ </a></span>String() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">String::String </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copies str. </p> +<p >\params str C-style string </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a3f420d69fbe3de91711dc69148d23cc7" name="a3f420d69fbe3de91711dc69148d23cc7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3f420d69fbe3de91711dc69148d23cc7">◆ </a></span>compare()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int String::compare </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classString.html">String</a> & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Compares two strings. </p> +<p >\params other C-style string </p><dl class="section return"><dt>Returns</dt><dd>strcmp between underlying C-style string and "other" </dd></dl> + +</div> +</div> +<a id="a64de9ab1af5df9397f8fbd8c79d5f4b6" name="a64de9ab1af5df9397f8fbd8c79d5f4b6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a64de9ab1af5df9397f8fbd8c79d5f4b6">◆ </a></span>operator+=() <span class="overload">[1/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classString.html">String</a> & String::operator+= </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Appends a C-style string. </p> +<p >\params str C-style string </p> + +</div> +</div> +<a id="a2e4c8591498da08d8ffe206fc45f62a5" name="a2e4c8591498da08d8ffe206fc45f62a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2e4c8591498da08d8ffe206fc45f62a5">◆ </a></span>operator+=() <span class="overload">[2/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classString.html">String</a> & String::operator+= </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>number</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Appends a number. </p> +<p >Converts the number to a C-style string and then uses += to append it. </p> + +</div> +</div> +<a id="a0a96f034ca01cc9fbb27e17330c66ca1" name="a0a96f034ca01cc9fbb27e17330c66ca1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0a96f034ca01cc9fbb27e17330c66ca1">◆ </a></span>operator+=() <span class="overload">[3/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classString.html">String</a> & String::operator+= </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>number</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Appends a number. </p> +<p >Converts the number to a C-style string and then uses += to append it. </p> + +</div> +</div> +<a id="aed8480111703abc1f281148c778b0445" name="aed8480111703abc1f281148c778b0445"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aed8480111703abc1f281148c778b0445">◆ </a></span>operator+=() <span class="overload">[4/4]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classString.html">String</a> & String::operator+= </td> + <td>(</td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>number</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Appends a number. </p> +<p >Converts the number to a C-style string and then uses += to append it. </p> + +</div> +</div> +<a id="ad76bb9eca15651c67332808cdaad6344" name="ad76bb9eca15651c67332808cdaad6344"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad76bb9eca15651c67332808cdaad6344">◆ </a></span>read()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void String::read </td> + <td>(</td> + <td class="paramtype">std::istream & </td> + <td class="paramname"><em>istr</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> from stream. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">istr</td><td>An input stream</td></tr> + </table> + </dd> +</dl> +<p>Directly reads bytes from stream (calls <a class="el" href="classString.html#ad76bb9eca15651c67332808cdaad6344" title="Reads String from stream.">read()</a> function). First reads the string length, then the underlying C-style string (including terminating zero).</p> +<dl class="section remark"><dt>Remarks</dt><dd>Doesn't alter the stream in any other way. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with binary ifstream </dd></dl> + +</div> +</div> +<a id="a7b0ea809587c21bc1d2b87bfee53e628" name="a7b0ea809587c21bc1d2b87bfee53e628"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7b0ea809587c21bc1d2b87bfee53e628">◆ </a></span>write()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void String::write </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>ostr</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Writes <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> to stream. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ostr</td><td>An output stream</td></tr> + </table> + </dd> +</dl> +<p>Directly writes bytes to stream (calls <a class="el" href="classString.html#a7b0ea809587c21bc1d2b87bfee53e628" title="Writes String to stream.">write()</a> function). First writes the string length, then the underlying C-style string (including terminating zero).</p> +<dl class="section remark"><dt>Remarks</dt><dd>Doesn't alter the stream in any other way. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with binary ofstream </dd></dl> + +</div> +</div> +<h2 class="groupheader">Friends And Related Function Documentation</h2> +<a id="aaf68eeb5ffc0983ecc68d49085e33102" name="aaf68eeb5ffc0983ecc68d49085e33102"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaf68eeb5ffc0983ecc68d49085e33102">◆ </a></span>operator<<</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::ostream & operator<< </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>ostr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classString.html">String</a> & </td> + <td class="paramname"><em>str</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Writes <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> to stream with << operator. </p> +<p >Uses the stream's << operator to write the underlying C-style string</p> +<dl class="section note"><dt>Note</dt><dd>Best used with std::cout or text std::ofstream </dd></dl> + +</div> +</div> +<a id="a145347940875a9da605f74c2138be157" name="a145347940875a9da605f74c2138be157"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a145347940875a9da605f74c2138be157">◆ </a></span>operator>></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::istream & operator>> </td> + <td>(</td> + <td class="paramtype">std::istream & </td> + <td class="paramname"><em>istr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classString.html">String</a> & </td> + <td class="paramname"><em>str</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Reads <a class="el" href="classString.html" title="A dynamically-allocated C-style string with extra features.">String</a> from stream with >> operator. </p> +<p >Uses the stream's getline function to read the data.</p> +<dl class="section warning"><dt>Warning</dt><dd>It takes at most 1024 characters from the stream! </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with std::cin or text std::ifstream </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/Generic/String/<a class="el" href="String_8h_source.html">String.h</a></li> +<li>src/Generic/String/String.cpp</li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 +</small></address> +</body> +</html> |
