Project Management Functions

Function List

InterfaceLoadTopoMSI
This function loads Topography information from a .msi database
InterfaceLoadClutterMSI
This function loads clutter information from a .msi database
WinProp_Open
Creates a new wave propagation project based on a specific scenario.
WinProp_Close
Closes the specified propagation project. All memory for prediction results and map data is freed.
WinProp_CopyResult
Copy propagation result.
WinProp_CopyRays
Copy ray elements.
WinProp_CopyRayMatrix
Copy ray matrix.
WinProp_CopyResultPlane
Copy propagation result.
WinProp_CopyResultPointsList
Copy points list result.
WinProp_ErrorText
Returns the error message corresponding to a given error code.
WinProp_FreeResultID
Release the result of the last calculation. If there was no calculation before, nothing happens.
WinProp_Version
This function returns the version of the WinProp API.
WinProp_FilterResult
This functions filters a predicted result with respect to the selected filter type.
WinProp_FilterResultPlane
This functions filters a predicted result on an arbitrary plane with respect to the selected filter type.
WinProp_Convert_Result
This function converts a result of a single receiver into a linear array of receivers
WinProp_Convert_Result_Free
WinProp_Releasedate
This function returns the release date of the WinProp API
WinProp_Result_Read
Reads a WinProp result into the API result structure.
WinProp_ResultPoints_Read
Reads WinProp point results into the API result structure.
WinProp_ResultTrajectories_Read
Reads WinProp trajectory results into the API result structure.
WinProp_RayMatrix_Read
Reads a WinProp ray matrix from a .ray file into the API result structure.
WinProp_Result_Write
This function writes prediction results to a file.
WinProp_Result_WritePoints
This function writes point prediction results to a file.
WinProp_FreeResult
This function frees memory allocated to the WinProp_Result structure.
WinProp_FreeResultPoint
This function frees memory allocated to the WinProp_ResultPoint structure.
WinProp_FreeRayMatrix
Free memory allocated to WinProp_RayMatrix
WinProp_FreeRayMatrixElement
Free memory allocated to WinProp_RayMatrixElement
WinProp_AllocateResult
This function allocates memory to the WinProp_Result structure.
WinProp_AllocateResultPlane
This function allocates memory to the WinProp_ResultPlane structure.
WinProp_AllocateResultPlaneList
This function allocates memory to the WinProp_ResultPlaneList structure.
WinProp_WriteBitmap
This function generates a bitmap file with WinProp results.
WinProp_WriteBitmapLegend
Write bitmap file with legend
WinProp_Legend_Allocate
This function allocates memory to the WinProp_Legend structure.
WinProp_Legend_Free
This function frees allocated memory from the WinProp_Legend structure
InterfaceLoadTopoASC
This function loads Topography information from an ASCII database.
InterfaceLoadClutterASC
This function loads clutter information from an ASCII database

Function Details

int InterfaceLoadTopoMSI(TOPOGRAPHY * Topo, char * FilenameDatabase)

Description

This function loads Topography information from a .msi database

Parameters

TOPOGRAPHY * Topo
Result struct with Topo information.
char * FilenameDatabase
Name of the database file.

Returns An integer: 0 = success, failure otherwise.

int InterfaceLoadClutterMSI(CLUTTER * Clutter, char * FilenameDatabase, char * FilenameCluttertable)

Description

This function loads clutter information from a .msi database

Parameters

CLUTTER * Clutter
Result struct with Clutter information.
char * FilenameDatabase
Name of the database file.
char * FilenameCluttertable
Name of the clutter table file.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Open(int * DataID, WinProp_Scenario * DataScenario, WinProp_Callback * DataCallback)

Description

Creates a new wave propagation project based on a specific scenario.

Parameters

int * DataID
New handle of the wave propagation project.
WinProp_Scenario * DataScenario
Scenario data (see WinProp_Scenario).
WinProp_Callback * DataCallback
Pointers to callback functions (see WinProp_Callback)..

