tfCSpecies.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/
 
#ifndef _WRAPS_C_TFCSPECIES_H_
#define _WRAPS_C_TFCSPECIES_H_
 
#include "tf_port_c.h"
 
#include "tfCStateVector.h"
#include "tfCParticle.h"
 
// Handles
 
struct CAPI_EXPORT tfStateSpeciesHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfStateSpeciesListHandle {
    void *tfObj;
};
 
struct CAPI_EXPORT tfStateSpeciesValueHandle {
    void *tfObj;
};
 
 
// state::Species //
 
 
CAPI_FUNC(HRESULT) tfStateSpecies_init(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_initS(struct tfStateSpeciesHandle *handle, const char *s);
 
CAPI_FUNC(HRESULT) tfStateSpecies_copy(struct tfStateSpeciesHandle *source, struct tfStateSpeciesHandle *destination);
 
CAPI_FUNC(HRESULT) tfStateSpecies_destroy(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getId(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setId(struct tfStateSpeciesHandle *handle, const char *sid);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getName(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setName(struct tfStateSpeciesHandle *handle, const char *name);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getSpeciesType(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setSpeciesType(struct tfStateSpeciesHandle *handle, const char *sid);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getCompartment(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setCompartment(struct tfStateSpeciesHandle *handle, const char *sid);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getInitialAmount(struct tfStateSpeciesHandle *handle, tfFloatP_t *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setInitialAmount(struct tfStateSpeciesHandle *handle, tfFloatP_t value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getInitialConcentration(struct tfStateSpeciesHandle *handle, tfFloatP_t *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setInitialConcentration(struct tfStateSpeciesHandle *handle, tfFloatP_t value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getSubstanceUnits(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setSubstanceUnits(struct tfStateSpeciesHandle *handle, const char *sid);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getSpatialSizeUnits(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setSpatialSizeUnits(struct tfStateSpeciesHandle *handle, const char *sid);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getUnits(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setUnits(struct tfStateSpeciesHandle *handle, const char *sname);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getHasOnlySubstanceUnits(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setHasOnlySubstanceUnits(struct tfStateSpeciesHandle *handle, bool value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getBoundaryCondition(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setBoundaryCondition(struct tfStateSpeciesHandle *handle, bool value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getCharge(struct tfStateSpeciesHandle *handle, int *charge);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setCharge(struct tfStateSpeciesHandle *handle, int value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getConstant(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setConstant(struct tfStateSpeciesHandle *handle, int value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_getConversionFactor(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_setConversionFactor(struct tfStateSpeciesHandle *handle, const char *sid);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetId(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetName(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetSpeciesType(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetCompartment(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetInitialAmount(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetInitialConcentration(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetSubstanceUnits(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetSpatialSizeUnits(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetUnits(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetCharge(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetConversionFactor(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetConstant(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetBoundaryCondition(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_isSetHasOnlySubstanceUnits(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetId(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetName(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetConstant(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetSpeciesType(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetInitialAmount(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetInitialConcentration(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetSubstanceUnits(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetSpatialSizeUnits(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetUnits(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetCharge(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetConversionFactor(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetCompartment(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetBoundaryCondition(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_unsetHasOnlySubstanceUnits(struct tfStateSpeciesHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpecies_hasRequiredAttributes(struct tfStateSpeciesHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpecies_toString(struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpecies_fromString(struct tfStateSpeciesHandle *handle, const char *str);
 
 
// state::SpeciesList //
 
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_init(struct tfStateSpeciesListHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_destroy(struct tfStateSpeciesListHandle *handle);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_getStr(struct tfStateSpeciesListHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_indexOf(struct tfStateSpeciesListHandle *handle, const char *s, unsigned int *i);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_getSize(struct tfStateSpeciesListHandle *handle, unsigned int *size);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_getItem(struct tfStateSpeciesListHandle *handle, unsigned int index, struct tfStateSpeciesHandle *species);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_getItemS(struct tfStateSpeciesListHandle *handle, const char *s, struct tfStateSpeciesHandle *species);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_insert(struct tfStateSpeciesListHandle *handle, struct tfStateSpeciesHandle *species);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_insertS(struct tfStateSpeciesListHandle *handle, const char *s);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_toString(struct tfStateSpeciesListHandle *handle, char **str, unsigned int *numChars);
 
CAPI_FUNC(HRESULT) tfStateSpeciesList_fromString(struct tfStateSpeciesListHandle *handle, const char *str);
 
 
// state::SpeciesValue //
 
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_init(struct tfStateSpeciesValueHandle *handle, struct tfStateStateVectorHandle *state_vector, unsigned int index);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getValue(struct tfStateSpeciesValueHandle *handle, tfFloatP_t *value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_setValue(struct tfStateSpeciesValueHandle *handle, tfFloatP_t value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getStateVector(struct tfStateSpeciesValueHandle *handle, struct tfStateStateVectorHandle *state_vector);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getIndex(struct tfStateSpeciesValueHandle *handle, unsigned int *index);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getSpecies(struct tfStateSpeciesValueHandle *handle, struct tfStateSpeciesHandle *species);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getBoundaryCondition(struct tfStateSpeciesValueHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_setBoundaryCondition(struct tfStateSpeciesValueHandle *handle, bool value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getInitialAmount(struct tfStateSpeciesValueHandle *handle, tfFloatP_t *value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_setInitialAmount(struct tfStateSpeciesValueHandle *handle, tfFloatP_t value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getInitialConcentration(struct tfStateSpeciesValueHandle *handle, tfFloatP_t *value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_setInitialConcentration(struct tfStateSpeciesValueHandle *handle, tfFloatP_t value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_getConstant(struct tfStateSpeciesValueHandle *handle, bool *value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_setConstant(struct tfStateSpeciesValueHandle *handle, int value);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_secreteL(struct tfStateSpeciesValueHandle *handle, tfFloatP_t amount, struct tfParticleListHandle *to, tfFloatP_t *secreted);
 
CAPI_FUNC(HRESULT) tfStateSpeciesValue_secreteD(struct tfStateSpeciesValueHandle *handle, tfFloatP_t amount, tfFloatP_t distance, tfFloatP_t *secreted);
 
#endif // _WRAPS_C_TFCSPECIES_H_