name.hpp

Go to the documentation of this file.

#ifndef GENESIS_PLACEMENT_PQUERY_NAME_H_
#define GENESIS_PLACEMENT_PQUERY_NAME_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 <string>
 
namespace genesis {
namespace placement {
 
// =================================================================================================
//     Pquery Name
// =================================================================================================
 
class PqueryName
{
public:
 
    // -------------------------------------------------------------------
    //     Constructor and Rule of Five
    // -------------------------------------------------------------------
 
    PqueryName () = default;
 
    explicit PqueryName( std::string const& name, double multiplicity = 1.0 )
        : name( name )
        , multiplicity( multiplicity )
    {}
 
    ~PqueryName() = default;
 
    PqueryName( PqueryName const& ) = default;
    PqueryName( PqueryName&& )      = default;
 
    PqueryName& operator= ( PqueryName const& ) = default;
    PqueryName& operator= ( PqueryName&& )      = default;
 
    // -------------------------------------------------------------------
    //     Conversion
    // -------------------------------------------------------------------
 
    operator std::string&()
    {
        return name;
    }
 
    operator std::string const&() const
    {
        return name;
    }
 
    // -------------------------------------------------------------------
    //     Public Property Data Members
    // -------------------------------------------------------------------
 
    // Yes, the following members are public data members. It's neither nice nor consistent,
    // but makes life so much easier for the moment. Maybe we'll change that in the future...
 
    std::string name;
 
    double multiplicity = 1.0;
 
};
 
} // namespace placement
} // namespace genesis
 
#endif // include guard