Goby3  3.0.2
2021.08.17
goby::middleware::DynamicGroup Class Reference

Implementation of Group for dynamic (run-time) instantiations. Use Group directly for static (compile-time) instantiations. More...

#include <goby/middleware/group.h>

Inheritance diagram for goby::middleware::DynamicGroup:
goby::middleware::Group

Public Member Functions

 DynamicGroup (const std::string &s, std::uint8_t i=Group::invalid_numeric_group)
 Construct a group with a string and possibly a numeric value (when this Group will be used on intervehicle and outer layers). More...
 
 DynamicGroup (std::uint8_t i)
 Construct a group with a numeric value only. More...
 
- Public Member Functions inherited from goby::middleware::Group
constexpr Group (const char *c, std::uint8_t i=invalid_numeric_group)
 Construct a group with a (C-style) string and possibly a numeric value (when this Group will be used on intervehicle and outer layers). More...
 
constexpr Group (std::uint8_t i=invalid_numeric_group)
 Construct a group with only a numeric value. More...
 
constexpr std::uint8_t numeric () const
 Access the group's numeric value. More...
 
constexpr const charc_str () const
 Access the group's string value as a C string. More...
 
 operator std::string () const
 Access the group's string value as a C++ string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from goby::middleware::Group
static constexpr std::uint8_t broadcast_group {0}
 Special group number representing the broadcast group (used when no grouping is required for a given type) More...
 
static constexpr std::uint8_t invalid_numeric_group {255}
 Special group number representing an invalid numeric group (unsuitable for intervehicle and outer layers) More...
 
static constexpr std::uint8_t maximum_valid_group {254}
 
- Protected Member Functions inherited from goby::middleware::Group
void set_c_str (const char *c)
 

Detailed Description

Implementation of Group for dynamic (run-time) instantiations. Use Group directly for static (compile-time) instantiations.

Definition at line 116 of file group.h.

Constructor & Destructor Documentation

◆ DynamicGroup() [1/2]

goby::middleware::DynamicGroup::DynamicGroup ( const std::string &  s,
std::uint8_t  i = Group::invalid_numeric_group 
)
inline

Construct a group with a string and possibly a numeric value (when this Group will be used on intervehicle and outer layers).

Definition at line 120 of file group.h.

◆ DynamicGroup() [2/2]

goby::middleware::DynamicGroup::DynamicGroup ( std::uint8_t  i)
inline

Construct a group with a numeric value only.

Definition at line 127 of file group.h.


The documentation for this class was generated from the following file: