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
|
// Copyright (C) 1999-2003 Paul O. Lewis
//
// This file is part of NCL (Nexus Class Library) version 2.0.
//
// NCL is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// NCL is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with NCL; if not, write to the Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
#ifndef NCL_NXSBLOCK_H
#define NCL_NXSBLOCK_H
class NxsReader;
/*----------------------------------------------------------------------------------------------------------------------
| This is the base class from which all block classes are derived. A NxsBlock-derived class encapsulates a Nexus block
| (e.g. DATA block, TREES block, etc.). The abstract virtual function Read must be overridden for each derived class
| to provide the ability to read everything following the block name (which is read by the NxsReader object) to the
| end or endblock statement. Derived classes must provide their own data storage and access functions. The abstract
| virtual function Report must be overridden to provide some feedback to user on contents of block. The abstract
| virtual function Reset must be overridden to empty the block of all its contents, restoring it to its
| just-constructed state.
*/
class NxsBlock
{
friend class NxsReader;
public:
NxsBlock();
virtual ~NxsBlock();
void SetNexus(NxsReader *nxsptr);
NxsString GetID();
bool IsEmpty();
void Enable();
void Disable();
bool IsEnabled();
bool IsUserSupplied();
virtual unsigned CharLabelToNumber(NxsString s);
virtual unsigned TaxonLabelToNumber(NxsString s);
virtual void SkippingCommand(NxsString commandName);
virtual void Report(std::ostream &out);
virtual void Reset();
NxsString errormsg; /* workspace for creating error messages */
protected:
bool isEmpty; /* true if this object is currently storing data */
bool isEnabled; /* true if this block is currently ebabled */
bool isUserSupplied; /* true if this object has been read from a file; false otherwise */
NxsReader *nexus; /* pointer to the Nexus file reader object */
NxsBlock *next; /* pointer to next block in list */
NxsString id; /* holds name of block (e.g., "DATA", "TREES", etc.) */
virtual void Read(NxsToken &token);
};
#endif
|
