~ubuntu-branches/ubuntu/precise/xerces-c/precise

« back to all changes in this revision

Viewing changes to doc/html/apiDocs-3/classStdInInputSource.html

  • Committer: Bazaar Package Importer
  • Author(s): Jay Berkenbilt
  • Date: 2009-02-22 16:52:23 UTC
  • Revision ID: james.westby@ubuntu.com-20090222165223-klimp8u8m73yn9zp
Tags: upstream-3.0.1
ImportĀ upstreamĀ versionĀ 3.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 
3
<title>Xerces-C++: StdInInputSource Class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.4 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
 
12
    <li><a href="files.html"><span>Files</span></a></li>
 
13
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
14
  </ul>
 
15
</div>
 
16
<div class="tabs">
 
17
  <ul>
 
18
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
 
19
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
20
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
21
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
22
  </ul>
 
23
</div>
 
24
<h1>StdInInputSource Class Reference</h1><!-- doxytag: class="StdInInputSource" --><!-- doxytag: inherits="InputSource" -->This class is a derivative of the standard <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> class.  
 
25
<a href="#_details">More...</a>
 
26
<p>
 
27
<div class="dynheader">
 
28
Inheritance diagram for StdInInputSource:</div>
 
29
<div class="dynsection">
 
30
 
 
31
<p><center><img src="classStdInInputSource.png" usemap="#StdInInputSource_map" border="0" alt=""></center>
 
32
<map name="StdInInputSource_map">
 
33
<area href="classInputSource.html" alt="InputSource" shape="rect" coords="0,56,108,80">
 
34
<area href="classXMemory.html" alt="XMemory" shape="rect" coords="0,0,108,24">
 
35
</map>
 
36
</div>
 
37
 
 
38
<p>
 
39
<a href="classStdInInputSource-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 
40
<tr><td></td></tr>
 
41
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
42
<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStdInInputSource.html#e3702d78b3a8e2949a7e364fc7cb0daf">StdInInputSource</a> (<a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
 
44
 
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Since the standard input is a canned source, the constructor is very simple.  <a href="#e3702d78b3a8e2949a7e364fc7cb0daf"></a><br></td></tr>
 
46
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
 
47
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStdInInputSource.html#2650066a02a8ed9f38b7e9496463def8">~StdInInputSource</a> ()</td></tr>
 
48
 
 
49
<tr><td colspan="2"><div class="groupHeader">Virtual methods</div></td></tr>
 
50
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classBinInputStream.html">BinInputStream</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStdInInputSource.html#4f259440552e17f7480435d63d2a33ba">makeStream</a> () const </td></tr>
 
51
 
 
52
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method will return a binary input stream derivative that will parse from the standard input of the local host.  <a href="#4f259440552e17f7480435d63d2a33ba"></a><br></td></tr>
 
53
</table>
 
54
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
55
This class is a derivative of the standard <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> class. 
 
56
<p>
 
57
It provides for the parser access to data via the standard input. This input source is not commonly used, but can be useful when implementing such things as pipe based tools which exchange XML data.<p>
 
58
As with all <a class="el" href="classInputSource.html" title="A single input source for an XML entity.">InputSource</a> derivatives. The primary objective of an input source is to create an input stream via which the parser can spool in data from the referenced source. <hr><h2>Constructor &amp; Destructor Documentation</h2>
 
59
<a class="anchor" name="e3702d78b3a8e2949a7e364fc7cb0daf"></a><!-- doxytag: member="StdInInputSource::StdInInputSource" ref="e3702d78b3a8e2949a7e364fc7cb0daf" args="(MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
 
60
<div class="memitem">
 
61
<div class="memproto">
 
62
      <table class="memname">
 
63
        <tr>
 
64
          <td class="memname">StdInInputSource::StdInInputSource           </td>
 
65
          <td>(</td>
 
66
          <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const &nbsp;</td>
 
67
          <td class="paramname"> <em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code>          </td>
 
68
          <td>&nbsp;)&nbsp;</td>
 
69
          <td width="100%"></td>
 
70
        </tr>
 
71
      </table>
 
72
</div>
 
73
<div class="memdoc">
 
74
 
 
75
<p>
 
76
Since the standard input is a canned source, the constructor is very simple. 
 
77
<p>
 
78
It just uses local platform services to open up the standard input source as file, a new handleof which it gives to each new stream it creates. 
 
79
</div>
 
80
</div><p>
 
81
<a class="anchor" name="2650066a02a8ed9f38b7e9496463def8"></a><!-- doxytag: member="StdInInputSource::~StdInInputSource" ref="2650066a02a8ed9f38b7e9496463def8" args="()" -->
 
82
<div class="memitem">
 
83
<div class="memproto">
 
84
      <table class="memname">
 
85
        <tr>
 
86
          <td class="memname">StdInInputSource::~StdInInputSource           </td>
 
87
          <td>(</td>
 
88
          <td class="paramname">          </td>
 
89
          <td>&nbsp;)&nbsp;</td>
 
90
          <td width="100%"></td>
 
91
        </tr>
 
92
      </table>
 
93
</div>
 
94
<div class="memdoc">
 
95
 
 
96
<p>
 
97
 
 
98
</div>
 
99
</div><p>
 
100
<hr><h2>Member Function Documentation</h2>
 
101
<a class="anchor" name="4f259440552e17f7480435d63d2a33ba"></a><!-- doxytag: member="StdInInputSource::makeStream" ref="4f259440552e17f7480435d63d2a33ba" args="() const " -->
 
102
<div class="memitem">
 
103
<div class="memproto">
 
104
      <table class="memname">
 
105
        <tr>
 
106
          <td class="memname"><a class="el" href="classBinInputStream.html">BinInputStream</a>* StdInInputSource::makeStream           </td>
 
107
          <td>(</td>
 
108
          <td class="paramname">          </td>
 
109
          <td>&nbsp;)&nbsp;</td>
 
110
          <td width="100%"> const<code> [virtual]</code></td>
 
111
        </tr>
 
112
      </table>
 
113
</div>
 
114
<div class="memdoc">
 
115
 
 
116
<p>
 
117
This method will return a binary input stream derivative that will parse from the standard input of the local host. 
 
118
<p>
 
119
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A dynamically allocated binary input stream derivative that can parse from the standardinput. </dd></dl>
 
120
 
 
121
<p>Implements <a class="el" href="classInputSource.html#f0722ef511e91e7b290528b3fd13be09">InputSource</a>.</p>
 
122
 
 
123
</div>
 
124
</div><p>
 
125
<hr>The documentation for this class was generated from the following file:<ul>
 
126
<li><a class="el" href="StdInInputSource_8hpp-source.html">StdInInputSource.hpp</a></ul>
 
127
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 07:56:12 2009 for Xerces-C++ by&nbsp;
 
128
<a href="http://www.doxygen.org/index.html">
 
129
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
 
130
</body>
 
131
</html>