Skip to content

Insert/SampleAtDepth.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
#   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.

aggregate SampleAtDepth {
  """
  Take a water sample at a specified depth.
  """

  arguments {
    TargetDepth = 5 meter
      """
      Depth to sample at. Initialized to 5 m.
      """

    SettleTime = 10 second
      """
      Time to wait after reaching target depth before triggering sample.
      Initialized to 10 minutes.
      """

    MaxWaitNotReachingDepth = 3 hour
      """
      Maximum wait time the vehicle cannot reach the targeted depth.
      Initialized to 3 hours.
      """

    RotateOnly = 0 bool

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

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

    ESPCartridgeType = NaN count
      """
      Specifies ESP cartridge type code.
      """

    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.
      """
  }

  run when ( called )

  aggregate ReportInvalidDepth {
    run in sequence

    break if ( not ( isNaN ( TargetDepth ) ) )

    syslog fault "SampleAtDepth received an invalid target depth. Skipping sample."
  }

  aggregate sample {
    run in sequence

    break if ( isNaN ( TargetDepth ) )

    aggregate ApproachDepth {
      run in sequence

      syslog "Moving to " + TargetDepth~meter

      behavior Guidance:Pitch {
        run in sequence

        timeout duration=MaxWaitNotReachingDepth {
          syslog important "Timed out trying to reach the targeted depth. Stopping mission."

          behavior Guidance:Execute {
            run in sequence

            set command = "stop"
          }
        }

        set depth = TargetDepth
      }
    }

    aggregate SampleWrapper {
      run in sequence

      behavior Guidance:Pitch {
        run in parallel

        set depth = TargetDepth
      }

      syslog important "At " + Universal:depth~meter + ", settling for " + SettleTime~minute

      behavior Guidance:Wait {
        run in sequence

        set duration = SettleTime
      }

      aggregate SampleCANONSampler {
        run in sequence

        break if ( not ( UseCANONSampler ) )

        assign in parallel Science:CANONSampler.sampleTimeout = CANONSamplerTimeout

        assign in parallel Science:CANONSampler.rotateOnly = RotateOnly

        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
        }

        syslog important "CANONSampler sampling at " + Universal:depth~meter + " in "
             + Science:CTD_NeilBrown.bin_mean_sea_water_temperature~celsius + " water with "
             + Science:WetLabsBB2FL.bin_mean_mass_concentration_of_chlorophyll_in_sea_water~microgram_per_liter
             + " chlorophyll fluorescence."

        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 SampleESP {
        run in sequence

        break if ( not ( UseESP ) )

        aggregate SelectESPCartridge {
          run in sequence

          break if ( isNaN ( ESPCartridgeType ) )

          behavior Science:ESPCartridgeSelect {
            run in sequence

            timeout duration=P1M

            set cartridgeType = ESPCartridgeType
          }
        }

        readDatum id="TriggerESP" {
          Science:ESPComponent.sampling
        }

        syslog important "ESP sampling at " + Universal:depth~meter + " in "
             + Science:CTD_Seabird.bin_mean_sea_water_temperature~celsius + " water with "
             + Science:WetLabsBB2FL.bin_mean_mass_concentration_of_chlorophyll_in_sea_water~microgram_per_liter
             + "chlorophyll fluorescence."

        readDatum id="WaitForESP" {
          Science:ESPComponent.sample_number
        }
      }
    }
  }
}