fbarray.h File Reference

A template class for arrays. More...

#include <kaydaradef.h>
#include <fbsdk/fbversion.h>
#include <assert.h>
#include <string.h>

Go to the source code of this file.

Classes

class  FBArrayTemplate< Type >
 Template class to contain an array of items. More...

Defines

#define FBSDK_DLL   K_DLLIMPORT
 Ensure that FBSDK_DLL is defined only once...
#define FB_DEFINE_ARRAY(DllTag, Type)   typedef class DllTag FBArrayTemplate< FB##Type* > FBArray##Type;
 Define an array (template) for a component (discard the FB..).
#define FBImplementArray(DllTag, Type)   template class DllTag FBSDKNamespaceFunc( FBArrayTemplate ) < FB##Type* >;
 Implement an array.

Typedefs

typedef class FBSDK_DLL
FBArrayTemplate< bool * > 
FBArrayHBool
 Pre-defined common used array types.
typedef class FBSDK_DLL
FBArrayTemplate< char * > 
FBArrayHChar
typedef class FBSDK_DLL
FBArrayTemplate< int * > 
FBArrayHkInt
typedef class FBSDK_DLL
FBArrayTemplate< unsigned int * > 
FBArrayHkUInt
typedef class FBSDK_DLL
FBArrayTemplate< float * > 
FBArrayHkFloat
typedef class FBSDK_DLL
FBArrayTemplate< double * > 
FBArrayHkDouble
typedef class FBSDK_DLL
FBArrayTemplate< void * > 
FBArrayHVoid
typedef class FBSDK_DLL
FBArrayTemplate< bool > 
FBArrayBool
typedef class FBSDK_DLL
FBArrayTemplate< char > 
FBArrayChar
typedef class FBSDK_DLL
FBArrayTemplate< int > 
FBArrayInt
typedef class FBSDK_DLL
FBArrayTemplate< unsigned int > 
FBArrayUInt
typedef class FBSDK_DLL
FBArrayTemplate< float > 
FBArrayFloat
typedef class FBSDK_DLL
FBArrayTemplate< double > 
FBArrayDouble

Functions

FBSDK_DLL void * FBRealloc (void *memblock, size_t size)
 General allocation function, actually calling standard function "realloc".
FBSDK_DLL void FBFree (void *memblock)
 General free function, actually calling standard function "free".

Detailed Description

A template class for arrays.

Definition in file fbarray.h.


Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Ensure that FBSDK_DLL is defined only once...

Definition at line 47 of file fbarray.h.

#define FB_DEFINE_ARRAY (   DllTag,
  Type 
)    typedef class DllTag FBArrayTemplate< FB##Type* > FBArray##Type;

Define an array (template) for a component (discard the FB..).

Define a type corresponding to the array in the header file.

Parameters:
DllTagAssociated DLL.
TypeType (component) to register as an array (discard the FB).

Definition at line 360 of file fbarray.h.

#define FBImplementArray (   DllTag,
  Type 
)    template class DllTag FBSDKNamespaceFunc( FBArrayTemplate ) < FB##Type* >;

Implement an array.

Instanciates the template class in the *.cxx file.

Parameters:
DllTagAssociated DLL.
TypeType to register as an array.

Definition at line 371 of file fbarray.h.


Typedef Documentation

typedef class FBSDK_DLL FBArrayTemplate<bool *> FBArrayHBool

Pre-defined common used array types.

Definition at line 340 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<char *> FBArrayHChar

Definition at line 341 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<int *> FBArrayHkInt

Definition at line 342 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<unsigned int *> FBArrayHkUInt

Definition at line 343 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<float *> FBArrayHkFloat

Definition at line 344 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<double *> FBArrayHkDouble

Definition at line 345 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<void *> FBArrayHVoid

Definition at line 346 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<bool> FBArrayBool

Definition at line 348 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<char> FBArrayChar

Definition at line 349 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<int> FBArrayInt

Definition at line 350 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<unsigned int> FBArrayUInt

Definition at line 351 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<float> FBArrayFloat

Definition at line 352 of file fbarray.h.

typedef class FBSDK_DLL FBArrayTemplate<double> FBArrayDouble

Definition at line 353 of file fbarray.h.


Function Documentation

FBSDK_DLL void* FBRealloc ( void *  memblock,
size_t  size 
)

General allocation function, actually calling standard function "realloc".

Parameters:
memblockMemory block to reallocate.
sizeSize of block to allocate
Returns:
new allocated or resized block.
FBSDK_DLL void FBFree ( void *  memblock)

General free function, actually calling standard function "free".

Parameters:
memblockMemory block to free.