← Back to branch summary

~ubuntu-branches/ubuntu/wily/qca2/wily-proposed

« back to all changes in this revision

Viewing changes to apidocs/html/classQCA_1_1KeyLength.html

  • Committer: Bazaar Package Importer
  • Author(s): Jan Niehusmann
  • Date: 2007-10-27 18:51:54 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20071027185154-4ir9ys3h2q9fofrw
Tags: 2.0.0-2
Upload to unstable

Show diffs side-by-side

added added

removed removed

Lines of Context:
apidocs/html/classQCA_1_1KeyLength.html
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
3
<title>Qt Cryptographic Architecture: QCA::KeyLength Class Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.4.6 -->
 
7
<!-- Generated by Doxygen 1.5.2 -->
8
8
<div class="tabs">
9
9
  <ul>
10
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="modules.html"><span>Modules</span></a></li>
11
12
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12
 
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
 
13
    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13
14
    <li><a href="files.html"><span>Files</span></a></li>
14
15
    <li><a href="dirs.html"><span>Directories</span></a></li>
15
16
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16
17
    <li><a href="examples.html"><span>Examples</span></a></li>
17
 
  </ul></div>
 
18
  </ul>
 
19
</div>
18
20
<div class="tabs">
19
21
  <ul>
20
22
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21
23
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22
24
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23
 
  </ul></div>
 
25
  </ul>
 
26
</div>
24
27
<div class="nav">
25
28
<a class="el" href="namespaceQCA.html">QCA</a>::<a class="el" href="classQCA_1_1KeyLength.html">KeyLength</a></div>
26
 
<h1>QCA::KeyLength Class Reference</h1><!-- doxytag: class="QCA::KeyLength" -->Simple container for acceptable key lengths.  
 
29
<h1>QCA::KeyLength Class Reference<br>
 
30
<small>
 
31
[<a class="el" href="group__UserAPI.html">QCA user API</a>]</small>
 
32
</h1><!-- doxytag: class="QCA::KeyLength" -->Simple container for acceptable key lengths.  
27
33
<a href="#_details">More...</a>
28
34
<p>
29
35
<code>#include &lt;<a class="el" href="qca__core_8h-source.html">QtCrypto</a>&gt;</code>
30
36
<p>
31
37
Collaboration diagram for QCA::KeyLength:<p><center><img src="classQCA_1_1KeyLength__coll__graph.png" border="0" usemap="#QCA_1_1KeyLength__coll__map" alt="Collaboration graph"></center>
 
38
<map name="QCA_1_1KeyLength__coll__map">
 
39
<area shape="rect" title="_min\n_max\n_multiple" alt="" coords="71,31,79,39"><area shape="rect" title="_min\n_max\n_multiple" alt="" coords="71,133,79,141"></map>
32
40
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classQCA_1_1KeyLength-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
33
41
<tr><td></td></tr>
34
42
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
35
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#125d135d18a4e9c3d1a2ddaa05614c9a">KeyLength</a> (int min, int max, int multiple)</td></tr>
36
44
 
37
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#28133f7c298597f29cb9f77af50a5c97">minimum</a> () const </td></tr>
38
 
 
39
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#0372698f88e2a8f0cc48290ef8c4d05c">maximum</a> () const </td></tr>
40
 
 
41
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#40fae6b408f546a9c1c44ea6f0eb14b8">multiple</a> () const </td></tr>
 
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#b52bfff3fa7be18c719394410ded15ef">maximum</a> () const</td></tr>
 
46
 
 
47
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#237e16f1f1d1b30b60765528bf9d277b">minimum</a> () const</td></tr>
 
48
 
 
49
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1KeyLength.html#80e1d9b5de257b30213f5860495e92c1">multiple</a> () const</td></tr>
42
50
 
43
51
</table>
44
52
<hr><a name="_details"></a><h2>Detailed Description</h2>
45
53
Simple container for acceptable key lengths. 
46
54
<p>
47
 
The <a class="el" href="classQCA_1_1KeyLength.html">KeyLength</a> specifies the minimum and maximum byte sizes allowed for a key, as well as a "multiple" which the key size must evenly divide into.<p>
48
 
As an example, if the key can be 4, 8 or 12 bytes, you can express this as <div class="fragment"><pre class="fragment"><a class="code" href="classQCA_1_1KeyLength.html#125d135d18a4e9c3d1a2ddaa05614c9a">KeyLength</a> keyLen( 4, 12, 4 );
 
