Note: Goby version 1 (shown here) is now considered obsolete. Please use version 2 for new projects, and consider upgrading old projects.

Goby Underwater Autonomy Project  Series: 1.1, revision: 163, released on 2013-02-06 14:23:27 -0500
moos/libmoos_util/tes_moos_app.proto
00001 import "goby/protobuf/option_extensions.proto";
00002 
00003 message TesMoosAppConfig
00004 {
00005   // Global moos variables (Specified outside "ProcessConfig" blocks)
00006   optional bool log = 100 [default = true, (moos_global) = "log",
00007                            (description)="Should we write a text log of the terminal output?"];
00008   optional string log_path = 101 [default = "./",
00009                                   (moos_global) = "log_path",
00010                                   (description)="Directory path to write the text log of the terminal output (if log=true)"];
00011   optional string community = 102 [(moos_global) = "Community",
00012                                    (description)="The vehicle's name", (example)="AUV23"];
00013   optional double lat_origin = 103 [(moos_global) = "LatOrigin",
00014                                     (description)="Latitude in decimal degrees of the local cartesian datum",
00015                                     (example)="42.5"];
00016   optional double lon_origin = 104 [(moos_global) = "LongOrigin",
00017                                     (description)="Longitude in decimal degrees of the local cartesian datum",
00018                                     (example)="10.9"];
00019   
00020   optional uint32 app_tick = 1 [default = 10,
00021                                 (description)="Frequency at which to run Iterate()."];
00022   
00023   optional uint32 comm_tick = 2 [default = 10,
00024                                  (description)="Frequency at which to call into the MOOSDB for mail."];
00025   
00026   enum Verbosity { VERBOSITY_QUIET = 1; VERBOSITY_WARN = 2; VERBOSITY_VERBOSE = 3; VERBOSITY_DEBUG = 4; VERBOSITY_GUI = 5; }
00027   optional Verbosity verbosity = 3 [default = VERBOSITY_VERBOSE,
00028                                     (description)="Verbosity of the terminal window output"];
00029 
00030   // post various configuration values to the MOOSDB on startup
00031   message Initializer
00032   {
00033     enum Type
00034     {
00035       INI_DOUBLE = 1;
00036       INI_STRING = 2;
00037     }
00038     required Type type = 1 [(description)="type of MOOS variable to publish",
00039                             (example)="INI_DOUBLE"];
00040     required string moos_var = 2 [(description)="name of MOOS variable to publish to",
00041                                   (example)="SOME_MOOS_VAR"];
00042     optional string global_cfg_var = 3 [(description)="Optionally, instead of giving `sval` or `dval`, give a name here of a global MOOS variable (one at the top of the file) whose contents should be written to `moos_var`", (example)="LatOrigin"]; // pull from globals at top of MOOS file
00043     optional double dval = 4 [(description)="Value to write for type==INI_DOUBLE",
00044                               (example)="3.454"]; // required if type == MOOS_DOUBLE
00045     optional string sval = 5 [(description)="Value to write for type==INI_STRING",
00046                               (example)="a string"]; // required if type == MOOS_STRING
00047   }  
00048   repeated Initializer initializer = 10 [(description)="Publish a constant value to the MOOSDB at startup"];
00049 }
00050     
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends