Attraction.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) 2023 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"
#include "bio/physical/common/Class.h"
#include "bio/physical/macro/Macros.h"
#include "bio/physical/relativity/Identifiable.h"
 
namespace bio {
namespace physical {
 
template < typename DIMENSION >
class Attraction:
    public physical::Class< Attraction< DIMENSION > >,
    virtual public Identifiable< DIMENSION >
{
public:
    
    typedef double Force;
    
    Attraction(
        const DIMENSION& dimension = 0, //Invalid Id across DIMENSIONS
        const Force strength = 0.0,
        Pointer< Perspective< DIMENSION > > perspective = NULL
    ):
        physical::Class< Attraction< DIMENSION > >(
            this,
            Pointer< ::bio::physical::Symmetry >()
        ),
        Identifiable< DIMENSION >(dimension, perspective),
        m_dimension(dimension),
        m_strength(strength)
    {}
    
    void SetForce(const Force strength)
    {
        m_strength = strength;
    }
    
    Force GetForce() const
    {
        return m_strength;
    }
 
    bool operator==(const Attraction& other) const
    {
        return m_dimension == other.m_dimension;
    }
    
protected:
    DIMENSION m_dimension;
    Force m_strength;
};
 
} //physical namespace
} //bio namespace