FsFrequencyADF Struct Reference

A struct representing a ADF frequency used in FlightSim. This can convert between strings, decimal and FSUIPC's BCD format for offsets. More...

Public Member Functions
ushort	ToBCDMain ()
	Gets the Main part of the ADF Frequency as a Binary-Coded Decimal (BCD). Used by FSUIPC in the MAIN ADF offsets.
ushort	ToBCDExtended ()
	Gets the Extended part of the ADF Frequency as a Binary-Coded Decimal (BCD). Used by FSUIPC in the EXTENDED ADF offsets.
decimal	ToDecimal ()
	Gets the ADF Frequency as a decimal type.
override string	ToString ()
	Gets the ADF Frequncy as a string. NOTE this is not take into account the user's culture settings. It always formats with a . for the decimal point.
	FsFrequencyADF (ushort freqBCDMain, ushort freqBCDExtended)
	Creates a new ADF Frequency from the Binary-Coded Decimal (BCD) format used by FSUIPC.
	FsFrequencyADF (string freqString)
	Creates a new ADF Frequency from a string. NOTE The string must be in Invariant Culture. That is, the decimal place must be a . not a ,.
	FsFrequencyADF (decimal freqDecimal)
	Creates a new ADF Frequency from a decimal value.

Detailed Description

A struct representing a ADF frequency used in FlightSim. This can convert between strings, decimal and FSUIPC's BCD format for offsets.

Constructor & Destructor Documentation

FsFrequencyADF() [1/3]

FsFrequencyADF ( ushort freqBCDMain, ushort freqBCDExtended )

inline

Creates a new ADF Frequency from the Binary-Coded Decimal (BCD) format used by FSUIPC.

Parameters

freqBCDMain	The Main part of the ADF Frequency value in BCD format
freqBCDExtended	The Extended part of the ADF Frequency value in BCD format

FsFrequencyADF() [2/3]

FsFrequencyADF ( string freqString )

inline

Creates a new ADF Frequency from a string. NOTE The string must be in Invariant Culture. That is, the decimal place must be a . not a ,.

Parameters

freqString

The ADF Frequency as a string

FsFrequencyADF() [3/3]

FsFrequencyADF ( decimal freqDecimal )

inline

Creates a new ADF Frequency from a decimal value.

Parameters

freqDecimal

The ADF Frequency as a decimal

Member Function Documentation

ToBCDExtended()

ushort ToBCDExtended ( )

inline

Gets the Extended part of the ADF Frequency as a Binary-Coded Decimal (BCD). Used by FSUIPC in the EXTENDED ADF offsets.

Returns

A ushort in BCD format that can written to FSUIPC offsets

ToBCDMain()

ushort ToBCDMain ( )

inline

Gets the Main part of the ADF Frequency as a Binary-Coded Decimal (BCD). Used by FSUIPC in the MAIN ADF offsets.

Returns

A ushort in BCD format that can written to FSUIPC offsets

ToDecimal()

decimal ToDecimal ( )

inline

Gets the ADF Frequency as a decimal type.

Returns

The ADF Frequency as a decimal

ToString()

override string ToString ( )

inline

Gets the ADF Frequncy as a string. NOTE this is not take into account the user's culture settings. It always formats with a . for the decimal point.

Returns

A string representing the ADF Frequency.