Returns An integer: 0 = success, otherwise an error.

int WinProp_Close(int DataID)

Description

Closes the specified propagation project. All memory for prediction results and map data is freed.

Parameters

int DataID
Handle of project to be closed.

Returns An integer: 0 = success, otherwise an error.

int WinProp_CopyResult(WinProp_Result * DestinationResult, const WinProp_Result * SourceResult)

Description

Copy propagation result.

Parameters

WinProp_Result * DestinationResult
destination result (see WinProp_Result).
const WinProp_Result * SourceResult
source result (see WinProp_Result).

Returns An integer: 0 = success, otherwise an error.

int WinProp_CopyRays(WinProp_RayMatrixElement * dest, const WinProp_RayMatrixElement * src)

Description

Copy ray elements.

Parameters

WinProp_RayMatrixElement * dest
destination ray elements (see WinProp_RayMatrixElement).
const WinProp_RayMatrixElement * src
source ray elements (see WinProp_RayMatrixElement).

Returns An integer: 0 = success, otherwise an error.

int WinProp_CopyRayMatrix(WinProp_RayMatrix * dest, const WinProp_RayMatrix * src)

Description

Copy ray matrix.

Parameters

WinProp_RayMatrix * dest
destination ray matrix (see WinProp_RayMatrix).
const WinProp_RayMatrix * src
source ray matrix (see WinProp_RayMatrix).

Returns An integer: 0 = success, otherwise an error.

int WinProp_CopyResultPlane(WinProp_ResultPlane * DestinationResult, WinProp_ResultPlane * SourceResult)

Description

Copy propagation result.

Parameters

WinProp_ResultPlane * DestinationResult
destination result (see WinProp_ResultPlane).
WinProp_ResultPlane * SourceResult
source result (see WinProp_ResultPlane).

Returns An integer: 0 = success, otherwise an error.

int WinProp_CopyResultPointsList(WinProp_ResultPointsList * dest, const WinProp_ResultPointsList * src)

Description

Copy points list result.

Parameters

WinProp_ResultPointsList * dest
destination points list result (see WinProp_ResultPointsList).
const WinProp_ResultPointsList * src
source points list result (see WinProp_ResultPointsList).

Returns An integer: 0 = success, otherwise an error.

int WinProp_ErrorText(unsigned int ID, char * Message, int BufferSize)

Description

Returns the error message corresponding to a given error code.

Parameters

unsigned int ID
Error number.
char * Message
String with error message.
int BufferSize
Size of the buffer.

Returns An integer: 0 = success, otherwise an error.

int WinProp_FreeResultID(int DataID)

Description

Release the result of the last calculation. If there was no calculation before, nothing happens.

Parameters

int DataID
ID of project (handle of the project see WinProp_Open).

Returns An integer: 0 = success, otherwise an error.

int WinProp_Version(unsigned int * majorRelease, unsigned int * majorUpdate, unsigned int * majorBugfix, char * fullVersion, int fullVersionSize)

Description

This function returns the version of the WinProp API.

Parameters

unsigned int * majorRelease
If non-null, gets set to the major release version.
unsigned int * majorUpdate
If non-null, gets set to the major update version.
unsigned int * majorBugfix
If non-null, gets set to the bugfix update version.
char * fullVersion
If non-null, gets set to the full version string, including a build ID.
int fullVersionSize
The size of the fullVersion buffer.

Returns An integer: 0 = success, otherwise an error.

int WinProp_FilterResult(WinProp_Result * Result, int Order, int Type)

Description

This functions filters a predicted result with respect to the selected filter type.

Parameters

WinProp_Result * Result
Result to be filtered.
int Order
Order of filter (must be odd).
int Type
Type of filter: Median (0) or Mean (1).

Returns An integer: 0 = success, otherwise an error.

int WinProp_FilterResultPlane(WinProp_ResultPlane * Result, int Order, int Type)

Description

This functions filters a predicted result on an arbitrary plane with respect to the selected filter type.

