FlightGear wiki - User contributions [en]

Portal:Wiki

2020-06-14T15:42:41Z

Chillz: Fixing grammatical errors, making main page more easier to understand

{{Main page/Header
|title=Welcome to the wiki editing portal
|introduction= This is the place to find out what is happening on the FlightGear wiki. Learn what tasks need to be done and what groups there are to join, and share news about recent events or current activities taking place on the wiki.
|rightbox=

|rightcolumn1= </div>
<span style="font-size:105%; font-weight:bold">Checking articles</span><br />
<span style="font-style:italic;">
Also check: [[Special:NewPages|new articles]], [[Special:NewFiles|new files]] and [[Special:RecentChanges|recent changes]].</span>
|rightcolumn2= [[FIle:Portal lamp.png|40px]] </div>
<span style="font-size:105%; font-weight:bold">Inspiration for new articles</span><br />
<span style="font-style:italic;">
[[Understanding the Project]]<br/>
[[Special:WantedPages|Most wanted articles]]<br/>
[[Help:Translate|Translating articles]]</span>
|rightcolumn3= [[File:Portal_radarwheel.png|40px]] </div>
<span style="font-size:105%; font-weight:bold">Improving articles</span><br />
<span style="font-style:italic;">
[[Wiki Housekeepking]]<br>
[[:Category:Articles considered for deletion|Articles considered for deletion]] – [[:Category:Accuracy disputes|Accuracy disputes]]<br/>
[[:Category:Stubs|Extending short articles]]<br/>
[[Fixing up articles with wrong quotes]]<br/>
[[:Category:Articles to be merged|Articles to be merged]]<br/>
[[FlightGear wiki:Manual of Style|Manual of Style]]</span>
|rightcolumn4= [[File:Portal developer.png|40px]] </div>
<span style="font-size:105%; font-weight:bold">Regular maintenance</span><br />
<span style="font-style:italic;">
[[Portal:Wiki/Plugin Requests|Plugin Installation Requests]]<br/>
[[:Category:Picture of the week|Pictures of the week]]<br/>
Uncategorized: [[Special:UncategorizedFiles|files]] – [[Special:UncategorizedPages|pages]]<br/>
[[Special:LonelyPages|Orphaned pages]] – Pages with no links to them yet.<br/>
[[:Category:Undocumented templates|Undocumented templates]]<br/>
[[Special:Categories|Categories]]<br/>
[[FlightGear wiki:Missing images|If you find missing images]]<br/>
[[FlightGear wiki:Notes to administrators|Notes to admins]]</span>


|sections=
{{Main page/Leftbox|title=Get involved!
|contents=Just like FlightGear itself, the wiki can be considered open-source. Everyone is encouraged to [[Special:UserLogin|register an account]] and start contributing!

Maybe you noticed that the article on your favourite aircraft is a bit [[:Category:out of date|out of date]] and you can give it a refresh, or the Howto on making coffee on the 747 [[:Category:cleanup|needs a cleanup]], or the one on Blender [[:Category:Image requested|lacks a picture]], you have found a spam link or simply a typo and want to fix it! All are very valid reasons to join and every little effort helps the maintainers, even just adding the [[:Category:Maintenance templates|proper template]] to let them know. Remember to add a meaningful summary message, maintainers [[Special:RecentChanges|do read them]]!

By the way, do you want to help with [[Help:Maintenance|regular maintenance]]? That would allow you to learn a whole lot on the FlightGear project. In fact, ''maintaining documentation is the classical way of getting into an open project''.

This portal provides links to useful wiki tools and articles, ranging from how to write your first article to extensive markup techniques. See also the [[Help:Contents|help pages]].

One last note. Remember that any contribution to this wiki is licensed under the [[GPL|GNU GPL version 2]].

}}

{{Main page/Leftbox|title=Discuss!
|contents=__NOTOC__
Discuss the wiki and helping each other out improving the wiki!

Please, '''remember to sign your comments''': use four tildes ("<tt><nowiki>~~~~</nowiki></tt>") or the sign button ([[File:Button sig.png|16px]]) above the editor text box.

; Individual pages: To discuss individual pages, use their "Discussion" page accessible through the tab at the top left of corner of the page.

; The wiki in general: Discuss the wiki, its organization and maintenance at the [[FlightGear wiki:Village pump|Village pump]].

; Chat: There is a wiki-related IRC channel at irc://irc.flightgear.org/#wiki

}}

}}
{{Main page/Rightcolumn end|title=[[Special:Statistics|Wiki statistics]]
|contents=
* {{NUMBEROFARTICLES}} articles
* {{NUMBEROFFILES}} files
* {{NUMBEROFUSERS}} users
}}

[[ca:Portal:Wiki]]
[[es:Portal:Wiki]]
[[fr:Portal:Wiki]]
[[nl:Portaal:Wiki]]
[[Category:Portals]]

Howto:Start using vectors and hashes in Nasal

2020-06-14T13:24:13Z

Chillz: Fixing 30 grammatical errors whilst reviewing afterwards

{{Nasal Navigation}}
Here we look into how to '''start using vectors and hashes in Nasal''' to simplify and generalize code. Vectors and hashes are two data structures that [[Nasal]] uses to store data. Vectors are in some other programming languages called for example lists or one-dimensional arrays, and hashes are similar to C's structs.

In many cases repetitive code can be generalized and rewritten into vectors, hashes or helper functions using them. Some of the advantages with rewriting repetitive code this way is that it helps maintenance by requiring less typing when modifying and/or when fixing bugs.

