Goby3  3.0.1
2021.08.17
goby Namespace Reference

The global namespace for the Goby project. More...

Namespaces

 acomms
 Classes and functions pertaining to acoustic communications (acomms) as well as related marine relevant communications links (such as satellite)
 
 apps
 
 common
 Deprecated functions largely related to time handling (use goby::time for new work)
 
 middleware
 Objects implementing the Goby nested middleware.
 
 moos
 
 test
 
 time
 Functions and objects related to timekeeping.
 
 util
 
 zeromq
 

Classes

class  Exception
 simple exception class for goby applications More...
 
class  GobyFieldOptions
 
class  GobyFieldOptions_ConfigurationOptions
 
class  GobyMessageOptions
 

Typedefs

typedef std::uint32_t uint32
 
typedef std::int32_t int32
 
typedef std::uint64_t uint64
 
typedef std::int64_t int64
 

Enumerations

enum  GobyFieldOptions_ConfigurationOptions_ConfigAction { GobyFieldOptions_ConfigurationOptions_ConfigAction_ALWAYS = 1, GobyFieldOptions_ConfigurationOptions_ConfigAction_NEVER = 2, GobyFieldOptions_ConfigurationOptions_ConfigAction_ADVANCED = 3 }
 

Functions

template<typename App >
int run (const goby::middleware::ConfiguratorInterface< typename App::ConfigType > &cfgtor)
 Run a Goby application using the provided Configurator. More...
 
template<typename App , typename Configurator = middleware::ProtobufConfigurator<typename App::ConfigType>>
int run (int argc, char *argv[])
 Shorthand for goby::run for Configurators that have a constructor that simply takes argc, argv, e.g. MyConfigurator(int argc, char* argv[]). Allows for backwards-compatibility pre-Configurator. More...
 
bool GobyFieldOptions_ConfigurationOptions_ConfigAction_IsValid (int value)
 
const ::google::protobuf::EnumDescriptor * GobyFieldOptions_ConfigurationOptions_ConfigAction_descriptor ()
 
const ::std::string & GobyFieldOptions_ConfigurationOptions_ConfigAction_Name (GobyFieldOptions_ConfigurationOptions_ConfigAction value)
 
bool GobyFieldOptions_ConfigurationOptions_ConfigAction_Parse (const ::std::string &name, GobyFieldOptions_ConfigurationOptions_ConfigAction *value)
 
std::string version_message ()
 

Variables

GobyFieldOptionsDefaultTypeInternal _GobyFieldOptions_default_instance_
 
GobyFieldOptions_ConfigurationOptionsDefaultTypeInternal _GobyFieldOptions_ConfigurationOptions_default_instance_
 
GobyMessageOptionsDefaultTypeInternal _GobyMessageOptions_default_instance_
 
const GobyFieldOptions_ConfigurationOptions_ConfigAction GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MIN = GobyFieldOptions_ConfigurationOptions_ConfigAction_ALWAYS
 
const GobyFieldOptions_ConfigurationOptions_ConfigAction GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MAX = GobyFieldOptions_ConfigurationOptions_ConfigAction_ADVANCED
 
const int GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_ARRAYSIZE = GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MAX + 1
 
static const int kFieldFieldNumber = 1009
 
extern ::google::protobuf::internal::ExtensionIdentifier< ::google::protobuf::FieldOptions, ::google::protobuf::internal::MessageTypeTraits< ::goby::GobyFieldOptions >, 11, false > field
 
static const int kMsgFieldNumber = 1009
 
extern ::google::protobuf::internal::ExtensionIdentifier< ::google::protobuf::MessageOptions, ::google::protobuf::internal::MessageTypeTraits< ::goby::GobyMessageOptions >, 11, false > msg
 
const std::string VERSION_STRING = "3.0.1"
 
const std::string VERSION_DATE = "2021.08.17"
 

Detailed Description

The global namespace for the Goby project.

All objects related to the Goby Underwater Autonomy Project.

Typedef Documentation

◆ int32

typedef std::int32_t goby::int32

Definition at line 33 of file primitive_types.h.

◆ int64

typedef std::int64_t goby::int64

Definition at line 35 of file primitive_types.h.

◆ uint32

typedef std::uint32_t goby::uint32

Definition at line 32 of file primitive_types.h.

◆ uint64

typedef std::uint64_t goby::uint64

Definition at line 34 of file primitive_types.h.

Enumeration Type Documentation

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction

Enumerator
GobyFieldOptions_ConfigurationOptions_ConfigAction_ALWAYS 
GobyFieldOptions_ConfigurationOptions_ConfigAction_NEVER 
GobyFieldOptions_ConfigurationOptions_ConfigAction_ADVANCED 

Definition at line 74 of file option_extensions.pb.h.

Function Documentation

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_descriptor()

const ::google::protobuf::EnumDescriptor* goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_descriptor ( )

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_IsValid()

bool goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_IsValid ( int  value)

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_Name()

const ::std::string& goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_Name ( GobyFieldOptions_ConfigurationOptions_ConfigAction  value)
inline

Definition at line 85 of file option_extensions.pb.h.

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_Parse()

bool goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_Parse ( const ::std::string &  name,
GobyFieldOptions_ConfigurationOptions_ConfigAction value 
)
inline

Definition at line 89 of file option_extensions.pb.h.

◆ run() [1/2]

template<typename App >
int goby::run ( const goby::middleware::ConfiguratorInterface< typename App::ConfigType > &  cfgtor)

Run a Goby application using the provided Configurator.

Blocks caller until Application::quit() is called

Parameters
cfgtorSubclass of ConfiguratorInterface used to configure the App
Template Parameters
AppApplication subclass
Returns
same as int main(int argc, char* argv)

Definition at line 277 of file interface.h.

◆ run() [2/2]

template<typename App , typename Configurator = middleware::ProtobufConfigurator<typename App::ConfigType>>
int goby::run ( int  argc,
char argv[] 
)

Shorthand for goby::run for Configurators that have a constructor that simply takes argc, argv, e.g. MyConfigurator(int argc, char* argv[]). Allows for backwards-compatibility pre-Configurator.

Parameters
argcsame as argc in int main(int argc, char* argv)
argvsame as argv in int main(int argc, char* argv)
Template Parameters
AppApplication subclass
ConfiguratorConfigurator object that has a constructor such as Configurator(int argc, char* argv)
Returns
same as int main(int argc, char* argv)

Definition at line 64 of file interface.h.

◆ version_message()

std::string goby::version_message ( )
inline

Definition at line 40 of file version.h.

Variable Documentation

◆ _GobyFieldOptions_ConfigurationOptions_default_instance_

GobyFieldOptions_ConfigurationOptionsDefaultTypeInternal goby::_GobyFieldOptions_ConfigurationOptions_default_instance_

◆ _GobyFieldOptions_default_instance_

GobyFieldOptionsDefaultTypeInternal goby::_GobyFieldOptions_default_instance_

◆ _GobyMessageOptions_default_instance_

GobyMessageOptionsDefaultTypeInternal goby::_GobyMessageOptions_default_instance_

◆ field

extern ::google::protobuf::internal::ExtensionIdentifier< ::google::protobuf::FieldOptions, ::google::protobuf::internal::MessageTypeTraits< ::goby::GobyFieldOptions >, 11, false > goby::field

Definition at line 556 of file option_extensions.pb.h.

◆ glog

util::FlexOstream goby::glog

Access the Goby logger through this object.

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_ARRAYSIZE

const int goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_ARRAYSIZE = GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MAX + 1

Definition at line 82 of file option_extensions.pb.h.

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MAX

const GobyFieldOptions_ConfigurationOptions_ConfigAction goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MAX = GobyFieldOptions_ConfigurationOptions_ConfigAction_ADVANCED

Definition at line 81 of file option_extensions.pb.h.

◆ GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MIN

const GobyFieldOptions_ConfigurationOptions_ConfigAction goby::GobyFieldOptions_ConfigurationOptions_ConfigAction_ConfigAction_MIN = GobyFieldOptions_ConfigurationOptions_ConfigAction_ALWAYS

Definition at line 80 of file option_extensions.pb.h.

◆ kFieldFieldNumber

const int goby::kFieldFieldNumber = 1009
static

Definition at line 553 of file option_extensions.pb.h.

◆ kMsgFieldNumber

const int goby::kMsgFieldNumber = 1009
static

Definition at line 557 of file option_extensions.pb.h.

◆ msg

extern ::google::protobuf::internal::ExtensionIdentifier< ::google::protobuf::MessageOptions, ::google::protobuf::internal::MessageTypeTraits< ::goby::GobyMessageOptions >, 11, false > goby::msg

Definition at line 560 of file option_extensions.pb.h.

◆ VERSION_DATE

const std::string goby::VERSION_DATE = "2021.08.17"

Definition at line 38 of file version.h.

◆ VERSION_STRING

const std::string goby::VERSION_STRING = "3.0.1"

Definition at line 37 of file version.h.