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

Public Member Functions

TransmitterReceiver (GeoPos pos)

Constructor.

void SetBoost (bool bBoost, double rxGain)

Boost coverage with supplied receiver gain.Internal use

void SetCoverageArea (GeoRect r)

Set coverage area as a GeoRect.This kind of area is not required to contain the unit position, and will not move along with the unit position

void SetCoverageArea (GeoPos pos, double radius)

Move unit to a position, and set its assigned coverage area to be neighborhood with given radius around that position.If the position is the current one, the effect is to adjust the radius of the assigned coverage area

void SetCoverageArea (GeoPos[] route)

Set coverage area to trace a route.

Parameters

route Array of waypoints

void SetCoverageArea (GeoPos3D[] airroute)

Set coverage area to trace a route with elevation.

bool GetValue (GeoPos gp, ref double value)

Get coverage value (meaning depends on model) at given position.

Parameters

gp	position
value	coverage value

Returns: True if value is available at given point

bool Calculate ()

Caculate or recalculate coverage according currently assigned properties.

Returns: True if calculation initiated successfully

void Cancel ()

Cancels an ongoing coverage calculation.

void AddAntennaEffects (CoverageMatrix pAcc, bool bAttached)

Add antenna effects to a specific coverage matrix, based on antenna characteristics and effective azimuth and elevation values for the matrix' elements. Internal ues only.

Parameters

pAcc	Coverage matrix
bAttached	true if pAcc is attched to global coverage. False if newly calculated or if global coverage is locked

void ToStream (Stream ost)

Save unit along with parameters and coverage data to stream.

Parameters

ost

bool FromStream (Stream ist)

Load unit parameters and coverage data from stream.

Parameters

ist

Returns

void AddAntennaEffects (CoverageMatrix pAcc, bool bAttached)

Add antenna effects to a specific coverage matrix, based on antenna characteristics and effective azimuth and elevation values for the matrix' elements. Internal ues only.

void SetBoost (bool bBoost, double rxGain)

Boost coverage with supplied receiver gain.

void SetCoverageArea (GeoRect r)

Set coverage area as a GeoRect.

void SetCoverageArea (GeoPos pos, double radius)

Move unit to a position, and set its assigned coverage area to be neighborhood with given radius around that position.

void SetCoverageArea (GeoPos[] route)

Set coverage area to trace a route.

void SetCoverageArea (GeoPos3D[] airroute)

Set coverage area to trace a route with elevation.

bool GetValue (GeoPos gp, ref double value)

Get coverage value (meaning depends on model) at given position.

bool Calculate ()

Caculate or recalculate coverage according currently assigned properties.

void Cancel ()

Cancels an ongoing coverage calculation.

void ToStream (Stream ost)

Save unit along with parameters and coverage data to stream.

bool FromStream (Stream ist)

Load unit parameters and coverage data from stream.

Properties
Guid	Id `[get, set]`
	Get unique id.

bool	IsRangeToolEnabled `[get, set]`
	Enable or disable range tool.Only applies to circle coverage area type.

bool	IsAreaSizeToolEnabled `[get, set]`
	Enable or disable area size tool.Only applies to GeoRect coverage area type.

bool	IsMoveToolEnabled `[get, set]`
	Enable or disable range tool.Only applies to circle coverage area type.

bool	AutoRecalcCoverage `[get, set]`
	Gets or sets if recalculation of coverage should be attempted automatically when position or coverage area are changed by tools. Default is true.

IRadioPropagationLayer	Layer `[get, set]`
	Get or set the RadioPropagationLayer owning the unit.The set method is for internal use

CoverageData	Coverage `[get]`
	Get the coverage data, if available.

bool	Visible `[get, set]`
	Get or set if the coverage of this unit contributes to the combined coverage of the layer.

double	TxPower `[get, set]`
	Tx power in Watts.

double	UavTxPower `[get, set]`
	Tx power in Watts for a remote Uav transmitter.

IAntenna	Antenna `[get, set]`
	Antenna with specific gain distribution.

double	TxGain `[get, set]`
	Tx antenna gain in dBm. Ignored if Antenna is present.

double	UavTxGain `[get, set]`
	Tx antenna gain in dBm for a remote Uav transmitter.

