Inheritance diagram for TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider:

Public Member Functions

RadioPropagationProvider (IElevationDataInterfacer elevationDataInterfacer, IMapResources mapResources, IPropagationToolManager toolManager)

Constructor, includes loading of external native modules.

RadioPropagationModelInfo GetModelByName (string modelName)

Finds a computation method from lookup by name in the Models dictionary.

Parameters

modelName

Returns

bool AddLayer (IRadioPropagationLayer layer)

Handles addition of a new RadioPropagationLayer.

Parameters

layer

Returns

void RemoveLayer (IRadioPropagationLayer layer)

Handles removal of an existing RadioPropagationLayer.

Parameters

layer

bool StoreLayer (string path, IRadioPropagationLayer layer)

Store a RadioPropagationLayer to a named file.

Parameters

path
layer

Returns

IRadioPropagationLayer LoadLayer (string path)

Creates a RadioPropagationLayer from file.

Parameters

path

Returns

bool ExportCoverageChartToGeoTIFF (string path, IRadioPropagationLayer layer)

Export a layer's coverage chart to a named file using the GeoTIFF format.

Parameters

path
layer

Returns

void RegisterAntennaType (string antennaType, IAntennaGainDistribution gainDistribution)

Register or redefine an antenna type along with nominal gain distribution model.

Parameters

antennaType
gainDistribution

IAntennaGainDistribution GetGainDistribution (string antennaType)

Gets nominal gain distribution model associated with a specific antenna type.

Parameters

antennaType

Returns

IEnumerable< string > GetRegisteredAntennaTypes ()

Gets set of registered antenna types.

Returns

RadioPropagationModelInfo GetModelByName (string modelName)

Finds a computation method from lookup by name in the Models dictionary.

bool AddLayer (IRadioPropagationLayer layer)

Handles addition of a new RadioPropagationLayer.

void RemoveLayer (IRadioPropagationLayer layer)

Handles removal of an existing RadioPropagationLayer.

bool StoreLayer (string path, IRadioPropagationLayer layer)

Store a RadioPropagationLayer to a named file.

IRadioPropagationLayer LoadLayer (string path)

Creates a RadioPropagationLayer from file.

bool ExportCoverageChartToGeoTIFF (string path, IRadioPropagationLayer layer)

Export a layer's coverage chart to a named file using the GeoTIFF format.

void RegisterAntennaType (string antennaType, IAntennaGainDistribution gainDistribution)

Register or redefine an antenna type along with nominal gain distribution model.

IAntennaGainDistribution GetGainDistribution (string antennaType)

Gets nominal gain distribution model associated with a specific antenna type.

IEnumerable< string > GetRegisteredAntennaTypes ()

Gets set of registered antenna types.

Properties
IRadioPropagationNativeBridge	NativeBridge `[get]`
	Access to native (C++) methods.

IPropagationToolManager	ToolManager `[get]`
	Get tool manager.

ObservableCollection< IRadioPropagationLayer >	Layers `[get]`
	Ordered sets of transmitter-receiver units.Use the AddLayer()/RemoveLayer() methods to add/remove layers. Do not add/remove from this collection directly

Dictionary< string, RadioPropagationModelInfo >	Models `[get]`
	Collection of methods for computation of microwave propagation in terrain - among other things.

uint	Version `[get]`
	Gets code version for data file compatibility checks.

Properties inherited from TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider
IPropagationToolManager	ToolManager `[get]`
	Get tool manager.

IRadioPropagationNativeBridge	NativeBridge `[get]`
	Access to native (C++) methods.

ObservableCollection< IRadioPropagationLayer >	Layers `[get]`
	Ordered sets of transmitter-receiver units.

Dictionary< string, RadioPropagationModelInfo >	Models `[get]`
	Collection of methods for computation of microwave propagation in terrain - among other things.

uint	Version `[get]`
	Gets code version for data file compatibility checks.

Detailed Description

Constructor & Destructor Documentation

◆ RadioPropagationProvider()

TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.RadioPropagationProvider	(	IElevationDataInterfacer	elevationDataInterfacer,
		IMapResources	mapResources,
		IPropagationToolManager	toolManager
	)

inline

Constructor, includes loading of external native modules.

Parameters

elevationDataInterfacer	Access to elevation data
mapResources	Access to bitmap rendering in a geo context

Member Function Documentation

◆ AddLayer()

bool TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.AddLayer ( IRadioPropagationLayer layer )

inline

Handles addition of a new RadioPropagationLayer.

Parameters

layer

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ ExportCoverageChartToGeoTIFF()

bool TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.ExportCoverageChartToGeoTIFF	(	string	path,
		IRadioPropagationLayer	layer
	)

inline

Export a layer's coverage chart to a named file using the GeoTIFF format.

Parameters

path
layer

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ GetGainDistribution()

IAntennaGainDistribution TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.GetGainDistribution ( string antennaType )

inline

Gets nominal gain distribution model associated with a specific antenna type.

Parameters

antennaType

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ GetModelByName()

RadioPropagationModelInfo TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.GetModelByName ( string modelName )

inline

Finds a computation method from lookup by name in the Models dictionary.

Parameters

modelName

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ GetRegisteredAntennaTypes()

IEnumerable< string > TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.GetRegisteredAntennaTypes ( )

inline

Gets set of registered antenna types.

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ LoadLayer()

IRadioPropagationLayer TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.LoadLayer ( string path )

inline

Creates a RadioPropagationLayer from file.

Parameters

path

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ RegisterAntennaType()

void TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.RegisterAntennaType	(	string	antennaType,
		IAntennaGainDistribution	gainDistribution
	)

inline

Register or redefine an antenna type along with nominal gain distribution model.

Parameters

antennaType
gainDistribution

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ RemoveLayer()

void TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.RemoveLayer ( IRadioPropagationLayer layer )

inline

Handles removal of an existing RadioPropagationLayer.

Parameters

layer

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ StoreLayer()

bool TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.StoreLayer	(	string	path,
		IRadioPropagationLayer	layer
	)

inline

Store a RadioPropagationLayer to a named file.

Parameters

path
layer

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

Property Documentation

◆ Layers

ObservableCollection<IRadioPropagationLayer> TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.Layers

get

Ordered sets of transmitter-receiver units.Use the AddLayer()/RemoveLayer() methods to add/remove layers. Do not add/remove from this collection directly

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ Models

Dictionary<string, RadioPropagationModelInfo> TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.Models

get

Collection of methods for computation of microwave propagation in terrain - among other things.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ NativeBridge

IRadioPropagationNativeBridge TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.NativeBridge

get

Access to native (C++) methods.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ ToolManager

IPropagationToolManager TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.ToolManager

get

Get tool manager.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

◆ Version

uint TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.Version

get

Gets code version for data file compatibility checks.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.

The documentation for this class was generated from the following file:

Src/Layers/RadioPropagation/TPG.GeoFramework.RadioPropagation.Provider/RadioPropagationProvider.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RadioPropagationProvider()

Member Function Documentation

◆ AddLayer()

◆ ExportCoverageChartToGeoTIFF()

◆ GetGainDistribution()

◆ GetModelByName()

◆ GetRegisteredAntennaTypes()

◆ LoadLayer()

◆ RegisterAntennaType()

◆ RemoveLayer()

◆ StoreLayer()

Property Documentation

◆ Layers

◆ Models

◆ NativeBridge

◆ ToolManager

◆ Version