FSDeveloper Wiki - User contributions [en-gb]

C: XML Variables in C Gauges

2018-07-23T17:36:29Z

JB3DG:

{{Infobox-Applicable-FSVersion
| FSXA = true
| FSX = true
| FS2004 = true
| FS2002 = false
| XP10 = false
| XP9 = false
}}

==C: XML Variables in C Gauges==

To control XML variables from a C gauge:

// declare the variable and pointer ID for the variable

double pitot_cover = 1 ; // this is the C variable
ID pitot_cover_id; // this is the pointer address to the XML variable

// Register the variable (this is the XML "name," e.g., L:PitotCover

case PANEL_SERVICE_PRE_INITIALIZE:
pitot_cover_id = register_named_variable ( "PitotCover" );
break;

// now, you can use the next two statements to
// (a) associate the ID with the XML variable, then
// (b) set the variable to be identical to the C variable, e.g., pitot_cover

case PANEL_SERVICE_PRE_UPDATE:
set_named_variable_value ( pitot_cover_id, (FLOAT64)pitot_cover ) ;
break;

// now, in my mouse routine, I can set the value of pitot_cover, and it will
//be automatically passed to the XML variable!

BOOL FSAPI mouse_pitotcb( PPIXPOINT relative_point, FLAGS32 mouse_flags)
{
if ( pitot_cover == 0 ) { pitot_cover = 1 ; } else { pitot_cover = 0 ; }
return FALSE;
}

// now, to use the XML variable to control the C variable, the only
// difference is that you would use the get_named_variable_value command
// instead, and omit the mouse code!

pitot_cover = get_named_variable_value (pitot_cover_id);

'''Alternate Method'''

There is another method that may be used to communicate between C gauges and XML gauges, using the execute_calculator_code(); function. Here is the prototype for the function:

execute_calculator_code(PCSTRINGZ code, FLOAT64* fvalue, SINT32* ivalue, PCSTRINGZ* svalue);

"Translating" the function into more easily understood pseudo-code, we have this:

execute_calculator_code(XML variable name,units, floating point var name, integer variable name, string variable name);

To use the function, first determine from the "units" of the XML variable whether the returned value will be a floating point number, an integer, or a string.

When constructing the function call, only ONE of the fields 2 through 4 will be used, an the unused fields filled with "NULL" value. For example, we want to fetch an ADF frequency, so we'd use something like this:

FLOAT64 adf1_frequency = 0; // first declare the float C variable
execute_calculator_code("(A:ADF ACTIVE FREQUENCY:1, KHz)",&adf1_frequency,NULL,NULL);

If the XML variable is an integer, here is an example:

SINT32 time_of_day; // first declare the integer C variable
execute_calculator_code("(E:TIME OF DAY,Enum)",NULL,&time_of_day,NULL);

If the XML variable is a string, here is an example:

PCSTRINGZ WP_NextID; // first declare the string C variable
execute_calculator_code("(A:GPS WP_NEXT ID,string)",NULL,NULL,&WP_NextID);

Custom L:variables may also be obtained following the same structure shown above.

''BOOLEAN:''
execute_calculator_code("(L:MyCustomVariable,bool)",NULL,&my_custom_variable,NULL);

''FLOAT:''
execute_calculator_code("(L:MyCustomVariable,enum)",&my_custom_variable,NULL,NULL);

This method is much easier to use than the method described in the previous section.

To SEND a command with this method, use the following format:

execute_calculator_code("(>K:SOUND_TOGGLE)", NULL, NULL, NULL);

If you need to pass a value for a SET type key_event, simply use the same syntax used in an XML gauge by prefixing the command with the value (which can itself be another XML variable as shown below):

execute_calculator_code("(A:Plane heading degrees gyro,degrees) (>K:HEADING_BUG_SET)", NULL, NULL, NULL);

To set an L:variable, use this syntax:

