Project Management Functions

Function List

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_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_FilterResultPlanes: This functions filters predicted results on arbitrary planes 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_ResultPlanes_Read: Reads a WinProp plane results 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_PlanesRayMatrix_Read: Reads a WinProp ray matrices for planes 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_Result_WriteTrajectories: This function writes trajectory prediction results to a file.
WinProp_ResultsRays_Read: Read WinProp results from the given file(s).
WinProp_ConvertWalls: Conversion of polygons into walls. Converted file will be stored in WinProp file format.
WinProp_ConvertBuildings: Conversion of urban buildings into WinProp file format (*.odb).
WinProp_ConvertPixelTopo: Conversion of topography into WinProp file format (*.tdb).
WinProp_ConvertClutter: Conversion of clutter into WinProp file format (*.mdb).
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
InterfaceLoadTopoMSI: This function loads Topography information from a .msi database
InterfaceLoadClutterMSI: This function loads clutter information from a .msi database
WinProp_ProjectIndoorWrite: Write indoor project file. Note that this is under active development and the interface may change in future versions.

Function Details

int WinProp_Open(int * DataID, const WinProp_Scenario * DataScenario, const 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.
const WinProp_Scenario * DataScenario: Scenario data (see WinProp_Scenario).
const 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_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_FilterResultPlanes(WinProp_ResultPlaneList * Result, int Order, int Type)

Description

This functions filters predicted results on arbitrary planes with respect to the selected filter type.

Parameters

WinProp_ResultPlaneList * 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(const WinProp_Result * Result, WinProp_Result_2 * Resultlinear)

Description

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

Parameters

const 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_ResultPlanes_Read(WinProp_ResultPlaneList * Result, const char * Filename)

Description

Reads a WinProp plane results into the API result structure.

Parameters

WinProp_ResultPlaneList * Result: TNon-null, the result.
const char * Filename: Filename of of the binary WinProp results.

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_PlanesRayMatrix_Read(WinProp_RayMatrixList * Result, const char * Filename)

Description

Reads a WinProp ray matrices for planes from a .ray file into the API result structure.

Parameters

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

Returns An int.

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

Description

This function writes prediction results to a file.

Parameters

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

Returns An integer: 0 = success, failure otherwise.

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

Description

This function writes point prediction results to a file.

Parameters

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

Returns An integer: 0 = success, failure otherwise.

int WinProp_Result_WriteTrajectories(int DataID, const WinProp_ResultTrajectoryList * Result, const WinProp_Trajectory * Trajectories, int NrTrajectories, const WinProp_Antenna * Transmitter, const char * Filename)

Description

This function writes trajectory prediction results to a file.

Parameters

int DataID: Handle of wave propagation project.
const WinProp_ResultTrajectoryList * Result: Computed result.
const WinProp_Trajectory * Trajectories: Structure with trajectories details.
int NrTrajectories: Number of trajectories.
const WinProp_Antenna * Transmitter: Structure with transmitter details.
const char * Filename: Name of the file to which results are written.

Returns An integer: 0 = success, failure otherwise.

int WinProp_ResultsRays_Read(WinProp_Result * Result, WinProp_RayMatrix * ResultRays, WinProp_ResultPointsList * WinPropResultPoints, WinProp_ResultTrajectoryList * WinPropResultsTrajectories, WinProp_ResultPlaneList * WinPropResultsPlanes, WinProp_RayMatrixList * WinPropResultRaysPlanes, const bool readRays, const char * Filename, const char * FilenameRays, WinProp_Callback * callbacks, const double NotComputedValue)

Description

Read WinProp results from the given file(s).

Parameters

WinProp_Result * Result: If non-null, the area result.
WinProp_RayMatrix * ResultRays: If non-null, the area result rays.
WinProp_ResultPointsList * WinPropResultPoints: If non-null, the point results.
WinProp_ResultTrajectoryList * WinPropResultsTrajectories: If non-null, the trajectories results.
WinProp_ResultPlaneList * WinPropResultsPlanes: If non-null, the arbitrary planes results.
WinProp_RayMatrixList * WinPropResultRaysPlanes: If non-null, the arbitrary planes result rays.
const bool readRays: True to read rays.
const char * Filename: Filename of the file.
const char * FilenameRays: If non-null, the filename of the ray file, otherwise ray filename will be derived from Filename.
WinProp_Callback * callbacks: If non-null, callbacks to record warning / error messages and progress.
const double NotComputedValue: The value, which should be assigned to not computed pixels.

Returns An int.

int WinProp_ConvertWalls(INDOOR_WALLS * InterfaceWalls, MATERIALS * InterfaceMaterials, const char * OutputFileName, WinProp_Callback * Callback)

Description

Conversion of polygons into walls. Converted file will be stored in WinProp file format.

Parameters

INDOOR_WALLS * InterfaceWalls: Walls to be converted to WinProp file format.
MATERIALS * InterfaceMaterials: Materials assigned to vector data.
const char * OutputFileName: Name of output file.
WinProp_Callback * Callback: Callback for percent output and messages.

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

int WinProp_ConvertBuildings(URBAN_BUILDINGS * InterfaceBuildings, const char * OutputFileName, WinProp_Callback * Callback)

Description

Conversion of urban buildings into WinProp file format (*.odb).

Parameters

URBAN_BUILDINGS * InterfaceBuildings: Buildings to be converted to WinProp file format.
const char * OutputFileName: Name of output file.
WinProp_Callback * Callback: Callback for percent output and messages.

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

int WinProp_ConvertPixelTopo(TOPOGRAPHY * InterfaceTopo, const char * OutputFileName, WinProp_Callback * Callback)

Description

Conversion of topography into WinProp file format (*.tdb).

Parameters

TOPOGRAPHY * InterfaceTopo: Topography to be converted to WinProp file format
const char * OutputFileName: Name of output file.
WinProp_Callback * Callback: Callback for percent output and messages.

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

int WinProp_ConvertClutter(CLUTTER * InterfaceClutter, const char * OutputFileName, WinProp_Callback * Callback)

Description

Conversion of clutter into WinProp file format (*.mdb).

Parameters

CLUTTER * InterfaceClutter: Clutter to be converted to WinProp file format
const char * OutputFileName: Name of output file.
WinProp_Callback * Callback: Callback for percent output and messages.

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

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

Description

This function generates a bitmap file with WinProp results.

Parameters

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

Returns An integer: 0 = success, failure otherwise.

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

Description

Write bitmap file with legend

Parameters

const WinProp_Result * Result: Result structure (see WinProp_Result).
double MeterPerPixel: Meter per pixel.
const char * FilenameOutput: Name of the bitmap file to be written.
const 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, const char * FilenameDatabase)

