diff --git a/docs/Components/Auxiliary/Payload.md b/docs/Components/Auxiliary/Payload.md new file mode 100644 index 0000000..23b5926 --- /dev/null +++ b/docs/Components/Auxiliary/Payload.md @@ -0,0 +1,23 @@ +# Payload + +Payload is a class created to act as a variable-mass container. Currently it is simple an AttachedComponent with the type 'payload'. + +## Instantiation +To instantiate a Payload one can pass the same arguments used to instantiate an AttachedComponent: + +``` python +import math +from vec import Vector2 + +from adr.Components.Auxiliary import Payload + +main_payload = Payload( + name='main_payload', + mass=9.2, + relative_position=Vector2(-0.2, 0), + relative_angle=math.radians(0) +) + +print(main_payload.type) +>>> payload +``` diff --git a/mkdocs.yml b/mkdocs.yml index e666197..4fb564e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ nav: AttachedComponent: Components/AttachedComponent.md Auxiliary: LandingGear: Components/Auxiliary/LandingGear.md + Payload: Components/Auxiliary/Payload.md World: Ambient: World/Ambient.md constants: World/constants.md diff --git a/tests/Components/Auxiliary/test_Payload.py b/tests/Components/Auxiliary/test_Payload.py new file mode 100644 index 0000000..5b6c40f --- /dev/null +++ b/tests/Components/Auxiliary/test_Payload.py @@ -0,0 +1,20 @@ +import pytest +import math +from vec import Vector2 + +from adr.Components.Auxiliary import Payload + + +@pytest.fixture +def main_payload(): + main_payload = Payload( + name='main_payload', + mass=9.2, + relative_position=Vector2(-0.2, 0), + relative_angle=math.radians(0) + ) + return main_payload + + +def test_instantiation(main_payload): + assert(main_payload.type == 'payload')