55
The <a class="el" href="classQCA_1_1KeyLength.html" title="Simple container for acceptable key lengths.">KeyLength</a> specifies the minimum and maximum byte sizes allowed for a key, as well as a "multiple" which the key size must evenly divide into.<p>
 
56
As an example, if the key can be 4, 8 or 12 bytes, you can express this as <div class="fragment"><pre class="fragment"><a class="code" href="classQCA_1_1KeyLength.html#125d135d18a4e9c3d1a2ddaa05614c9a" title="Construct a KeyLength object.">KeyLength</a> keyLen( 4, 12, 4 );
49
57
</pre></div><p>
50
 
If you want to express a <a class="el" href="classQCA_1_1KeyLength.html">KeyLength</a> that takes any number of bytes (including zero), you may want to use <div class="fragment"><pre class="fragment"><span class="preprocessor">#include&lt;limits&gt;</span>
51
 
<a class="code" href="classQCA_1_1KeyLength.html#125d135d18a4e9c3d1a2ddaa05614c9a">KeyLength</a>( 0, std::numeric_limits&lt;int&gt;::max(), 1 );
 
58
If you want to express a <a class="el" href="classQCA_1_1KeyLength.html" title="Simple container for acceptable key lengths.">KeyLength</a> that takes any number of bytes (including zero), you may want to use <div class="fragment"><pre class="fragment"><span class="preprocessor">#include&lt;limits&gt;</span>
 
59
<a class="code" href="classQCA_1_1KeyLength.html#125d135d18a4e9c3d1a2ddaa05614c9a" title="Construct a KeyLength object.">KeyLength</a>( 0, std::numeric_limits&lt;int&gt;::max(), 1 );
52
60
</pre></div> <dl compact><dt><b>Examples: </b></dt><dd>
53
61
 
54
62
<p>
55
 
<a class="el" href="aes-cmac_8cpp-example.html#_a8">aes-cmac.cpp</a>.</dl>
 
63
<a class="el" href="aes-cmac_8cpp-example.html#_a12">aes-cmac.cpp</a>.</dl>
56
64
<p>
57
65
<hr><h2>Constructor &amp; Destructor Documentation</h2>
58
 
<a class="anchor" name="125d135d18a4e9c3d1a2ddaa05614c9a"></a><!-- doxytag: member="QCA::KeyLength::KeyLength" ref="125d135d18a4e9c3d1a2ddaa05614c9a" args="(int min, int max, int multiple)" --><p>
59
 
<table class="mdTable" cellpadding="2" cellspacing="0">
60
 
  <tr>
61
 
    <td class="mdRow">
62
 
      <table cellpadding="0" cellspacing="0" border="0">
63
 
        <tr>
64
 
          <td class="md" nowrap valign="top">QCA::KeyLength::KeyLength           </td>
65
 
          <td class="md" valign="top">(&nbsp;</td>
66
 
          <td class="md" nowrap valign="top">int&nbsp;</td>
67
 
          <td class="mdname" nowrap> <em>min</em>, </td>
68
 
        </tr>
69
 
        <tr>
70
 
          <td class="md" nowrap align="right"></td>
71
 
          <td class="md"></td>
72
 
          <td class="md" nowrap>int&nbsp;</td>
73
 
          <td class="mdname" nowrap> <em>max</em>, </td>
74
 
        </tr>
75
 
        <tr>
76
 
          <td class="md" nowrap align="right"></td>
77
 
          <td class="md"></td>
78
 
          <td class="md" nowrap>int&nbsp;</td>
79
 
          <td class="mdname" nowrap> <em>multiple</em></td>
80
 
        </tr>
81
 
        <tr>
82
 
          <td class="md"></td>
83
 
          <td class="md">)&nbsp;</td>
84
 
          <td class="md" colspan="2"><code> [inline]</code></td>
 
66
<a class="anchor" name="125d135d18a4e9c3d1a2ddaa05614c9a"></a><!-- doxytag: member="QCA::KeyLength::KeyLength" ref="125d135d18a4e9c3d1a2ddaa05614c9a" args="(int min, int max, int multiple)" -->
 
67
<div class="memitem">
 
68
<div class="memproto">
 
69
      <table class="memname">
 
70
        <tr>
 
