TransMembraneDomain.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/molecular/Vesicle.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace molecular {
 
class TransMembraneDomain
{
public:
    TransMembraneDomain(Pointer< Vesicle > interior = Pointer< Vesicle >());
 
    
    ~TransMembraneDomain();
 
    void SetVesicle(Pointer< Vesicle > interior);
 
 
    Pointer< Vesicle > GetVesicle();
 
    Pointer< const Vesicle > GetVesicle() const;
 
    
    void IngressSolute(Pointer< chemical::Solute > external);
 
    
    void IngressSolution(Pointer< chemical::Solution > external);
 
    
    chemical::Solute Egress(const Name& soluteName);
    
    chemical::Solute Egress(const Id& soluteId);
 
    Pointer< chemical::Solute > Secrete(const Name& soluteName);
 
 
    Pointer< chemical::Solute > Secrete(const Id& soluteId);
 
 
private:
    Pointer< Vesicle > mInterior;
};
 
} //molecular namespace
} //bio namespace