Basic Markdown Documentation of Android Casting Structure #174
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Markdown Documentation describing the main casting functionality within OpenAthena Android
mkrupczak3
requested changes
Oct 11, 2024
| @@ -0,0 +1,105 @@ | |||
| # OpenAthena Android Core Functionality | |||
| Core Casting Functionality within OA Android is defined by 3 main classes: MetaDataExtractor, DEMParser, and TargetGetter. | |||
| These classes are managed by the AthenaApp and MainActivity classes. | |||
There was a problem hiding this comment.
The association here presents a bit of a false equivalency. AthenaApp is a singleton for managing persistent app state, while MainActivity, DEM Activity, FullscreenSelectionActivity, etc. extend the AthenaActivity abstract class. AthenaActivity manages the behavior of subclasses much more than AthenaApp
| + minArcAngle() | ||
| + radNormalize() | ||
| + degNormalize() | ||
| + azumuthToUnitCircle() |
|
|
||
| ``` | ||
| ### MainActivity and AthenaApp | ||
| These main components are managed by the MainActivity and AthenaApp classes. MainActivity can be considered the entry point for all major actions within OpenAthena. Metadata extraction, DEM management, and target acquisition all take place within MainActivity. Activities may not be persistent across the life of the application, so AthenaApp is used to hold all state information persistently across activities. It is for this reason that both TargetGetter and AthenaApp contain a DEMParser object, with the persistent object being passed to TargetGetter as necessary. These classes do not contribute to the actual casting functionality, but manage the casting functionality within Android. |
There was a problem hiding this comment.
And AthenaActivity abstract class and its static variables
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Basic markdown file containing class diagrams and descriptions for the core casting engine within OpenAthena Android.