app_config.proto

Go to the documentation of this file.

syntax = "proto2";
import "goby/protobuf/option_extensions.proto";
import "goby/util/protobuf/debug_logger.proto";
import "dccl/option_extensions.proto";
 
package goby.middleware.protobuf;
 
message AppConfig
{
    option (dccl.msg).unit_system = "si";
 
    optional string name = 1 [
        (goby.field).example = "myapp_g",
        (goby.field).description =
            "default is 'binary': change this to run multiple instances",
        (goby.field).cfg = { action: ADVANCED }
    ];
 
    optional string binary = 2 [(goby.field) = {
        description: "compiled binary name; set by configurator."
        cfg { action: NEVER }
    }];
 
    optional double loop_frequency = 3 [
        (goby.field) = {
            description: "Frequency to call loop() at. If not set, uses compile-time loop frequency. Zero or negative means loop() is never called."
        },
        (dccl.field).units = { base_dimensions: "T^-1" }
    ];
 
    optional goby.util.protobuf.GLogConfig glog_config = 10
        [(goby.field).description =
             "configure the Goby Logger (TTY terminal and file debugging "
             "logger)"];
 
    message SimulatorSettings
    {
        message Time
        {
            optional bool use_sim_time = 1 [
                default = false,
                (goby.field).description =
                    "Enable the use of a different clock for all calls to "
                    "goby::time::SystemClock::now<time::MicroTime>() and "
                    "related"
            ];
            optional int32 warp_factor = 2 [
                default = 1,
                (goby.field).description =
                    "Warp factor used to simulate faster-than-realtime "
                    "missions. For example warp_factor: 10 means run the clock "
                    "10x the real time."
            ];
            optional int64 reference_microtime = 3 [
                (goby.field).description =
                    "Reference time to use when running with use_sim_time: "
                    "true (defaults to 00:00 UTC on January 1 of the current "
                    "year). The time difference between now and the reference "
                    "time is multiplied by the warp factor to calculate the "
                    "modified simulation time",
                (goby.field).cfg = { action: ADVANCED },
                (dccl.field).units = { prefix: "micro" base_dimensions: "T" }
            ];
        }
        optional Time time = 1;
    }
    optional SimulatorSettings simulation = 20
        [(goby.field).description = "Simulation related settings"];
 
    message Geodesy
    {
        required double lat_origin = 1 [(dccl.field).units = {
            system: "angle::degree"
            derived_dimensions: "plane_angle"
        }];
        required double lon_origin = 2 [(dccl.field).units = {
            system: "angle::degree"
            derived_dimensions: "plane_angle"
        }];
    }
    optional Geodesy geodesy = 30 [
        (goby.field).description = "Geodesy related settings",
        (goby.field).cfg = { action: ADVANCED }
    ];
 
    message Health
    {
        optional bool run_health_monitor_thread = 1 [default = true];
    }
    optional Health health_cfg = 40 [(goby.field).cfg = { action: ADVANCED }];
 
    message Tool
    {
        repeated string extra_cli_param = 1;
    }
    optional Tool tool_cfg = 50 [(goby.field).cfg = { action: NEVER }];
 
    optional bool debug_cfg = 100 [
        default = false,
        (goby.field).description =
            "If true, rather than launch the application, simply write the "
            "parsed configuration to stdout and exit",
        (goby.field).cfg = { action: ADVANCED }
    ];
}