double	RxGain `[get, set]`
	Set antenna receiver gain.For coverage, for comparision between units, a value common throughout the RadioPropagation layer will be employed rather than the indiviual gain

double	RxHeight `[get, set]`
	Set or get receiver antenna height, in meters AGL.For coverage, for comparision between units, a value common throughout the RadioPropagation layer will be employed rather than the indiviual rx antenna height

double	MinSignal `[get, set]`
	Set or get the minimum signal strength in dBm for successful connectivity receptions.

double	SNRatio `[get, set]`
	Set or get the max acceptable signal to noice ratio for successful connectivity receptions.

NetworkUnitRole	Role `[get, set]`
	Set or get the unit role as member of a connectivity network.

double	TxHeight `[get, set]`
	Set or get the transmitter antenna height, in meters AGL.

GeoPos	Position `[get, set]`
	Set or get the unit position.If the assigned coverage area is a neighborhood of given radius around the unit position, that area will move along with position change.

CoverageArea	CoverageArea `[get]`
	Get the currently assigned coverage area.

double	Frequency `[get, set]`
	Carrier frequency in MHz, preferably within the VHF-UHF ranges.NB! The 'get' method returns the layer frequency unless the individual unit frequency is explicitly set to a positive value. The layer frequency is the one used for coverage calculations for all units within the layer.

int	Polarization `[get]`
	Get active wave polarization.

RadioPropagationModelInfo	Model `[get]`
	Get active propagation model.

double	Refraction `[get]`
	Get active refraction value.

int	NumberOfKnifeEdges `[get]`
	Get number of diffraction knife edges in currently assigned model

bool	Working `[get]`
	Get if unit is currently performing a coverage calculation.

Properties inherited from TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver
Guid	Id `[get]`
	Get unique id.

bool	IsRangeToolEnabled `[get, set]`
	Enable or disable range tool.

bool	IsAreaSizeToolEnabled `[get, set]`
	Enable or disable area size tool.

bool	IsMoveToolEnabled `[get, set]`
	Enable or disable range tool.

bool	AutoRecalcCoverage `[get, set]`
	Gets or sets if recalculation of coverage should be attempted automatically when position or coverage area are changed by tools. Default is true.

IRadioPropagationLayer	Layer `[get, set]`
	Get or set the RadioPropagationLayer owning the unit.

CoverageData	Coverage `[get]`
	Get the coverage data, if available.

bool	Visible `[get, set]`
	Get or set if the coverage of this unit contributes to the combined coverage of the layer.

new double	TxPower `[get, set]`
	Tx power in Watts.

new double	UavTxPower `[get, set]`
	Tx power in Watts for a remote Uav transmitter.

new IAntenna	Antenna `[get, set]`
	Antenna with specific gain distribution.

new double	TxGain `[get, set]`
	Tx antenna gain in dBm. Ignored if Antenna is present.

new double	UavTxGain `[get, set]`
	Tx antenna gain in dBm for a remote Uav transmitter.

new double	RxGain `[get, set]`
	Set antenna receiver gain.

new double	RxHeight `[get, set]`
	Set or get receiver antenna height, in meters AGL.

new double	MinSignal `[get, set]`
	Set or get the minimum signal strength in dBm for successful connectivity receptions.

new double	SNRatio `[get, set]`
	Set or get the max acceptable signal to noice ratio for successful connectivity receptions.

new NetworkUnitRole	Role `[get, set]`
	Set or get the unit role as member of a connectivity network.

new double	TxHeight `[get, set]`
	Set or get the transmitter antenna height, in meters AGL.

new GeoPos	Position `[get, set]`
	Set or get the unit position.

CoverageArea	CoverageArea `[get]`
	Get the currently assigned coverage area.

new double	Frequency `[get, set]`
	Carrier frequency in MHz, preferably within the VHF-UHF ranges.

new int	Polarization `[get]`
	Get active wave polarization.

new RadioPropagationModelInfo	Model `[get]`
	Get active propagation model.

new double	Refraction `[get]`
	Get active refraction value.

new int	NumberOfKnifeEdges `[get]`
	Get number of diffraction knife edges in currently assigned model

bool	Working `[get]`
	Get if unit is currently performing a coverage calculation.