Parameters

WinProp_ResultPlane * Result
Result to be filtered.
int Order
Order of filter (must be odd).
int Type
Type Median (0) or Mean (1).

Returns An integer: 0 = success, otherwise an error.

int WinProp_Convert_Result(WinProp_Result * Result, WinProp_Result_2 * Resultlinear)

Description

This function converts a result of a single receiver into a linear array of receivers

Parameters

WinProp_Result * Result
Original result.
WinProp_Result_2 * Resultlinear
Result in linear array .

Returns An integer: 0 = success, otherwise an error.

int WinProp_Convert_Result_Free(WinProp_Result_2 * ResultFree)

Description

Parameters

WinProp_Result_2 * ResultFree
array to be freed.

Returns An integer: 0 = success.

int WinProp_Releasedate(unsigned int * Year, unsigned int * Month, unsigned int * Day)

Description

This function returns the release date of the WinProp API

Parameters

unsigned int * Year
If non-null, the year of release.
unsigned int * Month
If non-null, the month of release.
unsigned int * Day
If non-null, the day of release.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Result_Read(WinProp_Result * Result, const char * Filename)

Description

Reads a WinProp result into the API result structure.

Parameters

WinProp_Result * Result
The result.
const char * Filename
Filename of the file to be read.

Returns An int.

int WinProp_ResultPoints_Read(WinProp_ResultPointsList * Result, const char * FilenameRes, const char * FilenameRays)

Description

Reads WinProp point results into the API result structure.

Parameters

WinProp_ResultPointsList * Result
Non-null, the result.
const char * FilenameRes
The filename of the binary WinProp results.
const char * FilenameRays
The filename of the binary .ray file.

Returns An int.

int WinProp_ResultTrajectories_Read(WinProp_ResultTrajectoryList * Result, const char * FilenameRes, const char * FilenameRays)

Description

Reads WinProp trajectory results into the API result structure.

Parameters

WinProp_ResultTrajectoryList * Result
Non-null, the result.
const char * FilenameRes
The filename of the binary WinProp results.
const char * FilenameRays
The filename of the binary .ray file.

Returns An int.

int WinProp_RayMatrix_Read(WinProp_RayMatrix * Result, const char * Filename)

Description

Reads a WinProp ray matrix from a .ray file into the API result structure.

Parameters

WinProp_RayMatrix * Result
Non-null, the result.
const char * Filename
Filename of the file.

Returns An int.

int WinProp_Result_Write(int DataID, WinProp_Result * Result, WinProp_Antenna * Transmitter, char * Filename)

Description

This function writes prediction results to a file.

Parameters

int DataID
Handle of wave propagation project.
WinProp_Result * Result
Computed result.
WinProp_Antenna * Transmitter
Structure with transmitter details.
char * Filename
name of the file to which results are written.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Result_WritePoints(int DataID, WinProp_ResultPointsList * Result, WinProp_Antenna * Transmitter, char * Filename)

Description

This function writes point prediction results to a file.

Parameters

int DataID
Handle of wave propagation project.
WinProp_ResultPointsList * Result
Computed result.
WinProp_Antenna * Transmitter
Structure with transmitter details.
char * Filename
name of the file to which results are written.

Returns An integer: 0 = success, failure otherwise.

int WinProp_FreeResult(WinProp_Result * Result)

Description

This function frees memory allocated to the WinProp_Result structure.

Parameters

WinProp_Result * Result
the computed result.

Returns An integer: 0.

int WinProp_FreeResultPoint(WinProp_ResultPoint * Result)

Description

This function frees memory allocated to the WinProp_ResultPoint structure.

Parameters

WinProp_ResultPoint * Result
the computed result.

Returns An integer: 0.

int WinProp_FreeRayMatrix(WinProp_RayMatrix * RayMatrix)

Description

Free memory allocated to WinProp_RayMatrix

Parameters

WinProp_RayMatrix * RayMatrix
The ray matrix to be freed.

