tfCStateVector.h File Reference

#include "tf_port_c.h"

Include dependency graph for tfCStateVector.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tfStateStateVectorHandle
	Handle to a state::StateVector instance. More...

Functions
HRESULT	tfStateStateVector_destroy (struct tfStateStateVectorHandle *handle)
	Destroy an instance.
HRESULT	tfStateStateVector_getSize (struct tfStateStateVectorHandle *handle, unsigned int *size)
	Get size of vector.
HRESULT	tfStateStateVector_getSpecies (struct tfStateStateVectorHandle *handle, struct tfStateSpeciesListHandle *slist)
	Get the species of the state vector.
HRESULT	tfStateStateVector_reset (struct tfStateStateVectorHandle *handle)
	reset the species values based on the values specified in the species.
HRESULT	tfStateStateVector_getStr (struct tfStateStateVectorHandle *handle, char **str, unsigned int *numChars)
	Get a summary string of the state vector.
HRESULT	tfStateStateVector_getItem (struct tfStateStateVectorHandle *handle, int i, tfFloatP_t *value)
	Get the value of an item.
HRESULT	tfStateStateVector_setItem (struct tfStateStateVectorHandle *handle, int i, tfFloatP_t value)
	Set the value of an item.
HRESULT	tfStateStateVector_toString (struct tfStateStateVectorHandle *handle, char **str, unsigned int *numChars)
	Get a JSON string representation.
HRESULT	tfStateStateVector_fromString (struct tfStateStateVectorHandle *handle, const char *str)
	Create from a JSON string representation.

Function Documentation

tfStateStateVector_destroy()

HRESULT tfStateStateVector_destroy

(

struct tfStateStateVectorHandle *

handle

)

Destroy an instance.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateStateVector_fromString()

HRESULT tfStateStateVector_fromString	(	struct tfStateStateVectorHandle *	handle,
		const char *	str )

Create from a JSON string representation.

Returns

S_OK on success

tfStateStateVector_getItem()

HRESULT tfStateStateVector_getItem	(	struct tfStateStateVectorHandle *	handle,
		int	i,
		tfFloatP_t *	value )

Get the value of an item.

Parameters

handle	populated handle
i	index of item
value	value of item

Returns

S_OK on success

tfStateStateVector_getSize()

HRESULT tfStateStateVector_getSize	(	struct tfStateStateVectorHandle *	handle,
		unsigned int *	size )

Get size of vector.

Parameters

handle	populated handle
size	vector size

Returns

S_OK on success

tfStateStateVector_getSpecies()

HRESULT tfStateStateVector_getSpecies	(	struct tfStateStateVectorHandle *	handle,
		struct tfStateSpeciesListHandle *	slist )

Get the species of the state vector.

Parameters

handle	populated handle
slist	species list

Returns

S_OK on success

tfStateStateVector_getStr()

HRESULT tfStateStateVector_getStr	(	struct tfStateStateVectorHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a summary string of the state vector.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateStateVector_reset()

HRESULT tfStateStateVector_reset

(

struct tfStateStateVectorHandle *

handle

)

reset the species values based on the values specified in the species.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateStateVector_setItem()

HRESULT tfStateStateVector_setItem	(	struct tfStateStateVectorHandle *	handle,
		int	i,
		tfFloatP_t	value )

Set the value of an item.

Parameters

handle	populated handle
i	index of item
value	value of item

Returns

S_OK on success

tfStateStateVector_toString()

HRESULT tfStateStateVector_toString	(	struct tfStateStateVectorHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a JSON string representation.

Parameters

handle	populated handle
str	string representation
numChars	number of characters of string representation

Returns

S_OK on success