NavigationSignalCharacteristics | DME Component Libraries for Java 2024 r3

java.lang.Object
- agi.foundation.navigation.advanced.NavigationSignalCharacteristics

public class NavigationSignalCharacteristics
extends Object

Defines specific details for GPS Signals.

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`GpsCAChipLength` The length of the CA code chip, in seconds.
`static double`	`GpsCACodeBandwidth` The total bandwidth of the CA code, between the first nulls.
`static double`	`GpsCCodeBandwidth` The total bandwidth of the C code, between the first nulls.
`static double`	`GpsIQCodeBandwidth` The total bandwidth of the L5 IQ code, between the first nulls.
`static double`	`GpsL1CChipLength` The length of the L1C code chip, in seconds.
`static double`	`GpsL1Frequency` The frequency of the GPS L1 carrier.
`static double`	`GpsL2CChipLength` The length of the L2C code chip, in seconds.
`static double`	`GpsL2Frequency` The frequency of the GPS L2 carrier.
`static double`	`GpsL5Frequency` The frequency of the GPS L5 carrier.
`static double`	`GpsL5IQChipLength` The length of the L5 I and Q code chips, in seconds.
`static double`	`GpsMCodeBandwidth` The total bandwidth of the M code, between the first nulls.
`static double`	`GpsMCodeChipLength` The length of the M code chip, in seconds.
`static double`	`GpsPYChipLength` The length of the P(Y) code chip, in seconds.
`static double`	`GpsPYCodeBandwidth` The total bandwidth of the P(Y) code, between the first nulls.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAntennaCorrelationLoss()` Gets the attenuation of the signal due to correlation losses.
`double`	`getAntennaPolarizationLoss()` Gets the attenuation of the signal due to antenna polarization effects.
`double`	`getBandwidth()` Gets the bandwidth the navigation signal uses.
`double`	`getCarrierFrequency()` Gets the carrier frequency on which the navigation signal is broadcast.
`double`	`getChipLength()` Gets the length of one pulse of navigation signal data.
`double`	`getDataRate()` Gets the rate at which data is encoded on the navigation signal.
`double`	`getDifferentialGroupDelay()` Gets the group delay between two navigation signal transmissions.
`static Map<NavigationSignalType,NavigationSignalCharacteristics>`	`getFromBlock(NavigationBlockType blockType)` Provides the complete set of signals and their characteristics for a given block type.
`static NavigationSignalCharacteristics`	`getFromType(NavigationSignalType signalType)` Provides the signal characteristics specific to a type of signal.
`static NavigationSignalCharacteristics`	`getFromType(NavigationSignalType signalType, NavigationBlockType blockType)` Provides the signal characteristics specific to a type and block of signal.
`NavigationSignalType`	`getSignalType()` Gets the navigation signal type, including frequency and code.
`double`	`getSubcarrierFrequency()` Gets the sub-carrier frequency if one is used for the code.
`double`	`getTransmissionPower()` Gets the navigation signal's transmitted power.
`void`	`setChipLength(double value)` Sets the length of one pulse of navigation signal data.
`void`	`setSubcarrierFrequency(double value)` Sets the sub-carrier frequency if one is used for the code.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GpsL1Frequency
```
public static final double GpsL1Frequency
```
    The frequency of the GPS L1 carrier.
    
    See Also:
    
    Constant Field Values
  - GpsL2Frequency
```
public static final double GpsL2Frequency
```
    The frequency of the GPS L2 carrier.
    
    See Also:
    
    Constant Field Values
  - GpsL5Frequency
```
public static final double GpsL5Frequency
```
    The frequency of the GPS L5 carrier.
    
    See Also:
    
    Constant Field Values
  - GpsCAChipLength
```
public static final double GpsCAChipLength
```
    The length of the CA code chip, in seconds.
    
    See Also:
    
    Constant Field Values
  - GpsPYChipLength
```
public static final double GpsPYChipLength
```
    The length of the P(Y) code chip, in seconds.
    
    See Also:
    
    Constant Field Values
  - GpsL1CChipLength
```
public static final double GpsL1CChipLength
```
    The length of the L1C code chip, in seconds.
    
    See Also:
    
    Constant Field Values
  - GpsL2CChipLength
```
public static final double GpsL2CChipLength
```
    The length of the L2C code chip, in seconds.
    
    See Also:
    
    Constant Field Values
  - GpsL5IQChipLength
```
public static final double GpsL5IQChipLength
```
    The length of the L5 I and Q code chips, in seconds.
    
    See Also:
    
    Constant Field Values
  - GpsMCodeChipLength
```
public static final double GpsMCodeChipLength
```
    The length of the M code chip, in seconds.
    
    See Also:
    
    Constant Field Values
  - GpsCACodeBandwidth
```
public static final double GpsCACodeBandwidth
```
    The total bandwidth of the CA code, between the first nulls.
    
    See Also:
    
    Constant Field Values
  - GpsPYCodeBandwidth
```
public static final double GpsPYCodeBandwidth
```
    The total bandwidth of the P(Y) code, between the first nulls.
    
    See Also:
    
    Constant Field Values
  - GpsCCodeBandwidth
```
public static final double GpsCCodeBandwidth
```
    The total bandwidth of the C code, between the first nulls.
    
    See Also:
    
    Constant Field Values
  - GpsMCodeBandwidth
```
public static final double GpsMCodeBandwidth
```
    The total bandwidth of the M code, between the first nulls.
    
    See Also:
    
    Constant Field Values
  - GpsIQCodeBandwidth
```
public static final double GpsIQCodeBandwidth
```
    The total bandwidth of the L5 IQ code, between the first nulls.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getFromType
```
@Nonnull
public static NavigationSignalCharacteristics getFromType(@Nonnull
                                                                    NavigationSignalType signalType,
                                                                    @Nonnull
                                                                    NavigationBlockType blockType)
