physical/symmetry/Axis.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2022 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <string>
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace physical {
 
class Wave;
 
class Symmetry;
 
class Axis
{
public:
    Axis();
 
    virtual ~Axis();
 
    static ::std::string Failed();
 
    virtual ::std::string Rotate(Pointer< const Symmetry > symmetry) const;
 
    virtual Pointer< Symmetry > Rotate(std::string) const;
 
    virtual ::std::string operator|(Pointer< Wave > particle) const;
 
    virtual Pointer< Symmetry > operator()(std::string encoded) const;
 
protected:
 
    virtual ::std::string Encode(Pointer< const Symmetry > symmetry) const;
 
};
 
} //physical namespace
} //bio namespace