LinearStructureInterface.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/structure/Structure.h"
 
namespace bio {
namespace chemical {
 
class ExcitationBase;
 
class LinearStructureInterface :
    virtual public ThreadSafe,
    virtual public Atom
{
public:
    LinearStructureInterface()
    {
    }
 
    virtual ~LinearStructureInterface()
    {
    }
 
    template < typename T >
    Code Insert(
        T toAdd,
        const Position position = BOTTOM,
        const StandardDimension optionalPositionArg = 0, // assuming 0 is the InvalidId for all Perspectives.
        const bool transferSubContents = false
    )
    {
        Code ret = code::GeneralFailure();
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->InsertImplementation(
                toAdd,
                position,
                optionalPositionArg,
                transferSubContents
            );
        }
        UnlockThread();
        return ret;
    }
 
    template < typename T >
    T GetById(StandardDimension id)
    {
        T ret = NULL;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->GetByIdImplementation(
                id
            );
        }
        UnlockThread();
        return ret;
    }
 
    template < typename T >
    const T GetById(
        StandardDimension id
    ) const
    {
        T ret = NULL;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->GetByIdImplementation(
                id
            );
        }
        UnlockThread();
        return ret;
    }
 
    template < typename T >
    T GetByName(
        Name name
    )
    {
        T ret = NULL;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->GetByNameImplementation(
                name
            );
        }
        UnlockThread();
        return ret;
    }
 
    template < typename T >
    const T GetByName(
        Name name
    ) const
    {
        T ret = NULL;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->GetByNameImplementation(
                name
            );
        }
        UnlockThread();
        return ret;
    }
 
    template < typename T >
    T GetOrCreateById(
        StandardDimension id
    )
    {
        T ret = NULL;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->GetOrCreateByIdImplementation(
                id
            );
        }
        UnlockThread();
        return ret;
    }
 
    template < typename T >
    T GetOrCreateByName(
        Name name
    )
    {
        T ret = NULL;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->GetOrCreateByNameImplementation(
                name
            );
        }
        UnlockThread();
        return ret;
    }
 
 
    template < typename T >
    Emission ForEach(
        ExcitationBase* excitation
    )
    {
        Emission ret;
        LockThread();
        LinearMotif< T >* implementer = this->AsBonded< LinearMotif< T >* >();
        if (implementer)
        {
            ret = implementer->ForEachImplementation(excitation);
        }
        UnlockThread();
        return ret;
    }
};
 
} //chemical namespace
} //bio namespace