Bond.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/chemical/common/Types.h"
#include "bio/chemical/common/BondTypes.h"
#include "bio/physical/arrangement/Arrangement.h"
 
namespace bio {
 
namespace physical {
class Wave;
}
 
namespace chemical {
 
class Bond
{
public:
    Bond();
 
    Bond(
        AtomicNumber id,
        physical::Wave* bonded,
        BondType type = bond_type::Unknown());
 
    ~Bond();
 
    bool operator==(const AtomicNumber id) const;
 
    bool operator==(const Bond& other) const;
 
    bool Form(
        AtomicNumber id,
        physical::Wave* bonded,
        BondType type = bond_type::Unknown());
 
    AtomicNumber GetId() const;
 
    physical::Wave* GetBonded();
 
    const physical::Wave* GetBonded() const;
 
    BondType GetType() const;
 
    bool IsEmpty() const;
 
    void Break();
 
private:
    AtomicNumber m_id;
    physical::Wave* m_bonded;
    BondType m_type;
};
 
typedef physical::Arrangement< Bond* > Bonds;
 
} //chemical namespace
} //bio namespace