''Constant:''
execute_calculator_code(" 120 (>L:CustomXMLvar,enum)",NULL,NULL,NULL);

''C Variable:''
FLOAT64 myVar = 100.00;
char cTemp[60];
sprintf_s(cTemp, %f%s, myVar, " (>L:MyVar,number)");
PCSTRINGZ szString = cTemp;
execute_calculator_code(szString,NULL,NULL,NULL);

[[Category:Aircraft Design]]
[[Category:Panel and Gauge Design]]

C: XML Variables in C Gauges

2018-07-23T17:35:54Z

JB3DG:

{{Infobox-Applicable-FSVersion
| FSXA = true
| FSX = true
| FS2004 = true
| FS2002 = false
| XP10 = false
| XP9 = false
}}

==C: XML Variables in C Gauges==

To control XML variables from a C gauge:

// declare the variable and pointer ID for the variable

double pitot_cover = 1 ; // this is the C variable
ID pitot_cover_id; // this is the pointer address to the XML variable

// Register the variable (this is the XML "name," e.g., L:PitotCover

case PANEL_SERVICE_PRE_INITIALIZE:
pitot_cover_id = register_named_variable ( "PitotCover" );
break;

// now, you can use the next two statements to
// (a) associate the ID with the XML variable, then
// (b) set the variable to be identical to the C variable, e.g., pitot_cover

case PANEL_SERVICE_PRE_UPDATE:
set_named_variable_value ( pitot_cover_id, (FLOAT64)pitot_cover ) ;
break;

// now, in my mouse routine, I can set the value of pitot_cover, and it will
//be automatically passed to the XML variable!

BOOL FSAPI mouse_pitotcb( PPIXPOINT relative_point, FLAGS32 mouse_flags)
{
if ( pitot_cover == 0 ) { pitot_cover = 1 ; } else { pitot_cover = 0 ; }
return FALSE;
}

// now, to use the XML variable to control the C variable, the only
// difference is that you would use the get_named_variable_value command
// instead, and omit the mouse code!

pitot_cover_id = check_named_variable("PitotCover");
pitot_cover = get_named_variable_value (pitot_cover_id);

'''Alternate Method'''

There is another method that may be used to communicate between C gauges and XML gauges, using the execute_calculator_code(); function. Here is the prototype for the function:

execute_calculator_code(PCSTRINGZ code, FLOAT64* fvalue, SINT32* ivalue, PCSTRINGZ* svalue);

"Translating" the function into more easily understood pseudo-code, we have this:

execute_calculator_code(XML variable name,units, floating point var name, integer variable name, string variable name);

To use the function, first determine from the "units" of the XML variable whether the returned value will be a floating point number, an integer, or a string.

When constructing the function call, only ONE of the fields 2 through 4 will be used, an the unused fields filled with "NULL" value. For example, we want to fetch an ADF frequency, so we'd use something like this:

FLOAT64 adf1_frequency = 0; // first declare the float C variable
execute_calculator_code("(A:ADF ACTIVE FREQUENCY:1, KHz)",&adf1_frequency,NULL,NULL);

If the XML variable is an integer, here is an example:

SINT32 time_of_day; // first declare the integer C variable
execute_calculator_code("(E:TIME OF DAY,Enum)",NULL,&time_of_day,NULL);

If the XML variable is a string, here is an example:

PCSTRINGZ WP_NextID; // first declare the string C variable
execute_calculator_code("(A:GPS WP_NEXT ID,string)",NULL,NULL,&WP_NextID);

Custom L:variables may also be obtained following the same structure shown above.

''BOOLEAN:''
execute_calculator_code("(L:MyCustomVariable,bool)",NULL,&my_custom_variable,NULL);

''FLOAT:''
execute_calculator_code("(L:MyCustomVariable,enum)",&my_custom_variable,NULL,NULL);

This method is much easier to use than the method described in the previous section.

To SEND a command with this method, use the following format:

