goby::middleware::tool::interface::PubSubEntry Struct Reference

One publication or subscription as written to (and read from) an interface file. More...

#include <goby/middleware/tool/interface/pubsub_entry.h>

Public Types
enum class	Direction { UNKNOWN , PUBLISH , SUBSCRIBE }

Public Member Functions
	PubSubEntry ()=default
	PubSubEntry (Layer l, Direction dir, const YAML::Node &yaml, const std::string &th="")
	PubSubEntry (Layer l, Direction d, std::string th, std::string g, std::string s, std::string t, bool tk, goby::middleware::Necessity n, bool r)
bool	unresolved () const
	A dynamic group whose string goby_clang_tool could not determine.
bool	unbound () const
	A dynamic group whose numeric part is still unknown.
std::string	display_group () const
	The group as a deployment sees it, with any bound numeric values.
std::string	publish_index_str () const
void	write_yaml_map (YAML::Emitter &yaml_out, bool include_thread=true, bool inner_pub=false, bool include_necessity=true) const

Public Attributes
Layer	layer {Layer::UNKNOWN}
Direction	direction {Direction::UNKNOWN}
std::string	thread
std::string	group
std::string	scheme
std::string	type
bool	thread_is_known {true}
goby::middleware::Necessity	necessity {goby::middleware::Necessity::OPTIONAL}
bool	is_regex {false}
bool	is_inner_pub {false}
bool	dynamic {false}
bool	numeric_runtime {false}
std::string	expr
std::set< std::uint32_t >	bound_numerics
bool	necessity_overridden {false}
int	publish_index {-1}

Detailed Description

One publication or subscription as written to (and read from) an interface file.

Definition at line 102 of file pubsub_entry.h.

Member Enumeration Documentation

Direction

enum class goby::middleware::tool::interface::PubSubEntry::Direction

strong

Enumerator
UNKNOWN
PUBLISH
SUBSCRIBE

Definition at line 104 of file pubsub_entry.h.

Constructor & Destructor Documentation

PubSubEntry() [1/3]

goby::middleware::tool::interface::PubSubEntry::PubSubEntry ( )

default

PubSubEntry() [2/3]

goby::middleware::tool::interface::PubSubEntry::PubSubEntry ( Layer  l, Direction  dir, const YAML::Node &  yaml, const std::string &  th = ""  )

inline

Definition at line 113 of file pubsub_entry.h.

PubSubEntry() [3/3]

goby::middleware::tool::interface::PubSubEntry::PubSubEntry ( Layer  l, Direction  d, std::string  th, std::string  g, std::string  s, std::string  t, bool  tk, goby::middleware::Necessity  n, bool  r  )

inline

Definition at line 140 of file pubsub_entry.h.

Member Function Documentation

display_group()

std::string goby::middleware::tool::interface::PubSubEntry::display_group ( ) const

inline

The group as a deployment sees it, with any bound numeric values.

Definition at line 236 of file pubsub_entry.h.

publish_index_str()

std::string goby::middleware::tool::interface::PubSubEntry::publish_index_str ( ) const

inline

Definition at line 190 of file pubsub_entry.h.

unbound()

bool goby::middleware::tool::interface::PubSubEntry::unbound ( ) const

inline

A dynamic group whose numeric part is still unknown.

Definition at line 182 of file pubsub_entry.h.

unresolved()

bool goby::middleware::tool::interface::PubSubEntry::unresolved ( ) const

inline

A dynamic group whose string goby_clang_tool could not determine.

Definition at line 179 of file pubsub_entry.h.

write_yaml_map()

void goby::middleware::tool::interface::PubSubEntry::write_yaml_map ( YAML::Emitter &  yaml_out, bool  include_thread = true, bool  inner_pub = false, bool  include_necessity = true  ) const

inline

Definition at line 195 of file pubsub_entry.h.

Member Data Documentation

bound_numerics

std::set<std::uint32_t> goby::middleware::tool::interface::PubSubEntry::bound_numerics

Definition at line 174 of file pubsub_entry.h.

direction

Direction goby::middleware::tool::interface::PubSubEntry::direction {Direction::UNKNOWN}

Definition at line 155 of file pubsub_entry.h.

dynamic

bool goby::middleware::tool::interface::PubSubEntry::dynamic {false}

Definition at line 168 of file pubsub_entry.h.

expr

std::string goby::middleware::tool::interface::PubSubEntry::expr

Definition at line 172 of file pubsub_entry.h.

group

std::string goby::middleware::tool::interface::PubSubEntry::group

Definition at line 158 of file pubsub_entry.h.

is_inner_pub

bool goby::middleware::tool::interface::PubSubEntry::is_inner_pub {false}

Definition at line 165 of file pubsub_entry.h.

is_regex

bool goby::middleware::tool::interface::PubSubEntry::is_regex {false}

Definition at line 163 of file pubsub_entry.h.

layer

Layer goby::middleware::tool::interface::PubSubEntry::layer {Layer::UNKNOWN}

Definition at line 154 of file pubsub_entry.h.

necessity

goby::middleware::Necessity goby::middleware::tool::interface::PubSubEntry::necessity {goby::middleware::Necessity::OPTIONAL}

Definition at line 162 of file pubsub_entry.h.

necessity_overridden

bool goby::middleware::tool::interface::PubSubEntry::necessity_overridden {false}

Definition at line 176 of file pubsub_entry.h.

numeric_runtime

bool goby::middleware::tool::interface::PubSubEntry::numeric_runtime {false}

Definition at line 170 of file pubsub_entry.h.

publish_index

int goby::middleware::tool::interface::PubSubEntry::publish_index {-1}

mutable

Definition at line 188 of file pubsub_entry.h.

scheme

std::string goby::middleware::tool::interface::PubSubEntry::scheme

Definition at line 159 of file pubsub_entry.h.

thread

std::string goby::middleware::tool::interface::PubSubEntry::thread

Definition at line 157 of file pubsub_entry.h.

thread_is_known

bool goby::middleware::tool::interface::PubSubEntry::thread_is_known {true}

Definition at line 161 of file pubsub_entry.h.

type

std::string goby::middleware::tool::interface::PubSubEntry::type

Definition at line 160 of file pubsub_entry.h.

---

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

• goby/middleware/tool/interface/pubsub_entry.h