Debian Codegraph @

doc/artificialFastqGenerator/class-use/Read.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (version 1.7.0_51) on Wed Oct 01 16:41:56 BST 2014 -->
6 <title>Uses of Class artificialFastqGenerator.Read</title>
7 <meta name="date" content="2014-10-01">
8 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
9 </head>
10 <body>
11 <script type="text/javascript"><!--
12 if (location.href.indexOf('is-external=true') == -1) {
13 parent.document.title="Uses of Class artificialFastqGenerator.Read";
14 }
15 //-->
16 </script>
17 <noscript>
18 <div>JavaScript is disabled on your browser.</div>
19 </noscript>
20 <!-- ========= START OF TOP NAVBAR ======= -->
21 <div class="topNav"><a name="navbar_top">
22 <!-- -->
23 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24 <!-- -->
25 </a>
26 <ul class="navList" title="Navigation">
27 <li><a href="../../artificialFastqGenerator/package-summary.html">Package</a></li>
28 <li><a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Class</a></li>
29 <li class="navBarCell1Rev">Use</li>
30 <li><a href="../package-tree.html">Tree</a></li>
31 <li><a href="../../deprecated-list.html">Deprecated</a></li>
32 <li><a href="../../index-files/index-1.html">Index</a></li>
33 <li><a href="../../help-doc.html">Help</a></li>
34 </ul>
35 </div>
36 <div class="subNav">
37 <ul class="navList">
38 <li>Prev</li>
39 <li>Next</li>
40 </ul>
41 <ul class="navList">
42 <li><a href="../../index.html?artificialFastqGenerator/class-use/Read.html" target="_top">Frames</a></li>
43 <li><a href="Read.html" target="_top">No Frames</a></li>
44 </ul>
45 <ul class="navList" id="allclasses_navbar_top">
46 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
47 </ul>
48 <div>
49 <script type="text/javascript"><!--
50 allClassesLink = document.getElementById("allclasses_navbar_top");
51 if(window==top) {
52 allClassesLink.style.display = "block";
53 }
54 else {
55 allClassesLink.style.display = "none";
56 }
57 //-->
58 </script>
59 </div>
60 <a name="skip-navbar_top">
61 <!-- -->
62 </a></div>
63 <!-- ========= END OF TOP NAVBAR ========= -->
64 <div class="header">
65 <h2 title="Uses of Class artificialFastqGenerator.Read" class="title">Uses of Class<br>artificialFastqGenerator.Read</h2>
66 </div>
67 <div class="classUseContainer">
68 <ul class="blockList">
69 <li class="blockList">
70 <ul class="blockList">
71 <li class="blockList"><a name="artificialFastqGenerator">
72 <!-- -->
73 </a>
74 <h3>Uses of <a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a> in <a href="../../artificialFastqGenerator/package-summary.html">artificialFastqGenerator</a></h3>
75 <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
76 <caption><span>Methods in <a href="../../artificialFastqGenerator/package-summary.html">artificialFastqGenerator</a> that return <a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></span><span class="tabEnd">&nbsp;</span></caption>
77 <tr>
78 <th class="colFirst" scope="col">Modifier and Type</th>
79 <th class="colLast" scope="col">Method and Description</th>
80 </tr>
81 <tbody>
82 <tr class="altColor">
83 <td class="colFirst"><code><a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></code></td>
84 <td class="colLast"><span class="strong">Read.</span><code><strong><a href="../../artificialFastqGenerator/Read.html#getPairedEndRead()">getPairedEndRead</a></strong>()</code>
85 <div class="block">Get the read with which this read object forms a pair.</div>
86 </td>
87 </tr>
88 </tbody>
89 </table>
90 <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
91 <caption><span>Methods in <a href="../../artificialFastqGenerator/package-summary.html">artificialFastqGenerator</a> that return types with arguments of type <a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></span><span class="tabEnd">&nbsp;</span></caption>
92 <tr>
93 <th class="colFirst" scope="col">Modifier and Type</th>
94 <th class="colLast" scope="col">Method and Description</th>
95 </tr>
96 <tbody>
97 <tr class="altColor">
98 <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&gt;</code></td>
99 <td class="colLast"><span class="strong">Nucleobase.</span><code><strong><a href="../../artificialFastqGenerator/Nucleobase.html#getCoveringReads()">getCoveringReads</a></strong>()</code>
100 <div class="block">Get the list of covering reads - the reads which include this nucleobase.</div>
101 </td>
102 </tr>
103 </tbody>
104 </table>
105 <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
106 <caption><span>Methods in <a href="../../artificialFastqGenerator/package-summary.html">artificialFastqGenerator</a> with parameters of type <a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></span><span class="tabEnd">&nbsp;</span></caption>
107 <tr>
108 <th class="colFirst" scope="col">Modifier and Type</th>
109 <th class="colLast" scope="col">Method and Description</th>
110 </tr>
111 <tbody>
112 <tr class="altColor">
113 <td class="colFirst"><code>void</code></td>
114 <td class="colLast"><span class="strong">Nucleobase.</span><code><strong><a href="../../artificialFastqGenerator/Nucleobase.html#addCoveringRead(artificialFastqGenerator.Read)">addCoveringRead</a></strong>(<a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;read)</code>
115 <div class="block">Add a read to the list of reads which cover this nucleobase.</div>
116 </td>
117 </tr>
118 <tr class="rowColor">
119 <td class="colFirst"><code>void</code></td>
120 <td class="colLast"><span class="strong">Read.</span><code><strong><a href="../../artificialFastqGenerator/Read.html#setPairedEndRead(artificialFastqGenerator.Read)">setPairedEndRead</a></strong>(<a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;pairedEndRead)</code>
121 <div class="block">Set the read with which this read object forms a pair.</div>
122 </td>
123 </tr>
124 <tr class="altColor">
125 <td class="colFirst"><code>void</code></td>
126 <td class="colLast"><span class="strong">Read.</span><code><strong><a href="../../artificialFastqGenerator/Read.html#updateNucleobaseCoverage(artificialFastqGenerator.Read)">updateNucleobaseCoverage</a></strong>(<a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;read)</code>
127 <div class="block">For each of the reference genome nucleobases in this read, add
128 the read into the nucleobase's covering reads ArrayList.</div>
129 </td>
130 </tr>
131 </tbody>
132 </table>
133 <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
134 <caption><span>Constructors in <a href="../../artificialFastqGenerator/package-summary.html">artificialFastqGenerator</a> with parameters of type <a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></span><span class="tabEnd">&nbsp;</span></caption>
135 <tr>
136 <th class="colOne" scope="col">Constructor and Description</th>
137 </tr>
138 <tbody>
139 <tr class="altColor">
140 <td class="colLast"><code><strong><a href="../../artificialFastqGenerator/Read.html#Read(java.util.ArrayList, long, artificialFastqGenerator.Read, boolean, char[], char[], int, int)">Read</a></strong>(java.util.ArrayList&lt;<a href="../../artificialFastqGenerator/Nucleobase.html" title="class in artificialFastqGenerator">Nucleobase</a>&gt;&nbsp;sequence,
141 long&nbsp;uniqueID,
142 <a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a>&nbsp;pairedEndRead,
143 boolean&nbsp;leftPEAndNeedsWriting,
144 char[]&nbsp;encodedQualityScores,
145 char[]&nbsp;genotypesThatAreRead,
146 int&nbsp;xCoordinate,
147 int&nbsp;yCoordinate)</code>
148 <div class="block">Initialise a new Read object.</div>
149 </td>
150 </tr>
151 </tbody>
152 </table>
153 </li>
154 </ul>
155 </li>
156 </ul>
157 </div>
158 <!-- ======= START OF BOTTOM NAVBAR ====== -->
159 <div class="bottomNav"><a name="navbar_bottom">
160 <!-- -->
161 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
162 <!-- -->
163 </a>
164 <ul class="navList" title="Navigation">
165 <li><a href="../../artificialFastqGenerator/package-summary.html">Package</a></li>
166 <li><a href="../../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Class</a></li>
167 <li class="navBarCell1Rev">Use</li>
168 <li><a href="../package-tree.html">Tree</a></li>
169 <li><a href="../../deprecated-list.html">Deprecated</a></li>
170 <li><a href="../../index-files/index-1.html">Index</a></li>
171 <li><a href="../../help-doc.html">Help</a></li>
172 </ul>
173 </div>
174 <div class="subNav">
175 <ul class="navList">
176 <li>Prev</li>
177 <li>Next</li>
178 </ul>
179 <ul class="navList">
180 <li><a href="../../index.html?artificialFastqGenerator/class-use/Read.html" target="_top">Frames</a></li>
181 <li><a href="Read.html" target="_top">No Frames</a></li>
182 </ul>
183 <ul class="navList" id="allclasses_navbar_bottom">
184 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
185 </ul>
186 <div>
187 <script type="text/javascript"><!--
188 allClassesLink = document.getElementById("allclasses_navbar_bottom");
189 if(window==top) {
190 allClassesLink.style.display = "block";
191 }
192 else {
193 allClassesLink.style.display = "none";
194 }
195 //-->
196 </script>
197 </div>
198 <a name="skip-navbar_bottom">
199 <!-- -->
200 </a></div>
201 <!-- ======== END OF BOTTOM NAVBAR ======= -->
202 </body>
203 </html>