# uuv_plume_msgs

Link to the uuv_plume_simulator repository here

#### Description¶

Plume simulator messages and services package.

#### ROS Services¶

##### SetCurrentDirection¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

float64 angle
---
bool success

##### GetPlumeConfiguration¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

---
string model_name
int32 n_points
int32 max_particles_per_iter
geometry_msgs/Point source
float64 x_min
float64 x_max
float64 y_min
float64 y_max
float64 z_min
float64 z_max

##### SetCurrentVelocity¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

float64 velocity
float64 horizontal_angle
---
bool success

##### StorePlumeState¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

string output_dir
string filename
---
bool success
string plume_file

##### DeletePlume¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

---
bool success

##### GetPlumeSourcePosition¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

---
geometry_msgs/Point source

##### SetPlumeConfiguration¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

int32 n_points
int32 max_particles_per_iter
---
bool success

##### CreatePassiveScalarTurbulentPlume¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

geometry_msgs/Vector3 turbulent_diffusion_coefficients
geometry_msgs/Point source
float64 buoyancy_flux
float64 stability_param
int32 n_points
int32 max_particles_per_iter
float64 x_min
float64 x_max
float64 y_min
float64 y_max
float64 z_min
float64 z_max
float64 max_life_time
---
bool success

##### GetCurrentModel¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

---
float64 mean
float64 min
float64 max
float64 noise
float64 mu

##### LoadPlumeParticles¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

string plume_file
---
bool success

##### SetPlumeLimits¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

float64 x_min
float64 x_max
float64 y_min
float64 y_max
float64 z_min
float64 z_max
---
bool success

##### SetPlumeSourcePosition¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

geometry_msgs/Point source
---
bool success

##### CreateSpheroidPlume¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

geometry_msgs/Point source
geometry_msgs/Quaternion orientation
int32 n_points
float32 a
float32 c
float64 x_min
float64 x_max
float64 y_min
float64 y_max
float64 z_min
float64 z_max
---
bool success

##### SetCurrentModel¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
# Unless required by applicable law or agreed to in writing, software
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and

float64 mean
float64 min
float64 max
float64 noise
float64 mu
---
bool success

##### GetNumParticles¶
# Copyright (c) 2016 The UUV Simulator Authors.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#