In addition to storing data hashes can "store" functions and be used as object classes. Object classes can be created by adding a function into a hash, that will create a new hash when called, a so called ''constructor'' (sometimes abbreviated to ''ctor'' or ''c'tor'') usually named <code>'''new'''()</code>.

== Learn more about vectors ==
Imagine a piece of Nasal code working with 5 different waypoints. You would need to manage the data for each waypoint. A simple version using different variables for each data set might look like this:

<syntaxhighlight lang="nasal">
var wp1 = 0;
var wp1alt = 0;
var wp1dist = 0;
var wp1angle = 0;
var wp1length = 0;
var wp1id = "";
var wp1brg = 0;

var wp2 = 0;
var wp2alt = 0;
var wp2dist = 0;
var wp2angle = 0;
var wp2length = 0;
var wp2id = "";
var wp2brg = 0;

var wp3 = 0;
var wp3alt = 0;
var wp3dist = 0;
var wp3angle = 0;
var wp3length = 0;
var wp3id = "";
var wp3brg = 0;

var wp4 = 0;
var wp4alt = 0;
var wp4dist = 0;
var wp4angle = 0;
var wp4length = 0;
var wp4id = "";
var wp4brg = 0;

var wp5 = 0;
var wp5alt = 0;
var wp5dist = 0;
var wp5angle = 0;
var wp5length = 0;
var wp5id = "";
var wp5brg = 0;
</syntaxhighlight>

Now, this is fairly repetitive and not overly scalable, because the variable names are hardcoded and need to be changed in a lot of places in the source code.

Just imagine we'd need to support more than just 5 waypoints, like maybe 10, 20, 50 or maybe even 1000 waypoints. As you can see, this method is very inflexible, complicated, tedious and error-prone.

Such code contains so called "code smells", another example would be code like this:
<syntaxhighlight lang="nasal">
var l0 = "";
var l1 = "";
var l2 = "";
var l3 = "";
var l4 = "";
var l5 = "";
var l6 = "";
var l7 = "";
var l8 = "";
var l9 = "";
var l10 = "";
var l11 = "";
var l12 = "";
var l13 = "";
var l14 = "";
var l15 = "";
var l16 = "";
var l17 = "";
var l18 = "";
var l19 = "";
var l20 = "";

var hist1 = "";
var hist2 = "";
var hist3 = "";
var hist4 = "";
var hist5 = "";
var hist6 = "";

IDENTl3 = "";
IDENTl4 = "";
IDENTr4 = "";
IDENTl5 = "";
IDENTr5 = "";
IDENTl8 = "";

setprop("/instrumentation/efb/display/line0-l", l0);
setprop("/instrumentation/efb/display/line1-l", l1);
setprop("/instrumentation/efb/display/line2-l", l2);
setprop("/instrumentation/efb/display/line3-l", l3);
setprop("/instrumentation/efb/display/line4-l", l4);
setprop("/instrumentation/efb/display/line5-l", l5);
setprop("/instrumentation/efb/display/line6-l", l6);
setprop("/instrumentation/efb/display/line7-l", l7);
setprop("/instrumentation/efb/display/line8-l", l8);
setprop("/instrumentation/efb/display/line9-l", l9);
setprop("/instrumentation/efb/display/line10-l", l10);
setprop("/instrumentation/efb/display/line11-l", l11);
setprop("/instrumentation/efb/display/line12-l", l12);
setprop("/instrumentation/efb/display/line13-l", l13);
setprop("/instrumentation/efb/display/line14-l", l14);
setprop("/instrumentation/efb/display/line15-l", l15);
setprop("/instrumentation/efb/display/line16-l", l16);
setprop("/instrumentation/efb/display/line17-l", l17);
setprop("/instrumentation/efb/display/line18-l", l18);
setprop("/instrumentation/efb/display/line19-l", l19);
setprop("/instrumentation/efb/display/line20-l", l20);
</syntaxhighlight>

Whenever you see such a code, it should be obvious that using arrays/vectors would be a good idea.

So, it would be better to use a vector of waypoints instead. A vector is a list of things (variables) that can be easily accessed using an index into the vector. Pretty much like an array in C or C++, with the added advantage that the vector can be dynamically resized, e.g. using the setsize() library call. Consider the following example:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1", "wp2", "wp3", "wp4", "wp5"];
</syntaxhighlight>

This piece of code is equivalent to creating 5 different variables named "waypoints[n]" with an access index from n=0 to 4 (5 elements in total).

As you can see below, indexing starts at 0.

The problem is, that this only gives us a list of single waypoints:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1", "wp2", "wp3", "wp4", "wp5"];
print(waypoints[0]); # print wp1
print(waypoints[1]); # print wp2
print(waypoints[2]); # print wp3
print(waypoints[3]); # print wp4
print(waypoints[4]); # print wp5
</syntaxhighlight>

To do this using a conventional for loop, you would use the size() function to get the size of the vector:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1","wp2","wp3","wp4","wp5"];
for(var index; index < size(waypoints); index=index+1) {
print(waypoints[index]);
}
</syntaxhighlight>

The same thing can be accomplished using the forindex loop:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1","wp2","wp3","wp4","wp5"];
forindex(var index; waypoints) {
print(waypoints[index]);
}
</syntaxhighlight>

Now, waypoints being a vector, we can also use a simple foreach loop, that works without a counter, to process each element easily:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1","wp2","wp3","wp4","wp5"];
foreach(var wpt; waypoints) {
print(wpt);
}
</syntaxhighlight>

What we need to save all the other waypoint specific information is a new variable type that serves as the "container" for variables, so that we can save several variables for each waypoint.

<syntaxhighlight lang="nasal">
var wp4 = 0; # waypoint number
var wp4alt = 0; # waypoint altitude
var wp4dist = 0; # waypoint distance
var wp4angle = 0; # waypoint angle
var wp4length = 0; # waypoint length
var wp4id = ""; # waypoint id
var wp4brg = 0; # waypoint bearing
</syntaxhighlight>

== A vector based version ==

One simple way to accomplish this is by using another vector for each waypoint, nested inside the original vector. So that we end up with a two-dimensional data structure. For example, imagine a folder containing subfolders, with folders not having names but rather indices (numbers).

So we could be using a "main" vector to store all waypoints, while each field of the main vector is a different vector that contains all waypoint-specific data.

<syntaxhighlight lang="nasal">
var wp4 = 0; # waypoint number
var wp4alt = 0; # waypoint altitude
var wp4dist = 0; # waypoint distance
var wp4angle = 0; # waypoint angle
var wp4length = 0; # waypoint length
var wp4id = ""; # waypoint id
var wp4brg = 0; # waypoint bearing

var waypoint4 = [wp4,wp4alt,wp4dist,wp4angle,wp4length,wp4id, wp4brg];
var waypoints = [waypoint4]
</syntaxhighlight>

First of all, we are setting up all the different variables for wp4, next, you are storing all variables in a vector called "waypoint4". In the end, we store this vector in another vector named "waypoints".

So, the very first vector element would be waypoints[0] and it would point to another vector (waypoint4), the elements of waypoint4 would be also available by index:

<syntaxhighlight lang="nasal">
var wp4 = 1; # waypoint number
var wp4alt = 1000; # waypoint altitude
var wp4dist = 20.4; # waypoint distance
var wp4angle = 33.4; #waypoint angle
var wp4length = 12; # waypoint length
var wp4id = "none"; # waypoint id
var wp4brg = 122; # waypoint bearing

var waypoint4 = [wp4,wp4alt,wp4dist,wp4angle,wp4length,wp4id, wp4brg];
var waypoints = [waypoint4]

print ( waypoints[0][0] ) # contains the data stored in wp4
print ( waypoints[0][1] ) # contains the data stored in wp4alt
print ( waypoints[0][2] ) # contains the data stored in wp4dist
print ( waypoints[0][3] ) # contains the data stored in wp4angle
print ( waypoints[0][4] ) # contains the data stored in wp4length
print ( waypoints[0][5] ) # contains the data stored in wp4id
print ( waypoints[0][6] ) # contains the data stored in wp4brg
</syntaxhighlight>

What we have here is a list of waypoints, with the first (0th) element containing another vector.

Obviously, you could add a bunch of other waypoints to the "waypoints" vector, too:

<syntaxhighlight lang="nasal">
var waypoint4 = [wp4,wp4alt,wp4dist,wp4angle,wp4length,wp4id, wp4brg];
var waypoint5 = [wp5,wp5alt,wp5dist,wp5angle,wp5length,wp5id, wp5brg];
var waypoints = [waypoint4, waypoint5]
</syntaxhighlight>

The only problem with this approach is, that you'll need to set up all those wp variables - so there's a shorter version possible, by directly adding your data without using variables, i.e. "inline":

<syntaxhighlight lang="nasal">
var waypoint4 = [1,1000,12,22,44,"none", 33];
var waypoint5 = [2,1500,22,42,14,"none", 133];
var waypoints = [waypoint4, waypoint5];
</syntaxhighlight>

There's an even more succinct version possible. The next step would be to use embedded vectors directly:

<syntaxhighlight lang="nasal">
var waypoints = [
[1,1000,12,22,44,"none", 33],
[2,1500,22,42,14,"none", 133]
];
</syntaxhighlight>

This is just formatted for clarity, the following snippet would be equivalent, but not as readable to people new to vectors:

<syntaxhighlight lang="nasal">
var waypoints = [ [1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133] ];
</syntaxhighlight>

Accessing such a vector with embedded (or nested) vectors is still as simple:

<syntaxhighlight lang="nasal">
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]
print(waypoints[0][0]) # prints 1
print(waypoints[0][1]) # prints 1000
print(waypoints[1][0]) # prints 2
print(waypoints[1][1]) # prints 1500
</syntaxhighlight>

The only issue here is that you'll need to keep vector ordering in mind so that you can always access the right element number. This could be simplified by using some variables with telling names as the index for each vector:

<syntaxhighlight lang="nasal">
# these are used self-explanatory indices - so that you don't need to remember each field's position:
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;

var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]
print(waypoints[0][ALTITUDE]) # prints 1
print(waypoints[0][DISTANCE]) # prints 1000
print(waypoints[1][ALTITUDE]) # prints 2
print(waypoints[1][DISTANCE]) # prints 1500
</syntaxhighlight>

Now, this yields already fairly readable source code:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]

# print the altitude for each waypoint in the vector:
foreach(var waypoint; waypoints) {
print( waypoint[ALTITUDE] );
}
</syntaxhighlight>

So, this would already be much better than our original version, because we can now have an arbitrary number of waypoints. New waypoints would need to be added to the waypoints vector by using the append() library function:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]
print(waypoints[0][ALTITUDE]) # prints 1
print(waypoints[0][DISTANCE]) # prints 1000
print(waypoints[1][ALTITUDE]) # prints 2
print(waypoints[1][DISTANCE]) # prints 1500

append(waypoints, [3,3000,122,212,34,"none", 133] );
</syntaxhighlight>

Next, we could come up with some helper functions to deal with the vector details transparently, using the same method as before: self-explanatory indices, which spares us having to remember the purpose of each field:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]];

var get = func (n,what) {
return waypoints[n][what];
}

var set = func (n,what,value) {
waypoints[n][what]=value;
}

print( get(0, ALTITUDE) ); # prints 1
print( get(0, DISTANCE) ); # prints 1000
print( get(1, ALTITUDE) ); # prints 2
print( get(1, DISTANCE) ); # prints 1500
</syntaxhighlight>

There's one caveat here: The set function doesn't check the size of the vector, so it may try to access elements that are not there. To fix this, you'd need to use a size(vec) call and check its size, and then adjust the size as needed using the setsize(vec,size) library function.

You could even add some more high level helpers for each waypoint field:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]];

var get = func (n,what) {
return waypoints[n][what];
}

var set = func (n,what,value) {
waypoints[n][what]=value;
}

var get_alt = func(n) {
return get(n,ALTITUDE);
}

var get_dist = func(n) {
return get(n,DISTANCE);
}

var get_angle = func(n) {
return get(n,ANGLE);
}

var get_length = func(n) {
return get(n,LENGTH);
}

var get_id = func(n) {
return get(n,ID);
}

var get_brg = func(n) {
return get(n,BEARING);
}
</syntaxhighlight>

There's still one issue though: we are using lots of variables and helpers that all belong to the "waypoints" type, but which clutter our source code.

So, next, we are going to look into an even more flexible approach that nicely maps each waypoint field and all helper functions to a symbolic name, without having to remember vector indices and such: using Nasal hashes, which are easier to use than complex arrangements using nested vectors.

== A hash based version (recommended) ==

Now, to wrap these fields into a single variable that serves as the container for other variables, we could use a Nasal hash and start completely from scratch.

Consider the following empty hash:

<syntaxhighlight lang="nasal">
var waypoint = {};
</syntaxhighlight>

Next, we are going to add some fields to our new variable "container". Each new field can be assigned an initial value, this is done by treating the field as a value/key pair, with a colon (:) separating both. And with multiple fields being separated by a comma (formatting only added for clarity):

<syntaxhighlight lang="nasal">
# declare a new hash named waypoint
var waypoint = {
# add a few fields and assign a value to each field:
number:0,
altitude:0,
distance:0,
angle:0,
length:0,
ID:0,
bearing:0
};
</syntaxhighlight>

which is equivalent to this, more succinct, version:
<syntaxhighlight lang="nasal">
var waypoint = {number:0,altitude:0,distance:0,angle:0,length:0,ID:0,bearing:0};
</syntaxhighlight>

This is already equivalent to our first example that used a vector to store this waypoint info, the only difference is here that we assign symbolic names (like number, altitude, distance etc) to each field, rather than just a numeric index, as was the case in the vector example.

This adds the following "member fields" to the waypoint hash and sets their initial value to 0:
* number
* altitude
* distance
* angle
* length
* ID
* bearing

Now, to access any of these fields, we would use the "dot notation" by first specifying the name of the enclosing context (which is just a fancy word for the name of the hash) and the name of the field we are interested in. You could read this as LOCATION.FIELD (i.e. get FIELD out of location).

<syntaxhighlight lang="nasal">
var waypoint = {number:0,altitude:0,distance:0,angle:0,length:0,ID:0,bearing:0};
print ( waypoint.number );
print ( waypoint.altitude );
print ( waypoint.distance );
print ( waypoint.angle );
print ( waypoint.length );
print ( waypoint.ID );
print ( waypoint.bearing );
</syntaxhighlight>

So, the hash represents the surrounding environment (i.e. context or "namespace") in which these symbols are valid. For more information on namespaces, please see [[Namespaces and Methods]].

Now, to make this is a little more interesting and to show what's happening, we are going to change the value of each field:

<syntaxhighlight lang="nasal">
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
print ( waypoint.number ); # prints 1
print ( waypoint.altitude ); # prints 2
print ( waypoint.distance ); # prints 3
print ( waypoint.angle ); # prints 4
print ( waypoint.length ); # 5
print ( waypoint.ID ); #6
print ( waypoint.bearing ); #7
</syntaxhighlight>

So, you could obviously create several different versions of this hash to store your waypoint data:

<syntaxhighlight lang="nasal">
var waypoint1 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint2 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint3 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint4 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint5 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
</syntaxhighlight>

This is already a pretty cool thing because you would end up with 5 different containers all having their own set of fields, that you can access and set arbitrarily - without affecting the other containers.

But the cool thing comes next:

As you may have noticed, the code (internal structure of fields) for each waypoint is 100% identical - so we could just as well tell the Nasal engine to use an existing hash as a TEMPLATE for a new object instead of having to replicate the hash over and over again. This is accomplished using the "parents" keyword:

<syntaxhighlight lang="nasal">
var Position3D = {x:1.00, y:2.00, z:3.00};
var p1 = { parents: [Position3D] };
var p2 = { parents: [Position3D] };
var p3 = { parents: [Position3D] };
</syntaxhighlight>

This creates three different new containers/hashes by copying the fields from the hash specified in the parents' vector.

What parents will do is this: whenever a hash contains a vector field named "parents:" pointing to other hashes, it will look up the parent hashes and use them as a template and copy the fields of the parent hashes to the new hash, i.e. less typing for you!

This means, that the previously posted code could be easily abbreviated and written like this:

<syntaxhighlight lang="nasal">
var waypoint1 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint2 = {parents:[waypoint1] };
var waypoint3 = {parents:[waypoint1] };
var waypoint4 = {parents:[waypoint1] };
var waypoint5 = {parents:[waypoint1] };
</syntaxhighlight>

You could even introduce a new helper function to create new objects, let's call it new_waypoint:

<syntaxhighlight lang="nasal">
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var new_waypoint = func() {
return { parents:[waypoint] };
}

var waypoint1 = new_waypoint();
var waypoint2 = new_waypoint();
var waypoint3 = new_waypoint();
var waypoint4 = new_waypoint();
var waypoint5 = new_waypoint();
</syntaxhighlight>

or using a vector for each object, which has the added advantage that you can easily create arbitrary amounts of waypoints on demand:

<syntaxhighlight lang="nasal">
# this is our template for new waypoints
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};

# this is our allocator function creating new waypoints
var new_waypoint = func {return {parents:[waypoint] };}

var waypoints = [nil,nil,nil,nil,nil]; # initialize the vector to set its size

# populate the waypoints vector by allocating one new waypoint per "slot"
waypoints[0] = new_waypoint();
waypoints[1] = new_waypoint();
waypoints[2] = new_waypoint();
waypoints[3] = new_waypoint();
waypoints[4] = new_waypoint();
</syntaxhighlight>

A shorter version would read:

<syntaxhighlight lang="nasal">
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var new_waypoint = func {return {parents:[waypoint] };}

var NUM_ELEMENTS = 5;
var waypoints = [];
setsize(waypoints, NUM_ELEMENTS);

forindex(var i; waypoints)
waypoints[i] = new_waypoint();
</syntaxhighlight>

Once we start using a hash as a template for other hashes using the "parents" vector, we are creating a class that is copied to each new hash. This new copy of the class is called an "object" after creation.

A "class" is just a template for a certain data type that consists of other data types and provides functions to work with the class. The functions publicly accessible are called its "interface" because these functions are meant to be used by the users of your class. This is in contrast to member fields which are usually not meant to be accessed directly.

Once a class is used as a template to create a new object, we say the class is getting "instantiated", i.e. an instance of the class (an actual object) is created. This makes it then possible to make use of its interface and access member functions (which are methods). Also see {{forum link|p=145769}}.

Now, given that the creation of new hashes using a template class is such a common thing to do - we could just as well add a new function to the parent hash that we can use to construct new hashes. As you could see already, the fields (or members) of a hash are specified in a well-defined form using the key/value format where key and value are separated by a colon: "field_name:value".

<syntaxhighlight lang="nasal">
var waypoint1 = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7
};
</syntaxhighlight>

This isn't any different for fields that are of type "function":

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,

hello: func {
print("Hello");
}
};
</syntaxhighlight>

Note that we have added a new field named "hello" to our waypoint hash. This can be easily accessed and also called:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
hello: func {
print("Hello");
}
};

var w = {parents: [waypoint]};
w.hello();
</syntaxhighlight>

On the other hand, we were just about to make the construction of such hashes much simpler. This can be done by creating a new function that constructs hashes dynamically using a hash:

<syntaxhighlight lang="nasal">
var make_waypoint = func {
return { parents:[waypoint] };
}
</syntaxhighlight>

Next, we are going to change the function and and embed it into the hash, so that the constructor function becomes a part of the class, renaming it to "new":

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func {
return {parents:[waypoint]}
}
};
</syntaxhighlight>

So, whenever we need a new hash object of type "waypoint", we can simply call this construction function (which we'll call a constructor from now on):

<syntaxhighlight lang="nasal">
var wp = waypoint.new();
</syntaxhighlight>

This is what most Nasal code using OOP will typically look like.

== Hashes and foreach (enumerating a hash) ==

To iterate through all elements in a hash the keys(hash) method is used to produce a vector of the keys for the hash.

<syntaxhighlight lang="nasal">
var namehash = {};
namehash["value1"]= 1;
namehash["value2"] =2;

foreach(var hash_key ; keys(namehash))
print(namehash[hash_key]);
</syntaxhighlight>

== A generic constructor ==

Sometimes, you'll work with classes that do not have any custom constructor functions - but you can easily create a generic constructor, too:

<syntaxhighlight lang="nasal">
var new = func(obj) {
return {parents:obj};
}
</syntaxhighlight>

As long as '''obj''' is a vector of hashes, it can be simply invoked like this:

<syntaxhighlight lang="nasal">
var p = new( [Position3D] );
</syntaxhighlight>

Now, once you remember that Nasal implicitly has an '''arg''' vector for its arguments, the whole thing can be simplified like this:

<syntaxhighlight lang="nasal">
var new = func {
return {parents:arg};
}

var Position3D = {x:0.0, y:0.0, z:0.0};

var p = new( Position3D );
</syntaxhighlight>

This will simply create a function named "new" which accepts an implicit list of arguments (in the implicit "args" vector). The function returns a hash whose parents field is set to the args vector, so this method could even be used for multiple inheritances. Note that the Position3D hash no longer has its constructor, it's just a simple hash in this case.

To make this look a little nicer, we can also rename the default argument vector (i.e. args) to something more informative, like "classes":

<syntaxhighlight lang="nasal">
var new = func(classes...) {
return {parents:classes};
}

var Position3D = {x:0.0, y:0.0, z:0.0};

var p = new( Position3D );
</syntaxhighlight>

Using this approach, you could even make the "new operator" call custom constructors automatically for each created object.

You could even implement an overloaded function that creates arrays/vectors of objects.

A simple generic constructor can be expressed in a very succinct fashion:

<syntaxhighlight lang="nasal">
# a new function with an implicit arg parameter that simply returns a new hash with the parents' field set to all arguments provided
var new = func return { parents:arg };

var Position3D = {x:0.0, y:0.0, z:0.0};

var p = new( Position3D );
</syntaxhighlight>

Now, let's imagine you want to add another member function to print a certain field's value, such as "number".
Given that objects created from the same class template, there needs to be a way for a method (class function) to refer to itself (its object), i.e. to refer to the object itself, otherwise, the function wouldn't know what object is meant, and what object it is referring to.

This can be accomplished using the "me" keyword which ensures that the member function is always referring to the currently active object (itself):

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func {
return {parents:[waypoint]};
},
show_number: func {
print(me.number);
}
};
</syntaxhighlight>

Note how we are just prepending the "me" keyword to the object's field, making it clear that "me" is the requested namespace/context of the field to be retrieved.

On the other hand, maybe you'd like to add some information (such as the number) during construction time to the object. So this would require changing the constructor function to accept a parameter, too:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
return {parents:[waypoint]};
},
show_number: func {
print(me.number);
}
};
</syntaxhighlight>

Note how the new function has been changed to accept a parameter named "n".

Now, to actually set the number field during construction time to the value of n, you could create a temporary hash:

<syntaxhighlight lang="nasal">
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
}
</syntaxhighlight>

Or in its entirety:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
},
show_number: func {
print(me.number);
}
};
</syntaxhighlight>

Now, back to your initial example regarding a list of waypoints:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
},
};

var waypoints = [waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new() ];
</syntaxhighlight>

Note how this creates a vector of 5 waypoints (0..4), each of these waypoints is a full object that can be conveniently accessed:

<syntaxhighlight lang="nasal">
waypoints[0].bearing = 100;
waypoints[1].altitude = 100;
waypoints[2].ID = "none";
</syntaxhighlight>

You can also use Nasal's support for looping to conveniently process these waypoints:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
},
dump: func {
print("Altitude:", me.altitude, " distance:", me.distance, " Bearing:", me.bearing);
}
};

var waypoints = [waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new(), ];

foreach(var w; waypoints) {
w.dump();
}

</syntaxhighlight>

As you may remember, the parents' keyword points not just to a single "class template" (hash), but instead to a vector of hashes. This makes it possible to use several different hashes as the template for a new hash:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};

var propulsion = {horse_power:0};
var vehicle = {tyres:0};

# create different propulsion classes:
var engine = new(propulsion);
var piston_engine = new (engine);
var turboprop_engine = new(engine);
var jet_engine = new(engine);

var car = new(vehicle, propulsion);
var boat = new(vehicle, propulsion);
var airplane = new(vehicle, propulsion);

# seaplane is a new type of vehicle that inherits from the classes boat and aeroplane
var seaplane = new(boat, airplane);
</syntaxhighlight>

There are two important concepts to keep in mind here: The relationship between classes is classified according to an "IS A" and "HAS A" pattern:

* a car "IS A" vehicle
* an aeroplane "IS A" vehicle
* an elephant "IS AN" animal

* a car "HAS AN" engine (0..x)
* an airplane "HAS AN" engine (0..x)
* an elephant "HAS" ears

The difference when dealing with these relationships is that whenever something "IS" something, the right thing to do is to directly create a new object using the parent class:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};
var animal = {eyes:0,ears:0};

var dog = new(animal);
var cat = new(animal);
var bird = new(animal);
var spider = new(animal);
</syntaxhighlight>

Now, imagine we wanted to keep the number of legs for each animal, too: 4 legs for dogs and cats, 2 legs for birds and 8 legs for spiders:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};
var animal = {eyes:0,ears:0,legs:0};

var dog = new(animal);
var cat = new(animal);
var bird = new(animal);
var spider = new(animal);
</syntaxhighlight>

However, at some point we may need additional information for each leg - such as the length of each leg. That's where we use a new "leg" class (an animal HAS legs), so that the animal class no longer just contains the number of legs, but rather contains a vector of "leg" objects:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};
var leg = {length:0};
var animal = {eyes:0,ears:0,legs:[] };

var dog = new(animal);
var cat = new(animal);
var bird = new(animal);
var spider = new(animal);
</syntaxhighlight>

This was a very simple introduction to object-oriented programming in Nasal.

[[Category:Nasal howto|Module, Create a new Nasal]]

User:Chillz

2020-06-14T11:01:21Z

Chillz:

User:Chillz

2020-06-14T10:57:47Z

Chillz:

__NOEDITSECTION__
<center><font face="Arial Rounded MT Bold"><span style="color:Red;font-size:255%"><b>''Welcome to my UserPage.. !! ''</b></span></font face="Arial Rounded MT Bold"> </center>
</div>
{{-}}
<center></center>
<center><span style="font-family: Segoe Script"><span style="font-size: 13pt">Today's date: [[{{#time:l|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:l|}}</span></span>]] [[{{#time:F|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:F|}}</span></span>]] [[{{#time:F j|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:j|}}</span></span>]], [[{{#time:Y|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:Y|}}</span></span>]]</span></span></center>


<div style="position: relative; z-index: 3; width: 670px; height: 480px; margin: 0 auto;">

<div style="position: absolute; z-index: 1; left: 1px; top: 1px">
[[image:BranMoviC Hakken.gif|130px|link=|alt={{PAGENAME}}]]  <font face="Times New Roman">[[User:{{PAGENAME}}/About Me|<span style="color:lightgrey;font-size:120%"><b>About Me</b></span>]]
</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 20px; top: 130px">
[[Image:Nixie2.gif|100px|Sepiola atlantica|link=|alt={{PAGENAME}}]]  <span class="plainlinks"><font face="Times New Roman">[https://template.miraheze.org/wiki/Special:CentralAuth/{{PAGENAME}}<span style="color:lightgrey;font-size:120%"><b>Contribution</span></b></span>]</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 30px; top: 250px">
[[Image:The Fairybread Barnstar.gif|100px|link=|alt={{PAGENAME}}]]  <font face="Times New Roman">[[User Talk:{{PAGENAME}}/Templatian|<span style="color:lightgrey;font-size:140%"><b><small>BarnStars</small></b></span>]]</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 30px; top: 380px">
[[Image:Gears animation A-B.gif|100px|link=|alt={{PAGENAME}}]]  <font face="Times New Roman">[[User:{{PAGENAME}}/Useful|<span style="color:lightgrey;font-size:130%"><b>Useful Link</b></span>]]</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 400px; top: 1px">
<font face="Times New Roman">[[User Talk:{{PAGENAME}}|<span style="color:lightgrey;font-size:120%"><b>Talk page</b></span>]]</font face="Times New Roman">  [[Image:E-mail.gif]]</div>

<div style="position: absolute; z-index: 1; left: 400px; top: 145px">
<font face="Times New Roman">[[User:{{PAGENAME}}/Sandbox|<span style="color:lightgrey;font-size:100%"><b>Sandbox</b></span>]]</font face="Times New Roman">  [[Image:KeretaApiPuterMajuMundur.gif|200px|link=|alt={{PAGENAME}}]]</div>

<div style="position: absolute; z-index: 1; left: 400px; top: 300px">
<font face="Times New Roman">[[User:{{PAGENAME}}/TOP 10|<span style="color:lightgrey;font-size:100%"><b>Top 10</b></span>]]</font face="Times New Roman">  [[Image:Horse gallop.gif|100px|link=|alt=mmrsafy]] [[Image:Horse gallop.gif|100px|link=|alt=mmrsafy]] [[Image:Horse gallop.gif|100px|link=|alt=mmrsafy]] </div>
 <div style="position: absolute; z-index: 1; left: 220px; top: 205px">
</div>
</div>
</div>

'''Note 1:''' '''Chillz''' is a '''NEW''' editor on the [[FlightGear wiki]].

'''Note 2:''' '''Chillz''' joined the wiki project on '''14 June 2020'''.

'''Note 3:''' '''Chillz''' has amassed over '''10''' contributions to the [[FlightGear wiki]].

'''Note 4:''' '''Chillz''' is destined to become an '''ADMIN''' on the FlightGear wiki!

'''Note 5:''' If you get the time, feel free to check out her [[User:Chillz/sandbox|sandbox]].

'''Note 6:''' '''Chillz''' is real good at fixing grammatical errors.

'''Note 7:''' '''Chillz''' is on the look out for any '''VANDALISM'''. She is a '''24/7''' [[Special:RecentChanges|recent changes]] '''PATROLLER'''.

'''Note 8:''' Need any '''help''' or assistance with '''anything'''? Leave her a '''NOTE''' on her [[User talk:Chillz|talk page]]! (Emails not allowed!)

[[Category:Users]]

User:Chillz

2020-06-14T10:57:01Z

Chillz:

__NOEDITSECTION__
<center><font face="Arial Rounded MT Bold"><span style="color:Red;font-size:255%"><b>''Welcome to my UserPage.. !! ''</b></span></font face="Arial Rounded MT Bold"> </center>
</div>
{{-}}
<center></center>
<center><span style="font-family: Segoe Script"><span style="font-size: 13pt">Today's date: [[{{#time:l|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:l|}}</span></span>]] [[{{#time:F|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:F|}}</span></span>]] [[{{#time:F j|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:j|}}</span></span>]], [[{{#time:Y|}}|<span style="color:magenta;"><span style="font-family: Segoe Script">{{#time:Y|}}</span></span>]]</span></span></center>
<div style="padding: 4px .2em; word-spacing: 4px; border: 1px solid #A3B1BF;" align="center">
<inputbox>
type=fulltext
width=65
searchbuttonlabel=Search Miraheze
break=no
</inputbox></div>
<div style="position:absolute; z-index:100; right:1px; top:4px;" class="metadata" id="developer">{{Wiki favicon|icon_nr=4}}{{click|link=User talk:{{PAGENAME}}|image=Farm-Fresh female.png|width=25px|height=35px|title=I'm a woman.}}</div>

<span style="position:absolute;top:-15px;left:-401px;z-index:-1">[[Image:Lilium jankae 1.jpg.jpg|350px]]</span>
<div style="border: 3px solid lightgrey; background-color:Black; padding: .5em 1em; margin: 5px 5px 0; text-align: left">



<div style="position: relative; z-index: 3; width: 670px; height: 480px; margin: 0 auto;">

<div style="position: absolute; z-index: 1; left: 1px; top: 1px">
[[image:BranMoviC Hakken.gif|130px|link=|alt={{PAGENAME}}]]  <font face="Times New Roman">[[User:{{PAGENAME}}/About Me|<span style="color:lightgrey;font-size:120%"><b>About Me</b></span>]]
</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 20px; top: 130px">
[[Image:Nixie2.gif|100px|Sepiola atlantica|link=|alt={{PAGENAME}}]]  <span class="plainlinks"><font face="Times New Roman">[https://template.miraheze.org/wiki/Special:CentralAuth/{{PAGENAME}}<span style="color:lightgrey;font-size:120%"><b>Contribution</span></b></span>]</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 30px; top: 250px">
[[Image:The Fairybread Barnstar.gif|100px|link=|alt={{PAGENAME}}]]  <font face="Times New Roman">[[User Talk:{{PAGENAME}}/Templatian|<span style="color:lightgrey;font-size:140%"><b><small>BarnStars</small></b></span>]]</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 30px; top: 380px">
[[Image:Gears animation A-B.gif|100px|link=|alt={{PAGENAME}}]]  <font face="Times New Roman">[[User:{{PAGENAME}}/Useful|<span style="color:lightgrey;font-size:130%"><b>Useful Link</b></span>]]</font face="Times New Roman"></div>

<div style="position: absolute; z-index: 1; left: 400px; top: 1px">
<font face="Times New Roman">[[User Talk:{{PAGENAME}}|<span style="color:lightgrey;font-size:120%"><b>Talk page</b></span>]]</font face="Times New Roman">  [[Image:E-mail.gif]]</div>

<div style="position: absolute; z-index: 1; left: 400px; top: 145px">
<font face="Times New Roman">[[User:{{PAGENAME}}/Sandbox|<span style="color:lightgrey;font-size:100%"><b>Sandbox</b></span>]]</font face="Times New Roman">  [[Image:KeretaApiPuterMajuMundur.gif|200px|link=|alt={{PAGENAME}}]]</div>

<div style="position: absolute; z-index: 1; left: 400px; top: 300px">
<font face="Times New Roman">[[User:{{PAGENAME}}/TOP 10|<span style="color:lightgrey;font-size:100%"><b>Top 10</b></span>]]</font face="Times New Roman">  [[Image:Horse gallop.gif|100px|link=|alt=mmrsafy]] [[Image:Horse gallop.gif|100px|link=|alt=mmrsafy]] [[Image:Horse gallop.gif|100px|link=|alt=mmrsafy]] </div>
 <div style="position: absolute; z-index: 1; left: 220px; top: 205px">
</div>
</div>
</div>

'''Note 1:''' '''Chillz''' is a '''NEW''' editor on the [[FlightGear wiki]].

'''Note 2:''' '''Chillz''' joined the wiki project on '''14 June 2020'''.

'''Note 3:''' '''Chillz''' has amassed over '''10''' contributions to the [[FlightGear wiki]].

'''Note 4:''' '''Chillz''' is destined to become an '''ADMIN''' on the FlightGear wiki!

'''Note 5:''' If you get the time, feel free to check out her [[User:Chillz/sandbox|sandbox]].

'''Note 6:''' '''Chillz''' is real good at fixing grammatical errors.

'''Note 7:''' '''Chillz''' is on the look out for any '''VANDALISM'''. She is a '''24/7''' [[Special:RecentChanges|recent changes]] '''PATROLLER'''.

'''Note 8:''' Need any '''help''' or assistance with '''anything'''? Leave her a '''NOTE''' on her [[User talk:Chillz|talk page]]! (Emails not allowed!)

[[Category:Users]]

User:Chillz

2020-06-14T10:50:13Z

Chillz: User category

'''Note 1:''' '''Chillz''' is a '''NEW''' editor on the [[FlightGear wiki]].

'''Note 2:''' '''Chillz''' joined the wiki project on '''14 June 2020'''.

'''Note 3:''' '''Chillz''' has amassed over '''10''' contributions to the [[FlightGear wiki]].

'''Note 4:''' '''Chillz''' is destined to become an '''ADMIN''' on the FlightGear wiki!

'''Note 5:''' If you get the time, feel free to check out her [[User:Chillz/sandbox|sandbox]].

'''Note 6:''' '''Chillz''' is real good at fixing grammatical errors.

'''Note 7:''' '''Chillz''' is on the look out for any '''VANDALISM'''. She is a '''24/7''' [[Special:RecentChanges|recent changes]] '''PATROLLER'''.

'''Note 8:''' Need any '''help''' or assistance with '''anything'''? Leave her a '''NOTE''' on her [[User talk:Chillz|talk page]]! (Emails not allowed!)

[[Category:Users]]

User:Chillz

2020-06-14T10:49:06Z

Chillz: Note

User:Chillz

2020-06-14T10:42:40Z

Chillz:

'''Chillz''' is a NEW editor on the FlightGear wiki. Need help or assistance with anything? Leave her a note on her [[User talk:Chillz|talk page]]!

'''Note 1:''' '''Chillz''' is destined to become an '''ADMIN''' on the FlightGear wiki!

'''Note 2:''' If you get the time, feel free to check out her [[User:Chillz/sandbox|sandbox]].

'''Note 3:''' '''Chillz''' is real good at fixing grammatical errors.

'''Note 4:''' '''Chillz''' is on the look out for any '''VANDALISM'''. She is a '''24/7''' [[Special:RecentChanges|recent changes]] '''PATROLLER'''.

User:Chillz

2020-06-14T10:42:23Z

Chillz: Also note

'''Chillz''' is a NEW editor on the FlightGear wiki. Need help or assistance with anything? Leave her a note on her [[User talk:Chillz|talk page]]!

'''Note 1:''' '''Chillz''' is destined to become an '''ADMIN''' on the FlightGear wiki!

'''Note 2:''' If you get the time, feel free to check out her [[User:Chillz/sandbox|sandbox]].

'''Note 3:''' '''Chillz''' is real good at fixing grammatical errors.

'''Note 4:''' '''Chillz''' is on the look out for any '''VANDALISM'''. She is an '''24/7''' [[Special:RecentChanges|recent changes]] '''PATROLLER'''.

User:Chillz

2020-06-14T10:40:47Z

Chillz: Also note

User:Chillz

2020-06-14T10:40:06Z

Chillz: Also noe

Developer Mode

2020-06-14T10:38:13Z

Chillz: Fixing 5 grammatical errors

{{Stub}}
{{See also|Startup Modes}}
03/2017: James pushed a build system change <ref>https://sourceforge.net/p/flightgear/mailman/message/35666576/</ref><ref>https://sourceforge.net/p/flightgear/mailman/message/35692898/</ref>, to do the following:
* define a FG_BUILD_TYPE in Cmake, with values ‘Dev’ (default), ‘Nightly’ and ‘Release’. (other values can be added if meaningful, eg ‘release-candidate’)
* replace the existing FG_NIGHTLY and ENABLE_DEV_WARNINGS Cmake options
* add a /sim/developer-mode boolean flag
* initialise the default value of this based on the build-type.

*Right now*, the only controversial thing is that Nightly builds default to developer-mode=true. - allow developer-mode to be forced on and off in *any* build from the command line —developer (switches it on) —developer=false (switch it off, for testing in a self-compiled build) - use this to switch the severity of the SG_DEV_WARN and SG_DEV_ALERT log messages up or down - replace all the previous compile-time conditional warnings controlled by ‘ENABLE_DEV_WARNINGS’ to be dev warnings at runtime. - report the build type in lots of places, eg via JSON, on startup, etc I also just updated the fgmeta build script used by Jenkins to pass (I hope!) correct values for FG_BUILD_TYPE to Cmake for our nightly and release builds, but this layer can be improved now, I guess. Please test: the new splash screen shows a red warning text for Nightly builds, we could also show something in developer mode if it's useful. We can also discuss hiding UI elements or picking different defaults based on the developer mode; since it’s a run-time switch, we aren’t excluding anyone from contributing by hiding things in ‘out-of-the-box’ mode in release builds, is my opinion. Candidate things to hide, more suggestions welcome: - the entire Debug menu - wireframe mode in Rendering settings (and probably a few more things there) I will gradually review warnings for dev-mode suitability, using the ‘can an end-user do anything meaningful with this message?’ criteria, I believe Richard Harrison also volunteered to do a review of that. Any feedback on this system is welcome, we have a whole release cycle to decide what, if anything, we change in developer-mode vs normal. (Oh and the launcher will get an ‘enable developer mode’ checkbox shortly)<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35693664/
|title = <nowiki> [Flightgear-devel] Developer-mode, warnings, build-type </nowiki>
|author = <nowiki> James Turner </nowiki>
|date = Feb 28th, 2017
|added = Feb 28th, 2017
|script_version = 0.40
}}</ref>

== References ==
{{Appendix}}

User:Chillz

2020-06-14T10:35:41Z

Chillz: Also note

'''Chillz''' is a NEW editor on the FlightGear wiki. Need help or assistance with anything? Leave her a note on her [[User talk:Chillz|talk page]]!

'''Note:''' '''Chillz''' is destined to become an '''ADMIN''' on the FlightGear wiki!

Air traffic control

2020-06-14T10:34:09Z

Chillz: Fixing 4 grammatical errors

'''Air traffic control''' (ATC) is a service mostly provided by ground-based controllers who direct aircraft on the ground and in the air. The primary purpose of ATC systems worldwide is to separate aircraft to prevent collisions, to organize and expedite the flow of traffic, and to provide information and other support for pilots when able. In some countries, ATC may also play a security or defence role (as in the United States), or be run entirely by the military (as in Brazil).

== Related content ==
* [[ATC phraseology]] lists common phraseology and their meanings.
* [[Spoken_ATC]] allows the pilot to listen to the directives of the Air Traffic Controller.
* [[Red Griffin ATC]] Speaking Air Traffic Controller Addon for FlightGear

== ATC in FlightGear multi-player ==
To know if an area is controlled or booked:
* Check for announced ATC sessions on [http://flightgear-atc.alwaysdata.net/ Lenny's website].
* Check the Pilot List in FlightGear or the [[MPMap|Multiplayer map]]. Usually, controllers:
** have a callsign ''XXXX_DE'', ''XXXX_GN'', ''XXXX_TW'' or ''XXXX_AP'' (where ''XXXX'' is the ICAO code of the airport they are manning);
** generally use ''[[OpenRadar]]'' or ''[[ATC-pie]]'', which appear as aircraft models on the map, or older ''ATC-*'' named models.

=== For pilots ===
* [[ATC Tutorial]]
* [[ATC best practices#For pilots|Best practices]]
* [[SquawkGear|Connecting to Vatsim]]

=== For controllers ===
* [[ATC best practices#For controllers|Best practices]]
* "[http://flightgear-atc.alwaysdata.net Lenny's website]" is today's ''de facto'' ATC platform featuring a [[Flight_planning|flight plan]] database, tutorials and resources, software downloads, and a schedule where ATCs announce their session and let pilots know when and which airport will be controlled

Software for controlling on FlightGear:
* Standalone programs for more realistic experience: [[OpenRadar]], [[ATC-pie]]
* FG aircraft like [[ATC-FS]], an ATC model with flight strips

[[Category:Air Traffic Control]]
[[it:Controllo Traffico Aereo]]

Air traffic control

2020-06-14T10:33:08Z

Chillz:

'''Air traffic control''' (ATC) is a service mostly provided by ground-based controllers who direct aircraft on the ground and in the air. The primary purpose of ATC systems worldwide is to separate aircraft to prevent collisions, to organize and expedite the flow of traffic, and to provide information and other support for pilots when able. In some countries, ATC may also play a security or defense role (as in the United States), or actually be run entirely by the military (as in Brazil).

== Related content ==
* [[ATC phraseology]] lists common phraseology and their meanings.
* [[Spoken_ATC]] allows the pilot to listen to the directives of the Air Traffic Controller.
* [[Red Griffin ATC]] Speaking Air Traffic Controller Addon for FlightGear

== ATC in FlightGear multi-player ==
To know if an area is controlled or booked:
* Check for announced ATC sessions on [http://flightgear-atc.alwaysdata.net/ Lenny's website].
* Check the Pilot List in FlightGear or the [[MPMap|Multiplayer map]]. Usually, controllers:
** have a callsign ''XXXX_DE'', ''XXXX_GN'', ''XXXX_TW'' or ''XXXX_AP'' (where ''XXXX'' is the ICAO code of the airport they are manning);
** generally use ''[[OpenRadar]]'' or ''[[ATC-pie]]'', which appear as aircraft models on the map, or older ''ATC-*'' named models.

=== For pilots ===
* [[ATC Tutorial]]
* [[ATC best practices#For pilots|Best practices]]
* [[SquawkGear|Connecting to Vatsim]]

=== For controllers ===
* [[ATC best practices#For controllers|Best practices]]
* "[http://flightgear-atc.alwaysdata.net Lenny's website]" is today's ''de facto'' ATC platform featuring a [[Flight_planning|flight plan]] data base, tutorials and resources, software downloads, and a schedule where ATCs announce their session and let pilots know when and which airport will be controlled

Software for controlling on FlightGear:
* Standalone programs for more realistic experience: [[OpenRadar]], [[ATC-pie]]
* FG aircrafts like [[ATC-FS]], an ATC model with flight strips

[[Category:Air Traffic Control]]
[[it:Controllo Traffico Aereo]]

Air traffic control

2020-06-14T10:32:52Z

Chillz:

'''Air traffic control''' (ATC) is a service mostly provided by ground-based controllers who direct aircraft on the ground and in the air. The primary purpose of ATC systems worldwide is to separate aircraft to prevent collisions, to organize and expedite the flow of traffic, and to provide information and other support for pilots when able. In some countries, ATC may also play a security or defense role (as in the United States), or actually be run entirely by the military (as in Brazil).

== Related content ==
* [[ATC phraseology]] lists common phraseology and their meanings.
* [[Spoken_ATC]] allows the pilot to listen to the directives of the Air Traffic Controller.
* [[Red Griffin ATC]] Speaking Air Traffic Controller Addon for FlightGear

== ATC in FlightGear multi-player ==
To know if an area is controlled or booked:
*Check for announced ATC sessions on [http://flightgear-atc.alwaysdata.net/ Lenny's website].
*Check the Pilot List in FlightGear or the [[MPMap|Multiplayer map]]. Usually, controllers:
** have a callsign ''XXXX_DE'', ''XXXX_GN'', ''XXXX_TW'' or ''XXXX_AP'' (where ''XXXX'' is the ICAO code of the airport they are manning);
** generally use ''[[OpenRadar]]'' or ''[[ATC-pie]]'', which appear as aircraft models on the map, or older ''ATC-*'' named models.

=== For pilots ===
* [[ATC Tutorial]]
* [[ATC best practices#For pilots|Best practices]]
* [[SquawkGear|Connecting to Vatsim]]

=== For controllers ===
* [[ATC best practices#For controllers|Best practices]]
* "[http://flightgear-atc.alwaysdata.net Lenny's website]" is today's ''de facto'' ATC platform featuring a [[Flight_planning|flight plan]] data base, tutorials and resources, software downloads, and a schedule where ATCs announce their session and let pilots know when and which airport will be controlled

Software for controlling on FlightGear:
* Standalone programs for more realistic experience: [[OpenRadar]], [[ATC-pie]]
* FG aircrafts like [[ATC-FS]], an ATC model with flight strips

[[Category:Air Traffic Control]]
[[it:Controllo Traffico Aereo]]

Air traffic control

2020-06-14T10:32:23Z

Chillz: Article is NOT a stub

'''Air traffic control''' (ATC) is a service mostly provided by ground-based controllers who direct aircraft on the ground and in the air. The primary purpose of ATC systems worldwide is to separate aircraft to prevent collisions, to organize and expedite the flow of traffic, and to provide information and other support for pilots when able. In some countries, ATC may also play a security or defense role (as in the United States), or actually be run entirely by the military (as in Brazil).

== Related content ==
* [[ATC phraseology]] lists common phraseology and their meanings.
* [[Spoken_ATC]] allows the pilot to listen to the directives of the Air Traffic Controller.
* [[Red Griffin ATC]] Speaking Air Traffic Controller Addon for FlightGear

== ATC in FlightGear multi-player ==

To know if an area is controlled or booked:
*Check for announced ATC sessions on [http://flightgear-atc.alwaysdata.net/ Lenny's website].
*Check the Pilot List in FlightGear or the [[MPMap|Multiplayer map]]. Usually, controllers:
** have a callsign ''XXXX_DE'', ''XXXX_GN'', ''XXXX_TW'' or ''XXXX_AP'' (where ''XXXX'' is the ICAO code of the airport they are manning);
** generally use ''[[OpenRadar]]'' or ''[[ATC-pie]]'', which appear as aircraft models on the map, or older ''ATC-*'' named models.

=== For pilots ===

* [[ATC Tutorial]]
* [[ATC best practices#For pilots|Best practices]]
* [[SquawkGear|Connecting to Vatsim]]

=== For controllers ===

* [[ATC best practices#For controllers|Best practices]]
* "[http://flightgear-atc.alwaysdata.net Lenny's website]" is today's ''de facto'' ATC platform featuring a [[Flight_planning|flight plan]] data base, tutorials and resources, software downloads, and a schedule where ATCs announce their session and let pilots know when and which airport will be controlled

Software for controlling on FlightGear:
* Standalone programs for more realistic experience: [[OpenRadar]], [[ATC-pie]]
* FG aircrafts like [[ATC-FS]], an ATC model with flight strips

[[Category:Air Traffic Control]]

[[it:Controllo Traffico Aereo]]

User talk:Chillz

2020-06-14T10:31:11Z

Chillz: Created blank page

Howto:Start using vectors and hashes in Nasal

2020-06-14T10:30:46Z

Chillz: Fixing 50 grammatical errors

{{Nasal Navigation}}

Here we look into how to '''start using vectors and hashes in Nasal''' to simplify and generalize code. Vectors and hashes are two data structures that [[Nasal]] uses to store data. Vectors are in some other programming languages called for example lists or one-dimensional arrays, and hashes are similar to C's structs.

In many cases repetitive code can be generalized and rewritten into vectors, hashes or helper functions using them. Some of the advantages with rewriting repetitive code this way is that it helps maintenance by requiring less typing when modifying and/or when fixing bugs.

In addition to storing data hashes can "store" functions and be used as object classes. Object classes can be created by adding a function into a hash, that will create a new hash when called, a so called ''constructor'' (sometimes abbreviated to ''ctor'' or ''c'tor'') usually named <code>'''new'''()</code>.

== Learn more about vectors ==
Imagine a piece of Nasal code working with 5 different waypoints. You would need to manage the data for each waypoint. A simple version using different variables for each data set might look like this:

<syntaxhighlight lang="nasal">
var wp1 = 0;
var wp1alt = 0;
var wp1dist = 0;
var wp1angle = 0;
var wp1length = 0;
var wp1id = "";
var wp1brg = 0;

var wp2 = 0;
var wp2alt = 0;
var wp2dist = 0;
var wp2angle = 0;
var wp2length = 0;
var wp2id = "";
var wp2brg = 0;

var wp3 = 0;
var wp3alt = 0;
var wp3dist = 0;
var wp3angle = 0;
var wp3length = 0;
var wp3id = "";
var wp3brg = 0;

var wp4 = 0;
var wp4alt = 0;
var wp4dist = 0;
var wp4angle = 0;
var wp4length = 0;
var wp4id = "";
var wp4brg = 0;

var wp5 = 0;
var wp5alt = 0;
var wp5dist = 0;
var wp5angle = 0;
var wp5length = 0;
var wp5id = "";
var wp5brg = 0;
</syntaxhighlight>

Now, this is fairly repetitive and not overly scalable, because the variable names are hardcoded and need to be changed in a lot of places in the source code.

Just imagine we'd need to support more than just 5 waypoints, like maybe 10, 20, 50 or maybe even 1000 waypoints. As you can see, this method is very inflexible, complicated, tedious and error-prone.

Such code contains so called "code smells", another example would be code like this:
<syntaxhighlight lang="nasal">
var l0 = "";
var l1 = "";
var l2 = "";
var l3 = "";
var l4 = "";
var l5 = "";
var l6 = "";
var l7 = "";
var l8 = "";
var l9 = "";
var l10 = "";
var l11 = "";
var l12 = "";
var l13 = "";
var l14 = "";
var l15 = "";
var l16 = "";
var l17 = "";
var l18 = "";
var l19 = "";
var l20 = "";

var hist1 = "";
var hist2 = "";
var hist3 = "";
var hist4 = "";
var hist5 = "";
var hist6 = "";

IDENTl3 = "";
IDENTl4 = "";
IDENTr4 = "";
IDENTl5 = "";
IDENTr5 = "";
IDENTl8 = "";

setprop("/instrumentation/efb/display/line0-l", l0);
setprop("/instrumentation/efb/display/line1-l", l1);
setprop("/instrumentation/efb/display/line2-l", l2);
setprop("/instrumentation/efb/display/line3-l", l3);
setprop("/instrumentation/efb/display/line4-l", l4);
setprop("/instrumentation/efb/display/line5-l", l5);
setprop("/instrumentation/efb/display/line6-l", l6);
setprop("/instrumentation/efb/display/line7-l", l7);
setprop("/instrumentation/efb/display/line8-l", l8);
setprop("/instrumentation/efb/display/line9-l", l9);
setprop("/instrumentation/efb/display/line10-l", l10);
setprop("/instrumentation/efb/display/line11-l", l11);
setprop("/instrumentation/efb/display/line12-l", l12);
setprop("/instrumentation/efb/display/line13-l", l13);
setprop("/instrumentation/efb/display/line14-l", l14);
setprop("/instrumentation/efb/display/line15-l", l15);
setprop("/instrumentation/efb/display/line16-l", l16);
setprop("/instrumentation/efb/display/line17-l", l17);
setprop("/instrumentation/efb/display/line18-l", l18);
setprop("/instrumentation/efb/display/line19-l", l19);
setprop("/instrumentation/efb/display/line20-l", l20);
</syntaxhighlight>

Whenever you see such a code, it should be obvious that using arrays/vectors would be a good idea.

So, it would be better to use a vector of waypoints instead. A vector is a list of things (variables) that can be easily accessed using an index into the vector. Pretty much like an array in C or C++, with the added advantage that the vector can be dynamically resized, e.g. using the setsize() library call. Consider the following example:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1", "wp2", "wp3", "wp4", "wp5"];
</syntaxhighlight>

This piece of code is equivalent to creating 5 different variables named "waypoints[n]" with an access index from n=0 to 4 (5 elements in total).

As you can see below, indexing starts at 0.

The problem is, that this only gives us a list of single waypoints:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1", "wp2", "wp3", "wp4", "wp5"];
print(waypoints[0]); # print wp1
print(waypoints[1]); # print wp2
print(waypoints[2]); # print wp3
print(waypoints[3]); # print wp4
print(waypoints[4]); # print wp5
</syntaxhighlight>

To do this using a conventional for loop, you would use the size() function to get the size of the vector:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1","wp2","wp3","wp4","wp5"];
for(var index; index < size(waypoints); index=index+1) {
print(waypoints[index]);
}
</syntaxhighlight>

The same thing can be accomplished using the forindex loop:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1","wp2","wp3","wp4","wp5"];
forindex(var index; waypoints) {
print(waypoints[index]);
}
</syntaxhighlight>

Now, waypoints being a vector, we can also use a simple foreach loop, that works without a counter, to process each element easily:

<syntaxhighlight lang="nasal">
var waypoints = ["wp1","wp2","wp3","wp4","wp5"];
foreach(var wpt; waypoints) {
print(wpt);
}
</syntaxhighlight>

What we need to save all the other waypoint specific information is a new variable type that serves as the "container" for variables, so that we can save several variables for each waypoint.

<syntaxhighlight lang="nasal">
var wp4 = 0; # waypoint number
var wp4alt = 0; # waypoint altitude
var wp4dist = 0; # waypoint distance
var wp4angle = 0; # waypoint angle
var wp4length = 0; # waypoint length
var wp4id = ""; # waypoint id
var wp4brg = 0; # waypoint bearing
</syntaxhighlight>

== A vector based version ==

One simple way to accomplish this is by using another vector for each waypoint, nested inside the original vector. So that we end up with a two-dimensional data structure. For example, imagine a folder containing subfolders, with folders not having names but rather indices (numbers).

So we could be using a "main" vector to store all waypoints, while each field of the main vector is a different vector that contains all waypoint-specific data.

<syntaxhighlight lang="nasal">
var wp4 = 0; # waypoint number
var wp4alt = 0; # waypoint altitude
var wp4dist = 0; # waypoint distance
var wp4angle = 0; # waypoint angle
var wp4length = 0; # waypoint length
var wp4id = ""; # waypoint id
var wp4brg = 0; # waypoint bearing

var waypoint4 = [wp4,wp4alt,wp4dist,wp4angle,wp4length,wp4id, wp4brg];
var waypoints = [waypoint4]
</syntaxhighlight>

First of all, we are setting up all the different variables for wp4, next, you are storing all variables in a vector called "waypoint4". In the end, we store this vector in another vector named "waypoints".

So, the very first vector element would be waypoints[0] and it would point to another vector (waypoint4), the elements of waypoint4 would be also available by index:

<syntaxhighlight lang="nasal">
var wp4 = 1; # waypoint number
var wp4alt = 1000; # waypoint altitude
var wp4dist = 20.4; # waypoint distance
var wp4angle = 33.4; #waypoint angle
var wp4length = 12; # waypoint length
var wp4id = "none"; # waypoint id
var wp4brg = 122; # waypoint bearing

var waypoint4 = [wp4,wp4alt,wp4dist,wp4angle,wp4length,wp4id, wp4brg];
var waypoints = [waypoint4]

print ( waypoints[0][0] ) # contains the data stored in wp4
print ( waypoints[0][1] ) # contains the data stored in wp4alt
print ( waypoints[0][2] ) # contains the data stored in wp4dist
print ( waypoints[0][3] ) # contains the data stored in wp4angle
print ( waypoints[0][4] ) # contains the data stored in wp4length
print ( waypoints[0][5] ) # contains the data stored in wp4id
print ( waypoints[0][6] ) # contains the data stored in wp4brg
</syntaxhighlight>

What we have here is a list of waypoints, with the first (0th) element containing another vector.

Obviously, you could add a bunch of other waypoints to the "waypoints" vector, too:

<syntaxhighlight lang="nasal">
var waypoint4 = [wp4,wp4alt,wp4dist,wp4angle,wp4length,wp4id, wp4brg];
var waypoint5 = [wp5,wp5alt,wp5dist,wp5angle,wp5length,wp5id, wp5brg];
var waypoints = [waypoint4, waypoint5]
</syntaxhighlight>

The only problem with this approach is, that you'll need to set up all those wp variables - so there's a shorter version possible, by directly adding your data without using variables, i.e. "inline":

<syntaxhighlight lang="nasal">
var waypoint4 = [1,1000,12,22,44,"none", 33];
var waypoint5 = [2,1500,22,42,14,"none", 133];
var waypoints = [waypoint4, waypoint5];
</syntaxhighlight>

There's an even more succinct version possible. The next step would be to use embedded vectors directly:

<syntaxhighlight lang="nasal">
var waypoints = [
[1,1000,12,22,44,"none", 33],
[2,1500,22,42,14,"none", 133]
];
</syntaxhighlight>

This is just formatted for clarity, the following snippet would be equivalent, but not as readable to people new to vectors:

<syntaxhighlight lang="nasal">
var waypoints = [ [1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133] ];
</syntaxhighlight>

Accessing such a vector with embedded (or nested) vectors is still as simple:

<syntaxhighlight lang="nasal">
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]
print(waypoints[0][0]) # prints 1
print(waypoints[0][1]) # prints 1000
print(waypoints[1][0]) # prints 2
print(waypoints[1][1]) # prints 1500
</syntaxhighlight>

The only issue here is that you'll need to keep vector ordering in mind so that you can always access the right element number. This could be simplified by using some variables with telling names as the index for each vector:

<syntaxhighlight lang="nasal">
# these are used self-explanatory indices - so that you don't need to remember each field's position:
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;

var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]
print(waypoints[0][ALTITUDE]) # prints 1
print(waypoints[0][DISTANCE]) # prints 1000
print(waypoints[1][ALTITUDE]) # prints 2
print(waypoints[1][DISTANCE]) # prints 1500
</syntaxhighlight>

Now, this yields already fairly readable source code:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]

# print the altitude for each waypoint in the vector:
foreach(var waypoint; waypoints) {
print( waypoint[ALTITUDE] );
}
</syntaxhighlight>

So, this would already be much better than our original version, because we can now have an arbitrary number of waypoints. New waypoints would need to be added to the waypoints vector by using the append() library function:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]]
print(waypoints[0][ALTITUDE]) # prints 1
print(waypoints[0][DISTANCE]) # prints 1000
print(waypoints[1][ALTITUDE]) # prints 2
print(waypoints[1][DISTANCE]) # prints 1500

append(waypoints, [3,3000,122,212,34,"none", 133] );
</syntaxhighlight>

Next, we could come up with some helper functions to deal with the vector details transparently, using the same method as before: self-explanatory indices, which spares us having to remember the purpose of each field:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]];

var get = func (n,what) {
return waypoints[n][what];
}

var set = func (n,what,value) {
waypoints[n][what]=value;
}

print( get(0, ALTITUDE) ); # prints 1
print( get(0, DISTANCE) ); # prints 1000
print( get(1, ALTITUDE) ); # prints 2
print( get(1, DISTANCE) ); # prints 1500
</syntaxhighlight>

There's one caveat here: The set function doesn't check the size of the vector, so it may try to access elements that are not there. To fix this, you'd need to use size(vec) call and check its size, and then adjust the size as needed using the set size(vec, size) library function.

You could even add some more high level helpers for each waypoint field:

<syntaxhighlight lang="nasal">
var NUMBER=0; var ALTITUDE=1; var DISTANCE=2; var ANGLE=3; var LENGTH=4; var ID=5; var BRG=6;
var waypoints = [[1,1000,12,22,44,"none", 33], [2,1500,22,42,14,"none", 133]];

var get = func (n,what) {
return waypoints[n][what];
}

var set = func (n,what,value) {
waypoints[n][what]=value;
}

var get_alt = func(n) {
return get(n,ALTITUDE);
}

var get_dist = func(n) {
return get(n,DISTANCE);
}

var get_angle = func(n) {
return get(n,ANGLE);
}

var get_length = func(n) {
return get(n,LENGTH);
}

var get_id = func(n) {
return get(n,ID);
}

var get_brg = func(n) {
return get(n,BEARING);
}
</syntaxhighlight>

There's still one issue though: we are using lots of variables and helpers that all belong to the "waypoints" type, but which clutter our source code.

So, next, we are going to look into an even more flexible approach that nicely maps each waypoint field and all helper functions to a symbolic name, without having to remember vector indices and such: using Nasal hashes, which are easier to use than complex arrangements using nested vectors.

== A hash based version (recommended) ==

Now, to wrap these fields into a single variable that serves as the container for other variables, we could use a Nasal hash and start completely from scratch.

Consider the following empty hash:

<syntaxhighlight lang="nasal">
var waypoint = {};
</syntaxhighlight>

Next, we are going to add some fields to our new variable "container". Each new field can be assigned an initial value, this is done by treating the field as a value/key pair, with a colon (:) separating both. And with multiple fields being separated by a comma (formatting only added for clarity):

<syntaxhighlight lang="nasal">
# declare a new hash named waypoint
var waypoint = {
# add a few fields and assign a value to each field:
number:0,
altitude:0,
distance:0,
angle:0,
length:0,
ID:0,
bearing:0
};
</syntaxhighlight>

which is equivalent to this, more succinct, version:
<syntaxhighlight lang="nasal">
var waypoint = {number:0,altitude:0,distance:0,angle:0,length:0,ID:0,bearing:0};
</syntaxhighlight>

This is already equivalent to our first example that used a vector to store this waypoint info, the only difference is here that we assign symbolic names (like number, altitude, distance etc) to each field, rather than just a numeric index, as was the case in the vector example.

This adds the following "member fields" to the waypoint hash and sets their initial value to 0:
* number
* altitude
* distance
* angle
* length
* ID
* bearing

Now, to access any of these fields, we would use the "dot notation" by first specifying the name of the enclosing context (which is just a fancy word for the name of the hash) and the name of the field we are interested in. You could read this as LOCATION.FIELD (i.e. get FIELD out of location).

<syntaxhighlight lang="nasal">
var waypoint = {number:0,altitude:0,distance:0,angle:0,length:0,ID:0,bearing:0};
print ( waypoint.number );
print ( waypoint.altitude );
print ( waypoint.distance );
print ( waypoint.angle );
print ( waypoint.length );
print ( waypoint.ID );
print ( waypoint.bearing );
</syntaxhighlight>

So, the hash represents the surrounding environment (i.e. context or "namespace") in which these symbols are valid. For more information on namespaces, please see [[Namespaces and Methods]].

Now, to make this is a little more interesting and to show what's happening, we are going to change the value of each field:

<syntaxhighlight lang="nasal">
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
print ( waypoint.number ); # prints 1
print ( waypoint.altitude ); # prints 2
print ( waypoint.distance ); # prints 3
print ( waypoint.angle ); # prints 4
print ( waypoint.length ); # 5
print ( waypoint.ID ); #6
print ( waypoint.bearing ); #7
</syntaxhighlight>

So, you could obviously create several different versions of this hash to store your waypoint data:

<syntaxhighlight lang="nasal">
var waypoint1 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint2 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint3 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint4 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint5 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
</syntaxhighlight>

This is already a pretty cool thing because you would end up with 5 different containers all having their own set of fields, that you can access and set arbitrarily - without affecting the other containers.

But the cool thing comes next:

As you may have noticed, the code (internal structure of fields) for each waypoint is 100% identical - so we could just as well tell the Nasal engine to use an existing hash as a TEMPLATE for a new object instead of having to replicate the hash over and over again. This is accomplished using the "parents" keyword:

<syntaxhighlight lang="nasal">
var Position3D = {x:1.00, y:2.00, z:3.00};
var p1 = { parents: [Position3D] };
var p2 = { parents: [Position3D] };
var p3 = { parents: [Position3D] };
</syntaxhighlight>

This creates three different new containers/hashes by copying the fields from the hash specified in the parents' vector.

What parents will do is this: whenever a hash contains a vector field named "parents:" pointing to other hashes, it will look up the parent hashes and use them as a template and copy the fields of the parent hashes to the new hash, i.e. less typing for you!

This means, that the previously posted code could be easily abbreviated and written like this:

<syntaxhighlight lang="nasal">
var waypoint1 = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var waypoint2 = {parents:[waypoint1] };
var waypoint3 = {parents:[waypoint1] };
var waypoint4 = {parents:[waypoint1] };
var waypoint5 = {parents:[waypoint1] };
</syntaxhighlight>

You could even introduce a new helper function to create new objects, let's call it new_waypoint:

<syntaxhighlight lang="nasal">
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var new_waypoint = func() {
return { parents:[waypoint] };
}

var waypoint1 = new_waypoint();
var waypoint2 = new_waypoint();
var waypoint3 = new_waypoint();
var waypoint4 = new_waypoint();
var waypoint5 = new_waypoint();
</syntaxhighlight>

or using a vector for each object, which has the added advantage that you can easily create arbitrary amounts of waypoints on demand:

<syntaxhighlight lang="nasal">
# this is our template for new waypoints
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};

# this is our allocator function creating new waypoints
var new_waypoint = func {return {parents:[waypoint] };}

var waypoints = [nil,nil,nil,nil,nil]; # initialize the vector to set its size

# populate the waypoints vector by allocating one new waypoint per "slot"
waypoints[0] = new_waypoint();
waypoints[1] = new_waypoint();
waypoints[2] = new_waypoint();
waypoints[3] = new_waypoint();
waypoints[4] = new_waypoint();
</syntaxhighlight>

A shorter version would read:

<syntaxhighlight lang="nasal">
var waypoint = {number:1,altitude:2,distance:3,angle:4,length:5,ID:6,bearing:7};
var new_waypoint = func {return {parents:[waypoint] };}

var NUM_ELEMENTS = 5;
var waypoints = [];
setsize(waypoints, NUM_ELEMENTS);

forindex(var i; waypoints)
waypoints[i] = new_waypoint();
</syntaxhighlight>

Once we start using a hash as a template for other hashes using the "parents" vector, we are creating a class that is copied to each new hash. This new copy of the class is called an "object" after creation.

A "class" is just a template for a certain data type that consists of other data types and provides functions to work with the class. The functions publicly accessible are called its "interface" because these functions are meant to be used by the users of your class. This is in contrast to member fields which are usually not meant to be accessed directly.

Once a class is used as a template to create a new object, we say the class is getting "instantiated", i.e. an instance of the class (an actual object) is created. This makes it then possible to make use of its interface and access member functions (which are methods). Also see {{forum link|p=145769}}.

Now, given that the creation of new hashes using a template class is such a common thing to do - we could just as well add a new function to the parent hash that we can use to construct new hashes. As you could see already, the fields (or members) of a hash are specified in a well-defined form using the key/value format where key and value are separated by a colon: "field_name: value".

<syntaxhighlight lang="nasal">
var waypoint1 = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7
};
</syntaxhighlight>

This isn't any different for fields that are of type "function":

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,

hello: func {
print("Hello");
}
};
</syntaxhighlight>

Note that we have added a new field named "hello" to our waypoint hash. This can be easily accessed and also called:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
hello: func {
print("Hello");
}
};

var w = {parents: [waypoint]};
w.hello();
</syntaxhighlight>

On the other hand, we were just about to make the construction of such hashes much simpler. This can be done by creating a new function that constructs hashes dynamically using a hash:

<syntaxhighlight lang="nasal">
var make_waypoint = func {
return { parents:[waypoint] };
}
</syntaxhighlight>

Next, we are going to change the function and and embed it into the hash, so that the constructor function becomes a part of the class, renaming it to "new":

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func {
return {parents:[waypoint]}
}
};
</syntaxhighlight>

So, whenever we need a new hash object of type "waypoint", we can simply call this construction function (which we'll call a constructor from now on):

<syntaxhighlight lang="nasal">
var wp = waypoint.new();
</syntaxhighlight>

This is what most Nasal code using OOP will typically look like.

== Hashes and foreach (enumerating a hash) ==

To iterate through all elements in a "hash the keys(hash) method" is used to produce a vector of the keys for the hash.

<syntaxhighlight lang="nasal">
var namehash = {};
namehash["value1"]= 1;
namehash["value2"] =2;

foreach(var hash_key ; keys(namehash))
print(namehash[hash_key]);
</syntaxhighlight>

== A generic constructor ==

Sometimes, you'll work with classes that do not have any custom constructor functions - but you can easily create a generic constructor, too:

<syntaxhighlight lang="nasal">
var new = func(obj) {
return {parents:obj};
}
</syntaxhighlight>

As long as '''obj''' is a vector of hashes, it can be simply invoked like this:

<syntaxhighlight lang="nasal">
var p = new( [Position3D] );
</syntaxhighlight>

Now, once you remember that Nasal implicitly has an '''arg''' vector for its arguments, the whole thing can be simplified like this:

<syntaxhighlight lang="nasal">
var new = func {
return {parents:arg};
}

var Position3D = {x:0.0, y:0.0, z:0.0};

var p = new( Position3D );
</syntaxhighlight>

This will simply create a function named "new" which accepts an implicit list of arguments (in the implicit "args" vector). The function returns a hash whose parents field is set to the args vector, so this method could even be used for multiple inheritances. Note that the Position3D hash no longer has its constructor, it's just a simple hash in this case.

To make this look a little nicer, we can also rename the default argument vector (i.e. args) to something more informative, like "classes":

<syntaxhighlight lang="nasal">
var new = func(classes...) {
return {parents:classes};
}

var Position3D = {x:0.0, y:0.0, z:0.0};

var p = new( Position3D );
</syntaxhighlight>

Using this approach, you could even make the "new operator" call custom constructors automatically for each created object.

You could even implement an overloaded function that creates arrays/vectors of objects.

A simple generic constructor can be expressed in a very succinct fashion:

<syntaxhighlight lang="nasal">
# a new function with an implicit arg parameter that simply returns a new hash with the parents' field set to all arguments provided
var new = func return { parents:arg };

var Position3D = {x:0.0, y:0.0, z:0.0};

var p = new( Position3D );
</syntaxhighlight>

Now, let's imagine you want to add another member function to print a certain field's value, such as "number".
Given that objects created from the same class template, there needs to be away for a method (class function) to refer to itself (its object), i.e. to refer to the object itself, otherwise, the function wouldn't know what object is meant, and what object it is referring to.

This can be accomplished using the "me" keyword which ensures that the member function is always referring to the currently active object (itself):

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func {
return {parents:[waypoint]};
},
show_number: func {
print(me.number);
}
};
</syntaxhighlight>

Note how we are just prepending the "me" keyword to the object's field, making it clear that "me" is the requested namespace/context of the field to be retrieved.

On the other hand, maybe you'd like to add some information (such as the number) during construction time to the object. So this would require changing the constructor function to accept a parameter, too:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
return {parents:[waypoint]};
},
show_number: func {
print(me.number);
}
};
</syntaxhighlight>

Note how the new function has been changed to accept a parameter named "n".

Now, to actually set the number field during construction time to the value of n, you could create a temporary hash:

<syntaxhighlight lang="nasal">
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
}
</syntaxhighlight>

Or in its entirety:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
},
show_number: func {
print(me.number);
}
};
</syntaxhighlight>

Now, back to your initial example regarding a list of waypoints:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
},
};

var waypoints = [waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new() ];
</syntaxhighlight>

Note how this creates a vector of 5 waypoints (0..4), each of these waypoints is a full object that can be conveniently accessed:

<syntaxhighlight lang="nasal">
waypoints[0].bearing = 100;
waypoints[1].altitude = 100;
waypoints[2].ID = "none";
</syntaxhighlight>

You can also use Nasal's support for looping to conveniently process these waypoints:

<syntaxhighlight lang="nasal">
var waypoint = {
number:1,
altitude:2,
distance:3,
angle:4,
length:5,
ID:6,
bearing:7,
new: func(n) {
var t={parents:[waypoint]};
t.number = n;
return t;
},
dump: func {
print("Altitude:", me.altitude, " distance:", me.distance, " Bearing:", me.bearing);
}
};

var waypoints = [waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new(), waypoint.new(), ];

foreach(var w; waypoints) {
w.dump();
}

</syntaxhighlight>

As you may remember, the parents' keyword points not just to a single "class template" (hash), but instead to a vector of hashes. This makes it possible to use several different hashes as the template for a new hash:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};

var propulsion = {horse_power:0};
var vehicle = {tyres:0};

# create different propulsion classes:
var engine = new(propulsion);
var piston_engine = new (engine);
var turboprop_engine = new(engine);
var jet_engine = new(engine);

var car = new(vehicle, propulsion);
var boat = new(vehicle, propulsion);
var airplane = new(vehicle, propulsion);

# seaplane is a new type of vehicle that inherits from the classes boat and aeroplane
var seaplane = new(boat, airplane);
</syntaxhighlight>

There are two important concepts to keep in mind here: The relationship between classes is classified according to an "IS A" and "HAS A" pattern:

* a car "IS A" vehicle
* an aeroplane "IS A" vehicle
* an elephant "IS AN" animal

* a car "HAS AN" engine (0..x)
* an airplane "HAS AN" engine (0..x)
* an elephant "HAS" ears

The difference when dealing with these relationships is that whenever something "IS" something, the right thing to do is to directly create a new object using the parent class:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};
var animal = {eyes:0,ears:0};

var dog = new(animal);
var cat = new(animal);
var bird = new(animal);
var spider = new(animal);
</syntaxhighlight>

Now, imagine we wanted to keep the number of legs for each animal, too: 4 legs for dogs and cats, 2 legs for birds and 8 legs for spiders:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};
var animal = {eyes:0,ears:0,legs:0};

var dog = new(animal);
var cat = new(animal);
var bird = new(animal);
var spider = new(animal);
</syntaxhighlight>

However, at some point we may need additional information for each leg - such as the length of each leg. That's where we use a new "leg" class (an animal HAS legs), so that the animal class no longer just contains the number of legs, but rather contains a vector of "leg" objects:

<syntaxhighlight lang="nasal">
var new = func return {parents:arg};
var leg = {length:0};
var animal = {eyes:0,ears:0,legs:[] };

var dog = new(animal);
var cat = new(animal);
var bird = new(animal);
var spider = new(animal);
</syntaxhighlight>

This was a very simple introduction to object-oriented programming in Nasal.

[[Category: Nasal howto|Module, Create a new Nasal]]

User talk:Scttgs

2020-06-14T10:12:50Z

Chillz: Created page with "Great work on the World Scenery 3.0 roadmap article! --~~~~"

Great work on the [[World Scenery 3.0 roadmap]] article! --[[User:Chillz|Chillz]] ([[User talk:Chillz|talk]]) 06:12, 14 June 2020 (EDT)

User:Chillz

2020-06-14T10:11:32Z

Chillz: Created page with "'''Chillz''' is a NEW editor on the FlightGear wiki. Need help or assistance with anything? Leave her a note on her talk page!"

'''Chillz''' is a NEW editor on the FlightGear wiki. Need help or assistance with anything? Leave her a note on her [[User talk:Chillz|talk page]]!