Molecule.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/Types.h"
#include "bio/molecular/common/Class.h"
#include "bio/molecular/common/Filters.h"
#include "Surface.h"
#include "bio/chemical/structure/motif/LinearMotif.h"
 
namespace bio {
namespace molecular {
 
class Molecule :
    public Class< Molecule >,
    public physical::Perspective< StandardDimension >,
    public chemical::LinearMotif< Surface* >
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(molecular,
        Molecule)
 
     BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS(molecular,
        Molecule,
        &MoleculePerspective::Instance(),
        filter::Molecular())
 
    
    Molecule(const Molecule& toCopy);
 
    virtual ~Molecule();
 
    template < typename T >
    StandardDimension Use(
        Name varName,
        T* varPtr
    )
    {
        BIO_SANITIZE(!RotateTo(varName), ,
            return InvalidId());
        Surface* toAdd = new Surface(
            varName,
            this
        );
        toAdd->Use(varPtr);
        Add< Surface* >(toAdd);
        return toAdd->GetId();
    }
 
    StandardDimension Define(Name varName)
    {
        BIO_SANITIZE(!RotateTo(varName), ,
            return InvalidId());
        Surface* toAdd = new Surface(
            varName,
            this
        );
        Add< Surface* >(toAdd);
        return toAdd->GetId();
    }
 
    template < typename T >
    StandardDimension Define(Name varName)
    {
        BIO_SANITIZE(!RotateTo(varName), ,
            return InvalidId());
        Surface* toAdd = new Surface(
            varName,
            this
        );
        toAdd->Manage(new T());
        Add< Surface* >(toAdd);
        return toAdd->GetId();
    }
 
    template < typename T >
    StandardDimension Define(
        Name varName,
        const T& assignment
    )
    {
        BIO_SANITIZE(!RotateTo(varName), ,
            return InvalidId());
        Surface* toAdd = new Surface(
            varName,
            this
        );
        toAdd->Manage(new T(assignment));
        Add< Surface* >(toAdd);
        return toAdd->GetId();
    }
 
    virtual Surface* RotateTo(StandardDimension surfaceId);
 
    virtual const Surface* RotateTo(StandardDimension surfaceId) const;
 
    template < typename T >
    T RotateTo(StandardDimension surfaceId) const
    {
        return ChemicalCast< T >(RotateTo(surfaceId));
    }
 
    virtual Surface* RotateTo(Name surfaceName);
 
    virtual const Surface* RotateTo(Name surfaceName) const;
 
    template < typename T >
    T RotateTo(Name surfaceName) const
    {
        return ChemicalCast< T >(RotateTo(surfaceName));
    }
 
    virtual bool DuplicateFrom(
        Molecule* source,
        Name surface
    );
 
    virtual bool TransferFrom(
        Molecule* source,
        Name surface
    );
 
    virtual physical::Symmetry* Spin() const;
 
    virtual Code Reify(physical::Symmetry* symmetry);
 
    virtual Surface* operator()(StandardDimension surfaceId);
 
    virtual const Surface* operator()(StandardDimension surfaceId) const;
 
    template < typename T >
    Surface* operator()(StandardDimension surfaceId)
    {
        return ChemicalCast< T >(RotateTo(surfaceId));
    }
 
    virtual Surface* operator()(Name name);
 
    virtual const Surface* operator()(Name name) const;
 
    template < typename T >
    Surface* operator()(Name surfaceName)
    {
        return ChemicalCast< T >(RotateTo(surfaceName));
    }
    virtual Molecule* operator<<(Surface* source);
 
    virtual Surface* operator>>(Surface* target);
 
    virtual Molecule* operator<<(Molecule* source);
 
    virtual Molecule* operator>>(Molecule* target);
};
 
 
} //molecular namespace
} //bio namespace