71
          <td class="memname">QCA::KeyLength::KeyLength           </td>
 
72
          <td>(</td>
 
73
          <td class="paramtype">int&nbsp;</td>
 
74
          <td class="paramname"> <em>min</em>, </td>
 
75
        </tr>
 
76
        <tr>
 
77
          <td class="paramkey"></td>
 
78
          <td></td>
 
79
          <td class="paramtype">int&nbsp;</td>
 
80
          <td class="paramname"> <em>max</em>, </td>
 
81
        </tr>
 
82
        <tr>
 
83
          <td class="paramkey"></td>
 
84
          <td></td>
 
85
          <td class="paramtype">int&nbsp;</td>
 
86
          <td class="paramname"> <em>multiple</em></td><td>&nbsp;</td>
 
87
        </tr>
 
88
        <tr>
 
89
          <td></td>
 
90
          <td>)</td>
 
91
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
85
92
        </tr>
86
93
      </table>
87
 
    </td>
88
 
  </tr>
89
 
</table>
90
 
<table cellspacing="5" cellpadding="0" border="0">
91
 
  <tr>
92
 
    <td>
93
 
      &nbsp;
94
 
    </td>
95
 
    <td>
 
94
</div>
 
95
<div class="memdoc">
96
96
 
97
97
<p>
98
98
Construct a KeyLength object. 
104
104
    <tr><td valign="top"></td><td valign="top"><em>multiple</em>&nbsp;</td><td>the number of bytes that the key must be a multiple of. </td></tr>
105
105
  </table>
106
106
</dl>
107
 
    </td>
108
 
  </tr>
109
 
</table>
 
107
 
 
108
</div>
 
109
</div><p>
110
110
<hr><h2>Member Function Documentation</h2>
111
 
<a class="anchor" name="28133f7c298597f29cb9f77af50a5c97"></a><!-- doxytag: member="QCA::KeyLength::minimum" ref="28133f7c298597f29cb9f77af50a5c97" args="() const " --><p>
112
 
<table class="mdTable" cellpadding="2" cellspacing="0">
113
 
  <tr>
114
 
    <td class="mdRow">
115
 
      <table cellpadding="0" cellspacing="0" border="0">
116
 
        <tr>
117
 
          <td class="md" nowrap valign="top">int QCA::KeyLength::minimum           </td>