execute_calculator_code("(>K:SOUND_TOGGLE)", NULL, NULL, NULL);

If you need to pass a value for a SET type key_event, simply use the same syntax used in an XML gauge by prefixing the command with the value (which can itself be another XML variable as shown below):

execute_calculator_code("(A:Plane heading degrees gyro,degrees) (>K:HEADING_BUG_SET)", NULL, NULL, NULL);

To set an L:variable, use this syntax:

''Constant:''
execute_calculator_code(" 120 (>L:CustomXMLvar,enum)",NULL,NULL,NULL);

''C Variable:''
FLOAT64 myVar = 100.00;
char cTemp[60];
sprintf_s(cTemp, %f%s, myVar, " (>L:MyVar,number)");
PCSTRINGZ szString = cTemp;
execute_calculator_code(szString,NULL,NULL,NULL);

[[Category:Aircraft Design]]
[[Category:Panel and Gauge Design]]

C: Decimal to BCO

2018-02-12T14:33:56Z

JB3DG:

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = true
| FS2002 = true
| FS2000 = true
| FS98 = true
}}
== C: Decimal to BCO ==

While the BCD conversion is useful for setting radios, it cannot be used for setting the Transponder. Instead, BCO must be used. Example below:

UINT32 Dec2Bco(int xpdr)
{
int x = xpdr % 10;
int x1 = (((xpdr / 10) % 10) * 16) + x;
int x2 = (((xpdr / 100) % 10) * 256) + x1;
int x3 = ((xpdr / 1000) * 4096) + x2;
return UINT32(x3);
}

To use:

trigger_key_event(KEY_XPNDR_SET, Dec2Bco(7700));//Emergency! Mayday! Mayday!
[[Category:Aircraft Design]]
[[Category:Panel and Gauge Design]]

C: Decimal to BCO

2018-02-12T14:32:09Z

JB3DG: Created page with "{{Infobox-Applicable-FSVersion | FSXI = false | FSXA = true | FSX = true | FS2004 = true | FS2002 = true | FS2000 = true | FS98 = true }} == C: Decimal to BCO == While the BC..."

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = true
| FS2002 = true
| FS2000 = true
| FS98 = true
}}
== C: Decimal to BCO ==

While the BCD conversion is useful for setting radios, it cannot be used for setting the Transponder. Instead, BCO must be used. Example below:

#include <math.h>
UINT32 Dec2Bco(int xpdr)
{
int x = xpdr % 10;
int x1 = (((xpdr / 10) % 10) * 16) + x;
int x2 = (((xpdr / 100) % 10) * 256) + x1;
int x3 = ((xpdr / 1000) * 4096) + x2;
return UINT32(x3);
}

To use:

trigger_key_event(KEY_XPNDR_SET, Dec2Bco(7700));//Emergency! Mayday! Mayday!
[[Category:Aircraft Design]]
[[Category:Panel and Gauge Design]]

C: C++: Get Magnetic Variation for any lat/lon

2017-12-29T12:18:49Z

JB3DG: JB3DG moved page C: C++: Get Magnetic Variation for any lat/lon to C: Get Magnetic Variation for any lat/lon over redirect

#REDIRECT [[C: Get Magnetic Variation for any lat/lon]]

C: Get Magnetic Variation for any lat/lon

2017-12-29T12:18:49Z

JB3DG: JB3DG moved page C: C++: Get Magnetic Variation for any lat/lon to C: Get Magnetic Variation for any lat/lon over redirect

{{Infobox-Applicable-FSVersion
| P3D4 = true
| P3D2 = true
| P3D = true
| FSXI = unknown
| FSXA = true
| FSX = true
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
| XP10 = false
| XP9 = false
}}

The following undocumented function may be used to avoid conflicts between navigation databases and scenery magnetic variation or for any other purpose the developer might find useful.

In your choice of your project's header files, do the following function prototype:

