Tissue Forge C 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
tfCStateVector.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of Tissue Forge.
3 * Copyright (c) 2022-2024 T.J. Sego
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published
7 * by the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 ******************************************************************************/
19
25#ifndef _WRAPS_C_TFCSTATEVECTOR_H_
26#define _WRAPS_C_TFCSTATEVECTOR_H_
27
28#include "tf_port_c.h"
29
30// Handles
31
36struct CAPI_EXPORT tfStateStateVectorHandle {
37 void *tfObj;
38};
39
40
42// state::StateVector //
44
45
52CAPI_FUNC(HRESULT) tfStateStateVector_destroy(struct tfStateStateVectorHandle *handle);
53
61CAPI_FUNC(HRESULT) tfStateStateVector_getSize(struct tfStateStateVectorHandle *handle, unsigned int *size);
62
71
78CAPI_FUNC(HRESULT) tfStateStateVector_reset(struct tfStateStateVectorHandle *handle);
79
88CAPI_FUNC(HRESULT) tfStateStateVector_getStr(struct tfStateStateVectorHandle *handle, char **str, unsigned int *numChars);
89
98CAPI_FUNC(HRESULT) tfStateStateVector_getItem(struct tfStateStateVectorHandle *handle, int i, tfFloatP_t *value);
99
108CAPI_FUNC(HRESULT) tfStateStateVector_setItem(struct tfStateStateVectorHandle *handle, int i, tfFloatP_t value);
109
118CAPI_FUNC(HRESULT) tfStateStateVector_toString(struct tfStateStateVectorHandle *handle, char **str, unsigned int *numChars);
119
125CAPI_FUNC(HRESULT) tfStateStateVector_fromString(struct tfStateStateVectorHandle *handle, const char *str);
126
127#endif // _WRAPS_C_TFCSTATEVECTOR_H_
Handle to a state::SpeciesList instance.
Definition tfCSpecies.h:47
Handle to a state::StateVector instance.
Definition tfCStateVector.h:36
HRESULT tfStateStateVector_getStr(struct tfStateStateVectorHandle *handle, char **str, unsigned int *numChars)
Get a summary string of the state vector.
HRESULT tfStateStateVector_reset(struct tfStateStateVectorHandle *handle)
reset the species values based on the values specified in the species.
HRESULT tfStateStateVector_getItem(struct tfStateStateVectorHandle *handle, int i, tfFloatP_t *value)
Get the value of an item.
HRESULT tfStateStateVector_destroy(struct tfStateStateVectorHandle *handle)
Destroy an instance.
HRESULT tfStateStateVector_toString(struct tfStateStateVectorHandle *handle, char **str, unsigned int *numChars)
Get a JSON string representation.
HRESULT tfStateStateVector_getSize(struct tfStateStateVectorHandle *handle, unsigned int *size)
Get size of vector.
HRESULT tfStateStateVector_setItem(struct tfStateStateVectorHandle *handle, int i, tfFloatP_t value)
Set the value of an item.
HRESULT tfStateStateVector_getSpecies(struct tfStateStateVectorHandle *handle, struct tfStateSpeciesListHandle *slist)
Get the species of the state vector.
HRESULT tfStateStateVector_fromString(struct tfStateStateVectorHandle *handle, const char *str)
Create from a JSON string representation.