Properties inherited from TPG.GeoFramework.RadioPropagation.Data.INetworkUnit
GeoPos	Position `[get]`
	Position of transmitter-receiver unit.

NetworkUnitRole	Role `[get]`
	Unit role within a layer set.

RadioPropagationModelInfo	Model `[get]`
	Microwave propagation model.

double	Refraction `[get]`
	Refraction coefficient used for wave propagation calculations.

int	NumberOfKnifeEdges `[get]`
	Max number of diffraction edges. Used with the VHF/UHF model.

int	Polarization `[get]`
	Wave polarization. Used with the VHF/UHF model.

double	Frequency `[get]`
	Carrier wave frequency in MHz.

double	RxHeight `[get]`
	Rx antenna height in meters AGL.

double	TxHeight `[get]`
	Tx antenna height in maters AGL.

double	TxPower `[get]`
	Tx power in Watts.

IAntenna	Antenna `[get]`
	Antenna with specific gain distribution.

double	TxGain `[get]`
	Nominal Tx antenna gain in dBm. Ignored if Antenna is present.

double	RxGain `[get]`
	Nominal Rx antenna gain in dBm.

double	MinSignal `[get]`
	Minimum acceptable signal strength in dBm.

double	SNRatio `[get]`
	Max acceptable signal-to-noice ratio in dB.

Events
EventHandler	CalculationStarted = delegate { }

EventHandler	CalculationComplete = delegate { }

EventHandler	CalculationCancelled = delegate { }

Events inherited from TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver
EventHandler	CalculationStarted
	Coverage calculation started event.

EventHandler	CalculationComplete
	Coverage calculation complete event.

EventHandler	CalculationCancelled
	Coverage calculation cancelled event.

Detailed Description

Constructor & Destructor Documentation

◆ TransmitterReceiver()

TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.TransmitterReceiver ( GeoPos pos )

inline

Constructor.

Parameters

pos

Member Function Documentation

◆ AddAntennaEffects()

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.AddAntennaEffects	(	CoverageMatrix	pAcc,
		bool	bAttached
	)

inline

Add antenna effects to a specific coverage matrix, based on antenna characteristics and effective azimuth and elevation values for the matrix' elements. Internal ues only.

Parameters

pAcc	Coverage matrix
bAttached	true if pAcc is attched to global coverage. False if newly calculated or if global coverage is locked

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Calculate()

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Calculate ( )

inline

Caculate or recalculate coverage according currently assigned properties.

Returns: True if calculation initiated successfully

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Cancel()

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Cancel ( )

inline

Cancels an ongoing coverage calculation.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ FromStream()

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.FromStream ( Stream ist )

inline

Load unit parameters and coverage data from stream.

Parameters

ist

Returns

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ GetValue()

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.GetValue	(	GeoPos	gp,
		ref double	value
	)

inline

Get coverage value (meaning depends on model) at given position.

Parameters

gp	position
value	coverage value

Returns: True if value is available at given point

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ SetBoost()

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.SetBoost	(	bool	bBoost,
		double	rxGain
	)

inline

Boost coverage with supplied receiver gain.Internal use

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ SetCoverageArea() [1/4]

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.SetCoverageArea	(	GeoPos	pos,
		double	radius
	)

inline

Move unit to a position, and set its assigned coverage area to be neighborhood with given radius around that position.If the position is the current one, the effect is to adjust the radius of the assigned coverage area

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ SetCoverageArea() [2/4]

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.SetCoverageArea ( GeoPos3D[] airroute )

inline

Set coverage area to trace a route with elevation.

Parameters

route Array of waypoints

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ SetCoverageArea() [3/4]

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.SetCoverageArea ( GeoPos[] route )

inline

Set coverage area to trace a route.

Parameters

route Array of waypoints

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ SetCoverageArea() [4/4]

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.SetCoverageArea ( GeoRect r )

inline

Set coverage area as a GeoRect.This kind of area is not required to contain the unit position, and will not move along with the unit position

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ ToStream()

void TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.ToStream ( Stream ost )

inline

Save unit along with parameters and coverage data to stream.

Parameters

ost

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

Property Documentation

◆ Antenna

IAntenna TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Antenna

getset

Antenna with specific gain distribution.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ AutoRecalcCoverage

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.AutoRecalcCoverage

