Class CubePrimitiveChannel

Class Documentation

class CubePrimitiveChannel

A channel for logging CubePrimitive messages to a topic.

Note

While channels are fully thread-safe, the CubePrimitive struct is not thread-safe. Avoid modifying it concurrently or during a log operation.

Public Functions

FoxgloveError log(const CubePrimitive &msg, std::optional<uint64_t> log_time = std::nullopt) noexcept

Log a message to the channel.

Parameters:

  • msg – The CubePrimitive message to log.

  • log_time – The timestamp of the message. If omitted, the current time is used.

uint64_t id() const noexcept

Uniquely identifies a channel in the context of this program.

Returns:

The ID of the channel.

CubePrimitiveChannel(const CubePrimitiveChannel &other) noexcept = delete
CubePrimitiveChannel &operator=(const CubePrimitiveChannel &other) noexcept = delete
CubePrimitiveChannel(CubePrimitiveChannel &&other) noexcept = default

Default move constructor.

CubePrimitiveChannel &operator=(CubePrimitiveChannel &&other) noexcept = default

Default move assignment.

~CubePrimitiveChannel() = default

Default destructor.

Public Static Functions

static FoxgloveResult<CubePrimitiveChannel> create(const std::string_view &topic, const Context &context = Context())

Create a new channel.

Parameters:

  • topic – The topic name. You should choose a unique topic name per channel for compatibility with the Foxglove app.

  • context – The context which associates logs to a sink. If omitted, the default context is used.