File: NxsDataBlock.html

package info (click to toggle)
libncl 2.1.18%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,344 kB
  • ctags: 3,526
  • sloc: xml: 43,716; cpp: 30,400; sh: 10,658; python: 231; makefile: 190
file content (106 lines) | stat: -rw-r--r-- 4,461 bytes parent folder | download | duplicates (5)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><title>NEXUS CLASS LIBRARY: NxsDataBlock Class</title>

<style type="text/css">
<!--
@import url(ncl.css);
.quickref {font-family: Arial, sans-serif}
.public {font-weight: bold; color: black; background: white;}
.protected {font-weight: bold; color: teal; background: white;}
.private {font-weight: bold; color: red; background: white;}
.groupheading {font-size: large; font-weight: bold;}
.classy {font-family: Arial, sans-serif; color: navy;}
.variablename {font-weight: bold; color: maroon;}
-->
</style>
</head>
<body>

<table border="1" width="100%">
<tr><td>
<table border="0" width="100%">
<tr>
<td align="left"><span class="classy">NEXUS CLASS LIBRARY</span></td>
<td align="right"><span class="classy"><a href="v2.0index.html">home</a> | <a href="classes.html">classes</a> | <a href="functions.html">functions</a></span></td>
</tr>
</table>
</td></tr>
</table>

<h1>Class NxsDataBlock</h1>

<h2>Member Functions</h2>
<a href="#NxsDataBlock25"><span class="quickref">NxsDataBlock</span></a><a href="#Reset38"><span class="quickref">, Reset</span></a><a href="#TransferTo49"><span class="quickref">, TransferTo</span></a>
<h2>Class Description</h2>

<p>
This class handles reading and storage for the NEXUS block DATA. It is derived from the  <a href="NxsCharactersBlock.html">NxsCharactersBlock</a>  class,  and differs from  <a href="NxsCharactersBlock.html">NxsCharactersBlock</a>  only in name and the fact that <span class="variablename">newtaxa</span> is initially true rather than false.


<h3>Key to symbols and colors</h3>

<p><span class="public">public</span>, <span class="protected">protected</span>, <span class="private">private</span>, <code>A</code> = abstract, <code>C</code> = constructor, <code>D</code> = destructor, <code>I</code> = inline, <code>S</code> = static, <code>V</code> = virtual, <code>F</code> = friend</p>
<p>&nbsp;</p>
<center>
<table border="5" cellpadding="1" cellspacing="0" width="95%">
<tr bgcolor="#CCCCFF">
<td><span class="groupheading">Member Functions</span></td>
</table>
<table border="1" cellpadding="3" cellspacing="0" width="95%">
<tr><td>
<table width="100%" border="0" cellpadding="1">
<tr>
<td>C</td>
<td>&nbsp;</td>
<td align="right" valign="top" width="15%"><code></code></td>
<td>&nbsp;</td>
<td align="left" valign="top" width="82%"><code class="public"><a name="NxsDataBlock25">NxsDataBlock</a></code><code>(NxsTaxaBlock *tb, NxsAssumptionsBlock *ab)</code></td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td><dd>Sets <span class="variablename">id</span> to "DATA" and <span class="variablename">newtaxa</span> to true, and calls the base class (<a href="NxsCharactersBlock.html">NxsCharactersBlock</a>) constructor.</dd></td>
</tr>
</table>
</td></tr>
<tr><td>
<table width="100%" border="0" cellpadding="1">
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td align="right" valign="top" width="15%"><code>void</code></td>
<td>&nbsp;</td>
<td align="left" valign="top" width="82%"><code class="public"><a name="Reset38">Reset</a></code><code>()</code></td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td><dd>Calls Reset function of the parent class (<a href="NxsCharactersBlock.html">NxsCharactersBlock</a>) and resets <span class="variablename">newtaxa</span> to true in preparation for  reading another DATA block.</dd></td>
</tr>
</table>
</td></tr>
<tr><td>
<table width="100%" border="0" cellpadding="1">
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td align="right" valign="top" width="15%"><code>void</code></td>
<td>&nbsp;</td>
<td align="left" valign="top" width="82%"><code class="public"><a name="TransferTo49">TransferTo</a></code><code>(NxsCharactersBlock &charactersblock)</code></td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td><dd>Converts this NxsDataBlock object into a <a href="NxsCharactersBlock.html">NxsCharactersBlock</a> object, storing the result in the supplied  <a href="NxsCharactersBlock.html">NxsCharactersBlock</a> object. This NxsDataBlock object will subsequently say it is empty when asked, and  the <span class="variablename">formerly_datablock</span> data member of <span class="variablename">charactersblock</span> will be set to true.</dd></td>
</tr>
</table>
</td></tr>
</table>
</center>