WPILibC++ 2024.3.2

Functions

char * NT_AllocateCharArray (size_t size)
 Allocates an array of chars. More...
 
NT_BoolNT_AllocateBooleanArray (size_t size)
 Allocates an array of booleans. More...
 
int64_t * NT_AllocateIntegerArray (size_t size)
 Allocates an array of ints. More...
 
float * NT_AllocateFloatArray (size_t size)
 Allocates an array of floats. More...
 
double * NT_AllocateDoubleArray (size_t size)
 Allocates an array of doubles. More...
 
struct NT_StringNT_AllocateStringArray (size_t size)
 Allocates an array of NT_Strings. More...
 
void NT_FreeCharArray (char *v_char)
 Frees an array of chars. More...
 
void NT_FreeBooleanArray (NT_Bool *v_boolean)
 Frees an array of booleans. More...
 
void NT_FreeIntegerArray (int64_t *v_int)
 Frees an array of ints. More...
 
void NT_FreeFloatArray (float *v_float)
 Frees an array of floats. More...
 
void NT_FreeDoubleArray (double *v_double)
 Frees an array of doubles. More...
 
void NT_FreeStringArray (struct NT_String *v_string, size_t arr_size)
 Frees an array of NT_Strings. More...
 

Detailed Description

Function Documentation

◆ NT_AllocateBooleanArray()

NT_Bool * NT_AllocateBooleanArray ( size_t  size)

Allocates an array of booleans.

Note that the size is the number of elements, and not the specific number of bytes to allocate. That is calculated internally.

Parameters
sizethe number of elements the array will contain
Returns
the allocated boolean array

After use, the array should be freed using the NT_FreeBooleanArray() function.

◆ NT_AllocateCharArray()

char * NT_AllocateCharArray ( size_t  size)

Allocates an array of chars.

Note that the size is the number of elements, and not the specific number of bytes to allocate. That is calculated internally.

Parameters
sizethe number of elements the array will contain
Returns
the allocated char array

After use, the array should be freed using the NT_FreeCharArray() function.

◆ NT_AllocateDoubleArray()

double * NT_AllocateDoubleArray ( size_t  size)

Allocates an array of doubles.

Note that the size is the number of elements, and not the specific number of bytes to allocate. That is calculated internally.

Parameters
sizethe number of elements the array will contain
Returns
the allocated double array

After use, the array should be freed using the NT_FreeDoubleArray() function.

◆ NT_AllocateFloatArray()

float * NT_AllocateFloatArray ( size_t  size)

Allocates an array of floats.

Note that the size is the number of elements, and not the specific number of bytes to allocate. That is calculated internally.

Parameters
sizethe number of elements the array will contain
Returns
the allocated double array

After use, the array should be freed using the NT_FreeFloatArray() function.

◆ NT_AllocateIntegerArray()

int64_t * NT_AllocateIntegerArray ( size_t  size)

Allocates an array of ints.

Note that the size is the number of elements, and not the specific number of bytes to allocate. That is calculated internally.

Parameters
sizethe number of elements the array will contain
Returns
the allocated double array

After use, the array should be freed using the NT_FreeIntArray() function.

◆ NT_AllocateStringArray()

struct NT_String * NT_AllocateStringArray ( size_t  size)

Allocates an array of NT_Strings.

Note that the size is the number of elements, and not the specific number of bytes to allocate. That is calculated internally.

Parameters
sizethe number of elements the array will contain
Returns
the allocated NT_String array

After use, the array should be freed using the NT_FreeStringArray() function.

◆ NT_FreeBooleanArray()

void NT_FreeBooleanArray ( NT_Bool v_boolean)

Frees an array of booleans.

Parameters
v_booleanpointer to the boolean array to free

◆ NT_FreeCharArray()

void NT_FreeCharArray ( char *  v_char)

Frees an array of chars.

Parameters
v_charpointer to the char array to free

◆ NT_FreeDoubleArray()

void NT_FreeDoubleArray ( double *  v_double)

Frees an array of doubles.

Parameters
v_doublepointer to the double array to free

◆ NT_FreeFloatArray()

void NT_FreeFloatArray ( float *  v_float)

Frees an array of floats.

Parameters
v_floatpointer to the float array to free

◆ NT_FreeIntegerArray()

void NT_FreeIntegerArray ( int64_t *  v_int)

Frees an array of ints.

Parameters
v_intpointer to the int array to free

◆ NT_FreeStringArray()

void NT_FreeStringArray ( struct NT_String v_string,
size_t  arr_size 
)

Frees an array of NT_Strings.

Parameters
v_stringpointer to the string array to free
arr_sizesize of the string array to free

Note that the individual NT_Strings in the array should NOT be freed before calling this. This function will free all the strings individually.