FSUIPC Client DLL
.NET interface for FSUIPC
FsFrequencyCOM Struct Reference

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

Public Member Functions

ushort ToBCD ()
 Gets the COM Frequency as a Binary-Coded Decimal (BCD). Used by FSUIPC in some offsets.
 
decimal ToDecimal ()
 Gets the COM Frequency as a decimal type.
 
override string ToString ()
 Gets the COM 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.
 
 FsFrequencyCOM (ushort freqBCD)
 Creates a new COM Frequency from the Binary-Coded Decimal (BCD) format used by FSUIPC.
 
 FsFrequencyCOM (string freqString)
 Creates a new COM Frequency from a string. NOTE The string must be in Invariant Culture. That is, the decimal place must be a . not a ,.
 
 FsFrequencyCOM (decimal freqDecimal)
 Creates a new COM Frequency from a decimal value.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FsFrequencyCOM() [1/3]

FsFrequencyCOM ( ushort freqBCD)
inline

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

Parameters
freqBCDThe COM Frequency value in BCD format

◆ FsFrequencyCOM() [2/3]

FsFrequencyCOM ( string freqString)
inline

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

Parameters
freqStringThe COM Frequency as a string

◆ FsFrequencyCOM() [3/3]

FsFrequencyCOM ( decimal freqDecimal)
inline

Creates a new COM Frequency from a decimal value.

Parameters
freqDecimalThe COM Frequency as a decimal

Member Function Documentation

◆ ToBCD()

ushort ToBCD ( )
inline

Gets the COM Frequency as a Binary-Coded Decimal (BCD). Used by FSUIPC in some offsets.

Returns
A ushort in BCD format that can written to FSUIPC offsets

◆ ToDecimal()

decimal ToDecimal ( )
inline

Gets the COM Frequency as a decimal type.

Returns
The COM Frequency as a decimal

◆ ToString()

override string ToString ( )
inline

Gets the COM 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 COM Frequency.