Skip to content

Science/smear_cylinder_sampling.tl

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
# ==================================
#     Generated by TethysL (do not edit)
#     ==================================
# Copyright (c) 2024 MBARI
#     MBARI Proprietary Information. Confidential. All Rights Reserved
#     Unauthorized copying or distribution of this file via any medium is strictly
#     prohibited.

# WARNING - This file contains information whose export is restricted by the
#     Export Administration Act of 1979 (Title 50, U.S.C., App. 2401 et seq.), as
#     amended. Violations of these export laws are subject to severe civil and/or
#     criminal penalties.
mission smear_cylinder_sampling {
  arguments {
    # Almost every mission should start with an overall timeout and a NeedCommsTime. Drift Missions will have an acoustic timeout instead of a NeedCommsTime.

    # You probably need to change these.

    NumSamplers = 1 count
      """
      Total number of ESP cartridges (Maximum 60) or CANON samplers. Set to 0
      to disable sampling.
      """

    # debug
    #     </Description><Units:count/><Value>3</Value></DefineArg>

    StartIndex = 1 count
      """
      Start index in ESP settings. If re-running mission, can skip settings of
      already-completed samples. Default is 1 (no skipping).
      """

    # debug
    #     </Description><Units:count/><Value>2</Value></DefineArg>

    CANONSamplerRotateOnly = 0 bool

    MissionTimeout = 2 hour
      """
      Maximum duration of mission
      """

    SurfaceCommsEndOfEachSample = true
      """
      Whether to go to surface for comms at completion of each sample
      (initialized to True.)
      """

    # debug
    #     </Description><False/></DefineArg>

    NeedCommsTimeInTransit = 30 minute
      """
      On the way transiting to the sampling location, how often to surface for
      commumications
      """

    BeingInterrogatedTimeout = 21 hour
      """
      If the vehicle does not receive an acoustic signal for more than this
      length of time, it will surface for communications. Set longer than
      MissionTimeout to effectively disable.
      """

    TrackAcousticTarget = false
      """
      Whether to track an acoustic target.
      """

    # debug
    #     </Description><True/></DefineArg>

    AcousticTargetContactLabel = 0 count
      """
      The acoustic address of the asset to be tracked
      """

    AcousticTargetDepth = NaN meter
      """
      Depth of acoustic target if known and fixed (or nearly fixed). For
      example, if the acoustic target is a Wave Glider, set it to zero. This
      will improve 2D projected position estimates in the Earth reference
      frame. Defaults to NaN.
      """

    AcousticTargetContactTimeout = 15 minute
      """
      Only use a sufficiently fresh handshake to update the tracking center.
      """

    MaxWaitNoFiring = 2 hour
      """
      If no firing after more than MaxWaitNoFiring, terminate mission.
      """

    # debug
    #     </Description><Units:hour/><Value>0.05</Value></DefineArg>

    SpeedTransit = 1.0 meter_per_second
      """
      Vehicle speed when transiting to the sampling location.
      """

    SpeedSampling = 1.0 meter_per_second
      """
      Vehicle speed when sampling on cylinder yoyo.
      """

    MaxDepth = 50 meter
      """
      Maximum depth for the entire mission.
      """

    TransitYoYoMinDepth = 3 meter
      """
      Minimum yoyo depth while transiting to the sampling location.
      """

    TransitYoYoMaxDepth = 30 meter
      """
      Maximum yoyo depth while transiting to the sampling location.
      """

    TransitCaptureRadius = 100 meter
      """
      Waypoint capture radius for transiting to the sampling location.
      """

    CylinderRadius = 20 meter
      """
      Radius of cylinder centered at the sampling location.
      """

    MaxCirclesOnCylinder = 1000 count
      """
      Maximum number of circles on cylinder.
      """

    TransitLatitude = NaN degree
      """
      The latitude of the sampling location. If NaN, will skip transit.
      """

    # debug
    #     </Description><Units:degree/><Value>36.80</Value></DefineArg>

    TransitLongitude = NaN degree
      """
      The longitude of the sampling location. If NaN, will skip transit.
      """

    # debug
    #     </Description><Units:degree/><Value>-121.82</Value></DefineArg>

    CenterLatitude = NaN degree
      """
      The latitude of the center of the circle. Fill this in to specify a
      start position, it will be overwritten once the vehicle receives an
      acoustic signal from the contact.
      """

    # debug
    #     </Description><Units:degree/><Value>36.80</Value></DefineArg>

    CenterLongitude = NaN degree
      """
      The longitude of the center of the circle. Fill this in to specify a
      start position, it will be overwritten once the vehicle receives an
      acoustic signal from the contact.
      """

    # debug
    #     </Description><Units:degree/><Value>-121.82</Value></DefineArg>

    CartridgeTypeCommon = -6 count
      """
      Value common to all samples unless set diffently: cartridge type.
      """

    CartridgeType[1..60] = -6 count
      """
      Sample {$}. Cartridge type.
      """

    ShallowBoundSmearCommon = 3 meter
      """
      Value common to all samples unless set diffently: shallow depth bound
      for smear sampling.
      """

    ShallowBoundSmear[1..60] = NaN meter
      """
      Shallow depth bound for smear sampling. Sample {$}.
      """

    DeepBoundSmearCommon = 30 meter
      """
      Value common to all samples unless set diffently: deep depth bound for
      smear sampling.
      """

    DeepBoundSmear[1..60] = NaN meter
      """
      Deep depth bound for smear sampling. Sample {$}.
      """

    WaitCommonBeforeFiring = 5.0 minute
      """
      Value common to all samples unless set diffently: Wait time before
      firing.
      """

    WaitCommonAfterFiring = 5.0 minute
      """
      Value common to all samples unless set diffently: Wait time after
      firing.
      """

    WaitBeforeFiring[1..60] = NaN minute
      """
      Wait time before firing. Sample {$}.
      """

    WaitAfterFiring[1..60] = NaN minute
      """
      Wait time after firing. Sample {$}.
      """

    # Use caution when changing these.

    YoYoMinAltitude = 9 meter
      """
      Minimum altitude while performing the YoYo behavior (for
      bottom-terminated YoYos).
      """

    MinAltitude = 7 meter
      """
      Minimum altitude for the entire mission.
      """

    MinOffshore = 2 kilometer
      """
      Minimum offshore distance for the entire mission.
      """

    # You probably do not need to change these.

    UseCANONSampler = Science:CANONSampler.loadAtStartup
      """
      Whether to use CANON Sampler to sample.
      """

    UseESP = Science:ESPComponent.loadAtStartup
      """
      Whether to use ESP to sample.
      """

    CANONSamplerTriggerTimeout = 3 minute
      """
      How long to wait for a CANON Sampler sample to start.
      """

    CANONSamplerTimeout = Science:CANONSampler.sampleTimeout
      """
      How long to wait for a CANON Sampler sample to complete.
      """

    TrackingUpdatePeriod = 15 second
      """
      How long to wait between acoustic queries
      """

    NumberOfPings = 1 count
      """
      Number of return pings to request with each acoustic query (more than 1
      will activate oneway mode)
      """

    NumberOfFixesLowPass = 4 count
      """
      Number of fixes to average to produce smoothed lat/lon/dep output
      (initialized to 4).
      """

    NumberOfStartingFixesToIgnore = 8 count
      """
      Number of fixes to ignore at the start of mission (as the vehicle just
      leaves surface, contact's location estimate especailly bearing can be
      erroneous. Initialized to 8, corresponding to 2 minutes if query
      interval TrackingUpdatePeriod = 15 s.
      """

    CylinderCircleMaxError = 100 meter
      """
      If this distance away from the circle, drive straight towards (or away
      from the center). Otherwise, try to reduce distance from the ideal
      circle.
      """

    CylinderCircleTurnToPort = false
      """
      If true, vehicle turns to the left around the center point. If false,
      vehicle turns to the right.
      """

    KwpHeading = 0.010 radian_per_meter
      """
      Used to relax waypoint cross-track error constant that is adjusted for
      docking. (You can override this setting by passing an argument.)
      """

    YoYoUpPitch = 20 degree
      """
      Vehicle up pitch while performing the YoYo behavior.
      """

    YoYoDownPitch = -20 degree
      """
      Vehicle down pitch while performing the YoYo behavior.
      """

    BuoyancyNeutral = Control:VerticalControl.buoyancyNeutral
      """
      Buoyancy bladder position while performing the YoYo behavior. Defaults
      to buoyancyNeutral setting in the Config/Control.cfg file. Set to NaN cc
      for active buoyancy
      """

    MassDefault = Control:VerticalControl.massDefault
      """
      Static setting for mass during the mission. Set to NaN mm for active
      mass position
      """

    # Internal variables that you should not change

    NeedCommsTimeVeryLong = 100 hour
      """
      How often to surface for commumications during sampling. Huge number to
      disable needcomms.
      """
  }

  output {
    ShallowBoundSmearIndividual = NaN meter
      """
      YoYoMinDepth individual.
      """

    DeepBoundSmearIndividual = NaN meter
      """
      YoYoMaxDepth individual.
      """

    WaitIndividualBeforeFiring = NaN minute
      """
      Wait before firing for each individual sample.
      """

    WaitIndividualAfterFiring = NaN minute
      """
      Wait after firing for each individual sample.
      """

    CartridgeTypeIndividual = NaN count
      """
      Cartridge type individual.
      """

    CartridgeTypeSet = -6 count
      """
      Cartridge type. Initialized to -6.
      """

    ElapsedSinceStartOrLastSample = 0 hour
      """
      The mission sets this variable to reset the ESP sample timer.
      """

    ElapsedSinceLastCenterUpdate = 0 hour
      """
      The mission sets this variable to reset the center update timer.
      """

    ElapsedTime = 0 hour
      """
      Only for syslog.
      """

    ContactLatitudeLowpass = NaN degree
      """
      Low-pass filtered latitude of contact (initialized to NaN).
      """

    ContactLongitudeLowpass = NaN degree
      """
      Low-pass filtered longitude of contact (initialized to NaN).
      """

    YoYoMinDepth = 1.5 meter
      """
      Minimum depth while performing the YoYo behavior. Program will overwrite
      for each sampler, e.g., ShallowBoundSmear1.
      """

    YoYoMaxDepth = 20 meter
      """
      Maximum depth while performing the YoYo behavior. Program will overwrite
      for each sampler, e.g., DeepBoundSmear1
      """

    WaitDurationBeforeFiring = 5.0 minute
      """
      Wait time before firing a sample. Program will set for each sampler,
      e.g., WaitBeforeFiring1.
      """

    WaitDurationAfterFiring = 5.0 minute
      """
      Wait time after firing a sample. Program will set for each sampler,
      e.g., WaitAfterFiring1.
      """

    CommsEndOfSampleCompleted = false
      """
      End-of-sample comms completed. Initialized to False.
      """

    StoppedForNoFiringForTooLong = false
      """
      Mission stopped because of no firing for too long. Initialized to false.
      """

    DepthLogged = 0.0 meter

    TempLogged = 0.0 celsius

    ChlLogged = 0.0 microgram_per_liter

    MissionStartCommsCompleted = false
      """
      MissionStartComms is completed (initialized to false).
      """

    TransitCompleted = false
      """
      Transit is completed (initialized to False).
      """

    FlagSamplingOngoing = false
      """
      Flag of water sampling in process (initialized to false).
      """

    SampleCompleted = false
      """
      Sampling completed. Initialized to false.
      """

    SampleOptionsSet = false
      """
      Sample options (DepDiffFromPeakChl, ReportAtSurface, ReacquirePeak)
      already set. Initialized to false.
      """

    CntSamples = 1 count
      """
      Count of water samples (initilized to 1).
      """
  }

  # Missions should almost always start with a timeout and a NeedComms aggregate. Drift missions will not use NeedComms.

  timeout duration=MissionTimeout

  insert id="NeedComms" Insert/NeedComms.tl

  insert Insert/Science.tl

  assign in sequence NeedComms:DiveInterval = NeedCommsTimeVeryLong

  # Missions should almost always start with standard safety envelopes

  insert Insert/StandardEnvelopes.tl

  assign in sequence StandardEnvelopes:MinAltitude = MinAltitude

  assign in sequence StandardEnvelopes:MaxDepth = MaxDepth

  assign in sequence StandardEnvelopes:MinOffshore = MinOffshore

  behavior Sample:AbortSample {
    run in parallel
  }

  insert Insert/AbortDrift.tl {
    redefineArg AcousticTimeout = BeingInterrogatedTimeout
  }

  # Many missions will keep mass position fixed at the default.

  behavior Guidance:Pitch {
    run in parallel

    set massPosition = MassDefault
  }

  behavior Guidance:Buoyancy {
    run in parallel

    set position = BuoyancyNeutral
  }

  behavior Guidance:AltitudeEnvelope {
    """
    Another altitude envelope for the YoYo behavior. This envelope
    should fall within the limits of the standard safety envelopes in
    Insert/StandardEnvelopes.tl in order to avoid commanding high pitch
    angles for bottom-terminated YoYos.
    """

    run in parallel

    set minAltitude = YoYoMinAltitude
  }

  aggregate TrackingAcousticTarget {
    run while ( TrackAcousticTarget )

    behavior Estimation:Tracking {
      run in parallel

      set contactLabelSetting = AcousticTargetContactLabel
      set numberOfSamplesSetting = NumberOfPings
      set updatePeriodSetting = TrackingUpdatePeriod
      set numFixesLowPassSetting = NumberOfFixesLowPass
      set numStartingFixesToIgnoreSetting = NumberOfStartingFixesToIgnore
      set contactDepthSetting = AcousticTargetDepth
    }
  }

  aggregate TriggerSampling {
    run when ( called )

    aggregate TriggerESP {
      run in sequence

      break if ( not ( UseESP ) )

      assign in sequence DepthLogged = Universal:depth

      assign in sequence TempLogged = Universal:sea_water_temperature

      assign in sequence ChlLogged = Universal:mass_concentration_of_chlorophyll_in_sea_water

      syslog important "Trigger ESP sampling. DepthLogged, TempLogged, ChlLogged = "
           + DepthLogged~meter + ", " + TempLogged~celsius + ", " + ChlLogged~microgram_per_liter + "."

      behavior Science:ESPCartridgeSelect {
        run in sequence

        timeout duration=P1M

        set cartridgeType = CartridgeTypeSet
      }

      readDatum {
        Science:ESPComponent.sampling
      }

      syslog important "Wait for ESP sampling to complete."

      readDatum {
        Science:ESPComponent.sample_number
      }
    }

    aggregate TriggerCANON {
      run in sequence

      break if ( not ( UseCANONSampler ) )

      assign in sequence DepthLogged = Universal:depth

      assign in sequence TempLogged = Universal:sea_water_temperature

      assign in sequence ChlLogged = Universal:mass_concentration_of_chlorophyll_in_sea_water

      syslog important "Trigger CANON sampling. DepthLogged, TempLogged, ChlLogged = "
           + DepthLogged~meter + ", " + TempLogged~celsius + ", " + ChlLogged~microgram_per_liter + "."

      assign in parallel Science:CANONSampler.sampleTimeout = CANONSamplerTimeout

      assign in parallel Science:CANONSampler.rotateOnly = CANONSamplerRotateOnly

      readDatum id="TriggerCANONSampler" {
        timeout duration=CANONSamplerTriggerTimeout {
          syslog important "Timed out triggering CANONSampler. Stopping mission."

          behavior Guidance:Execute {
            run in sequence

            set command = "stop"
          }
        }

        Science:CANONSampler.sampling
      }

      readDatum {
        timeout duration=CANONSamplerTimeout {
          syslog important "Timed out sampling with CANONSampler. Stopping mission."

          behavior Guidance:Execute {
            run in sequence

            set command = "stop"
          }
        }

        Science:CANONSampler.sample_number
      }
    }
  }

  aggregate InsertWaitBeforeFiring {
    run when ( called )

    syslog important "Wait " + WaitDurationBeforeFiring~minute + " before firing sample."

    behavior Guidance:Wait {
      run in sequence

      set duration = WaitDurationBeforeFiring
    }
  }

  aggregate InsertWaitAfterFiring {
    run when ( called )

    syslog important "Wait " + WaitDurationAfterFiring~minute + " after firing sample."

    behavior Guidance:Wait {
      run in sequence

      set duration = WaitDurationAfterFiring
    }
  }

  aggregate SetSampleOptions {
    run when ( called )

    aggregate SettingCartridgeTypeIndividual {
      run in sequence

      break if (
        isNaN ( CartridgeTypeIndividual )
        or ( not ( UseESP ) )
      )

      assign in sequence CartridgeTypeSet = CartridgeTypeIndividual
    }

    aggregate SettingCartridgeTypeCommon {
      run in sequence

      break if (
        not ( isNaN ( CartridgeTypeIndividual ) )
        or ( not ( UseESP ) )
      )

      assign in sequence CartridgeTypeSet = CartridgeTypeCommon
    }

    aggregate SettingYoYoMinDepthIndividual {
      run in sequence

      break if ( isNaN ( ShallowBoundSmearIndividual ) )

      assign in sequence YoYoMinDepth = ShallowBoundSmearIndividual
    }

    aggregate SettingYoYoMinDepthCommon {
      run in sequence

      break if (
        not ( isNaN ( ShallowBoundSmearIndividual ) )
      )

      assign in sequence YoYoMinDepth = ShallowBoundSmearCommon
    }

    aggregate SettingYoYoMaxDepthIndividual {
      run in sequence

      break if ( isNaN ( DeepBoundSmearIndividual ) )

      assign in sequence YoYoMaxDepth = DeepBoundSmearIndividual
    }

    aggregate SettingYoYoMaxDepthCommon {
      run in sequence

      break if (
        not ( isNaN ( DeepBoundSmearIndividual ) )
      )

      assign in sequence YoYoMaxDepth = DeepBoundSmearCommon
    }

    aggregate SettingWaitIndividualBeforeFiring {
      run in sequence

      break if (
        not ( WaitIndividualBeforeFiring >= 0 minute )
      )

      assign in sequence WaitDurationBeforeFiring = WaitIndividualBeforeFiring
    }

    aggregate SettingWaitCommonBeforeFiring {
      run in sequence

      break if ( WaitIndividualBeforeFiring >= 0 minute )

      assign in sequence WaitDurationBeforeFiring = WaitCommonBeforeFiring
    }

    aggregate SettingWaitIndividualAfterFiring {
      run in sequence

      break if (
        not ( WaitIndividualAfterFiring >= 0 minute )
      )

      assign in sequence WaitDurationAfterFiring = WaitIndividualAfterFiring
    }

    aggregate SettingWaitCommonAfterFiring {
      run in sequence

      break if ( WaitIndividualAfterFiring >= 0 minute )

      assign in sequence WaitDurationAfterFiring = WaitCommonAfterFiring
    }

    syslog important "Set CartridgeType (if ESP), YoYoMinDepth, YoYoMaxDepth, WaitDurationBeforeFiring, WaitDurationAfterFiring to "
         + CartridgeTypeSet~count + ", " + YoYoMinDepth~meter + ", " + YoYoMaxDepth~meter + ", "
         + WaitDurationBeforeFiring~minute + ", " + WaitDurationAfterFiring~minute + "."
  }

  aggregate Transit {
    run when ( called )

    aggregate TransitToSamplingLocation {
      run in sequence

      break if (
        isNaN ( TransitLatitude )
        or ( isNaN ( TransitLongitude ) )
      )

      assign in sequence NeedComms:DiveInterval = NeedCommsTimeInTransit

      behavior Guidance:SetSpeed {
        run in parallel

        set speed = SpeedTransit
      }

      behavior Guidance:DepthEnvelope {
        run in parallel

        set minDepth = TransitYoYoMinDepth
        set maxDepth = TransitYoYoMaxDepth
        set downPitch = YoYoDownPitch
        set upPitch = YoYoUpPitch
      }

      behavior Guidance:YoYo {
        run in parallel

        set downPitch = YoYoDownPitch
        set upPitch = YoYoUpPitch
      }

      behavior Guidance:Waypoint {
        run in sequence

        set latitude = TransitLatitude
        set longitude = TransitLongitude
        set captureRadius = TransitCaptureRadius
      }

      assign in sequence NeedComms:DiveInterval = NeedCommsTimeVeryLong

      assign in sequence ElapsedSinceStartOrLastSample = 0 hour

      assign in sequence TransitCompleted = true
    }

    aggregate NoTransit {
      run in sequence

      break if (
        not (
          isNaN ( TransitLatitude )
          or ( isNaN ( TransitLongitude ) )
        )
      )

      assign in sequence TransitCompleted = true
    }
  }

  aggregate MissionStart {
    run in sequence

    call id="MissionStartComms" refId="NeedComms"

    assign in sequence ElapsedSinceStartOrLastSample = 0 hour

    assign in sequence MissionStartCommsCompleted = true
  }

  call id="TransitSamplingLocation" refId="Transit"

  aggregate InitializeWithGPSlatlon {
    run when (
      isNaN ( CenterLatitude )
      or ( isNaN ( CenterLongitude ) )
    )

    assign in sequence CenterLatitude = Universal:latitude_fix

    assign in sequence CenterLongitude = Universal:longitude_fix

    syslog important "Initialize CenterLatitude and CenterLongitude to GPS fix: "
         + CenterLatitude~degree + ", " + CenterLongitude~degree + "."
  }

  aggregate UpdateCenter {
    run when (
      TrackAcousticTarget
      and ( elapsed ( Estimation:Tracking.range_to_contact ) < AcousticTargetContactTimeout )
    )

    assign in sequence ContactLatitudeLowpass = Estimation:Tracking.contact_latitude_lowpass

    assign in sequence ContactLongitudeLowpass = Estimation:Tracking.contact_longitude_lowpass

    # debug
    #               <Syslog Severity="Important">Overwrite or update. CenterLatitude, CenterLongitude, contact_latitude, contact_longitude, contact_latitude_lowpass, contact_longitude_lowpass = <Arg Name="CenterLatitude"/><Units:degree/>, <Arg Name="CenterLongitude"/><Units:degree/>, <Estimation:Tracking.contact_latitude/><Units:degree/>, <Estimation:Tracking.contact_longitude/><Units:degree/>, <Estimation:Tracking.contact_latitude_lowpass/><Units:degree/>, <Estimation:Tracking.contact_longitude_lowpass/><Units:degree/></Syslog>

    aggregate UpdateWithContactLowpassLatLon {
      run when (
        not ( isNaN ( ContactLatitudeLowpass ) )
        and ( not ( isNaN ( ContactLongitudeLowpass ) ) )
        and ( elapsed ( ElapsedSinceLastCenterUpdate ) >= TrackingUpdatePeriod )
      )

      assign in sequence CenterLatitude = ContactLatitudeLowpass

      assign in sequence CenterLongitude = ContactLongitudeLowpass

      assign in sequence ElapsedTime = elapsed ( ElapsedSinceLastCenterUpdate )

      syslog info "Updating. Elapsed time since last center update, CenterLatitude, CenterLongitude = "
           + ElapsedTime~second + ", " + CenterLatitude~degree + ", " + CenterLongitude~degree

      assign in sequence ElapsedSinceLastCenterUpdate = 0 hour
    }
  }

  aggregate Cylinder {
    run in sequence

    break if ( CntSamples == ( NumSamplers + 1 count ) )

    behavior Guidance:SetSpeed {
      run in parallel

      set speed = SpeedSampling
    }

    behavior Guidance:DepthEnvelope {
      run in parallel

      set minDepth = YoYoMinDepth
      set maxDepth = YoYoMaxDepth
      set downPitch = YoYoDownPitch
      set upPitch = YoYoUpPitch
    }

    behavior Guidance:YoYo {
      run in parallel

      set downPitch = YoYoDownPitch
      set upPitch = YoYoUpPitch
    }

    aggregate CylinderYoYo {
      run in sequence

      syslog important "Yoyo profile on a cylinder around location " + CenterLatitude~degree + ","
           + CenterLongitude~degree + ", at radius = " + CylinderRadius~meter + "."

      aggregate CylinderWrapper {
        run in sequence repeat=MaxCirclesOnCylinder

        assign in parallel Control:HorizontalControl.kwpHeading = KwpHeading

        behavior Guidance:Circle {
          run in sequence

          set latitude = CenterLatitude
          set longitude = CenterLongitude
          set radius = CylinderRadius
          set maxError = CylinderCircleMaxError
          set turnToPort = CylinderCircleTurnToPort
        }
      }
    }
  }

  aggregate TakeSamples {
    run in parallel

    break if ( CntSamples == ( NumSamplers + 1 count ) )

    aggregate NoFiringForTooLong {
      run when (
        TransitCompleted
        and ( elapsed ( ElapsedSinceStartOrLastSample ) > MaxWaitNoFiring )
        and ( not ( FlagSamplingOngoing ) )
        and ( not ( StoppedForNoFiringForTooLong ) )
      )

      assign in sequence ElapsedTime = elapsed ( ElapsedSinceStartOrLastSample )

      syslog important "No firing for too long. Stopping mission. Elapsed time since start or last sample, MaxWaitNoFiring, CntSamples = "
           + ElapsedTime~minute + ", " + MaxWaitNoFiring~minute + ", " + CntSamples~count

      behavior Guidance:Execute {
        run in sequence

        set command = "stop"
      }

      assign in sequence StoppedForNoFiringForTooLong = true
    }

    macro $k = 1..60 {
      aggregate SetOptionsOfSample$k {
        run when (
          not ( SampleOptionsSet )
          and ( CntSamples + StartIndex - 1 count == $k count )
          and ( CntSamples <= NumSamplers )
          and ( not ( FlagSamplingOngoing ) )
        )

        assign in sequence CartridgeTypeIndividual = CartridgeType[$k]

        assign in sequence ShallowBoundSmearIndividual = ShallowBoundSmear[$k]

        assign in sequence DeepBoundSmearIndividual = DeepBoundSmear[$k]

        assign in sequence WaitIndividualBeforeFiring = WaitBeforeFiring[$k]

        assign in sequence WaitIndividualAfterFiring = WaitAfterFiring[$k]

        call id="SetOptionsForSample$k" refId="SetSampleOptions"

        assign in sequence SampleOptionsSet = true
      }
    }

    aggregate FiringNoCommsEndOfSample {
      run when (
        Universal:depth >= YoYoMinDepth
        and ( Universal:depth <= YoYoMaxDepth )
        and MissionStartCommsCompleted
        and ( not ( FlagSamplingOngoing ) )
        and ( CntSamples <= NumSamplers )
        and SampleOptionsSet
        and ( not ( SampleCompleted ) )
        and ( not ( SurfaceCommsEndOfEachSample ) )
      )

      assign in sequence CommsEndOfSampleCompleted = false

      assign in sequence FlagSamplingOngoing = true

      call id="TransitSamplingLocation" refId="Transit"

      syslog important "Taking sample No." + CntSamples~count + "."

      assign in sequence ElapsedSinceStartOrLastSample = 0 hour

      call id="WaitBeforeFiring" refId="InsertWaitBeforeFiring"

      call id="Sampling" refId="TriggerSampling"

      call id="WaitAfterFiring" refId="InsertWaitAfterFiring"

      syslog important "Sample No." + CntSamples~count + " completed."

      assign in sequence SampleCompleted = true

      assign in sequence ElapsedSinceStartOrLastSample = 0 hour

      assign in sequence FlagSamplingOngoing = false
    }

    aggregate FiringCommsEndOfSample {
      run when (
        Universal:depth >= YoYoMinDepth
        and ( Universal:depth <= YoYoMaxDepth )
        and MissionStartCommsCompleted
        and ( not ( FlagSamplingOngoing ) )
        and ( CntSamples <= NumSamplers )
        and SampleOptionsSet
        and ( not ( SampleCompleted ) )
        and SurfaceCommsEndOfEachSample
      )

      assign in sequence CommsEndOfSampleCompleted = false

      assign in sequence FlagSamplingOngoing = true

      call id="TransitSamplingLocation" refId="Transit"

      syslog important "Taking sample No." + CntSamples~count + "."

      assign in sequence ElapsedSinceStartOrLastSample = 0 hour

      call id="WaitBeforeFiring" refId="InsertWaitBeforeFiring"

      call id="Sampling" refId="TriggerSampling"

      call id="WaitAfterFiring" refId="InsertWaitAfterFiring"

      syslog important "Sample No." + CntSamples~count + " completed."

      call id="CommsSampling" refId="NeedComms"

      assign in sequence CommsEndOfSampleCompleted = true

      assign in sequence SampleCompleted = true

      assign in sequence ElapsedSinceStartOrLastSample = 0 hour

      assign in sequence FlagSamplingOngoing = false
    }

    aggregate IncrementSampleCounter {
      run when (
        SampleCompleted
        and (
          not ( SurfaceCommsEndOfEachSample )
          or (
            SurfaceCommsEndOfEachSample
            and CommsEndOfSampleCompleted
          )
        )
      )

      assign in sequence CntSamples = CntSamples + 1 count

      assign in sequence SampleOptionsSet = false

      assign in sequence SampleCompleted = false
    }
  }
}