CNFixedObjectArray.h File Reference

Define CNFixedObjectArray data structure. More...

#include "CNFixedArray.h"
#include "CNObject.h"

Go to the source code of this file.

Classes
struct	CNFixedObjectArray
	Array of instances. More...

Functions
static void	CNInitFixedObjectArray (struct CNFixedObjectArray *dst, uint64_t maxnum, struct CNResource *resource)
	Initialize instance array. More...
void	CNDestroyFixedObjectArray (struct CNFixedObjectArray *dst)
	Destroy instance array. More...
static uint64_t	CNCountOfFixedObjectArray (const struct CNFixedObjectArray *src)
	Get the count of elements in the array. More...
static void	CNSetObjectToFixedObjectArray (struct CNFixedObjectArray *dst, unsigned int index, struct CNObject *src)
	Set objectto the array at the given index. More...
static struct CNObject *	CNObjectInFixedObjectArray (const struct CNFixedObjectArray *src, unsigned int index)
	Get object in the array. More...
struct CNObjectList	CNElementListOfFixedObjectArray (const struct CNFixedObjectArray *src, struct CNResource *resource)
	Make object list of array. More...
static CNBoolean	CNVisitElementOfFixedObjectArray (const struct CNFixedObjectArray *src, CNVisitElementOfFixedArrayFuncRef visitfunc, void *info)
	Visit all elements in the array. More...

Detailed Description

Define CNFixedObjectArray data structure.

Copyright

Copyright (C) 2013 Steel Wheels Project

Function Documentation

static void CNInitFixedObjectArray ( struct CNFixedObjectArray *  dst, uint64_t  maxnum, struct CNResource *  resource  )

inlinestatic

Initialize instance array.

Parameters

dst	Destination array
maxnum	Max number of elements
resource	Resource to allocate the array

References CNInitFixedArray(), and CNFixedObjectArray::coreArray.

void CNDestroyFixedObjectArray

(

struct CNFixedObjectArray *

dst

)

Destroy instance array.

Parameters

dst	Destination array

static uint64_t CNCountOfFixedObjectArray ( const struct CNFixedObjectArray *  src )

inlinestatic

Get the count of elements in the array.

Returns

Count of elements

Parameters

src	Source array

References CNCountOfFixedArray(), and CNFixedObjectArray::coreArray.

static void CNSetObjectToFixedObjectArray ( struct CNFixedObjectArray *  dst, unsigned int  index, struct CNObject *  src  )

inlinestatic

Set objectto the array at the given index.

Parameters

dst	Destination array
index	Index of the array to set
src	Souce object to be set

Note

The source object is retained in this function

References CNReleaseObject(), CNRetainObject(), CNSetPointerToFixedArray(), and CNFixedObjectArray::coreArray.

static struct CNObject* CNObjectInFixedObjectArray ( const struct CNFixedObjectArray *  src, unsigned int  index  )

static

Get object in the array.

Return values

insance	Instance in the array
null	No instance at the given index

Parameters

src	Source instance array
index	Index to choose element

References CNPointerInFixedArray(), and CNFixedObjectArray::coreArray.

struct CNObjectList CNElementListOfFixedObjectArray	(	const struct CNFixedObjectArray *	src,
		struct CNResource *	resource
	)

Make object list of array.

Returns

List of elements

Parameters

src	Source object array
resource	Resource to allocate the list

static CNBoolean CNVisitElementOfFixedObjectArray ( const struct CNFixedObjectArray *  src, CNVisitElementOfFixedArrayFuncRef  visitfunc, void *  info  )

inlinestatic

Visit all elements in the array.

Return values

TRUE	All elements are visited
FALSE	All elements are NOT visited

Parameters

src	Source array
visitfunc	Function which is called foreach elements
info	Additiona parameter for visit function

References CNVisitElementOfFixedArray(), and CNFixedObjectArray::coreArray.