taxopath_generator.hpp

Go to the documentation of this file.

#ifndef GENESIS_TAXONOMY_FORMATS_TAXOPATH_GENERATOR_H_
#define GENESIS_TAXONOMY_FORMATS_TAXOPATH_GENERATOR_H_

/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2018 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 <string>
#include <vector>

namespace genesis {
namespace taxonomy {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

class Taxon;
class Taxopath;

// =================================================================================================
//     Taxopath Generator
// =================================================================================================

class TaxopathGenerator
{
public:

    enum class TaxonField
    {
        kName,
        kRank,
        kId
    };

    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------

    TaxopathGenerator()  = default;
    ~TaxopathGenerator() = default;

    TaxopathGenerator( TaxopathGenerator const& ) = default;
    TaxopathGenerator( TaxopathGenerator&& )      = default;

    TaxopathGenerator& operator= ( TaxopathGenerator const& ) = default;
    TaxopathGenerator& operator= ( TaxopathGenerator&& )      = default;

    // -------------------------------------------------------------------------
    //     Generating
    // -------------------------------------------------------------------------

    std::string to_string(   Taxopath const& taxopath ) const;

    std::string operator() ( Taxopath const& taxopath ) const;

    std::string to_string(   Taxon const& taxon ) const;

    std::string operator() ( Taxon const& taxon ) const;

    // -------------------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------------------

    TaxopathGenerator& field( TaxonField value );

    TaxonField         field() const;

    TaxopathGenerator& delimiter( std::string const& value );

    std::string        delimiter() const;

    TaxopathGenerator& trim_nested_duplicates( bool value );

    bool               trim_nested_duplicates() const;

    TaxopathGenerator& append_delimiter( bool value );

    bool               append_delimiter() const;

    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------

private:

    TaxonField  field_                  = TaxonField::kName;
    std::string delimiter_              = ";";
    bool        trim_nested_duplicates_ = false;
    bool        append_delimiter_       = false;

};

} // namespace taxonomy
} // namespace genesis

#endif // include guard