A library for working with phylogenetic and population genetic data.
v0.32.0
taxon_data.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_TAXONOMY_TAXON_DATA_H_
2 #define GENESIS_TAXONOMY_TAXON_DATA_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
34 #include <memory>
35 
36 namespace genesis {
37 namespace taxonomy {
38 
39 // =================================================================================================
40 // Taxon Data
41 // =================================================================================================
42 
57 {
58  // -------------------------------------------------------------------
59  // Constructor and Rule of Five
60  // -------------------------------------------------------------------
61 
62 public:
63 
67  virtual ~BaseTaxonData() = default;
68 
75  BaseTaxonData( BaseTaxonData&& ) = delete;
76 
83  BaseTaxonData& operator= ( BaseTaxonData&& ) = delete;
84 
85 protected:
86 
90  BaseTaxonData() = default;
91 
95  BaseTaxonData( BaseTaxonData const& ) = default;
96 
100  BaseTaxonData& operator= ( BaseTaxonData const& ) = default;
101 
102 public:
103 
107  static std::unique_ptr< BaseTaxonData > create()
108  {
109  return std::unique_ptr< BaseTaxonData >( new BaseTaxonData() );
110  }
111 
115  virtual std::unique_ptr< BaseTaxonData > clone() const
116  {
117  return std::unique_ptr< BaseTaxonData >( new BaseTaxonData( *this ));
118  }
119 
120 };
121 
122 } // namespace taxonomy
123 } // namespace genesis
124 
125 #endif // include guard
genesis::taxonomy::BaseTaxonData
Base class for storing data on Taxa of a Taxonomy.
Definition: taxon_data.hpp:56
genesis::taxonomy::BaseTaxonData::~BaseTaxonData
virtual ~BaseTaxonData()=default
Virtual destructor. Needed for polymorphism.
genesis::taxonomy::BaseTaxonData::BaseTaxonData
BaseTaxonData()=default
Protected default constructor. Called from the create() function.
genesis::taxonomy::BaseTaxonData::operator=
BaseTaxonData & operator=(BaseTaxonData &&)=delete
Deleted move assignment.
genesis::taxonomy::BaseTaxonData::create
static std::unique_ptr< BaseTaxonData > create()
Create a new instance of this class. Use instead of default constructor.
Definition: taxon_data.hpp:107
genesis
Container namespace for all symbols of genesis in order to keep them separate when used as a library.
Definition: placement/formats/edge_color.cpp:42
genesis::taxonomy::BaseTaxonData::clone
virtual std::unique_ptr< BaseTaxonData > clone() const
Polymorphically copy an instance of this class. Use instead of copy constructor.
Definition: taxon_data.hpp:115