Network planning functions
Function List
- WinProp_Net_Project_Open
- This function creates a new network planning project
- WinProp_Net_Project_Open_WST
- This function creates a new network planning project
- WinProp_Net_Project_Close
- This function closes an existing project.
- WinProp_Net_Project_Para_Get
- This function gets parameters of the current air interface
- WinProp_Net_Project_Para_Set
- Set parameters of the current air interface
- WinProp_Net_Project_Compute
- This function starts computation with a network module.
- WinProp_Net_Project_ComputePoints
- Start computation with a network module on points.
- WinProp_Net_Project_ComputeTrajectories
- Start computation with a network module on trajectories.
- WinProp_Net_PropagationMap_Add
- Add wave propagation result.
- WinProp_Net_LosMap_Add
- Add Line-of-sight result
- WinProp_Net_RayMatrix_Add
- Add ray matrix result
- WinProp_Net_RayMatrixPlane_Add
- Add ray matrix results for planes
- WinProp_Net_PropagationPlane_Add
- Add wave propagation result on planes.
- WinProp_Net_PropagationPoint_Add
- Add wave propagation result of a list of points
- WinProp_Net_PropagationTrajectory_Add
- Add wave propagation result of a list of trajectories
- WinProp_Net_PropagationMap_Delete
- Delete wave propagation results.
- WinProp_Net_PropagationPlane_Delete
- Delete wave propagation results in a plane.
- WinProp_Net_PropagationPoints_Delete
- Delete wave propagation point results.
- WinProp_Net_PropagationTrajectory_Delete
- Delete wave propagation trajectory results.
- WinProp_Net_PropagationMap_Clean
- Remove all wave propagation results.
- WinProp_Net_NetworkMap_Global_Get
- Retrieve computed network results regardless of transmission mode or carrier.
- WinProp_Net_NetworkMap_Get
- Obtain computed network results.
- WinProp_Net_NetworkMap_Carrier_Get
- Obtain computed network results individually for a carrier.
- WinProp_Net_NetworkMonteCarloStats_Get
- Gets the Monte-Carlo result statistics of a network simulation.
- WinProp_Net_NetworkPlane_Global_Get
- Retrieve computed network results on planes regardless of transmission mode or carrier.
- WinProp_Net_NetworkPlane_Get
- Obtain computed network result on planes.
- WinProp_Net_NetworkPlane_Carrier_Get
- Obtain a individually for a carrier computed network result.
- WinProp_Net_NetworkTrajectoryList_Get
- Obtain computed network trajectories result.
- WinProp_Net_NetworkTrajectoryList_Carrier_Get
- Obtain a individually for a carrier computed network trajectories result.
- WinProp_Net_PropagationMap_GetTrxInfo
- Get information about transmitter.
- WinProp_Net_Carrier_Add
- Add carrier to air interface.
- WinProp_Net_Carrier_Check
- Get information about the carrier.
- WinProp_Net_Carrier_Delete
- Delete a carrier from interface.
- WinProp_Net_Carrier_Para_Set
- Sets a parameter of a carrier
- WinProp_Net_Carrier_Para_Get
- Gets a parameter of a carrier.
- WinProp_Net_TransmissionMode_Add
- Add new MCS/transmission mode/service.
- WinProp_Net_TransmissionMode_Delete
- Delete existing MCS/transmission mode.
- WinProp_Net_TransmissionMode_Para_Set
- Modify parameter of MCS.
- WinProp_Net_TransmissionMode_Para_Get
- Retrieve information about a network planning parameter.
- WinProp_Net_Channel_Add
- Add new channel to network project.
- WinProp_Net_Channel_Para_Set
- Set parameter of a channel.
- WinProp_Net_Channel_Para_Get
- Get parameter of a channel.
- WinProp_Net_Channel_Delete
- Delete channel from network project
- WinProp_Net_PrioMap_Set
- Set priority map for optimizer.
- WinProp_Net_PrioMap_Get
- Get priority map for optimizer.
- WinProp_Net_Application_Add
- Adds an application to the network planning project.
- WinProp_Net_Application_Delete
- Deletes an application from the network planning project.
- WinProp_Net_Application_TransmissionMode_Link
- Links an application to a transmission mode and sets the preference of that link.
- WinProp_Net_Application_TransmissionMode_Unlink
- Unlinks a transmission mode from an application.
- WinProp_Net_Application_ClutterClass_Link
- Links an application to a clutter class and sets various parameters of this link.
- WinProp_Net_Application_ClutterClass_Unlink
- Unlinks a clutter class from an application.
- WinProp_Net_Application_Para_Set
- Sets a parameter of an application.
- WinProp_Net_Application_Para_Get
- Gets a parameter of an application.
- WinProp_Net_Clutter_Set
- Sets the clutter data needed for network planning projects with Monte-Carlo simulation.
- WinProp_Net_Project_Result_Switch
- Sets the computation of the specified result type to the specified state.
- WinProp_Net_Project_Result_Enable
- Enables the computation of the specified result type.
- WinProp_Net_Project_Result_Disable
- Disables the computation of the specified result type.
Function Details
- int WinProp_Net_Project_Open(int * OUT_Handle, unsigned int IN_AirInterface, WinProp_Callback * IN_Callback)
Description
This function creates a new network planning projectParameters
- int * OUT_Handle
- Handle of this project.
- unsigned int IN_AirInterface
- Type of air interface. see defines in "AI_Define.h".
- WinProp_Callback * IN_Callback
- Pointer to callback functions for simulation progress.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_Open_WST(int * OUT_Handle, const char * IN_AirInterface, WinProp_Callback * IN_Callback)
Description
This function creates a new network planning projectParameters
- int * OUT_Handle
- Handle of this project.
- const char * IN_AirInterface
- Air interface description file.
- WinProp_Callback * IN_Callback
- Pointer to callback functions for simulation progress.
Returns An integer : 0 = success, failure otherwise.
- int WinProp_Net_Project_Close(int IN_Handle)
Description
This function closes an existing project.Parameters
- int IN_Handle
- Handle of project to be closed.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_Para_Get(int IN_Handle, int IN_Parameter, double * OUT_ReturnDouble, int * OUT_ReturnInt, char * OUT_ReturnChar)
Description
This function gets parameters of the current air interfaceParameters
- int IN_Handle
- Handle of the project.
- int IN_Parameter
- Parameter to be retreived.
- double * OUT_ReturnDouble
- Return value (if double required)
- int * OUT_ReturnInt
- Return value (if int required)
- char * OUT_ReturnChar
- Return value (if string required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_Para_Set(int IN_Handle, int IN_Parameter, const double * IN_Double, const int * IN_Int, const char * IN_Char)
Description
Set parameters of the current air interfaceParameters
- int IN_Handle
- Handle of the project.
- int IN_Parameter
- Parameter to be set.
- const double * IN_Double
- Return value (if double required)
- const int * IN_Int
- Return value (if int required)
- const char * IN_Char
- Return value (if string required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_Compute(int IN_Handle, WinProp_Callback * IN_Callback)
Description
This function starts computation with a network module.Parameters
- int IN_Handle
- Handle of the project to be computed.
- WinProp_Callback * IN_Callback
- Pointer to the callback functions for simulation progress.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_ComputePoints(int IN_Handle, WinProp_Callback * IN_Callback)
Description
Start computation with a network module on points.Parameters
- int IN_Handle
- Handle of the project to be computed.
- WinProp_Callback * IN_Callback
- Pointer to the callback functions for simulation progress.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_ComputeTrajectories(int IN_Handle, WinProp_Callback * IN_Callback)
Description
Start computation with a network module on trajectories.Parameters
- int IN_Handle
- Handle of the project to be computed.
- WinProp_Callback * IN_Callback
- Pointer to the callback functions for simulation progress.
Returns An integer : 0 = success, failure otherwise.
- int WinProp_Net_PropagationMap_Add(int IN_Handle, int * OUT_MapIndex, WinProp_Antenna * IN_Transmitter, WinProp_Result * IN_Map)
Description
Add wave propagation result.Parameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map.
- WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- WinProp_Result * IN_Map
- Wave propagation map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_LosMap_Add(int IN_Handle, int * OUT_MapIndex, WinProp_Antenna * IN_Transmitter, WinProp_Result * IN_LosMap)
Description
Add Line-of-sight resultParameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map.
- WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- WinProp_Result * IN_LosMap
- LOS result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_RayMatrix_Add(int IN_Handle, int * OUT_MapIndex, WinProp_Antenna * IN_Transmitter, WinProp_RayMatrix * IN_RayMatrix)
Description
Add ray matrix resultParameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map.
- WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- WinProp_RayMatrix * IN_RayMatrix
- ray matrix result.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_RayMatrixPlane_Add(int IN_Handle, int * OUT_MapIndex, WinProp_Antenna * IN_Transmitter, WinProp_RayMatrixList * IN_RayMatriList)
Description
Add ray matrix results for planesParameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map.
- WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- WinProp_RayMatrixList * IN_RayMatriList
- ray matrix results.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationPlane_Add(int IN_Handle, int * OUT_MapIndex, WinProp_Antenna * IN_Transmitter, WinProp_ResultPlaneList * IN_MapPlanes)
Description
Add wave propagation result on planes.Parameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map
- WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- WinProp_ResultPlaneList * IN_MapPlanes
- Wave propagation map (planes).
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationPoint_Add(int IN_Handle, int * OUT_MapIndex, WinProp_Antenna * IN_Transmitter, WinProp_ResultPointsList * IN_MapPoints)
Description
Add wave propagation result of a list of pointsParameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map.
- WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- WinProp_ResultPointsList * IN_MapPoints
- Wave propagation points list.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationTrajectory_Add(int IN_Handle, int * OUT_MapIndex, const WinProp_Antenna * IN_Transmitter, const WinProp_Trajectory * IN_Trajectories, int IN_NrTrajectories, const WinProp_ResultTrajectoryList * IN_MapTrajs)
Description
Add wave propagation result of a list of trajectoriesParameters
- int IN_Handle
- Handle of the project.
- int * OUT_MapIndex
- Assigned index to this map.
- const WinProp_Antenna * IN_Transmitter
- Information about transmitter.
- const WinProp_Trajectory * IN_Trajectories
- Information about receiver configuration in trajectory mode.
- int IN_NrTrajectories
- Number of trajectories.
- const WinProp_ResultTrajectoryList * IN_MapTrajs
- Wave propagation result list of trajectories.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationMap_Delete(int IN_Handle, int IN_MapIndex)
Description
Delete wave propagation results.Parameters
- int IN_Handle
- Handle of the project.
- int IN_MapIndex
- Index of map to be removed.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationPlane_Delete(int IN_Handle, int IN_MapIndex)
Description
Delete wave propagation results in a plane.Parameters
- int IN_Handle
- Handle of the project.
- int IN_MapIndex
- Index of map to be removed.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationPoints_Delete(int IN_Handle, int IN_MapIndex)
Description
Delete wave propagation point results.Parameters
- int IN_Handle
- Handle of the project.
- int IN_MapIndex
- Index of map to be removed.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationTrajectory_Delete(int IN_Handle, int IN_MapIndex)
Description
Delete wave propagation trajectory results.Parameters
- int IN_Handle
- Handle of the project.
- int IN_MapIndex
- Index of map to be removed.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationMap_Clean(int IN_Handle)
Description
Remove all wave propagation results.Parameters
- int IN_Handle
- Handle of the project.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkMap_Global_Get(int IN_Handle, int IN_ResultType, WinProp_Result ** OUT_NetworkResult)
Description
Retrieve computed network results regardless of transmission mode or carrier.Parameters
- int IN_Handle
- Handle of project.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_Result ** OUT_NetworkResult
- Pointer to network result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkMap_Get(int IN_Handle, int IN_Service, int IN_ResultType, WinProp_Result ** OUT_NetworkResult)
Description
Obtain computed network results.Parameters
- int IN_Handle
- Handle of project.
- int IN_Service
- Index of service or application in case of a Monte-Carlo area result.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_Result ** OUT_NetworkResult
- Pointer to network result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkMap_Carrier_Get(int IN_Handle, int IN_Service, int IN_Carrier, int IN_ResultType, WinProp_Result ** OUT_NetworkResult)
Description
Obtain computed network results individually for a carrier.Parameters
- int IN_Handle
- Handle of project.
- int IN_Service
- Index of service or application in case of a Monte-Carlo area result.
- int IN_Carrier
- Index of carrier.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_Result ** OUT_NetworkResult
- Pointer to network result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkMonteCarloStats_Get(int IN_Handle, WinProp_ResultMonteCarlo ** OUT_NetworkResult)
Description
Gets the Monte-Carlo result statistics of a network simulation.Parameters
- int IN_Handle
- Handle of the project.
- WinProp_ResultMonteCarlo ** OUT_NetworkResult
- If non-null, the out network result.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkPlane_Global_Get(int IN_Handle, int IN_ResultType, WinProp_ResultPlaneList ** OUT_NetworkPlanes)
Description
Retrieve computed network results on planes regardless of transmission mode or carrier.Parameters
- int IN_Handle
- Handle of project.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_ResultPlaneList ** OUT_NetworkPlanes
- Pointer to network result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkPlane_Get(int IN_Handle, int IN_Service, int IN_ResultType, WinProp_ResultPlaneList ** OUT_NetworkPlanes)
Description
Obtain computed network result on planes.Parameters
- int IN_Handle
- Handle of project.
- int IN_Service
- Index of service or application in case of a Monte-Carlo area result.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_ResultPlaneList ** OUT_NetworkPlanes
- Pointer to network result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkPlane_Carrier_Get(int IN_Handle, int IN_Service, int IN_Carrier, int IN_ResultType, WinProp_ResultPlaneList ** OUT_NetworkPlanes)
Description
Obtain a individually for a carrier computed network result.Parameters
- int IN_Handle
- Handle of the project.
- int IN_Service
- Index of service or application in case of a Monte-Carlo area result.
- int IN_Carrier
- Carrier.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_ResultPlaneList ** OUT_NetworkPlanes
- Pointer to network result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkTrajectoryList_Get(int IN_Handle, int IN_Service, int IN_ResultType, WinProp_ResultTrajectoryList ** OUT_NetworkTrajectoiries)
Description
Obtain computed network trajectories result.Parameters
- int IN_Handle
- Handle of project.
- int IN_Service
- Index of service or application in case of a Monte-Carlo area result.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_ResultTrajectoryList ** OUT_NetworkTrajectoiries
- Pointer to network trajectory list result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_NetworkTrajectoryList_Carrier_Get(int IN_Handle, int IN_Service, int IN_Carrier, int IN_ResultType, WinProp_ResultTrajectoryList ** OUT_NetworkTrajectoiries)
Description
Obtain a individually for a carrier computed network trajectories result.Parameters
- int IN_Handle
- Handle of the project.
- int IN_Service
- Index of service or application in case of a Monte-Carlo area result.
- int IN_Carrier
- Carrier.
- int IN_ResultType
- Type of result to be retrieved.
- WinProp_ResultTrajectoryList ** OUT_NetworkTrajectoiries
- Pointer to network trajectory list result map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PropagationMap_GetTrxInfo(int IN_Handle, int IN_MapIndex, WinProp_Antenna ** OUT_Transmitter)
Description
Get information about transmitter.Parameters
- int IN_Handle
- Handle of the project.
- int IN_MapIndex
- Assigned index to this map.
- WinProp_Antenna ** OUT_Transmitter
- Information about transmitter .
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Carrier_Add(int IN_Handle, unsigned int IN_CarrierIndex)
Description
Add carrier to air interface.Parameters
- int IN_Handle
- Handle of the project.
- unsigned int IN_CarrierIndex
- Index of new carrier.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Carrier_Check(int IN_Handle, unsigned int IN_CarrierIndex, double * OUT_FrequencyUplink, double * OUT_FrequencyDownlink)
Description
Get information about the carrier.Parameters
- int IN_Handle
- Handle of the project.
- unsigned int IN_CarrierIndex
- Index of the carrier.
- double * OUT_FrequencyUplink
- Uplink (UL) frequency of the carrier in MHz.
- double * OUT_FrequencyDownlink
- Downlink (DL) frequency of the carrier in MHz.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Carrier_Delete(int IN_Handle, unsigned int IN_CarrierIndex)
Description
Delete a carrier from interface.Parameters
- int IN_Handle
- Handle of the project.
- unsigned int IN_CarrierIndex
- Index of carrier to be removed.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Carrier_Para_Set(int IN_Handle, int IN_Index, int IN_Parameter, double * IN_DoubleValue, int * IN_IntValue, char * IN_Char)
Description
Sets a parameter of a carrierParameters
- int IN_Handle
- Handle of project.
- int IN_Index
- ID of carrier.
- int IN_Parameter
- The parameter to be set.
- double * IN_DoubleValue
- Double (if required)
- int * IN_IntValue
- Integer (if required)
- char * IN_Char
- String (if required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Carrier_Para_Get(int IN_Handle, int IN_Index, int IN_Parameter, double * OUT_RetuernDoubleValue, int * OUT_RetuernIntValue, char * OUT_RetuernCharValue)
Description
Gets a parameter of a carrier.Parameters
- int IN_Handle
- Handle of project.
- int IN_Index
- ID of carrier.
- int IN_Parameter
- The parameter to get.
- double * OUT_RetuernDoubleValue
- If non-null, the return double value.
- int * OUT_RetuernIntValue
- If non-null, the return int value.
- char * OUT_RetuernCharValue
- If non-null, the return character.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_TransmissionMode_Add(int IN_Handle, char * IN_Name, unsigned int IN_Index)
Description
Add new MCS/transmission mode/service.Parameters
- int IN_Handle
- Handle of the project.
- char * IN_Name
- Name of MCS.
- unsigned int IN_Index
- Index of new MCS.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_TransmissionMode_Delete(int IN_Handle, unsigned int IN_Index)
Description
Delete existing MCS/transmission mode.Parameters
- int IN_Handle
- Handle of the project.
- unsigned int IN_Index
- Index of MCS to be deleted.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_TransmissionMode_Para_Set(int IN_Handle, int IN_Index, int IN_Parameter, double * IN_DoubleValue, int * IN_IntValue, char * IN_Char)
Description
Modify parameter of MCS.Parameters
- int IN_Handle
- Handle of the project.
- int IN_Index
- Index of the MCS.
- int IN_Parameter
- Parameter to modify.
- double * IN_DoubleValue
- Double (if required)
- int * IN_IntValue
- Integer (if required)
- char * IN_Char
- String (if required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_TransmissionMode_Para_Get(int IN_Handle, int IN_Index, int IN_Parameter, double * OUT_ReturnDoubleValue, int * OUT_ReturnIntValue, char * OUT_ReturnChar)
Description
Retrieve information about a network planning parameter.Parameters
- int IN_Handle
- Handle of the project.
- int IN_Index
- Index of MCS.
- int IN_Parameter
- Parameter to retrieve.
- double * OUT_ReturnDoubleValue
- Double (if required)
- int * OUT_ReturnIntValue
- Integer (if required)
- char * OUT_ReturnChar
- String (if required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Channel_Add(int IN_Handle, char * IN_Name, unsigned int * OUT_Index)
Description
Add new channel to network project.Parameters
- int IN_Handle
- Handle of the project.
- char * IN_Name
- Name of new channel.
- unsigned int * OUT_Index
- Index of new channel.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Channel_Para_Set(int IN_Handle, int IN_Index, int IN_Parameter, double * IN_DoubleValue, int * IN_IntValue, char * IN_Char)
Description
Set parameter of a channel.Parameters
- int IN_Handle
- Handle of the project.
- int IN_Index
- Index of channel.
- int IN_Parameter
- Parameter to modify.
- double * IN_DoubleValue
- Double (if required)
- int * IN_IntValue
- Integer (if required)
- char * IN_Char
- String (if required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Channel_Para_Get(int IN_Handle, int IN_Index, int IN_Parameter, double * OUT_DoubleValue, int * OUT_IntValue, char * OUT_Char)
Description
Get parameter of a channel.Parameters
- int IN_Handle
- Handle of the project.
- int IN_Index
- Index of channel.
- int IN_Parameter
- Parameter to retrieve.
- double * OUT_DoubleValue
- Double (if required)
- int * OUT_IntValue
- Integer (if required)
- char * OUT_Char
- String (if required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Channel_Delete(int IN_Handle, unsigned int IN_Index)
Description
Delete channel from network projectParameters
- int IN_Handle
- Handle of the project.
- unsigned int IN_Index
- Index of channel to delete.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PrioMap_Set(int IN_Handle, WinProp_Result * IN_PrioMap)
Description
Set priority map for optimizer.Parameters
- int IN_Handle
- Handle of the project.
- WinProp_Result * IN_PrioMap
- Priority map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_PrioMap_Get(int IN_Handle, WinProp_Result ** OUT_PrioMap)
Description
Get priority map for optimizer.Parameters
- int IN_Handle
- Handle of the project.
- WinProp_Result ** OUT_PrioMap
- Priority map.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_Add(int IN_Handle, int IN_ID, int IN_Priority, float IN_Activity, int IN_TrafficMode, const char * IN_Name)
Description
Adds an application to the network planning project.Parameters
- int IN_Handle
- Handle of the project.
- int IN_ID
- ID of the application.
- int IN_Priority
- Application priority.
- float IN_Activity
- Application activity.
- int IN_TrafficMode
- The traffic mode of the application.
- const char * IN_Name
- Name of the application.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_Delete(int IN_Handle, int IN_ID)
Description
Deletes an application from the network planning project.Parameters
- int IN_Handle
- Handle of project.
- int IN_ID
- ID of application.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_TransmissionMode_Link(int IN_Handle, int IN_ID, int IN_TransmissionModeID, int IN_Preference)
Description
Links an application to a transmission mode and sets the preference of that link.Parameters
- int IN_Handle
- Handle of the project.
- int IN_ID
- ID of application.
- int IN_TransmissionModeID
- Identifier for the transmission mode.
- int IN_Preference
- The preference.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_TransmissionMode_Unlink(int IN_Handle, int IN_ID, int IN_TransmissionModeID)
Description
Unlinks a transmission mode from an application.Parameters
- int IN_Handle
- Handle of project.
- int IN_ID
- ID of application.
- int IN_TransmissionModeID
- Identifier for the transmission mode.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_ClutterClass_Link(int IN_Handle, int IN_ID, int IN_ClutterID, float IN_ArrivalRate, float IN_HoldTime, float IN_OfferedTraffic)
Description
Links an application to a clutter class and sets various parameters of this link.Parameters
- int IN_Handle
- Handle of project.
- int IN_ID
- ID of application.
- int IN_ClutterID
- Identifier for the clutter class.
- float IN_ArrivalRate
- The arrival rate.
- float IN_HoldTime
- The hold time.
- float IN_OfferedTraffic
- The offered traffic.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_ClutterClass_Unlink(int IN_Handle, int IN_ID, int IN_ClutterID)
Description
Unlinks a clutter class from an application.Parameters
- int IN_Handle
- Handle of project.
- int IN_ID
- ID of application.
- int IN_ClutterID
- Identifier for the clutter class.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_Para_Set(int IN_Handle, int IN_Index, int IN_Parameter, const double * IN_DoubleValue, const int * IN_IntValue, const char * IN_CharValue)
Description
Sets a parameter of an application.Parameters
- int IN_Handle
- Handle of project.
- int IN_Index
- ID of application.
- int IN_Parameter
- The parameter to be set.
- const double * IN_DoubleValue
- Double (if required)
- const int * IN_IntValue
- Integer (if required)
- const char * IN_CharValue
- String (if required)
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Application_Para_Get(int IN_Handle, int IN_Index, int IN_Parameter, double * OUT_ReturnDoubleValue, int * OUT_ReturnIntValue, char * OUT_ReturnChar)
Description
Gets a parameter of an application.Parameters
- int IN_Handle
- Handle of project.
- int IN_Index
- ID of application.
- int IN_Parameter
- The parameter to get.
- double * OUT_ReturnDoubleValue
- If non-null, the return double value.
- int * OUT_ReturnIntValue
- If non-null, the return int value.
- char * OUT_ReturnChar
- If non-null, the return character.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Clutter_Set(int IN_Handle, int IN_ClutterMode, const char * IN_ClutterTraffic, bool IN_ClutterIsIndex, const char * IN_ClutterTable, CLUTTER * IN_ClutterData)
Description
Sets the clutter data needed for network planning projects with Monte-Carlo simulation.Parameters
- int IN_Handle
- Handle of the project.
- int IN_ClutterMode
- The clutter mode.
- CLUTTERMODE_NONE = don't use clutter data
- CLUTTERMODE_FILE = load clutter data from specified files
- CLUTTERMODE_RAM = use clutter data from memory
- const char * IN_ClutterTraffic
- Filename to the clutter traffic database.
- bool IN_ClutterIsIndex
- True if clutter traffic is an index database.
- const char * IN_ClutterTable
- Filename to the clutter table.
- CLUTTER * IN_ClutterData
- If non-null, clutter data stored in memory, IN_ClutterMode needs to be set to CLUTTERMODE_RAM.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_Result_Switch(int IN_Handle, int IN_Parameter, bool IN_State)
Description
Sets the computation of the specified result type to the specified state.Parameters
- int IN_Handle
- Handle of project.
- int IN_Parameter
- The result type.
- bool IN_State
- Enable / disable the computation.
Returns An integer: 0 = success, failure otherwise.
- int WinProp_Net_Project_Result_Enable(int IN_Handle, int IN_Parameter)
Description
Enables the computation of the specified result type.Parameters
- int IN_Handle
- Handle of project.
- int IN_Parameter
- The result type.
Returns An int.
- int WinProp_Net_Project_Result_Disable(int IN_Handle, int IN_Parameter)
Description
Disables the computation of the specified result type.Parameters
- int IN_Handle
- Handle of project.
- int IN_Parameter
- The result type.
Returns An int.
The documentation was generated from the following file:
- source/Net/Net.h