getset

Gets or sets if recalculation of coverage should be attempted automatically when position or coverage area are changed by tools. Default is true.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Coverage

CoverageData TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Coverage

get

Get the coverage data, if available.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ CoverageArea

CoverageArea TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.CoverageArea

get

Get the currently assigned coverage area.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Frequency

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Frequency

getset

Carrier frequency in MHz, preferably within the VHF-UHF ranges.NB! The 'get' method returns the layer frequency unless the individual unit frequency is explicitly set to a positive value. The layer frequency is the one used for coverage calculations for all units within the layer.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Id

Guid TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Id

getset

Get unique id.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ IsAreaSizeToolEnabled

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.IsAreaSizeToolEnabled

getset

Enable or disable area size tool.Only applies to GeoRect coverage area type.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ IsMoveToolEnabled

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.IsMoveToolEnabled

getset

Enable or disable range tool.Only applies to circle coverage area type.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ IsRangeToolEnabled

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.IsRangeToolEnabled

getset

Enable or disable range tool.Only applies to circle coverage area type.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Layer

IRadioPropagationLayer TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Layer

getset

Get or set the RadioPropagationLayer owning the unit.The set method is for internal use

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ MinSignal

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.MinSignal

getset

Set or get the minimum signal strength in dBm for successful connectivity receptions.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Model

RadioPropagationModelInfo TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Model

get

Get active propagation model.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ NumberOfKnifeEdges

int TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.NumberOfKnifeEdges

get

Get number of diffraction knife edges in currently assigned model

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Polarization

int TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Polarization

get

Get active wave polarization.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Position

GeoPos TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Position

getset

Set or get the unit position.If the assigned coverage area is a neighborhood of given radius around the unit position, that area will move along with position change.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Refraction

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Refraction

get

Get active refraction value.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Role

NetworkUnitRole TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Role

getset

Set or get the unit role as member of a connectivity network.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ RxGain

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.RxGain

getset

Set antenna receiver gain.For coverage, for comparision between units, a value common throughout the RadioPropagation layer will be employed rather than the indiviual gain

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ RxHeight

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.RxHeight

getset

Set or get receiver antenna height, in meters AGL.For coverage, for comparision between units, a value common throughout the RadioPropagation layer will be employed rather than the indiviual rx antenna height

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ SNRatio

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.SNRatio

getset

Set or get the max acceptable signal to noice ratio for successful connectivity receptions.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ TxGain

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.TxGain

getset

Tx antenna gain in dBm. Ignored if Antenna is present.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ TxHeight

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.TxHeight

getset

Set or get the transmitter antenna height, in meters AGL.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ TxPower

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.TxPower

getset

Tx power in Watts.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ UavTxGain

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.UavTxGain

getset

Tx antenna gain in dBm for a remote Uav transmitter.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ UavTxPower

double TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.UavTxPower

getset

Tx power in Watts for a remote Uav transmitter.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Visible

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Visible

getset

Get or set if the coverage of this unit contributes to the combined coverage of the layer.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

◆ Working

bool TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.Working

get

Get if unit is currently performing a coverage calculation.

Implements TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.

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

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

Public Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ TransmitterReceiver()

Member Function Documentation

◆ AddAntennaEffects()

◆ Calculate()

◆ Cancel()

◆ FromStream()

◆ GetValue()

◆ SetBoost()

◆ SetCoverageArea() [1/4]

◆ SetCoverageArea() [2/4]

◆ SetCoverageArea() [3/4]

◆ SetCoverageArea() [4/4]

◆ ToStream()

Property Documentation

◆ Antenna

◆ AutoRecalcCoverage

◆ Coverage

◆ CoverageArea

◆ Frequency

◆ Id

◆ IsAreaSizeToolEnabled

◆ IsMoveToolEnabled

◆ IsRangeToolEnabled

◆ Layer

◆ MinSignal

◆ Model

◆ NumberOfKnifeEdges

◆ Polarization

◆ Position

◆ Refraction

◆ Role

◆ RxGain

◆ RxHeight

◆ SNRatio

◆ TxGain

◆ TxHeight

◆ TxPower

◆ UavTxGain

◆ UavTxPower

◆ Visible

◆ Working