Wave.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) 2021 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 "bio/physical/common/Types.h"
 
//@formatter:off
#if BIO_CPP_VERSION < 11
    #include <stdint.h>
#else
    #include <cstdint>
#endif
//@formatter:on
 
namespace bio {
 
//the easy way out...
//see AsAtom()
namespace chemical {
class Atom;
}
 
namespace physical {
 
class Symmetry;
 
typedef std::vector< Symmetry* > Symmetries;
 
class Wave;
 
typedef std::vector< Wave* > Waves;
typedef std::vector< const Wave* > ConstWaves;
 
class Wave
{
public:
 
    Wave(Symmetry* symmetry = NULL);
 
    virtual ~Wave();
 
    virtual Wave* Clone() const;
 
    virtual Properties GetProperties() const;
 
    static Properties GetResonanceBetween(ConstWaves waves);
 
    static Properties GetResonanceBetween(
        const Wave* wave1,
        const Wave* wave2
    );
 
    static Properties GetResonanceBetween(
        const Wave* wave,
        const Properties& properties
    );
 
    virtual Symmetry* Spin() const;
 
    virtual Code Reify(Symmetry* symmetry);
 
    virtual Wave* Modulate(Wave* signal);
 
    virtual Wave* Demodulate();
 
    virtual const Wave* Demodulate() const;
 
    virtual Code Attenuate(const Wave* other);
 
    virtual Code Disattenuate(const Wave* other);
 
    virtual Wave* AsWave()
    {
        return this;
    }
 
    virtual const Wave* AsWave() const
    {
        return this;
    }
 
    virtual chemical::Atom* AsAtom()
    {
        return NULL;
    }
 
    virtual const chemical::Atom* AsAtom() const
    {
        return NULL;
    }
 
    //HERE THERE BE OPERATORS
 
    virtual void operator|(Symmetry* symmetry);
 
    virtual Wave* operator*(Wave* signal);
 
    virtual Wave* operator*();
 
    virtual const Wave* operator*() const;
 
    virtual void operator+(const Wave* other);
 
    virtual void operator-(const Wave* other);
 
protected:
    Symmetry* m_symmetry;
 
    Wave* m_signal;
};
 
} //physical namespace
} //bio namespace