File: classXSECTXFMInputSource.html

package info (click to toggle)
xml-security-c 1.2.1-3
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 24,464 kB
  • ctags: 6,673
  • sloc: cpp: 36,830; xml: 23,415; sh: 2,365; makefile: 340; perl: 221
file content (157 lines) | stat: -rw-r--r-- 7,955 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XSECTXFMInputSource Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>XSECTXFMInputSource Class Reference<br>
<small>
[<a class="el" href="group__interfaces.html">Classes that interface applications to XML Security C.</a>]</small>
</h1><code>#include &lt;<a class="el" href="XSECTXFMInputSource_8hpp-source.html">XSECTXFMInputSource.hpp</a>&gt;</code>
<p>
Collaboration diagram for XSECTXFMInputSource:<p><center><img src="classXSECTXFMInputSource__coll__graph.png" border="0" usemap="#XSECTXFMInputSource__coll__map" alt="Collaboration graph"></center>
<map name="XSECTXFMInputSource__coll__map">
<area href="classTXFMChain.html" shape="rect" coords="199,462,293,486" alt="">
<area href="classTXFMBase.html" shape="rect" coords="202,372,290,396" alt="">
<area href="classXSECNameSpaceExpander.html" shape="rect" coords="7,281,197,305" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="11,190,193,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="89,9,171,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="179,100,297,124" alt="">
<area href="classXSECXPathNodeList.html" shape="rect" coords="221,281,370,305" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECTXFMInputSource-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
InputSource wrapper for a TXFMList. 
<p>
This class provides a wrapper for a TXFMList. It is used to provide an input to the Xerces Parser.<p>
<dl compact><dt><b>Note:</b></dt><dd>This is a one-off use class. In the process of providing bytes to the parser, it runs through the transforms, which (currently) cannot be reset. </dd></dl>

<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECTXFMInputSource.html#z227_0">XSECTXFMInputSource</a> (<a class="el" href="classTXFMChain.html">TXFMChain</a> *lst, bool deleteWhenDone=true)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct around an existing transform list.  <a href="#z227_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECTXFMInputSource.html#z227_1">~XSECTXFMInputSource</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#z227_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Stream management methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
BinInputStream *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECTXFMInputSource.html#z228_0">makeStream</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Interface method.  <a href="#z228_0"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z227_0" doxytag="XSECTXFMInputSource::XSECTXFMInputSource"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">XSECTXFMInputSource::XSECTXFMInputSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classTXFMChain.html">TXFMChain</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>lst</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>deleteWhenDone</em> = <code>true</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct around an existing transform list. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>lst</em>&nbsp;</td><td>The final TXFM element in the input chain. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>deleteWhenDone</em>&nbsp;</td><td>Flag to instruct the class to delete the chain when done. By default set to true. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z227_1" doxytag="XSECTXFMInputSource::~XSECTXFMInputSource"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual XSECTXFMInputSource::~XSECTXFMInputSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Destructor. 
<p>
Delete the object. If deleteWhenDone was set during construction, will delete the chain if it has not already been done.     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z228_0" doxytag="XSECTXFMInputSource::makeStream"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER BinInputStream* XSECTXFMInputSource::makeStream           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Interface method. 
<p>
Returns an InputStream that can be read by the parser     </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECTXFMInputSource_8hpp-source.html">XSECTXFMInputSource.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:46:00 2005 for XML-Security-C by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>