Functions for Clutter

Function List

InterfaceFrequencyLossInit
Initialise frequency loss structure.
InterfaceFrequencyLossAlloc
Memory allocation for frequency loss structure
InterfaceFrequencyLossCopy
Copy frequency loss structure.
InterfaceFrequencyLossFree
Free allocated memory for frequency loss structure.
InterfaceClutterClassInit
Initialise clutter class structure
InterfaceClutterClassAlloc
Memory allocation for clutter class structure.
InterfaceClutterClassCopy
Copy clutter class structure.
InterfaceClutterClassFree
Free allocated memory for clutter class structure.
InterfaceClutterInit
Initialise clutter data structure.
InterfaceClutterAlloc
Memory allocation for clutter structure Interface.
InterfaceClutterCopy
Copy clutter data structure.
InterfaceClutterFree
Free clutter data structure.
InterfaceClutterWriteASCII
Write clutter database to ASCII *.asc file in grid format.
InterfaceClutterPropertiesWriteASCII
Write clutter properties to ASCII *.mct file format.

Function Details

void InterfaceFrequencyLossInit(FREQUENCY_LOSS * frequencyLoss)

Description

Initialise frequency loss structure.

Parameters

FREQUENCY_LOSS * frequencyLoss
Frequency loss structure.

Returns None

int InterfaceFrequencyLossAlloc(FREQUENCY_LOSS * frequencyLoss)

Description

Memory allocation for frequency loss structure

Parameters

FREQUENCY_LOSS * frequencyLoss
Frequency loss structure.

Returns An integer: 0 = data valid

int InterfaceFrequencyLossCopy(FREQUENCY_LOSS * copy, FREQUENCY_LOSS * source)

Description

Copy frequency loss structure.

Parameters

FREQUENCY_LOSS * copy
Frequency loss structure (copy).
FREQUENCY_LOSS * source
Frequency loss structure to be copied.

Returns An integer: 0 = data valid

void InterfaceFrequencyLossFree(FREQUENCY_LOSS * frequencyLoss)

Description

Free allocated memory for frequency loss structure.

Parameters

FREQUENCY_LOSS * frequencyLoss
Frequency loss structure.

Returns None

void InterfaceClutterClassInit(CLUTTER_CLASS * clutterClass)

Description

Initialise clutter class structure

Parameters

CLUTTER_CLASS * clutterClass
Clutter class structure.

Returns None

int InterfaceClutterClassAlloc(int nbrAttenuations, CLUTTER_CLASS * clutterClass)

Description

Memory allocation for clutter class structure.

Parameters

int nbrAttenuations
Number of attenuations.
CLUTTER_CLASS * clutterClass
Clutter class structure.

Returns An integer: 0 = data valid

int InterfaceClutterClassCopy(CLUTTER_CLASS * copy, CLUTTER_CLASS * source)

Description

Copy clutter class structure.

Parameters

CLUTTER_CLASS * copy
Clutter class structure (copy).
CLUTTER_CLASS * source
Clutter class structure to be copied.

Returns An integer: 0 = data valid

void InterfaceClutterClassFree(CLUTTER_CLASS * clutterClass)

Description

Free allocated memory for clutter class structure.

Parameters

CLUTTER_CLASS * clutterClass
Clutter class structure.

Returns None

void InterfaceClutterInit(CLUTTER * clutter)

Description

Initialise clutter data structure.

Parameters

CLUTTER * clutter
data structure.

Returns None

int InterfaceClutterAlloc(int nbrColumns, int nbrLines, int nbrClutterClasses, CLUTTER * clutter)

Description

Memory allocation for clutter structure Interface.

Parameters

int nbrColumns
Number of columns.
int nbrLines
Number of lines.
int nbrClutterClasses
Number of clutter classes.
CLUTTER * clutter
Clutter data structure.

Returns An integer: 0 = data valid

int InterfaceClutterCopy(CLUTTER * copy, CLUTTER * source)

Description

Copy clutter data structure.

Parameters

CLUTTER * copy
Copy of clutter data.
CLUTTER * source
Source clutter data.

Returns An integer: 0 = data valid

void InterfaceClutterFree(CLUTTER * clutter)

Description

Free clutter data structure.

Parameters

CLUTTER * clutter
Clutter data structure.

Returns None

int InterfaceClutterWriteASCII(CLUTTER * clutter, const char * databaseName)

Description

Write clutter database to ASCII *.asc file in grid format.

Parameters

CLUTTER * clutter
Non-null, the clutter structure.
const char * databaseName
Filepath for output file.

Returns An int - 0 on success, !0 on failure.

int InterfaceClutterPropertiesWriteASCII(CLUTTER * clutter, const char * databaseName)

Description

Write clutter properties to ASCII *.mct file format.

Parameters

CLUTTER * clutter
Non-null, the clutter structure.
const char * databaseName
Filepath for output file.

Returns An int - 0 on success, !0 on failure.

The documentation was generated from the following file:
  • source/Public/Interface/Clutter.h