|
|
|
## +gui package
|
|
|
|
# ARTOA4 Packages
|
|
|
|
|
|
|
|
The gui package contains all definitions of the graphical user interface of ARTOA4. It writes all handles that can be controlled to the [artoaGui](./ARTOA4-memory-data-format-specification/artoaGui) variable.
|
|
|
|
The idea behind packages is to create more structured code and separate responsibilities. All packages have their individual purpose and are usually loosely coupled. Some of them use each other for calculations etc. though.
|
|
|
|
|
|
|
|
## +controller package
|
|
|
|
Except for controller and gui package, all packages can be used without the access of the global variables artoaWorkspace, artoaGui and artoaDataInput.
|
|
|
|
|
|
|
|
The controller package is the connector between the gui and the rest of the packages. The controller is the only package that reads and writes to all four global variables namely [artoaGui](./ARTOA4-memory-data-format-specification/artoaGui), [artoaWorkspace](./ARTOA3-memory-data-format-specification/artoaWorkspace), [artoaInputData](./ARTOA4-memory-data-format-specification/artoaInputData) and [artoaOutputData](./ARTOA4-memory-data-format-specification/artoaOutputData).
|
|
|
|
## Package "artoa"
|
|
|
|
|
|
|
|
The artoa package is the base of all other packages. This is to make sure the right functions are used in the right context.
|
|
|
|
|
|
|
|
## Package "controller"
|
|
|
|
|
|
|
|
The controller package is the connector between the gui and the rest of the packages. The controller is the only package that reads and writes to all four global variables namely [artoaGui](./ARTOA4-memory-data-format-specification/artoaGui), [artoaWorkspace](./ARTOA3-memory-data-format-specification/artoaWorkspace) and [artoaDataInput](./ARTOA4-memory-data-format-specification/artoaDataInput).
|
|
|
|
|
|
|
|
It is responsible for syncronizing the gui with the underlying model/data.
|
|
|
|
|
|
|
|
## Package "convert"
|
|
|
|
|
|
|
|
The conversion package contains functions that are being used to convert data into other types of data. For example a rafos date into day, month and year.
|
|
|
|
|
|
|
|
## Package "data"
|
|
|
|
|
|
|
|
This package is a generic package that deals with calculations or adjustments to data.
|
|
|
|
|
|
|
|
## Package "drift"
|
|
|
|
|
|
|
|
In this package, there are functions stored that belong to drift calculation etc.
|
|
|
|
|
|
|
|
## Package "float"
|
|
|
|
|
|
|
|
This package contains float specific functions.
|
|
|
|
|
|
|
|
## Package "gui"
|
|
|
|
|
|
|
|
All windows that are used in ARTOA4 are stored in this package. It contains only the definitions of the figures. To make them usable it is required to use functions from the controller package for example.
|
|
|
|
|
|
|
|
## Package "load"
|
|
|
|
|
|
|
|
Contains functions that deal with parsing/loading data from the file system.
|
|
|
|
|
|
|
|
## Package "offsets"
|
|
|
|
|
|
|
|
Calculations of the offsets and handling of the data format is stored in this package.
|
|
|
|
|
|
|
|
## Package "save"
|
|
|
|
|
|
|
|
Same as the load package, but for saving.
|
|
|
|
|
|
|
|
## Package "soundsources"
|
|
|
|
|
|
|
|
Functions that are about handling the soundsoure data, for example the colorregister functions are stored here.
|
|
|
|
|
|
|
|
## Package "toa"
|
|
|
|
|
|
|
|
Calculations about the TOAs are being placed here.
|
|
|
|
|
|
|
|
## Package "trajectory"
|
|
|
|
|
|
|
|
This package is all about calculation of trajectories as well as plot functions.
|
|
|
|
|
|
|
|
## Package "vendor"
|
|
|
|
|
|
|
|
This package contains includes third party packages or functions. |