```
    Provides the signal characteristics specific to a type and block of signal.
    
    Parameters:
    
    signalType - The signal type defining the characteristics required.
    
    blockType - The block type defining the parameters for block specific data.
    
    Returns:
    
    An instance of this class with the signal parameters filled in, representing the specified signal and block types.
  - getFromType
```
@Nonnull
public static NavigationSignalCharacteristics getFromType(@Nonnull
                                                                    NavigationSignalType signalType)
```
    Provides the signal characteristics specific to a type of signal. Note that signal parameters with different values by block type will have NaN values. Use the NavigationSignalCharacteristics.getFromType(NavigationSignalType,NavigationBlockType) method instead to retrieve those parameter values.
    
    Parameters:
    
    signalType - The signal type defining the characteristics required.
    
    Returns:
    
    An instance of this class with the signal parameters filled in, representing the specified signalType.
  - getFromBlock
```
@Nonnull
public static Map<NavigationSignalType,NavigationSignalCharacteristics> getFromBlock(@Nonnull
                                                                                               NavigationBlockType blockType)
```
    Provides the complete set of signals and their characteristics for a given block type.
    
    Parameters:
    
    blockType - The block type of GPS satellites broadcasting the desired signals.
    
    Returns:
    
    Dictionary keyed on NavigationSignalType, containing the signal characteristics for each signal type. The dictionary contains all the signals that the provided block type broadcasts.
  - getChipLength
```
public final double getChipLength()
```
    Gets the length of one pulse of navigation signal data. Note that this varies by NavigationSignalType.
  - setChipLength
```
public final void setChipLength(double value)
```
    Sets the length of one pulse of navigation signal data. Note that this varies by NavigationSignalType.
  - getSignalType
```
@Nonnull
public final NavigationSignalType getSignalType()
```
    Gets the navigation signal type, including frequency and code.
  - getCarrierFrequency
```
public final double getCarrierFrequency()
```
    Gets the carrier frequency on which the navigation signal is broadcast.
  - getBandwidth
```
public final double getBandwidth()
```
    Gets the bandwidth the navigation signal uses.
  - getDataRate
```
public final double getDataRate()
```
    Gets the rate at which data is encoded on the navigation signal.
  - getTransmissionPower
```
public final double getTransmissionPower()
```
    Gets the navigation signal's transmitted power.
  - getAntennaPolarizationLoss
```
public final double getAntennaPolarizationLoss()
```
    Gets the attenuation of the signal due to antenna polarization effects.
  - getAntennaCorrelationLoss
```
public final double getAntennaCorrelationLoss()
```
    Gets the attenuation of the signal due to correlation losses.
  - getDifferentialGroupDelay
```
public final double getDifferentialGroupDelay()
```
    Gets the group delay between two navigation signal transmissions.
  - getSubcarrierFrequency
```
public final double getSubcarrierFrequency()
```
    Gets the sub-carrier frequency if one is used for the code.
  - setSubcarrierFrequency
```
public final void setSubcarrierFrequency(double value)
```
    Sets the sub-carrier frequency if one is used for the code.

Class NavigationSignalCharacteristics

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GpsL1Frequency

GpsL2Frequency

GpsL5Frequency

GpsCAChipLength

GpsPYChipLength

GpsL1CChipLength

GpsL2CChipLength

GpsL5IQChipLength

GpsMCodeChipLength

GpsCACodeBandwidth

GpsPYCodeBandwidth

GpsCCodeBandwidth

GpsMCodeBandwidth

GpsIQCodeBandwidth

Method Detail

getFromType

getFromType

getFromBlock

getChipLength

setChipLength

getSignalType

getCarrierFrequency

getBandwidth

getDataRate

getTransmissionPower

getAntennaPolarizationLoss

getAntennaCorrelationLoss

getDifferentialGroupDelay

getSubcarrierFrequency

setSubcarrierFrequency