118
 
          <td class="md" valign="top">(&nbsp;</td>
119
 
          <td class="mdname1" valign="top" nowrap>          </td>
120
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
121
 
          <td class="md" nowrap> const<code> [inline]</code></td>
122
 
        </tr>
123
 
      </table>
124
 
    </td>
125
 
  </tr>
126
 
</table>
127
 
<table cellspacing="5" cellpadding="0" border="0">
128
 
  <tr>
129
 
    <td>
130
 
      &nbsp;
131
 
    </td>
132
 
    <td>
 
111
<a class="anchor" name="b52bfff3fa7be18c719394410ded15ef"></a><!-- doxytag: member="QCA::KeyLength::maximum" ref="b52bfff3fa7be18c719394410ded15ef" args="() const" -->
 
112
<div class="memitem">
 
113
<div class="memproto">
 
114
      <table class="memname">
 
115
        <tr>
 
116
          <td class="memname">int QCA::KeyLength::maximum           </td>
 
117
          <td>(</td>
 
118
          <td class="paramname">          </td>
 
119
          <td>&nbsp;)&nbsp;</td>
 
120
          <td width="100%"> const<code> [inline]</code></td>
 
121
        </tr>
 
122
      </table>
 
123
</div>
 
124
<div class="memdoc">
 
125
 
 
126
<p>
 
127
Obtain the maximum length for the key, in bytes. 
 
128
<p>
 
129
 
 
130
</div>
 
131
</div><p>
 
132
<a class="anchor" name="237e16f1f1d1b30b60765528bf9d277b"></a><!-- doxytag: member="QCA::KeyLength::minimum" ref="237e16f1f1d1b30b60765528bf9d277b" args="() const" -->
 
133
<div class="memitem">
 
134
<div class="memproto">
 
135
      <table class="memname">
 
136
        <tr>
 
137
          <td class="memname">int QCA::KeyLength::minimum           </td>
 
138
          <td>(</td>
 
139
          <td class="paramname">          </td>
 
140
          <td>&nbsp;)&nbsp;</td>
 
141
          <td width="100%"> const<code> [inline]</code></td>
 
142
        </tr>
 
143
      </table>
 
144
</div>
 
145
<div class="memdoc">
133
146
 
134
147
<p>
135
148
Obtain the minimum length for the key, in bytes. 
136
149
<p>
137
 
    </td>
138
 
  </tr>
139
 
</table>
140
 
<a class="anchor" name="0372698f88e2a8f0cc48290ef8c4d05c"></a><!-- doxytag: member="QCA::KeyLength::maximum" ref="0372698f88e2a8f0cc48290ef8c4d05c" args="() const " --><p>
141
 
<table class="mdTable" cellpadding="2" cellspacing="0">
142
 
  <tr>
143
 
    <td class="mdRow">
144
 
      <table cellpadding="0" cellspacing="0" border="0">
145
 
        <tr>
146
 
          <td class="md" nowrap valign="top">int QCA::KeyLength::maximum           </td>
147
 
          <td class="md" valign="top">(&nbsp;</td>
148
 
          <td class="mdname1" valign="top" nowrap>          </td>
149
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
150
 
          <td class="md" nowrap> const<code> [inline]</code></td>
151
 
        </tr>
152
 
      </table>
153
 
    </td>
154
 
  </tr>
155
 
</table>
156
 
<table cellspacing="5" cellpadding="0" border="0">
157
 
  <tr>
158
 
    <td>
159
 
      &nbsp;
160
 
    </td>
161
 
    <td>
162
150
 
163
 
<p>
164
 
Obtain the maximum length for the key, in bytes. 
165
 
<p>
166
 
    </td>
167
 
  </tr>
168
 
</table>
169
 
<a class="anchor" name="40fae6b408f546a9c1c44ea6f0eb14b8"></a><!-- doxytag: member="QCA::KeyLength::multiple" ref="40fae6b408f546a9c1c44ea6f0eb14b8" args="() const " --><p>
170
 
<table class="mdTable" cellpadding="2" cellspacing="0">
171
 
  <tr>
172
 
    <td class="mdRow">
173
 
      <table cellpadding="0" cellspacing="0" border="0">
 
151
</div>
 
152
</div><p>
 
153
<a class="anchor" name="80e1d9b5de257b30213f5860495e92c1"></a><!-- doxytag: member="QCA::KeyLength::multiple" ref="80e1d9b5de257b30213f5860495e92c1" args="() const" -->
 
154
<div class="memitem">
 
155
<div class="memproto">
 
156
      <table class="memname">
174
157
        <tr>
175
 
          <td class="md" nowrap valign="top">int QCA::KeyLength::multiple           </td>
176
 
          <td class="md" valign="top">(&nbsp;</td>
177
 
          <td class="mdname1" valign="top" nowrap>          </td>
178
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
179
 
          <td class="md" nowrap> const<code> [inline]</code></td>
 
158
          <td class="memname">int QCA::KeyLength::multiple           </td>
 
159
          <td>(</td>
 
160
          <td class="paramname">          </td>
 
161
          <td>&nbsp;)&nbsp;</td>
 
162
          <td width="100%"> const<code> [inline]</code></td>
180
163
        </tr>
181
164
      </table>
182
 
    </td>
183
 
  </tr>
184
 
</table>
185
 
<table cellspacing="5" cellpadding="0" border="0">
186
 
  <tr>
187
 
    <td>
188
 
      &nbsp;
189
 
    </td>
190
 
    <td>
 
165
</div>
 
166
<div class="memdoc">
191
167
 
192
168
<p>
193
169
Return the number of bytes that the key must be a multiple of. 
194
170
<p>
195
 
If this is one, then anything between minimum and maximum (inclusive) is acceptable.     </td>
196
 
  </tr>
197
 
</table>
 
171
If this is one, then anything between minimum and maximum (inclusive) is acceptable. 
 
172
</div>
 
173
</div><p>
198
174
<hr>The documentation for this class was generated from the following file:<ul>
199
175
<li><a class="el" href="qca__core_8h-source.html">qca_core.h</a></ul>
200
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Jul 6 12:15:01 2007 for Qt Cryptographic Architecture by&nbsp;
 
176
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 6 19:14:22 2007 for Qt Cryptographic Architecture by&nbsp;
201
177
<a href="http://www.doxygen.org/index.html">
202
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
178
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
203
179
</body>
204
180
</html>