netsim.proto

Go to the documentation of this file.

import "dccl/option_extensions.proto";
 
import "goby/protobuf/option_extensions.proto";
import "goby/acomms/protobuf/mm_driver.proto";
 
package netsim.protobuf;
 
message ImpulseResponse
{
   oneof src
   {
    string source = 1;
    int32  source_id = 21;
    }
    oneof rcv
    {
    string receiver = 2;
    int32  receiver_id = 22;
    }
    optional int32 number_array_elements = 3 [default = 1];
    repeated RayTrace raytrace = 4;
    message RayTrace
    {
        required double amplitude = 2 [(goby.field).description = "Pascal"];
        optional double doppler = 3 [
            (goby.field).description = "Doppler blueshift factor",
            default = 1.0
        ];
        optional double elevation = 4
            [(goby.field).description = "Degrees", default = 0];
        optional int32 surface_bounces = 5
            [(goby.field).description = "Number of ray surface bounces"];
        optional int32 bottom_bounces = 6
            [(goby.field).description = "Number of ray bottom bounces"];
        repeated ArrayElementDelay element = 7;
        message ArrayElementDelay
        {
            required double delay = 1;
        }
    }
    optional double noise_level = 5;
    optional double receiver_sound_speed = 6 [default = 1500];
    optional double surface_sound_speed = 7 [default = 1500];
    optional double bottom_sound_speed = 8 [default = 1500];
 
    optional string covariance_file = 9;
 
    optional int32 request_id = 10;
    optional double request_time = 11;
    optional double range = 12;
}
 
message ImpulseRequest
{
   oneof src
   {
    string source = 1;
    int32  source_id = 21;
    }
    oneof rcv
    {
    string receiver = 2;
    int32  receiver_id =22;
    }
 
    optional double sampling_frequency = 6 [default = 12000];
    optional int32 nfft = 7 [default = 2048];
 
    optional int32 request_id = 10;
    optional double request_time = 11;
 
    message ArrayElement
      {
        optional double x_offset = 1 [default = 0];
        optional double y_offset = 2 [default = 0];
        optional double z_offset = 3 [default = 0];
      }
    repeated ArrayElement  array_element = 40;
 
 }
 
message ObjFuncRequest
{
    option (dccl.msg).unit_system = "si";
 
oneof cntct
    {
      string contact = 1;
      int32 contact_id = 21;
    }
    optional int32 request_id = 2;
    optional double request_time = 3
        [(dccl.field).units = {base_dimensions: "T"}];
 
    repeated Receiver receiver = 4;
    required string requestor = 5;
    
    message Receiver
    {
       oneof recv
        {
         string node = 1;
         int32 node_id = 21;
    }
        optional double range = 2;
        optional double depth = 3;
    }
}
 
message ObjFuncResponse
{
    option (dccl.msg).unit_system = "si";
 
oneof cntct
    {
      string contact = 1;
      int32 contact_id = 21;
    }
    optional double contact_depth = 6;
    optional int32 request_id = 2;
    optional double request_time = 3
        [(dccl.field).units = {base_dimensions: "T"}];
    repeated Receiver receiver = 4;
    required string requestor = 5;
    message Receiver
    {
        optional string node = 1;
        optional int32  node_id = 21;
        required double range = 2;
    optional double delay = 3;
        required double depth = 4;
        required double metric_db = 5;
        optional double snr = 6;
        optional double mpp = 7;
    optional double tl = 8;
    optional double nl = 9;
        optional double mae = 10;
    }
}
 
message NavUpdate
{
    required int32 modem_tcp_port = 1;
    required double time = 2;
    required double lat = 3;
    required double lon = 4;
    required double depth = 5;
    required double speed = 6;
    required double heading = 7;
}
 
message ReceiveStats
{
    required int32 modem_tcp_port = 1;
    required int32 tx_modem_tcp_port = 2;
    required bool packet_success = 3;
    optional goby.acomms.micromodem.protobuf.ReceiveStatistics mm_stats = 4;
}
 
message NetSimManagerRequest
{
    required int32 id = 1;
    repeated NavUpdate nav = 2;
    repeated ReceiveStats stats = 3;
}
 
message NetSimManagerResponse
{
    required int32 request_id = 1;
    enum Status
    {
        UPDATE_ACCEPTED = 1;
        UPDATE_FAILED_INVALID_MODEM_TCP_PORT = 2;
        UPDATE_FAILED_INVALID_SOURCE_ADDRESS = 3;
        UPDATE_FAILED_OUT_OF_DEFINED_REGION = 4;
    }
    required Status status = 2;
}
 
message EnvironmentNavUpdate
{
    required int32 environment_id = 1;
    required NavUpdate nav = 2;
}
 
message EnvironmentImpulseRequest
{
    required int32 environment_id = 1;
    required ImpulseRequest req = 2;
}
 
message EnvironmentObjFuncRequest
{
    required int32 environment_id = 1;
    required ObjFuncRequest req = 2;
}