taxon.hpp

Go to the documentation of this file.

#ifndef GENESIS_TAXONOMY_TAXON_H_
#define GENESIS_TAXONOMY_TAXON_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2019 Lucas Czech and HITS gGmbH
 
    This program 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 3 of the License, or
    (at your option) any later version.
 
    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include "genesis/taxonomy/taxonomy.hpp"
#include "genesis/taxonomy/taxon_data.hpp"
 
#include <memory>
#include <string>
 
namespace genesis {
namespace taxonomy {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class Taxon;
void swap( Taxon& lhs, Taxon& rhs );
 
// =================================================================================================
//     Taxon
// =================================================================================================
 
class Taxon : public Taxonomy
{
public:
 
    // -------------------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------------------
 
    friend Taxonomy;
 
    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------
 
    Taxon();
 
    explicit Taxon( std::string const& name, std::string const& rank = "", std::string const& id = "" );
 
    virtual ~Taxon() override = default;
 
    Taxon( Taxon const& );
 
    Taxon( Taxon&& );
 
    Taxon& operator= ( Taxon const& );
 
    Taxon& operator= ( Taxon&& );
 
    friend void swap( Taxon& lhs, Taxon& rhs );
 
    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------
 
    std::string const& name() const;
 
    void               name( std::string const& value );
 
    std::string const& rank() const;
    void               rank( std::string const& value );
 
    std::string const& id() const;
    void               id( std::string const& value );
 
    Taxon const* parent () const;
 
    Taxon*       parent ();
 
    // -------------------------------------------------------------------------
    //     Data
    // -------------------------------------------------------------------------
 
    bool has_data() const;
 
    template< class TaxonDataType >
    TaxonDataType& data()
    {
        return dynamic_cast< TaxonDataType& >( *data_ );
    }
 
    template< class TaxonDataType >
    TaxonDataType const& data() const
    {
        return dynamic_cast< TaxonDataType const& >( *data_ );
    }
 
    template< class TaxonDataType >
    TaxonDataType* data_cast()
    {
        return dynamic_cast< TaxonDataType* >( data_.get() );
    }
 
    template< class TaxonDataType >
    TaxonDataType const* data_cast() const
    {
        return dynamic_cast< TaxonDataType const* >( data_.get() );
    }
 
    BaseTaxonData*       data_ptr();
 
    BaseTaxonData const* data_ptr() const;
 
    Taxon& reset_data( std::unique_ptr< BaseTaxonData > data );
 
    // -------------------------------------------------------------------------
    //     Protected Implementation Details
    // -------------------------------------------------------------------------
 
protected:
 
    Taxon& add_child_( Taxon const& child, bool merge_duplicates ) override;
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
private:
 
    std::string name_;
    std::string rank_;
    std::string id_;
 
    Taxon*      parent_;
 
    std::unique_ptr< BaseTaxonData > data_;
 
};
 
} // namespace taxonomy
} // namespace genesis
 
#endif // include guard