Surface.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/molecular/common/BondTypes.h"
#include "bio/molecular/common/Types.h"
#include "bio/molecular/common/Class.h"
#include "bio/molecular/macros/Macros.h"
#include "EnvironmentDependent.h"
#include "bio/chemical/structure/motif/LinearMotif.h"
 
namespace bio {
namespace molecular {
 
class Molecule;
 
class Surface :
    public Class< Surface >,
    public chemical::LinearMotif< Molecule* >,
    public EnvironmentDependent< Molecule >
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(molecular,
        Surface)
 
    
    Surface(
        Name name,
        Molecule* environment = NULL
    );
 
    Surface(const Surface& toCopy);
 
    virtual ~Surface();
 
    virtual physical::Symmetry* Spin() const;
 
    virtual Code Reify(physical::Symmetry* symmetry);
 
    template < typename T >
    T Manage(T varPtr)
    {
        FormBond(
            varPtr,
            bond_type::Manage());
    }
 
    template < typename T >
    T Use(T varPtr)
    {
        FormBond(
            varPtr,
            bond_type::Use());
    }
 
    template < typename T >
    T Bind(
        T toBind,
        BondType bondType = bond_type::Temporary())
    {
        FormBond(
            toBind,
            bondType
        );
        return toBind;
    }
 
    virtual physical::Wave* Release(
        physical::Wave* toRelease,
        BondType bondType = bond_type::Temporary());
 
    virtual chemical::Substance* Release(
        Name toRelease,
        physical::Perspective< StandardDimension >* perspective = NULL,
        BondType bondType = bond_type::Temporary());
 
    virtual chemical::Substance* Release(
        StandardDimension toRelease,
        physical::Perspective< StandardDimension >* perspective = NULL,
        BondType bondType = bond_type::Temporary());
 
    virtual physical::Waves ReleaseAll(BondType bondType = bond_type::Temporary());
 
    virtual void SetEnvironment(Molecule* environment);
 
    virtual void SetPerspective(Molecule* perspective);
 
    template < typename T >
    T operator+=(T toBind)
    {
        return Bind< T >(toBind);
    }
 
    virtual physical::Wave* operator-=(physical::Wave* toRelease);
 
    virtual chemical::Substance* operator-=(Name toRelease);
 
    virtual chemical::Substance* operator-=(StandardDimension toRelease);
 
    virtual physical::Waves operator--();
};
 
} //molecular namespace
} //bio namespace