edge.hpp

Go to the documentation of this file.

#ifndef GENESIS_TREE_TREE_EDGE_H_
#define GENESIS_TREE_TREE_EDGE_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2020 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/tree/tree/edge_data.hpp"
#include "genesis/tree/tree/link.hpp"
 
#include "genesis/utils/core/std.hpp"
 
#include <memory>
#include <string>
#include <typeinfo>
 
namespace genesis {
namespace tree {
 
// =================================================================================================
//     Forward declarations
// =================================================================================================
 
class Tree;
class TreeLink;
class TreeNode;
 
class BaseEdgeData;
 
// =================================================================================================
//     Tree Edge
// =================================================================================================
 
class TreeEdge
{
public:
 
    // ---------------------------------------------------------------------
    //     Typedefs and Enums
    // ---------------------------------------------------------------------
 
    friend class Tree;
 
    // ---------------------------------------------------------------------
    //     Constructor and Rule of Five
    // ---------------------------------------------------------------------
 
    TreeEdge()
        : index_( 0 )
        , link_p_( nullptr )
        , link_s_( nullptr )
        , data_( nullptr )
    {}
 
    TreeEdge( size_t index, TreeLink* primary_link, TreeLink* secondary_link )
        : index_(  index )
        , link_p_( primary_link )
        , link_s_( secondary_link )
        , data_( nullptr )
    {}
 
    ~TreeEdge() = default;
 
    // avoid copy constructor and assignment operator.
    // creating copies is maintained by Tree only.
 
    TreeEdge( TreeEdge const& ) = delete;
    TreeEdge( TreeEdge&& )      = delete;
 
    TreeEdge& operator= ( TreeEdge const& ) = delete;
    TreeEdge& operator= ( TreeEdge&& )      = delete;
 
    // ---------------------------------------------------------------------
    //     Accessors
    // ---------------------------------------------------------------------
 
    size_t index() const
    {
        return index_;
    }
 
    TreeLink& primary_link()
    {
        return *link_p_;
    }
 
    TreeLink const& primary_link() const
    {
        return *link_p_;
    }
 
    TreeLink& secondary_link()
    {
        return *link_s_;
    }
 
    TreeLink const& secondary_link() const
    {
        return *link_s_;
    }
 
    TreeNode& primary_node()
    {
        return link_p_->node();
    }
 
    TreeNode const& primary_node() const
    {
        return link_p_->node();
    }
 
    TreeNode& secondary_node()
    {
        return link_s_->node();
    }
 
    TreeNode const& secondary_node() const
    {
        return link_s_->node();
    }
 
    // ---------------------------------------------------------------------
    //     Data Accessors
    // ---------------------------------------------------------------------
 
    bool has_data() const
    {
        return data_.get() != nullptr;
    }
 
    template< class EdgeDataType >
    bool data_is( bool allow_null = false ) const
    {
        if( data_.get() == nullptr ) {
            return allow_null;
        }
        assert( data_.get() );
        auto const& ref = *data_.get();
        return ( typeid( ref ) == typeid( EdgeDataType ));
    }
 
    template< class EdgeDataType >
    bool data_is_derived_from( bool allow_null = false ) const
    {
        if( data_.get() == nullptr ) {
            return allow_null;
        }
        assert( data_.get() );
        return ( dynamic_cast< EdgeDataType const* >( data_.get() ) != nullptr );
    }
 
    template< class EdgeDataType >
    EdgeDataType& data()
    {
        return dynamic_cast< EdgeDataType& >( *data_ );
    }
 
    template< class EdgeDataType >
    EdgeDataType const& data() const
    {
        return dynamic_cast< EdgeDataType const& >( *data_ );
    }
 
    template< class EdgeDataType >
    EdgeDataType* data_cast()
    {
        return dynamic_cast< EdgeDataType* >( data_.get() );
    }
 
    template< class EdgeDataType >
    EdgeDataType const* data_cast() const
    {
        return dynamic_cast< EdgeDataType const* >( data_.get() );
    }
 
    BaseEdgeData* data_ptr()
    {
        return data_.get();
    }
 
    BaseEdgeData const* data_ptr() const
    {
        return data_.get();
    }
 
    // ---------------------------------------------------------------------
    //     Modifiers
    // ---------------------------------------------------------------------
 
    TreeEdge& reset_index( size_t val )
    {
        index_ = val;
        return *this;
    }
 
    TreeEdge& reset_primary_link(   TreeLink* val )
    {
        link_p_ = val;
        return *this;
    }
 
    TreeEdge& reset_secondary_link( TreeLink* val )
    {
        link_s_ = val;
        return *this;
    }
 
    TreeEdge& reset_data( std::unique_ptr< BaseEdgeData > data )
    {
        data_ = std::move( data );
        return *this;
    }
 
    // ---------------------------------------------------------------------
    //     Member Variables
    // ---------------------------------------------------------------------
 
private:
 
    size_t       index_;
 
    TreeLink*    link_p_;
    TreeLink*    link_s_;
 
    std::unique_ptr< BaseEdgeData > data_;
};
 
} // namespace tree
} // namespace genesis
 
#endif // include guard