Description

This function loads Topography information from an ASCII database.

Parameters

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

Returns An integer: 0 = success, failure otherwise.

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

Description

This function loads clutter information from an ASCII database

Parameters

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

Returns An integer: 0 = success, failure otherwise.

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_ProjectIndoorWrite(const WinProp_Filename projectFilePath, const WinProp_Scenario & winPropScenario, const WinProp_Area * winPropArea, const WinPropPointList_t * winPropPoints, const WinPropTrajectoryList_t * winPropTrajs, const WinPropAntennaList_t & winPropAntennas, const WinProp_Additional & winPropMore, const WinProp_Propagation_Results & outputResults, const Model_COST * modelParaCOST, const Model_DPM * modelParaDPM, const Model_RAYTRACING * modelParaRAYTRACING, const Model_FREESPACE * modelParaFREESPACE, const Model_VRT * modelParaVRT, const Model_MOTLEYKEENAN * modelParaMOTLEYKEENAN, const WinProp_Additional_Internal * winPropMoreInternal, const WinProp_SuperposeMS * msSuperpose, const WinProp_MS_Para * msPara, const WinProp_MS_AdditionalResults * msAdditionalResult)

Description

Write indoor project file. Note that this is under active development and the interface may change in future versions.

Parameters

const WinProp_Filename projectFilePath: The path to the project file to write.
const WinProp_Scenario & winPropScenario: Structure used to define a scenario (indoor in this case).
const WinProp_Area * winPropArea: Structure used to define the prediction area. null if unused.
const WinPropPointList_t * winPropPoints: Structure used to define the prediction points. null if unused.
const WinPropTrajectoryList_t * winPropTrajs: Structure used to define the prediction trajectories. null if unused.
const WinPropAntennaList_t & winPropAntennas: A list of transmitters used in the project. These are of type WinProp_Antenna_Area.
const WinProp_Additional & winPropMore: Additional settings for the project.
const WinProp_Propagation_Results & outputResults: Output results.
const Model_COST * modelParaCOST: (Optional) Settings of the COST model. null if unused.
const Model_DPM * modelParaDPM: (Optional) Settings of the DPM model. null if unused.
const Model_RAYTRACING * modelParaRAYTRACING: (Optional) Settings of the RAYTRACING model. null if unused.
const Model_FREESPACE * modelParaFREESPACE: (Optional) Settings of the FREESPACE model. null if unused.
const Model_VRT * modelParaVRT: (Optional) Settings of the VRT model. null if unused.
const Model_MOTLEYKEENAN * modelParaMOTLEYKEENAN: (Optional) Settings of the MOTLEY-KEENAN model. null if unused.
const WinProp_Additional_Internal * winPropMoreInternal: (Optional) Internal additional settings for the project. null if unused.
const WinProp_SuperposeMS * msSuperpose: (Optional) Structure used to define the RunMS superposition of propagation results with given receiving and transmitting array elements. null if unused.
const WinProp_MS_Para * msPara: (Optional) Structure used to specify the RunMS computation parameters. null if unused.
const WinProp_MS_AdditionalResults * msAdditionalResult: (Optional) Structure used to specify additional RunMS output results. null if unused.

Returns An integer: 0 = success, failure otherwise.

The documentation was generated from the following file:

source/Interface/Engine.h