Returns An integer: 0.

int WinProp_FreeRayMatrixElement(WinProp_RayMatrixElement * RayMatrixElement)

Description

Free memory allocated to WinProp_RayMatrixElement

Parameters

WinProp_RayMatrixElement * RayMatrixElement
The ray matrix element to be freed.

Returns An integer: 0.

int WinProp_AllocateResult(WinProp_Result * Result, int Columns, int Lines, int Heights, double * HeightsArray, double * TimeStepsArray)

Description

This function allocates memory to the WinProp_Result structure.

Parameters

WinProp_Result * Result
Result structure.
int Columns
Number of columns in result matrix.
int Lines
Number of rows in result matrix.
int Heights
Number of prediction heights.
double * HeightsArray
Array of prediction heights.
double * TimeStepsArray
Array of time steps.

Returns An integer: 0 = success, failure otherwise.

int WinProp_AllocateResultPlane(WinProp_ResultPlane * Result, int Columns, int Lines)

Description

This function allocates memory to the WinProp_ResultPlane structure.

Parameters

WinProp_ResultPlane * Result
Result structure.
int Columns
Number of columns.
int Lines
Number of lines.

Returns An integer: 0 = success, failure otherwise.

int WinProp_AllocateResultPlaneList(WinProp_ResultPlaneList * ResultPlanes, int NrResultPlanes)

Description

This function allocates memory to the WinProp_ResultPlaneList structure.

Parameters

WinProp_ResultPlaneList * ResultPlanes
Result plane structure.
int NrResultPlanes
Number of result planes.

Returns An integer: 0 = success, failure otherwise.

int WinProp_WriteBitmap(WinProp_Result * Result, double MeterPerPixel, char * FilenameOutput)

Description

This function generates a bitmap file with WinProp results.

Parameters

WinProp_Result * Result
Result structure (see WinProp_Result).
double MeterPerPixel
Meter per pixel.
char * FilenameOutput
Name of the bitmap file to be written.

Returns An integer: 0 = success, failure otherwise.

int WinProp_WriteBitmapLegend(WinProp_Result * Result, double MeterPerPixel, char * FilenameOutput, WinProp_Legend * Legend)

Description

Write bitmap file with legend

Parameters

WinProp_Result * Result
Result structure (see WinProp_Result).
double MeterPerPixel
Meter per pixel.
char * FilenameOutput
Name of the bitmap file to be written.
WinProp_Legend * Legend
Legend structure (see WinProp_Legend).

Returns An integer: 0 = success, failure otherwise.

int WinProp_Legend_Allocate(WinProp_Legend * Legend, int NrSamplingPoints)

Description

This function allocates memory to the WinProp_Legend structure.

Parameters

WinProp_Legend * Legend
Legend structure.
int NrSamplingPoints
Number of sampling points.

Returns An integer: 0 = success, failure otherwise.

int WinProp_Legend_Free(WinProp_Legend * Legend)

Description

This function frees allocated memory from the WinProp_Legend structure

Parameters

WinProp_Legend * Legend
Object to be freed.

Returns An integer: 0 = success, failure otherwise.

int InterfaceLoadTopoASC(TOPOGRAPHY * Topo, char * FilenameDatabase)

Description

This function loads Topography information from an ASCII database.

Parameters

TOPOGRAPHY * Topo
Result struct with Topo information.
char * FilenameDatabase
Name of the database file.

Returns An integer: 0 = success, failure otherwise.

int InterfaceLoadClutterASC(CLUTTER * Clutter, char * FilenameDatabase, char * FilenameCluttertable)

Description

This function loads clutter information from an ASCII database

Parameters

CLUTTER * Clutter
Result struct with Clutter information.
char * FilenameDatabase
Name of the database file.
char * FilenameCluttertable
Name of the clutter table file.

Returns An integer: 0 = success, failure otherwise.

The documentation was generated from the following file:
  • source.eng/Interface/EngineConvert.h