Struct SceneEntityDeletion

Struct Documentation

struct SceneEntityDeletion

Command to remove previously published entities.

Public Types

enum class SceneEntityDeletionType : uint8_t

An enumeration indicating which entities should match a SceneEntityDeletion command.

Values:

enumerator MATCHING_ID

Delete the existing entity on the same topic that has the provided id

enumerator ALL

Delete all existing entities on the same topic.

Public Functions

FoxgloveError encode(uint8_t *ptr, size_t len, size_t *encoded_len)

Encoded the SceneEntityDeletion as protobuf to the provided buffer.

On success, writes the serialized length to *encoded_len. If the provided buffer has insufficient capacity, writes the required capacity to *encoded_len and returns FoxgloveError::BufferTooShort. If the message cannot be encoded, writes the reason to stderr and returns FoxgloveError::EncodeError.

Parameters:

  • ptr – the destination buffer. must point to at least len valid bytes.

  • len – the length of the destination buffer.

  • encoded_len – where the serialized length or required capacity will be written to.

Public Members

std::optional<Timestamp> timestamp

Timestamp of the deletion. Only matching entities earlier than this timestamp will be deleted.

SceneEntityDeletionType type

Type of deletion action to perform.

std::string id

Identifier which must match if type is MATCHING_ID.

Public Static Functions

static Schema schema()

Get the SceneEntityDeletion schema.

The schema data returned is statically allocated.