Skip to content

Commit

Permalink
Changed old firesat references to new examples in mission model template
Browse files Browse the repository at this point in the history
  • Loading branch information
ewferg committed Mar 3, 2024
1 parent a14896e commit 8df5927
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/mission-modeling/activity-types/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ An **activity type** defines a simulated behavior that may be invoked by a plann
Activity types may define **parameters**, which are filled with **arguments** by a planner and provided to the activity upon execution.
Activity types may also define **validations** for the purpose of informing a planner when the parameters they have provided may be problematic.

For example, here is a simple activity type from the FireSat template mission model:
For example, here is a simple activity type from the examples in the template mission model:

<RemoteCodeBlock
language="java"
showLineNumbers
title="Aerie Mission Model Template (FireSat) - GncChangeControlMode.java"
url="https://raw.githubusercontent.com/NASA-AMMOS/aerie-mission-model-template/main/src/main/java/firesat/activities/gnc/GncChangeControlMode.java"
title="Aerie Mission Model Template - CollectData.java"
url="https://raw.githubusercontent.com/NASA-AMMOS/aerie-mission-model-template/main/examples/CollectData.java"
></RemoteCodeBlock>

Aerie automatically generates parameter serialization boilerplate for every activity type defined in the mission model's [package-info.java](../introduction.mdx#the-package-infojava-file).
Expand All @@ -23,7 +23,7 @@ Moreover, the generated Model base class provides helper methods for spawning ea
In order for Aerie to detect an activity type, its class must be annotated with the `@ActivityType` tag. An activity type is declared with its name using the following annotation:

```java
@ActivityType("GncChangeControlMode")
@ActivityType("CollectData")
```

By doing so, the Aerie annotation processor can discover all activity types declared in the mission model, and validate that activity type names are unique.
Expand Down
4 changes: 2 additions & 2 deletions docs/mission-modeling/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A mission model must contain a [package-info.java](https://www.baeldung.com/java
<RemoteCodeBlock
language="java"
showLineNumbers
title="Aerie Mission Model Template (FireSat) - package-info.java"
title="Aerie Mission Model Template - package-info.java"
url="https://raw.githubusercontent.com/NASA-AMMOS/aerie-mission-model-template/main/src/main/java/missionmodel/package-info.java"
></RemoteCodeBlock>

Expand All @@ -35,7 +35,7 @@ The top-level model is received by activities, however, so it must make accessib
<RemoteCodeBlock
language="java"
showLineNumbers
title="Aerie Mission Model Template (FireSat) - Mission.java"
title="Aerie Mission Model Template - Mission.java"
url="https://raw.githubusercontent.com/NASA-AMMOS/aerie-mission-model-template/main/src/main/java/missionmodel/Mission.java"
></RemoteCodeBlock>

Expand Down

0 comments on commit 8df5927

Please sign in to comment.