typedef float(__stdcall *ffe_get_magvar64)(const _llaf64*);

Then in your module_init function:

#ifdef _M_X64
#define PWORDX unsigned __int64
#else
#define PWORDX DWORD
#end

ffe_get_magvar64 fe_get_magvar64 = NULL;
void FSAPI module_init(void)
{
HMODULE hfedll = NULL;
GetModuleHandleEx( GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT, L"fe.dll", &hfedll);
if(hfedll )
GetSimTime6 = (fGetSimTime)GetProcAddress(hfedll , MAKEINTRESOURCEA(4)); }

Now wherever you wish to call this function, include the header where the prototype is contained and add:

extern ffe_get_magvar64 fe_get_magvar64;

To call it and find out how much time has passed:

_llaf64 lla = {lat, lon, alt};//_llaf64 is a struct in the gauges.h. lat/lon are in degrees and alt is in meters.
float mvar = fe_get_magvar64(&lla);

NOTE:

All FSX versions use ordinal 4.
For all 32bit versions of P3D however, use the following:
fe_get_magvar64 = (ffe_get_magvar64)GetProcAddress(hfedll, "?fe_get_magvar64@@YGMQAU_llaf64@@@Z");

For all versions of P3D v4, use the following:
fe_get_magvar64 = (ffe_get_magvar64)GetProcAddress(hfedll, "?fe_get_magvar64@@YAMQEAU_llaf64@@@Z");

[[Category:Aircraft Design]]
[[Category:Panel and Gauge Design]]

C: Get Magnetic Variation for any lat/lon

2017-12-29T12:15:19Z

JB3DG: JB3DG moved page C: Get Magnetic Variation for any lat/lon to C: C++: Get Magnetic Variation for any lat/lon

C: Get Magnetic Variation for any lat/lon

2017-12-29T12:14:14Z

JB3DG: Created page with "{{Infobox-Applicable-FSVersion | P3D4 = true | P3D2 = true | P3D = true | FSXI = unknown | FSXA = true | FSX = true | FS2004 = false | FS2002 = false | FS2000 = unknown | FS98..."

C: Decimal to BCD

2017-12-05T19:39:02Z

JB3DG: /* C: BCD to Decimal and Decimal to BCD */

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = true
| FS2002 = true
| FS2000 = true
| FS98 = true
}}
== C: BCD to Decimal and Decimal to BCD ==

This scheme was supplied by Arne Bartels which allows BCD conversion in both directions. Add the following to the master source file:-

#include <math.h>
#define Bcd2Dec(BcdNum) HornerScheme(BcdNum,0x10,10)
#define Dec2Bcd(DecNum) HornerScheme(DecNum,10,0x10)

UINT32 HornerScheme(UINT32 Num,UINT32 Divider,UINT32 Factor)
{
UINT32 Remainder=0,Quotient=0,Result=0;
Remainder=Num%Divider;
Quotient=Num/Divider;
if(!(Quotient==0&&Remainder==0))
Result+=HornerScheme(Quotient,Divider,Factor)*Factor+Remainder;
return Result;
}

Then for each sub-gauge that requires a BCD conversion use the following syntax:-

Bcd2Dec(bcd_number) for BCD to decimal and
Dec2Bcd(dec_number) for decimal to BCD conversions.

In order to send frequencies to the ADF radios, multiply the desired frequency by 10000:

float adf_freq = 0;
adf_freq = 286.5;
trigger_key_event(KEY_ADF_COMPLETE_SET, Dec2Bcd(adf_freq*10000));

In order to send frequencies to the COM or NAV radios, multiply the desired frequency by 100:

float com_freq = 0;
com_freq = 122.875;
trigger_key_event(KEY_COM_RADIO_SET, Dec2Bcd(com_freq * 100));//Change the event ID as needed for the NAV radio or the particular COM radio you wish to set

[[Category:Aircraft Design]]
[[Category:Panel and Gauge Design]]