UnorderedStructureInterface.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) 2022 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/common/ThreadSafe.h"
#include "bio/chemical/Atom.h"
#include "bio/chemical/structure/motif/LinearMotif.h"
 
namespace bio {
namespace chemical {
 
class UnorderedStructureInterface :
 virtual public ThreadSafe,
 virtual public Atom
{
public:
 
 UnorderedStructureInterface()
 {
 }
 
 virtual ~UnorderedStructureInterface()
 {
 }
 
 
 template < typename T >
 T Add(const T t)
 {
 T ret = 0;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->AddImplementation(t);
 }
 UnlockThread();
 return ret;
 }
 
 
 template < typename T >
 T Remove(const T t)
 {
 T ret = 0;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->RemoveImplementation(t);
 }
 UnlockThread();
 return ret;
 }
 
 
 template < typename T >
 void Import(const UnorderedMotif <T>* other)
 {
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 implementer->ImportImplementation(other);
 }
 UnlockThread();
 }
 
 template < typename T >
 void Import(const std::vector< T >& other)
 {
 for (
 typename std::vector< T >::const_iterator otr = other.begin();
 otr != other.end();
 ++otr
 )
 {
 this->Add< T >(*otr);
 }
 }
 
 Code ImportAll(const physical::Wave* other)
 {
 BIO_SANITIZE(other && other->AsAtom(), ,
 return code::BadArgument1())
 
 Code ret = code::Success();
 
 LockThread(); // in case m_bonds changes.
 Bond* bondBuffer;
 for (
 SmartIterator bnd = other->AsAtom()->GetAllBonds()->End();
 !bnd.IsAtBeginning();
 --bnd
 )
 {
 bondBuffer = bnd;
 if (bondBuffer->IsEmpty())
 {
 continue;
 }
 if (physical::Wave::GetResonanceBetween(
 bondBuffer->GetBonded(),
 AbstractMotif::GetClassProperties()).size() == 0)
 {
 continue;
 }
 const physical::Wave* otherBond = other->AsAtom()->GetBonded(other->AsAtom()->GetBondPosition(bondBuffer->GetId()));
 (Cast< AbstractMotif* >(bondBuffer->GetBonded()))->ImportImplementation(otherBond); //actual work
 }
 UnlockThread();
 
 return ret;
 }
 
 template < typename T >
 unsigned long GetCount() const
 {
 unsigned long ret = 0;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->GetCountImplementation();
 }
 UnlockThread();
 return ret;
 }
 
 
 template < typename T >
 Container* GetAll()
 {
 Container* ret = 0;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->GetAllImplementation();
 }
 UnlockThread();
 return ret;
 }
 
 
 template < typename T >
 const Container* GetAll() const
 {
 Container* ret = 0;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->GetAllImplementation();
 }
 UnlockThread();
 return ret;
 }
 
 
 template < typename T >
 bool Has(T content) const
 {
 bool ret = false;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->HasImplementation(content);
 }
 UnlockThread();
 return ret;
 }
 
 template < typename T >
 unsigned int GetNumMatching(const Container* other) const
 {
 unsigned int ret = 0;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->GetNumMatchingImplementation(other);
 }
 UnlockThread();
 return ret;
 }
 
 template < typename T >
 bool HasAll(const Container* contents) const
 {
 bool ret = false;
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->HasAllImplementation(contents);
 }
 UnlockThread();
 return ret;
 }
 
 template < typename T >
 void Clear()
 {
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 implementer->ClearImplementation();
 }
 UnlockThread();
 }
 
 template < typename T >
 std::string GetStringFrom(std::string separator = ", ")
 {
 std::string ret = "";
 LockThread();
 UnorderedMotif< T >* implementer = this->AsBonded< UnorderedMotif< T >* >();
 if (implementer)
 {
 ret = implementer->GetStringFromImplementation(separator);
 }
 UnlockThread();
 return ret;
 }
 
 template < typename T >
 std::vector< T > GetAllAsVector()
 {
 return this->template GetAll< T >()->
 template AsVector< T >();
 }
 
 template < typename T >
 const std::vector< T > GetAllAsVector() const
 {
 return this->template GetAll< T >()->
 template AsVector< T >();
 }
};
 
} //chemical namespace
} //bio namespace